apktool

#!/usr/bin/env python
# -*- mode: python; coding: utf-8 -*-

import os
import sys
import glob
# import zipfile
from atool import zipfile

# fix sys path to include our lib
DIR_PATH = os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
sys.path.insert(0, DIR_PATH)

from atool.apk import sysresource
from atool.apk.axml import AXMLParser
from atool.apk.axml import ResourceParser
from atool.apk.axml import ResObject

TOOL_NAME = 'apktool'
COMMANDS = ['dumpapk', 'dumpxml', 'cat', 'resolve', 'catr']

usage = '''usage: apktool <command> [args]
Type 'apktool <command> -h' for help of specific command.

Available commands:
   dumpxml       dump android binary xml
   dumpapk       dump all xml files in given apk file to current directory
   cat           dump specified xml from given apk file
   catr          dump R.java
   resolve       resolve resource name of given numeric id
'''

def get_cmd_path(cmd):
    '''Get absolute path of given command with PATH environment'''
    if cmd == "":
        return None
    path = os.environ.get("PATH")
    if path == None:
        path = os.environ.get("path")
    if path == None:
        return None
    for p in path.split(':'):
        f = p + "/" + cmd
        if os.access(f, os.X_OK):
            return f
    return None

def cmp_version(v1, v2):
    if v1 == v2:
        return 0
    a1 = v1.split(".")
    a2 = v2.split(".")
    while a1 or a2:
        if not a1:
            return -1
        if not a2:
            return 1
        c1 = a1.pop(0)
        c2 = a2.pop(0)
        if c1.isdigit() and c2.isdigit():
            return cmp(int(c1), int(c2))
        else:
            return cmp(c1, c2)

def get_android_jar(sdk_dir):
    '''Get android system resource file (android.jar)'''
    if not (os.path.isdir(sdk_dir + "/platforms")
            and os.path.isfile(sdk_dir + "/tools/android")):
        return None
    prefix = sdk_dir + "/platforms/android-"
    i = len(prefix)
    platforms = glob.glob(prefix + "*")
    if not platforms:
        return None
    vs = [item[i:] for item in platforms]
    vs.sort(cmp=cmp_version)
    jar = prefix + vs[-1] + "/android.jar"
    if os.path.isfile(jar):
        return jar
    else:
        return None

def get_android_resource():
    android = get_cmd_path("android")
    if android:
        android = os.path.realpath(android)
    jar = None
    if android:
        sdk_dir = os.path.dirname(os.path.dirname(android))
        jar = get_android_jar(sdk_dir)
    if jar == None:
        sdk_dir = os.environ.get("ANDROID_HOME")
        if sdk_dir:
            jar = get_android_jar(sdk_dir)
    return jar

def dump_xml(cmd, argv):
    usage = 'usage: %s %s <binary-xml> [<resources.arsc-or-.apk>]' % (TOOL_NAME, cmd)
    detail = '''
  Dump given xml file to stdout.

  If resources file (typically resources.arsc extracted from the
  same apk file) not specified, most xml attributes will be dumped
  as numeric value.

  System resources will be auto loaded (android sdk directory is
  resolved by path of command 'android', then try environment
  variable 'ANDROID_HOME'). If system resources can not be found,
  most xml attributes will be dumped as numeric value.
'''
    if len(argv) > 0 and argv[0] in ['-h', '--help']:
        print usage
        print detail
        sys.exit(0)

    if len(argv) < 1 or len(argv) > 2:
        print >> sys.stderr, usage
        sys.exit(1)
    restable = ResObject()
    androidjar = get_android_resource()
    if androidjar:
        res = get_archived_resource(androidjar)
        if res:
            restable.update(res)

    if len(argv) > 1:
        try:
            infile = open(argv[1], "rb")
            indata = infile.read()
            infile.close()
            if len(indata) > 4 and indata[0:4] == '\x50\x4b\x03\x04':
                res = get_archived_resource(argv[1])
                if res:
                    restable.update(res)
            else:
                parser = ResourceParser(indata)
                res = parser.parse_resources()
                if res:
                    restable.update(res)
        except Exception as e:
            print >> sys.stderr, "failed to process resource: ", e

    infile = open(argv[0], "rb")
    indata = infile.read()
    infile.close()
    parser = AXMLParser(indata)
    parser.set_restable(restable)
    (xml, ns) = parser.parsexml()
    xml.dump(sys.stdout, ns)

