feat: Add auxiliary resource table loading for split APK support

brut.apktool/apktool-lib/build.gradle.kts

@@ -38,4 +38,16 @@ dependencies {
 
     testImplementation(libs.junit)
     testImplementation(libs.xmlunit)
+
+    val sdkRoot = System.getenv("ANDROID_HOME")
+    compileOnly(
+        if (sdkRoot == null) {
+            GradleException("Missing ANDROID_HOME").printStackTrace()
+
+            "com.google.android:android:4.1.1.4"
+        } else {
+            val androidVersion = 33
+            files("$sdkRoot/platforms/android-$androidVersion/android.jar")
+        }
+    )
 }

brut.apktool/apktool-lib/src/main/java/brut/androlib/AaptInvoker.java

@@ -78,6 +78,10 @@ private void invokeAapt2(File apkFile, File manifest, File resDir, File rawDir,
 
         if (resDir != null) {
             File buildDir = new File(resDir.getParent(), "build");
+
+            //noinspection ResultOfMethodCallIgnored
+            buildDir.mkdir();
+
             resourcesZip = new File(buildDir, "resources.zip");
         }
 
@@ -170,7 +174,8 @@ private void invokeAapt2(File apkFile, File manifest, File resDir, File rawDir,
         cmd.add("--no-version-transitions");
         cmd.add("--no-resource-deduping");
 
-        cmd.add("--no-compile-sdk-metadata");
+        // TODO: Add this back, once AAPT2 from platform-tools 34.0.4 is stable
+        // cmd.add("--no-compile-sdk-metadata");
 
         // #3427 - Ignore stricter parsing during aapt2
         cmd.add("--warn-manifest-validation");

brut.apktool/apktool-lib/src/main/java/brut/androlib/ApkDecoder.java

@@ -57,6 +57,12 @@ public ApkDecoder(ExtFile apkFile) {
         this(apkFile, Config.getDefaultConfig());
     }
 
+    public ApkDecoder(ApkInfo apkInfo, Config config) {
+        this(apkInfo.getApkFile(), config);
+
+        mApkInfo = apkInfo;
+    }
+
     public ApkDecoder(ExtFile apkFile, Config config) {
         mApkFile = apkFile;
         mConfig = config;
@@ -74,7 +80,7 @@ public ApkInfo decode(File outDir) throws AndrolibException {
             mWorker = new BackgroundWorker(mConfig.jobs - 1);
         }
         try {
-            mApkInfo = new ApkInfo(mApkFile);
+            if (mApkInfo == null) mApkInfo = new ApkInfo(mApkFile);
             mResDecoder = new ResourcesDecoder(mConfig, mApkInfo);
 
             try {
@@ -325,8 +331,15 @@ private void writeApkInfo(File outDir) throws AndrolibException {
         }
 
         // record uncompressed files
+        Map<String, String> resFileMapping = mResDecoder.getResFileMapping();
+        recordUncompressedFiles(resFileMapping);
+
+        // write apk info to file
+        mApkInfo.save(new File(outDir, "apktool.yml"));
+    }
+
+    public void recordUncompressedFiles(Map<String, String> resFileMapping) throws AndrolibException {
         try {
-            Map<String, String> resFileMapping = mResDecoder.getResFileMapping();
             Set<String> uncompressedExts = new HashSet<>();
             Set<String> uncompressedFiles = new HashSet<>();
             Directory in = mApkFile.getDirectory();
@@ -377,8 +390,5 @@ private void writeApkInfo(File outDir) throws AndrolibException {
         } catch (DirectoryException ex) {
             throw new AndrolibException(ex);
         }
-
-        // write apk info to file
-        mApkInfo.save(new File(outDir, "apktool.yml"));
     }
 }

brut.apktool/apktool-lib/src/main/java/brut/androlib/res/ResourcesDecoder.java

@@ -28,6 +28,7 @@
 import brut.directory.ExtFile;
 import brut.xmlpull.MXSerializer;
 import com.google.common.collect.Sets;
+import brut.util.OSDetection;
 import org.xmlpull.v1.XmlSerializer;
 
 import java.io.*;
@@ -46,6 +47,7 @@ public class ResourcesDecoder {
     private final ApkInfo mApkInfo;
     private final ResTable mResTable;
     private final Map<String, String> mResFileMapping;
+    private boolean mIncludeAuxiliaryPublicXml;
 
     public ResourcesDecoder(Config config, ApkInfo apkInfo) {
         mConfig = config;
@@ -70,6 +72,18 @@ public void loadMainPkg() throws AndrolibException {
         mResTable.loadMainPkg(mApkInfo.getApkFile());
     }
 
+    public void loadAuxiliaryPkg(ExtFile apkFile) throws AndrolibException {
+        mResTable.loadAuxiliaryPkg(apkFile);
+    }
+
+    public void loadAuxiliaryPkgs(Collection<ExtFile> apkFiles) throws AndrolibException {
+        mResTable.loadAuxiliaryPkgs(apkFiles);
+    }
+
+    public void setIncludeAuxiliaryPublicXml(boolean includeAuxiliaryPublicXml) {
+        mIncludeAuxiliaryPublicXml = includeAuxiliaryPublicXml;
+    }
+
     public void decodeManifest(File apkDir) throws AndrolibException {
         if (!mApkInfo.hasManifest()) {
             return;
@@ -157,11 +171,15 @@ public void decodeResources(File apkDir) throws AndrolibException {
             return;
         }
 
-        mResTable.loadMainPkg(mApkInfo.getApkFile());
+        loadMainPkg();
 
         ResStreamDecoderContainer decoders = new ResStreamDecoderContainer();
         decoders.setDecoder("raw", new ResRawStreamDecoder());
-        decoders.setDecoder("9patch", new Res9patchStreamDecoder());
+
+        decoders.setDecoder(
+                "9patch",
+                OSDetection.isAndroid() ? new Res9patchAndroidStreamDecoder() : new Res9patchStreamDecoder()
+        );
 
         AXmlResourceParser axmlParser = new AXmlResourceParser(mResTable);
         XmlSerializer xmlSerializer = newXmlSerializer();
@@ -188,7 +206,7 @@ public void decodeResources(File apkDir) throws AndrolibException {
                 generateValuesFile(valuesFile, outDir, xmlSerializer);
             }
 
-            generatePublicXml(pkg, outDir, xmlSerializer);
+            generatePublicXml(pkg, outDir, xmlSerializer, mIncludeAuxiliaryPublicXml);
         }
 
         AndrolibException decodeError = axmlParser.getFirstError();
@@ -197,7 +215,7 @@ public void decodeResources(File apkDir) throws AndrolibException {
         }
     }
 
-    private XmlSerializer newXmlSerializer() throws AndrolibException {
+    public XmlSerializer newXmlSerializer() throws AndrolibException {
         try {
             XmlSerializer serial = new MXSerializer();
             serial.setFeature(MXSerializer.FEATURE_ATTR_VALUE_NO_ESCAPE, true);
@@ -232,14 +250,14 @@ private void generateValuesFile(ResValuesFile valuesFile, Directory resDir, XmlS
         }
     }
 
-    private void generatePublicXml(ResPackage pkg, Directory resDir, XmlSerializer serial)
+    private void generatePublicXml(ResPackage pkg, Directory resDir, XmlSerializer serial, boolean includeAuxiliary)
             throws AndrolibException {
         try (OutputStream out = resDir.getFileOutput("values/public.xml")) {
             serial.setOutput(out, null);
             serial.startDocument(null, null);
             serial.startTag(null, "resources");
 
-            for (ResResSpec spec : pkg.listResSpecs()) {
+            for (ResResSpec spec : mResTable.listResSpecs(pkg, includeAuxiliary)) {
                 serial.startTag(null, "public");
                 serial.attribute(null, "type", spec.getType().getName());
                 serial.attribute(null, "name", spec.getName());

brut.apktool/apktool-lib/src/main/java/brut/androlib/res/data/ResTable.java

@@ -42,6 +42,8 @@ public class ResTable {
     private final ApkInfo mApkInfo;
     private final Map<Integer, ResPackage> mPackagesById;
     private final Map<String, ResPackage> mPackagesByName;
+    private final Map<ResID, ResResSpec> mAuxiliaryResSpecs;
+    private final Map<String, ResResSpec> mAuxiliaryResSpecsByName;
     private final Set<ResPackage> mMainPackages;
     private final Set<ResPackage> mFramePackages;
 
@@ -63,6 +65,8 @@ public ResTable(Config config, ApkInfo apkInfo) {
         mApkInfo = apkInfo;
         mPackagesById = new HashMap<>();
         mPackagesByName = new HashMap<>();
+        mAuxiliaryResSpecs = new LinkedHashMap<>();
+        mAuxiliaryResSpecsByName = new LinkedHashMap<>();
         mMainPackages = new LinkedHashSet<>();
         mFramePackages = new LinkedHashSet<>();
     }
@@ -91,6 +95,16 @@ public ResResSpec getResSpec(int resID) throws AndrolibException {
     }
 
     public ResResSpec getResSpec(ResID resID) throws AndrolibException {
+        ResPackage pkg = mPackagesById.get(resID.pkgId);
+        if (pkg != null && pkg.hasResSpec(resID)) {
+            return pkg.getResSpec(resID);
+        }
+
+        ResResSpec auxiliarySpec = mAuxiliaryResSpecs.get(resID);
+        if (auxiliarySpec != null) {
+            return auxiliarySpec;
+        }
+
         return getPackage(resID.pkgId).getResSpec(resID);
     }
 
@@ -131,29 +145,27 @@ private ResPackage selectPkgWithMostResSpecs(ResPackage[] pkgs) {
     }
 
     public void loadMainPkg(ExtFile apkFile) throws AndrolibException {
-        LOGGER.info("Loading resource table...");
-        ResPackage[] pkgs = loadResPackagesFromApk(apkFile, mConfig.keepBrokenResources);
-        ResPackage pkg;
-
-        switch (pkgs.length) {
-            case 0:
-                pkg = new ResPackage(this, 0, null);
-                break;
-            case 1:
-                pkg = pkgs[0];
-                break;
-            case 2:
-                LOGGER.warning("Skipping package group: " + pkgs[0].getName());
-                pkg = pkgs[1];
-                break;
-            default:
-                pkg = selectPkgWithMostResSpecs(pkgs);
-                break;
+        if (mMainPkgLoaded) {
+            return;
         }
+
+        LOGGER.info("Loading resource table...");
+        ResPackage pkg = selectPkg(loadResPackagesFromApk(apkFile, mConfig.keepBrokenResources));
         addPackage(pkg, true);
         mMainPkgLoaded = true;
     }
 
+    public void loadAuxiliaryPkg(ExtFile apkFile) throws AndrolibException {
+        LOGGER.info("Loading auxiliary resource table from file: " + apkFile);
+        addAuxiliaryPackage(selectPkg(loadResPackagesFromApk(apkFile, mConfig.keepBrokenResources)));
+    }
+
+    public void loadAuxiliaryPkgs(Collection<ExtFile> apkFiles) throws AndrolibException {
+        for (ExtFile apkFile : apkFiles) {
+            loadAuxiliaryPkg(apkFile);
+        }
+    }
+
     private ResPackage loadFrameworkPkg(int id) throws AndrolibException {
         Framework framework = new Framework(mConfig);
         File frameworkApk = framework.getFrameworkApk(id, mConfig.frameworkTag);
@@ -224,7 +236,32 @@ public ResPackage getPackage(String name) throws AndrolibException {
     }
 
     public ResValue getValue(String pkg, String type, String name) throws AndrolibException {
-        return getPackage(pkg).getType(type).getResSpec(name).getDefaultResource().getValue();
+        try {
+            return getPackage(pkg).getType(type).getResSpec(name).getDefaultResource().getValue();
+        } catch (UndefinedResObjectException ex) {
+            ResResSpec auxiliarySpec = mAuxiliaryResSpecsByName.get(getSpecNameKey(pkg, type, name));
+            if (auxiliarySpec == null) {
+                throw ex;
+            }
+            return auxiliarySpec.getDefaultResource().getValue();
+        }
+    }
+
+    public Collection<ResResSpec> listResSpecs(ResPackage pkg, boolean includeAuxiliary) {
+        if (!includeAuxiliary) {
+            return pkg.listResSpecs();
+        }
+
+        Map<ResID, ResResSpec> specs = new LinkedHashMap<>();
+        for (ResResSpec spec : pkg.listResSpecs()) {
+            specs.put(spec.getId(), spec);
+        }
+        for (ResResSpec spec : mAuxiliaryResSpecs.values()) {
+            if (spec.getId().pkgId == pkg.getId()) {
+                specs.putIfAbsent(spec.getId(), spec);
+            }
+        }
+        return specs.values();
     }
 
     public void addPackage(ResPackage pkg, boolean main) throws AndrolibException {
@@ -246,6 +283,12 @@ public void addPackage(ResPackage pkg, boolean main) throws AndrolibException {
         }
     }
 
+    void addAuxiliaryPackage(ResPackage pkg) {
+        for (ResResSpec spec : pkg.listResSpecs()) {
+            addAuxiliaryResSpec(spec);
+        }
+    }
+
     public void setPackageRenamed(String pkg) {
         mPackageRenamed = pkg;
     }
@@ -381,4 +424,44 @@ private void loadVersionName(File apkDir) {
             mApkInfo.versionInfo.versionName = refValue;
         }
     }
+
+    private ResPackage selectPkg(ResPackage[] pkgs) {
+        switch (pkgs.length) {
+            case 0:
+                return new ResPackage(this, 0, null);
+            case 1:
+                return pkgs[0];
+            case 2:
+                LOGGER.warning("Skipping package group: " + pkgs[0].getName());
+                return pkgs[1];
+            default:
+                return selectPkgWithMostResSpecs(pkgs);
+        }
+    }
+
+    private void addAuxiliaryResSpec(ResResSpec spec) {
+        ResResSpec existingSpec = mAuxiliaryResSpecs.get(spec.getId());
+        if (existingSpec != null) {
+            if (!existingSpec.getName().equals(spec.getName())
+                    || !existingSpec.getType().getName().equals(spec.getType().getName())) {
+                LOGGER.warning("Ignoring conflicting auxiliary resource spec: " + spec);
+            }
+            return;
+        }
+
+        mAuxiliaryResSpecs.put(spec.getId(), spec);
+
+        String key = getSpecNameKey(spec.getPackage().getName(), spec.getType().getName(), spec.getName());
+        ResResSpec existingNamedSpec = mAuxiliaryResSpecsByName.get(key);
+        if (existingNamedSpec != null && !existingNamedSpec.getId().equals(spec.getId())) {
+            LOGGER.warning("Ignoring conflicting auxiliary resource name: " + key);
+            return;
+        }
+
+        mAuxiliaryResSpecsByName.putIfAbsent(key, spec);
+    }
+
+    private String getSpecNameKey(String pkg, String type, String name) {
+        return pkg + ":" + type + "/" + name;
+    }
 }