Feat: Introduce "res-mode" options. (#3318)

* Revert "Remove Apktool Dummys. (#3258)"

This reverts commit 0e226928ce.

* feat: properly add dummys

* refactor: shorten ResTypeSpec

* style: remove extra space

* refactor: extract FlagItem into own class

* refactor: notate which type is null

* fix: only add dummys if enabled

* feat: skip unknown (if enabled)

* feat: introduce "res-mode"

* feat: expose config on res table

* feat: add method to base attr for res skips

* fix: ensure autobuild doesn't choke

* refactor: remove java17 enhanced switch

* refactor: rename methods

* refactor: cleanup res-mode param

* test: introduction of test/sample apk

* refactor: make ResXmlPatcher public for loading XML

* test: assertions for dummy|leave|retain

* fix: prevent using `@null` as a name

* refactor: shorten long param for 'resm'

* refactor: leave for preserve

brut.apktool/apktool-lib/src/test/java/brut/androlib/TestUtils.java

@@ -18,15 +18,19 @@ package brut.androlib;
 
 import brut.androlib.exceptions.AndrolibException;
 import brut.androlib.res.Framework;
+import brut.androlib.res.xml.ResXmlPatcher;
 import brut.common.BrutException;
 import brut.directory.DirUtil;
 import brut.directory.Directory;
 import brut.directory.FileDirectory;
 import brut.util.OS;
+import org.w3c.dom.Document;
+import org.xml.sax.SAXException;
 import org.xmlpull.v1.XmlPullParser;
 import org.xmlpull.v1.XmlPullParserException;
 import org.xmlpull.v1.XmlPullParserFactory;
 
+import javax.xml.parsers.ParserConfigurationException;
 import java.io.*;
 import java.net.URL;
 import java.net.URLDecoder;
@@ -77,6 +81,14 @@ public abstract class TestUtils {
         }
     }
 