def get_archived_resource(archive):
    zfile = None
    try:
        try:
            zfile = zipfile.ZipFile(archive, "r")
        except Exception as e1:
            print >> sys.stderr, "failed to open zip archive:", archive, e1
            return None
        data = zfile.read("resources.arsc")
        zfile.close()
        zfile = None
        parser = ResourceParser(data)
        return parser.parse_resources()
    except Exception as e:
        if zfile:
            zfile.close()
        print >> sys.stderr, "failed to process resources.arsc:", e
    return None

def make_res_id(pkgid, typeid, entryid):
    return ((0xff000000 & (pkgid << 24)) |
            (0x00ff0000 & ((typeid) << 16)) |
            (0x0000ffff & (entryid)) )

def dump_r(pkg, outfile=sys.stdout):
    print >> outfile, "package %s\n" % (pkg.name)
    print >> outfile, "public final class R {"
    for tname in sorted(pkg.name_map.keys()):
        t = pkg.name_map[tname]
        print >> outfile, "    public static final class %s {" % (t.name)
        for k in sorted(t.id_map.keys()):
            e = t.id_map[k]
            eid = make_res_id(pkg.id, t.id, e.id)
            print >> outfile, "        public static final int %s = 0x%08x;  // %d" % (e.name, eid, eid)
        print >> outfile, "    }\n"
    print >> outfile, "}"

def cat_r(cmd, argv):
    usage = 'usage: %s %s <resources.arsc-or-.apk>' % (TOOL_NAME, cmd)
    detail = '''
  Dump R.java to stdout.

  resources file or apk file must specified.
'''
    if len(argv) > 0 and argv[0] in ['-h', '--help']:
        print usage
        print detail
        sys.exit(0)

    if len(argv) != 1:
        print >> sys.stderr, usage
        sys.exit(1)

    res = None
    try:
        infile = open(argv[0], "rb")
        indata = infile.read()
        infile.close()
        if len(indata) > 4 and indata[0:4] == '\x50\x4b\x03\x04':
            res = get_archived_resource(argv[1])
        else:
            parser = ResourceParser(indata)
            res = parser.parse_resources()
        if res == None or len(res.id_map) < 1:
            print >> std.err, "no package in restable"
            return
        if len(res.id_map) != 1:
            print >> std.err, "multiple package in restable"
            return
        ids = res.id_map.keys()
        pkg = res.id_map[ids[0]]
        dump_r(pkg)
    except Exception as e:
        print >> sys.stderr, "failed to process resource: ", e

    
def dump_apk(cmd, argv):
    usage = 'usage: %s %s <file.apk>' % (TOOL_NAME, cmd)
    detail = '''
  Dump all xml files in given apk file into current directory.

  System resources will be auto loaded (android sdk directory is
  resolved by path of command 'android', then try environment
  variable 'ANDROID_HOME'). If system resources can not be found,
  most xml attributes will be dumped as numeric value.
'''
    if len(argv) > 0 and argv[0] in ['-h', '--help']:
        print usage
        print detail
        sys.exit(0)

    if len(argv) != 1:
        print >> sys.stderr, usage
        sys.exit(1)
    apkfile = argv[0]
    restable = ResObject()
    androidjar = get_android_resource()
    if androidjar:
        # print >> sys.stderr, androidjar
        res = get_archived_resource(androidjar)
        if res:
            restable.update(res)
    infile = open(apkfile, "rb")
    indata = infile.read(4)
    infile.close()
    if len(indata) < 4 or indata[0:4] != "\x50\x4b\x03\x04":
        print >> sys.stderr, "not a apk file: %s" % (apkfile)
        sys.exit(1)
    res = get_archived_resource(apkfile)
    if res:
        restable.update(res)
    zfile = zipfile.ZipFile(apkfile, "r")
    zfile.getinfo("resources.arsc")
    flist = zfile.namelist()
    for fname in flist:
        if not fname.endswith(".xml"):
            continue
        if not (fname == 'AndroidManifest.xml' or fname.startswith("res/")):
            continue
        data = zfile.read(fname)
        fname = fname.lstrip("/")
        print "processing", fname
        try:
            parser = AXMLParser(data)
            parser.set_restable(restable)
            (xml, ns) = parser.parsexml()
            dirname = os.path.dirname(fname)
            if dirname and not os.path.exists(dirname):
                os.makedirs(dirname, 0755)
            outfile = open(fname, "wb")
            xml.dump(outfile, ns)
            outfile.close()
        except Exception as e:
            print >> sys.stderr, "  Error:", e
    zfile.close()


