perf(Bring back twitter): Optimize string replacement (#440)

* perf(Bring back twitter): Optimize string replacement

* Don't create new xml or append string when it is missing

* Minor fix

* Move pt_rBR to custom implementations to add strings

* Beautify log

* Remove the missing strings log

When user removed some languages from split apk and SettingsPatch was executed prior to this patch, this log always show warnings because SettingsPatch adds other languages.

* improve comment sentence

Author: kitadai31

src/main/kotlin/crimera/patches/twitter/misc/bringbacktwitter/BringBackTwitterResourcePatch.kt

@@ -7,12 +7,11 @@ import app.revanced.patcher.patch.annotation.Patch
 import app.revanced.util.ResourceGroup
 import app.revanced.util.asSequence
 import app.revanced.util.copyResources
-import app.util.measureExecutionTime
 import crimera.patches.twitter.misc.bringbacktwitter.custromstringsupdater.ja
+import crimera.patches.twitter.misc.bringbacktwitter.custromstringsupdater.pt_rBR
 import crimera.patches.twitter.misc.bringbacktwitter.strings.StringsMap
 import org.w3c.dom.Element
 import java.io.File
-import java.io.FileWriter
 
 @Patch(
     name = "Bring back twitter",
@@ -97,20 +96,16 @@ object BringBackTwitterResourcePatch : ResourcePatch() {
         // update strings to old ones
         updateStrings(context)
         ja.updateStrings(context)
+        pt_rBR.updateStrings(context)
     }
 
     private fun updateStrings(context: ResourceContext) {
         val langs = StringsMap.replacementMap
         for ((key, value) in langs) {
             val stringsFile = context["res/$key/strings.xml"]
-            if (!stringsFile.isFile) {
-
-                context["res/$key"].mkdirs()
-                FileWriter(stringsFile).use {
-                    it.write("<?xml version=\"1.0\" encoding=\"utf-8\"?><resources></resources>")
-                }
+            if (stringsFile.exists()) {
+                updateStringsFile(stringsFile, value, context)
             }
-            updateStringsFile(stringsFile, value, context)
         }
     }
 
@@ -121,39 +116,27 @@ object BringBackTwitterResourcePatch : ResourcePatch() {
         context.xmlEditor[stringsFile.toString()].use { editor ->
             val document = editor.file
 
-            for ((key, value) in stringsMap) {
-                val nodes = document.getElementsByTagName("string")
-                var keyReplaced = false
-                for (i in 0 until nodes.length) {
-                    val node = nodes.item(i)
-                    val name = node.attributes.getNamedItem("name")?.nodeValue
-                    if (name == key) {
-                        node.textContent = value
-                        keyReplaced = true
-                        break
-                    } else if (name == "conference_default_title") {/*
-                         * Parsing causes the default value which contains the
-                         * character 𝕏 to be "corrupted" so we change it to a normal X
-                         */
+            val nodes = document.getElementsByTagName("string")
+            for (i in 0 until nodes.length) {
+                val node = nodes.item(i)
+                val name = node.attributes.getNamedItem("name")?.nodeValue
+
+                if (name == "conference_default_title") {
+                    /*
+                     * Parsing XML causes the string which contains the
+                     * character "𝕏" to be corrupted, so we change it to "Twitter"
+                     */
+                    node.textContent = stringsMap[name] ?: run {
                         val content = node.textContent
-                        node.textContent = stringsMap[name] ?: run {
-                            val delimiter = if (content.contains("-")) '-' else ' '
-                            content.split(delimiter).joinToString(delimiter.toString()) {
-                                if (it.startsWithSpecialByte()) "Twitter" else it
-                            }
+                        val delimiter = if (content.contains("-")) '-' else ' '
+                        content.split(delimiter).joinToString(delimiter.toString()) {
+                            if (it.startsWithSpecialByte()) "Twitter" else it
                         }
                     }
+                    continue
                 }
 
-                // log which keys were not found or failed
-                if (!keyReplaced) {
-                    val colorElement = document.createElement("string")
-
-                    colorElement.setAttribute("name", key)
-                    colorElement.textContent = value
-
-                    document.getElementsByTagName("resources").item(0).appendChild(colorElement)
-                }
+                node.textContent = stringsMap[name] ?: continue
             }
         }
     }

…/misc/bringbacktwitter/strings/pt_rBR.kt …ktwitter/custromstringsupdater/pt_rBR.ktsrc/main/kotlin/crimera/patches/twitter/misc/bringbacktwitter/strings/pt_rBR.kt renamed to src/main/kotlin/crimera/patches/twitter/misc/bringbacktwitter/custromstringsupdater/pt_rBR.kt src/main/kotlin/crimera/patches/twitter/misc/bringbacktwitter/strings/pt_rBR.kt renamed to src/main/kotlin/crimera/patches/twitter/misc/bringbacktwitter/custromstringsupdater/pt_rBR.kt

@@ -1,4 +1,7 @@
-package crimera.patches.twitter.misc.bringbacktwitter.strings
+package crimera.patches.twitter.misc.bringbacktwitter.custromstringsupdater
+
+import app.revanced.patcher.data.ResourceContext
+import java.io.FileWriter
 
 object pt_rBR {
     val values = mapOf(
@@ -63,4 +66,40 @@ object pt_rBR {
         "ps__retweeted_on_twitter" to "*%s* retweetou em",
         "tweet_removed_from_your_bookmarks" to "Tweet removido dos seus Itens salvos"
     )
+
+    /*
+     * The official X app doesn't have Brazilian Portuguese string resources.
+     * So, add the strings instead of trying to replace them.
+     */
+    fun updateStrings(context: ResourceContext) {
+        if (!context["res/values-pt"].exists()) {
+            // User likely intentionally excluded the Portuguese split when merging split APKs.
+            // In this case, there is no need to add the pt-rBR strings.
+            return
+        }
+
+        val stringsFile = context["res/values-pt-rBR/strings.xml"]
+
+        // Note: If SettingsPatch was executed prior to this patch, stringsFile will exist.
+        if (!stringsFile.exists()) {
+            context["res/values-pt-rBR"].mkdirs()
+            FileWriter(stringsFile).use {
+                it.write("<?xml version=\"1.0\" encoding=\"utf-8\"?><resources></resources>")
+            }
+        }
+
+        // Append strings from the map.
+        context.xmlEditor[stringsFile.toString()].use {
+            val document = it.file
+            val parentNode = document.getElementsByTagName("resources").item(0)
+
+            for ((key, value) in values) {
+                val newElement = document.createElement("string")
+                newElement.setAttribute("name", key)
+                newElement.textContent = value
+
+                parentNode.appendChild(newElement)
+            }
+        }
+    }
 }

src/main/kotlin/crimera/patches/twitter/misc/bringbacktwitter/strings/StringsMap.kt

@@ -6,7 +6,6 @@ object StringsMap {
         "values-en-rGB" to en_rGB.values,
         "values-ru" to ru.values,
         "values-hi" to hi.values,
-        "values-pt-rBR" to pt_rBR.values,
         "values-tr" to tr.values,
         "values-zh-rCN" to zh_rCN.values,
         "values-zh-rTW" to zh_rTW.values,