+    public static Document getDocumentFromFile(File file) throws BrutException {
+        try {
+            return ResXmlPatcher.loadDocument(file);
+        } catch (ParserConfigurationException | SAXException | IOException ex) {
+            throw new BrutException(ex);
+        }
+    }
+
     public static void copyResourceDir(Class<?> class_, String dirPath, File out) throws BrutException {
         if (!out.exists()) {
             out.mkdirs();

brut.apktool/apktool-lib/src/test/java/brut/androlib/decode/ResourceModeTest.java

@@ -0,0 +1,140 @@
+/*
+ *  Copyright (C) 2010 Ryszard Wiśniewski <brut.alll@gmail.com>
+ *  Copyright (C) 2010 Connor Tumbleson <connor.tumbleson@gmail.com>
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *       https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package brut.androlib.decode;
+
+import brut.androlib.ApkDecoder;
+import brut.androlib.BaseTest;
+import brut.androlib.Config;
+import brut.androlib.TestUtils;
+import brut.directory.ExtFile;
+import brut.common.BrutException;
+import brut.util.OS;
+import java.io.File;
+import java.io.IOException;
+
+import org.junit.*;
+import org.w3c.dom.Document;
+
+import static org.junit.Assert.*;
+
+public class ResourceModeTest extends BaseTest {
+
+    @BeforeClass
+    public static void beforeClass() throws Exception {
+        TestUtils.cleanFrameworkFile();
+        sTmpDir = new ExtFile(OS.createTempDirectory());
+        TestUtils.copyResourceDir(ResourceModeTest.class, "decode/issue2836/", sTmpDir);
+    }
+
+    @AfterClass
+    public static void afterClass() throws BrutException {
+        OS.rmdir(sTmpDir);
+    }
+
+    @Test
+    public void checkDecodingModeAsRemove() throws BrutException, IOException {
+        String apk = "issue2836.apk";
+
+        Config config = Config.getDefaultConfig();
+        config.setDecodeResolveMode(Config.DECODE_RES_RESOLVE_REMOVE);
+
+        // decode issue2836.apk
+        ApkDecoder apkDecoder = new ApkDecoder(config, new File(sTmpDir + File.separator + apk));
+        sTestOrigDir = new ExtFile(sTmpDir + File.separator + apk + "remove.out");
+
+        File outDir = new File(sTmpDir + File.separator + apk + "remove.out");
+        apkDecoder.decode(outDir);
+
+        File stringsXml =  new File(sTestOrigDir,"res/values/strings.xml");
+        assertTrue(stringsXml.isFile());
+
+        File attrXml =  new File(sTestOrigDir,"res/values/attrs.xml");
+        Document attrDocument = TestUtils.getDocumentFromFile(attrXml);
+        assertEquals(3, attrDocument.getElementsByTagName("enum").getLength());
+
+        File colorXml =  new File(sTestOrigDir,"res/values/colors.xml");
+        Document colorDocument = TestUtils.getDocumentFromFile(colorXml);
+        assertEquals(8, colorDocument.getElementsByTagName("color").getLength());
+        assertEquals(0, colorDocument.getElementsByTagName("item").getLength());
+
+        File publicXml =  new File(sTestOrigDir,"res/values/public.xml");
+        Document publicDocument = TestUtils.getDocumentFromFile(publicXml);
+        assertEquals(21, publicDocument.getElementsByTagName("public").getLength());
+    }
+
+    @Test
+    public void checkDecodingModeAsDummies() throws BrutException, IOException {
+        String apk = "issue2836.apk";
+
+        Config config = Config.getDefaultConfig();
+        config.setDecodeResolveMode(Config.DECODE_RES_RESOLVE_DUMMY);
+
+        // decode issue2836.apk
+        ApkDecoder apkDecoder = new ApkDecoder(config, new File(sTmpDir + File.separator + apk));
+        sTestOrigDir = new ExtFile(sTmpDir + File.separator + apk + "dummies.out");
+
+        File outDir = new File(sTmpDir + File.separator + apk + "dummies.out");
+        apkDecoder.decode(outDir);
+
+        File stringsXml =  new File(sTestOrigDir,"res/values/strings.xml");
+        assertTrue(stringsXml.isFile());
+
+        File attrXml =  new File(sTestOrigDir,"res/values/attrs.xml");
+        Document attrDocument = TestUtils.getDocumentFromFile(attrXml);
+        assertEquals(4, attrDocument.getElementsByTagName("enum").getLength());
+
+        File colorXml =  new File(sTestOrigDir,"res/values/colors.xml");
+        Document colorDocument = TestUtils.getDocumentFromFile(colorXml);
+        assertEquals(8, colorDocument.getElementsByTagName("color").getLength());
+        assertEquals(1, colorDocument.getElementsByTagName("item").getLength());
+
+        File publicXml =  new File(sTestOrigDir,"res/values/public.xml");
+        Document publicDocument = TestUtils.getDocumentFromFile(publicXml);
+        assertEquals(22, publicDocument.getElementsByTagName("public").getLength());
+    }
+
+    @Test
+    public void checkDecodingModeAsLeave() throws BrutException, IOException {
+        String apk = "issue2836.apk";
+
+        Config config = Config.getDefaultConfig();
+        config.setDecodeResolveMode(Config.DECODE_RES_RESOLVE_RETAIN);
+
+        // decode issue2836.apk
+        ApkDecoder apkDecoder = new ApkDecoder(config, new File(sTmpDir + File.separator + apk));
+        sTestOrigDir = new ExtFile(sTmpDir + File.separator + apk + "leave.out");
+
+        File outDir = new File(sTmpDir + File.separator + apk + "leave.out");
+        apkDecoder.decode(outDir);
+
+        File stringsXml =  new File(sTestOrigDir,"res/values/strings.xml");
+        assertTrue(stringsXml.isFile());
+
+        File attrXml =  new File(sTestOrigDir,"res/values/attrs.xml");
+        Document attrDocument = TestUtils.getDocumentFromFile(attrXml);
+        assertEquals(4, attrDocument.getElementsByTagName("enum").getLength());
+
+        File colorXml =  new File(sTestOrigDir,"res/values/colors.xml");
+        Document colorDocument = TestUtils.getDocumentFromFile(colorXml);
+        assertEquals(8, colorDocument.getElementsByTagName("color").getLength());
+        assertEquals(0, colorDocument.getElementsByTagName("item").getLength());
+
+        File publicXml =  new File(sTestOrigDir,"res/values/public.xml");
+        Document publicDocument = TestUtils.getDocumentFromFile(publicXml);
+        assertEquals(21, publicDocument.getElementsByTagName("public").getLength());
+    }
+}