def cat_xml(cmd, argv):
    usage = 'usage: %s %s <file.apk> <name.xml>' % (TOOL_NAME, cmd)
    detail = '''
  Dump specified xml file from given apk file.

  System resources will be auto loaded (android sdk directory is
  resolved by path of command 'android', then try environment
  variable 'ANDROID_HOME'). If system resources can not be found,
  most xml attributes will be dumped as numeric value.
'''
    if len(argv) > 0 and argv[0] in ['-h', '--help']:
        print usage
        print detail
        sys.exit(0)

    if len(argv) != 2:
        print >> sys.stderr, usage
        sys.exit(1)
    apkfile = argv[0]
    zfile = zipfile.ZipFile(apkfile, "r")
    xmlfile = argv[1]
    data = zfile.read(xmlfile)
    zfile.close()
    if not data:
        sys.exit(0)
    restable = ResObject()
    androidjar = get_android_resource()
    if androidjar:
        res = get_archived_resource(androidjar)
        if res:
            restable.update(res)
    res = get_archived_resource(apkfile)
    if res:
        restable.update(res)
    parser = AXMLParser(data)
    parser.set_restable(restable)
    (xml, ns) = parser.parsexml()
    xml.dump(sys.stdout, ns)

def resolve_name(cmd, argv):
    usage = 'usage: %s %s <numeric_id> [<apk_or_arsc>]' % (TOOL_NAME, cmd)
    detail = '''
  Resolve resource name of given id.

  System resources will be auto loaded, optional apk file or resource file
  will also be searched.
'''
    if len(argv) > 0 and argv[0] in ['-h', '--help']:
        print usage
        print detail
        sys.exit(0)

    if len(argv) < 1 or len(argv) > 2:
        print >> sys.stderr, usage
        sys.exit(1)
    idstr = argv[0]
    radix = 10
    if idstr.startswith("0x") or idstr.startswith("0X"):
        radix = 16
    rid = 0
    try:
        rid = int(idstr, radix)
    except:
        print >> sys.stderr, "invalid id, not a number: ", idstr
        sys.exit(1)
    if rid <= 0 or rid >= 0xffffffff:
        print >> sys.stderr, "invalid id: ", idstr
        sys.exit(1)

    restable = ResObject()
    androidjar = get_android_resource()
    if androidjar:
        res = get_archived_resource(androidjar)
        if res:
            restable.update(res)
    if len(argv) > 1:
        try:
            infile = open(argv[1], "rb")
            indata = infile.read()
            infile.close()
            if len(indata) > 4 and indata[0:4] == "\x50\x4b\x03\x04":
                m = get_archived_resource(argv[1])
            else:
                parser = ResourceParser(indata)
                m = parser.parse_resources()
            restable.update(m)
        except Exception as e:
            print >> sys.stderr, "failed to process resource: ", e

    parser = ResourceParser("")
    parser.set_restable(restable)
    result = parser.dereference_resource(rid)
    if result == None:
        print >> sys.stderr, "can not resolve given id: 0x%08x" % (rid)
        sys.exit(1)
    print "0x%08x %s %s %s" % (rid, result[0], result[1], result[2])


if __name__ == '__main__':
    if len(sys.argv) < 2:
        print >> sys.stderr, "no command specified, type 'apktool help' for usage."
        sys.exit(1)

    command = sys.argv[1]
    argv = sys.argv[2:]

    if command in ['-h', '-help', '--help', 'help']:
        print usage,
        sys.exit(0)

    if command not in COMMANDS:
        print >> sys.stderr, "apktool: unknown command '%s'. See 'apktool help'." % (command)
    elif command == 'dumpxml':
        dump_xml(command, argv)
    elif command == 'dumpapk':
        dump_apk(command, argv)
    elif command == 'resolve':
        resolve_name(command, argv)
    elif command == 'cat':
        cat_xml(command, argv)
    elif command == 'catr':
        cat_r(command, argv)