chore(release): 11.0.2-dev.4 [skip ci]

## [11.0.2-dev.4](https://github.com/revanced/revanced-patcher/compare/v11.0.2-dev.3...v11.0.2-dev.4) (2023-06-27)

### Bug Fixes

* do not load annotations as patches ([519359a](519359a9eb))

.github/config.yml

@@ -0,0 +1,2 @@
+firstPRMergeComment: >
+  Thank you for contributing to ReVanced. Join us on [Discord](https://revanced.app/discord) if you want to receive a contributor role.

.github/workflows/pull_request.yml

@@ -7,10 +7,11 @@ on:
   workflow_dispatch:
 
 env:
-  MESSAGE: merge branch \`${{ github.head_ref || github.ref_name }}\` to \`main\`
+  MESSAGE: merge branch `${{ github.head_ref || github.ref_name }}` to `main`
 
 jobs:
   pull-request:
+    name: Open pull request
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

.github/workflows/release.yml

@@ -1,4 +1,5 @@
 name: Release
+
 on:
   workflow_dispatch:
   push:
@@ -9,6 +10,7 @@ on:
     branches:
       - main
       - dev
+
 jobs:
   release:
     name: Release
@@ -17,21 +19,27 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
         with:
+          # Make sure the release step uses its own credentials:
+          # https://github.com/cycjimmy/semantic-release-action#private-packages
+          persist-credentials: false
           fetch-depth: 0
-      - name: Setup JDK
+      - name: Cache
-        uses: actions/setup-java@v3
+        uses: actions/cache@v3
         with:
-          java-version: '17'
+          path: |
-          distribution: 'zulu'
+            ${{ runner.home }}/.gradle/caches
-          cache: gradle
+            ${{ runner.home }}/.gradle/wrapper
-      - name: Setup Node.js
+            .gradle
-        uses: actions/setup-node@v3
+            build
-        with:
+            node_modules
-          node-version: "latest"
+          key: ${{ runner.os }}-gradle-npm-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties', 'package-lock.json') }}
-          cache: 'npm'
+      - name: Build with Gradle
-      - name: Setup semantic-release
-        run: npm install semantic-release @saithodev/semantic-release-backmerge @semantic-release/git @semantic-release/changelog gradle-semantic-release-plugin -D
-      - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release
+        run: ./gradlew clean --no-daemon
+      - name: Setup semantic-release
+        run: npm install
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}
+        run: npm exec semantic-release

.gitignore

@@ -74,6 +74,7 @@ cmake-build-*/
 
 # IntelliJ
 out/
+.idea/
 
 # mpeltonen/sbt-idea plugin
 .idea_modules/
@@ -117,4 +118,7 @@ gradle-app.setting
 !src/test/resources/*
 
 # Dependency directories
-node_modules/
+node_modules/
+
+# Gradle props, to avoid sharing the gpr key
+gradle.properties

.idea/.gitignore

@@ -1,9 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml
-# Editor-based HTTP Client requests
-/httpRequests/
-# Datasource local storage ignored files
-/dataSources/
-/dataSources.local.xml
-/kotlinc.xml

.idea/codeStyles/Project.xml

@@ -1,10 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <code_scheme name="Project" version="173">
-    <JetCodeStyleSettings>
-      <option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
-    </JetCodeStyleSettings>
-    <codeStyleSettings language="kotlin">
-      <option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
-    </codeStyleSettings>
-  </code_scheme>
-</component>

.idea/codeStyles/codeStyleConfig.xml

@@ -1,5 +0,0 @@
-<component name="ProjectCodeStyleConfiguration">
-  <state>
-    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
-  </state>
-</component>

.idea/discord.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="DiscordProjectSettings">
-    <option name="show" value="PROJECT_FILES" />
-    <option name="description" value="" />
-  </component>
-</project>

.idea/git_toolbox_prj.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GitToolBoxProjectSettings">
-    <option name="commitMessageIssueKeyValidationOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-    <option name="commitMessageValidationEnabledOverride">
-      <BoolValueOverride>
-        <option name="enabled" value="true" />
-      </BoolValueOverride>
-    </option>
-  </component>
-</project>

.idea/inspectionProfiles/Project_Default.xml

@@ -1,6 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="UnusedSymbol" enabled="false" level="WARNING" enabled_by_default="false" />
-  </profile>
-</component>

.idea/misc.xml

@@ -1,10 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ExternalStorageConfigurationManager" enabled="true" />
-  <component name="FrameworkDetectionExcludesConfiguration">
-    <file type="web" url="file://$PROJECT_DIR$" />
-  </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="azul-17" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

.idea/vcs.xml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CommitMessageInspectionProfile">
-    <profile version="1.0">
-      <inspection_tool class="CommitFormat" enabled="true" level="WARNING" enabled_by_default="true" />
-      <inspection_tool class="CommitNamingConvention" enabled="true" level="WARNING" enabled_by_default="true" />
-    </profile>
-  </component>
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

.releaserc

@@ -23,10 +23,15 @@
     [
       "@saithodev/semantic-release-backmerge",
       {
-        branches: [{from: "main", to: "dev"}],
+        backmergeBranches: [{"from": "main", "to": "dev"}],
         clearWorkspace: true
       }
     ],
-    "@semantic-release/github"
+    [
+        "@semantic-release/github",
+        {
+            successComment: false
+        }
+    ]
   ]
 }

README.md

@@ -1,2 +1,3 @@
-# Patcher
+# 💉 ReVanced Patcher
-Patcher framework used in the ReVanced project.
+
+ReVanced Patcher used to patch Android applications.

build.gradle.kts

@@ -1,6 +1,5 @@
 plugins {
-    kotlin("jvm") version "1.7.0"
+    kotlin("jvm") version "1.8.10"
-    java
     `maven-publish`
 }
 
@@ -22,12 +21,12 @@ repositories {
 
 dependencies {
     implementation("xpp3:xpp3:1.1.4c")
-    implementation("org.smali:smali:2.5.2")
+    implementation("app.revanced:smali:2.5.3-a3836654")
-    implementation("app.revanced:multidexlib2:2.5.2.r2")
+    implementation("app.revanced:multidexlib2:2.5.3-a3836654")
-    implementation("org.apktool:apktool-lib:2.9.0-SNAPSHOT")
+    implementation("app.revanced:apktool-lib:2.7.0")
 
-    implementation(kotlin("reflect"))
+    implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.20-RC")
-    testImplementation(kotlin("test"))
+    testImplementation("org.jetbrains.kotlin:kotlin-test:1.8.20-RC")
 }
 
 tasks {
@@ -46,6 +45,10 @@ java {
     withSourcesJar()
 }
 
+kotlin {
+    jvmToolchain(11)
+}
+
 publishing {
     repositories {
         if (System.getenv("GITHUB_ACTOR") != null)

gradle.properties

@@ -1,2 +1,2 @@
 kotlin.code.style = official
-version = 6.4.0-dev.1
+version = 11.0.2-dev.4

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

package.json

@@ -1,8 +1,9 @@
 {
   "devDependencies": {
+    "@saithodev/semantic-release-backmerge": "^3.1.0",
     "@semantic-release/changelog": "^6.0.2",
     "@semantic-release/git": "^10.0.1",
-    "gradle-semantic-release-plugin": "^1.7.4",
+    "gradle-semantic-release-plugin": "^1.7.6",
-    "semantic-release": "^19.0.5"
+    "semantic-release": "^20.1.0"
   }
 }

src/main/kotlin/app/revanced/patcher/PatcherContext.kt

@@ -1,10 +1,9 @@
 package app.revanced.patcher
 
-import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.data.*
-import app.revanced.patcher.data.Context
+import app.revanced.patcher.logging.Logger
-import app.revanced.patcher.data.PackageMetadata
-import app.revanced.patcher.data.ResourceContext
 import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.util.ClassMerger.merge
 import org.jf.dexlib2.iface.ClassDef
 import java.io.File
 
@@ -14,6 +13,52 @@ data class PatcherContext(
 ) {
     val packageMetadata = PackageMetadata()
     internal val patches = mutableListOf<Class<out Patch<Context>>>()
+    internal val integrations = Integrations(this)
     internal val bytecodeContext = BytecodeContext(classes)
     internal val resourceContext = ResourceContext(resourceCacheDirectory)
+
+    internal class Integrations(val context: PatcherContext) {
+        var callback: ((File) -> Unit)? = null
+        private val integrations: MutableList<File> = mutableListOf()
+
+        fun add(integrations: List<File>) = this@Integrations.integrations.addAll(integrations)
+
+        /**
+         * Merge integrations.
+         * @param logger A logger.
+         */
+        fun merge(logger: Logger) {
+            with(context.bytecodeContext.classes) {
+                for (integrations in integrations) {
+                    callback?.let { it(integrations) }
+
+                    for (classDef in lanchon.multidexlib2.MultiDexIO.readDexFile(
+                        true,
+                        integrations,
+                        NAMER,
+                        null,
+                        null
+                    ).classes) {
+                        val type = classDef.type
+
+                        val result = classes.findIndexed { it.type == type }
+                        if (result == null) {
+                            logger.trace("Merging type $type")
+                            classes.add(classDef)
+                            continue
+                        }
+
+                        val (existingClass, existingClassIndex) = result
+
+                        logger.trace("Type $type exists. Adding missing methods and fields.")
+
+                        existingClass.merge(classDef, context, logger).let { mergedClass ->
+                            if (mergedClass !== existingClass) // referential equality check
+                                classes[existingClassIndex] = mergedClass
+                        }
+                    }
+                }
+            }
+        }
+    }
 }

src/main/kotlin/app/revanced/patcher/annotation/CompatibilityAnnotation.kt

@@ -7,8 +7,6 @@ import app.revanced.patcher.patch.Patch
  * @param compatiblePackages A list of packages a [Patch] is compatible with.
  */
 @Target(AnnotationTarget.CLASS)
-@Retention(AnnotationRetention.RUNTIME)
-@MustBeDocumented
 annotation class Compatibility(
     val compatiblePackages: Array<Package>,
 )
@@ -19,8 +17,6 @@ annotation class Compatibility(
  * @param versions The versions of the package the [Patch] is compatible with.
  */
 @Target()
-@Retention(AnnotationRetention.RUNTIME)
-@MustBeDocumented
 annotation class Package(
     val name: String,
     val versions: Array<String> = [],

src/main/kotlin/app/revanced/patcher/annotation/MetadataAnnotation.kt

@@ -7,8 +7,6 @@ import app.revanced.patcher.patch.Patch
  * @param name A suggestive name for the [Patch].
  */
 @Target(AnnotationTarget.CLASS)
-@Retention(AnnotationRetention.RUNTIME)
-@MustBeDocumented
 annotation class Name(
     val name: String,
 )
@@ -18,8 +16,6 @@ annotation class Name(
  * @param description A description for the [Patch].
  */
 @Target(AnnotationTarget.CLASS)
-@Retention(AnnotationRetention.RUNTIME)
-@MustBeDocumented
 annotation class Description(
     val description: String,
 )
@@ -30,8 +26,6 @@ annotation class Description(
  * @param version The version of a [Patch].
  */
 @Target(AnnotationTarget.CLASS)
-@Retention(AnnotationRetention.RUNTIME)
-@MustBeDocumented
 annotation class Version(
     val version: String,
 )

src/main/kotlin/app/revanced/patcher/data/Context.kt

@@ -54,17 +54,6 @@ class BytecodeContext internal constructor(classes: MutableList<ClassDef>) : Con
         }
         return proxy
     }
-
-    private companion object {
-        inline fun <reified T> Iterable<T>.find(predicate: (T) -> Boolean): T? {
-            for (element in this) {
-                if (predicate(element)) {
-                    return element
-                }
-            }
-            return null
-        }
-    }
 }
 
 /**

src/main/kotlin/app/revanced/patcher/extensions/AnnotationExtensions.kt

@@ -1,79 +1,33 @@
 package app.revanced.patcher.extensions
 
-import app.revanced.patcher.annotation.*
-import app.revanced.patcher.data.Context
-import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
-import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
-import app.revanced.patcher.patch.OptionsContainer
-import app.revanced.patcher.patch.Patch
-import app.revanced.patcher.patch.PatchOptions
-import app.revanced.patcher.patch.annotations.DependsOn
 import kotlin.reflect.KClass
-import kotlin.reflect.KVisibility
-import kotlin.reflect.full.companionObject
-import kotlin.reflect.full.companionObjectInstance
 
-/**
+internal object AnnotationExtensions {
- * Recursively find a given annotation on a class.
+    /**
- * @param targetAnnotation The annotation to find.
+     * Recursively find a given annotation on a class.
- * @return The annotation.
+     *
- */
+     * @param targetAnnotation The annotation to find.
-private fun <T : Annotation> Class<*>.findAnnotationRecursively(targetAnnotation: KClass<T>) =
+     * @return The annotation.
-    this.findAnnotationRecursively(targetAnnotation.java, mutableSetOf())
+     */
+    fun <T : Annotation> Class<*>.findAnnotationRecursively(targetAnnotation: KClass<T>): T? {
+        fun <T : Annotation> Class<*>.findAnnotationRecursively(
+            targetAnnotation: Class<T>, traversed: MutableSet<Annotation>
+        ): T? {
+            val found = this.annotations.firstOrNull { it.annotationClass.java.name == targetAnnotation.name }
 
+            @Suppress("UNCHECKED_CAST") if (found != null) return found as T
 
-private fun <T : Annotation> Class<*>.findAnnotationRecursively(
+            for (annotation in this.annotations) {
-    targetAnnotation: Class<T>, traversed: MutableSet<Annotation>
+                if (traversed.contains(annotation)) continue
-): T? {
+                traversed.add(annotation)
-    val found = this.annotations.firstOrNull { it.annotationClass.java.name == targetAnnotation.name }
 
-    @Suppress("UNCHECKED_CAST") if (found != null) return found as T
+                return (annotation.annotationClass.java.findAnnotationRecursively(targetAnnotation, traversed))
-
+                    ?: continue
-    for (annotation in this.annotations) {
-        if (traversed.contains(annotation)) continue
-        traversed.add(annotation)
-
-        return (annotation.annotationClass.java.findAnnotationRecursively(targetAnnotation, traversed)) ?: continue
-    }
-
-    return null
-}
-
-object PatchExtensions {
-    val Class<out Patch<Context>>.patchName: String
-        get() = findAnnotationRecursively(Name::class)?.name ?: this.simpleName
-
-    val Class<out Patch<Context>>.version
-        get() = findAnnotationRecursively(Version::class)?.version
-
-    val Class<out Patch<Context>>.include
-        get() = findAnnotationRecursively(app.revanced.patcher.patch.annotations.Patch::class)!!.include
-
-    val Class<out Patch<Context>>.description
-        get() = findAnnotationRecursively(Description::class)?.description
-
-    val Class<out Patch<Context>>.dependencies
-        get() = findAnnotationRecursively(DependsOn::class)?.dependencies
-
-    val Class<out Patch<Context>>.compatiblePackages
-        get() = findAnnotationRecursively(Compatibility::class)?.compatiblePackages
-
-    val Class<out Patch<Context>>.options: PatchOptions?
-        get() = kotlin.companionObject?.let { cl ->
-            if (cl.visibility != KVisibility.PUBLIC) return null
-            kotlin.companionObjectInstance?.let {
-                (it as? OptionsContainer)?.options
             }
+
+            return null
         }
-}
 
-object MethodFingerprintExtensions {
+        return this.findAnnotationRecursively(targetAnnotation.java, mutableSetOf())
-    val MethodFingerprint.name: String
+    }
-        get() = this.javaClass.simpleName
-
-    val MethodFingerprint.fuzzyPatternScanMethod
-        get() = javaClass.findAnnotationRecursively(FuzzyPatternScanMethod::class)
-
-    val MethodFingerprint.fuzzyScanThreshold
-        get() = fuzzyPatternScanMethod?.threshold ?: 0
 }

src/main/kotlin/app/revanced/patcher/extensions/MethodFingerprintExtensions.kt

@@ -0,0 +1,20 @@
+package app.revanced.patcher.extensions
+
+import app.revanced.patcher.extensions.AnnotationExtensions.findAnnotationRecursively
+import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+
+object MethodFingerprintExtensions {
+
+    /**
+     * The name of a [MethodFingerprint].
+     */
+    val MethodFingerprint.name: String
+        get() = this.javaClass.simpleName
+
+    /**
+     * The [FuzzyPatternScanMethod] annotation of a [MethodFingerprint].
+     */
+    val MethodFingerprint.fuzzyPatternScanMethod
+        get() = javaClass.findAnnotationRecursively(FuzzyPatternScanMethod::class)
+}

src/main/kotlin/app/revanced/patcher/extensions/PatchExtensions.kt

@@ -0,0 +1,71 @@
+package app.revanced.patcher.extensions
+
+import app.revanced.patcher.annotation.Compatibility
+import app.revanced.patcher.annotation.Description
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.data.Context
+import app.revanced.patcher.extensions.AnnotationExtensions.findAnnotationRecursively
+import app.revanced.patcher.patch.OptionsContainer
+import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.PatchOptions
+import app.revanced.patcher.patch.annotations.DependsOn
+import app.revanced.patcher.patch.annotations.RequiresIntegrations
+import kotlin.reflect.KVisibility
+import kotlin.reflect.full.companionObject
+import kotlin.reflect.full.companionObjectInstance
+
+object PatchExtensions {
+    /**
+     * The name of a [Patch].
+     */
+    val Class<out Patch<Context>>.patchName: String
+        get() = findAnnotationRecursively(Name::class)?.name ?: this.simpleName
+
+    /**
+     * The version of a [Patch].
+     */
+    val Class<out Patch<Context>>.version
+        get() = findAnnotationRecursively(Version::class)?.version
+
+    /**
+     * Weather or not a [Patch] should be included.
+     */
+    val Class<out Patch<Context>>.include
+        get() = findAnnotationRecursively(app.revanced.patcher.patch.annotations.Patch::class)!!.include
+
+    /**
+     * The description of a [Patch].
+     */
+    val Class<out Patch<Context>>.description
+        get() = findAnnotationRecursively(Description::class)?.description
+
+    /**
+     * The dependencies of a [Patch].
+     */
+    val Class<out Patch<Context>>.dependencies
+        get() = findAnnotationRecursively(DependsOn::class)?.dependencies
+
+    /**
+     * The packages a [Patch] is compatible with.
+     */
+    val Class<out Patch<Context>>.compatiblePackages
+        get() = findAnnotationRecursively(Compatibility::class)?.compatiblePackages
+
+    /**
+     * Weather or not a [Patch] requires integrations.
+     */
+    internal val Class<out Patch<Context>>.requiresIntegrations
+        get() = findAnnotationRecursively(RequiresIntegrations::class) != null
+
+    /**
+     * The options of a [Patch].
+     */
+    val Class<out Patch<Context>>.options: PatchOptions?
+        get() = kotlin.companionObject?.let { cl ->
+            if (cl.visibility != KVisibility.PUBLIC) return null
+            kotlin.companionObjectInstance?.let {
+                (it as? OptionsContainer)?.options
+            }
+        }
+}

src/main/kotlin/app/revanced/patcher/fingerprint/method/annotation/MethodFingerprintMetadata.kt

@@ -7,7 +7,6 @@ import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
  * @param threshold if [threshold] or more of the opcodes do not match, skip.
  */
 @Target(AnnotationTarget.CLASS)
-@Retention(AnnotationRetention.RUNTIME)
 annotation class FuzzyPatternScanMethod(
     val threshold: Int = 1
 )