Compare commits

...

26 Commits

Author SHA1 Message Date
semantic-release-bot
fc95b28c49 chore(release): 15.0.0-dev.4 [skip ci]
# [15.0.0-dev.4](https://github.com/ReVanced/revanced-patcher/compare/v15.0.0-dev.3...v15.0.0-dev.4) (2023-09-13)

### Bug Fixes

* Account for source patch dependency for tests ([6918418](69184187d9))
* Always make the generated patch depend on the source patch ([8de3063](8de30633ae))
* Catch correct exception ([637d487](637d48746f))
* Delegate `PatchBundleLoader` by mutable set of patches ([9a109c1](9a109c129b))
* Do not resolve the proxied patch to the proxy in the dependency list ([e112837](e11283744a))
* Do not set `CompatiblePackage.versions` if `@CompatiblePackage.versions` is empty ([6b1e0a1](6b1e0a1656))
* Filter for patches correctly ([4bc4b0d](4bc4b0dc01))
* Find dependency in `context.allPatches` ([670f015](670f0153de))
* Log the correct patch names ([9fdb8f0](9fdb8f087f))
* Print patch name instead of class name ([4e7811e](4e7811ea07))
* Print stack trace of exception ([aa71146](aa71146b1b))
* Run code-block if `executablePatches` does not yet contain `patch` ([1d7aeca](1d7aeca696))
* Suppress logger when loading patches in `PatchBundleLoader` ([72c9eb2](72c9eb2129))

### Code Refactoring

* Internalize processor constructor ([a802d0d](a802d0df46))

### BREAKING CHANGES

* This gets rid of the public constructor.
2023-09-13 03:44:27 +00:00
oSumAtrIX
69184187d9 fix: Account for source patch dependency for tests 2023-09-13 05:40:59 +02:00
oSumAtrIX
a802d0df46 refactor: Internalize processor constructor
BREAKING CHANGE: This gets rid of the public constructor.
2023-09-13 05:32:40 +02:00
oSumAtrIX
8de30633ae fix: Always make the generated patch depend on the source patch 2023-09-13 05:18:28 +02:00
oSumAtrIX
a1fbb7990f refactor: Simplify fingerprint resolution 2023-09-13 04:13:38 +02:00
oSumAtrIX
aa71146b1b fix: Print stack trace of exception
Otherwise the log will not include what originally raised the exception.
2023-09-13 03:58:46 +02:00
oSumAtrIX
9fdb8f087f fix: Log the correct patch names 2023-09-13 03:35:39 +02:00
oSumAtrIX
670f0153de fix: Find dependency in context.allPatches 2023-09-13 03:06:40 +02:00
oSumAtrIX
1d7aeca696 fix: Run code-block if executablePatches does not yet contain patch 2023-09-13 03:06:19 +02:00
oSumAtrIX
4e7811ea07 fix: Print patch name instead of class name 2023-09-13 03:05:37 +02:00
oSumAtrIX
e11283744a fix: Do not resolve the proxied patch to the proxy in the dependency list
If a patch is used as a dependency, it would be present in `dependencyResolutionMap`. If that patch would also be annotated, then the generated patch would depend on itself.
2023-09-13 03:05:06 +02:00
oSumAtrIX
91cdfd53ef refactor: Simplify accessing the patches from PatcherContext.executablePatches 2023-09-13 02:22:31 +02:00
oSumAtrIX
bc7d6b9941 refactor: Rename unused destructed parameter to _ 2023-09-13 02:17:54 +02:00
oSumAtrIX
6b1e0a1656 fix: Do not set CompatiblePackage.versions if @CompatiblePackage.versions is empty 2023-09-13 02:17:24 +02:00
oSumAtrIX
72c9eb2129 fix: Suppress logger when loading patches in PatchBundleLoader 2023-09-13 02:11:51 +02:00
oSumAtrIX
4bc4b0dc01 fix: Filter for patches correctly 2023-09-13 01:52:15 +02:00
oSumAtrIX
637d48746f fix: Catch correct exception 2023-09-13 01:51:46 +02:00
oSumAtrIX
9a109c129b fix: Delegate PatchBundleLoader by mutable set of patches 2023-09-13 01:36:53 +02:00
oSumAtrIX
d49e4ee5ea refactor: Remove unused logger 2023-09-13 00:08:52 +02:00
semantic-release-bot
30f0ea29a3 chore(release): 15.0.0-dev.3 [skip ci]
# [15.0.0-dev.3](https://github.com/ReVanced/revanced-patcher/compare/v15.0.0-dev.2...v15.0.0-dev.3) (2023-09-06)

### Bug Fixes

* Make `CompatiblePackage.versions` a property ([67b7dff](67b7dff67a))
* Use correct module name ([080fbe9](080fbe9feb))

* feat Use `Set` as super type for `PatchBundleLoader` ([4b76d19](4b76d19596))

### BREAKING CHANGES

* `PatchBundleLoader` is not a map anymore
* This renames packages and the Maven package.
2023-09-06 12:32:05 +00:00
oSumAtrIX
49930f6565 chore: Use correct resource names for tests 2023-09-06 14:27:51 +02:00
oSumAtrIX
909d89fa8d chore: Print correct error message 2023-09-06 14:23:26 +02:00
oSumAtrIX
81d1d7f544 refactor: Do not reify generic type 2023-09-06 06:34:38 +02:00
oSumAtrIX
67b7dff67a fix: Make CompatiblePackage.versions a property 2023-09-06 06:12:44 +02:00
oSumAtrIX
4b76d19596 feat Use Set as super type for PatchBundleLoader
BREAKING CHANGE: `PatchBundleLoader` is not a map anymore
2023-09-06 06:12:22 +02:00
oSumAtrIX
080fbe9feb fix: Use correct module name
BREAKING CHANGE: This renames packages and the Maven package.
2023-09-06 06:11:15 +02:00
28 changed files with 202 additions and 133 deletions

View File

@@ -1,3 +1,49 @@
# [15.0.0-dev.4](https://github.com/ReVanced/revanced-patcher/compare/v15.0.0-dev.3...v15.0.0-dev.4) (2023-09-13)
### Bug Fixes
* Account for source patch dependency for tests ([6918418](https://github.com/ReVanced/revanced-patcher/commit/69184187d90f126478d2f49415c1e3381217557f))
* Always make the generated patch depend on the source patch ([8de3063](https://github.com/ReVanced/revanced-patcher/commit/8de30633ae6eb7acf7f0a351e26d4a6c2fdbdfec))
* Catch correct exception ([637d487](https://github.com/ReVanced/revanced-patcher/commit/637d48746ff8694e01c5aead1c75a9a1efeb5ac8))
* Delegate `PatchBundleLoader` by mutable set of patches ([9a109c1](https://github.com/ReVanced/revanced-patcher/commit/9a109c129b135a634be1aad4130a06d9e8e96ecd))
* Do not resolve the proxied patch to the proxy in the dependency list ([e112837](https://github.com/ReVanced/revanced-patcher/commit/e11283744a21fe2d09435e99d6924462b6aac3b8))
* Do not set `CompatiblePackage.versions` if `@CompatiblePackage.versions` is empty ([6b1e0a1](https://github.com/ReVanced/revanced-patcher/commit/6b1e0a16568124e9f82fb5740353360fa8ec614a))
* Filter for patches correctly ([4bc4b0d](https://github.com/ReVanced/revanced-patcher/commit/4bc4b0dc0104073b62528d02a88383cecd7a50e7))
* Find dependency in `context.allPatches` ([670f015](https://github.com/ReVanced/revanced-patcher/commit/670f0153de10c6f0db25b08df1c01a2905037f84))
* Log the correct patch names ([9fdb8f0](https://github.com/ReVanced/revanced-patcher/commit/9fdb8f087f62babf6081879db65c80db639aa0a7))
* Print patch name instead of class name ([4e7811e](https://github.com/ReVanced/revanced-patcher/commit/4e7811ea07762667a1f22526dc176022038f60eb))
* Print stack trace of exception ([aa71146](https://github.com/ReVanced/revanced-patcher/commit/aa71146b1bf4ffebcc81a1663e15abae89e97ff0))
* Run code-block if `executablePatches` does not yet contain `patch` ([1d7aeca](https://github.com/ReVanced/revanced-patcher/commit/1d7aeca696be873dfaf88eaa6d312949a3b8572b))
* Suppress logger when loading patches in `PatchBundleLoader` ([72c9eb2](https://github.com/ReVanced/revanced-patcher/commit/72c9eb212985f99f3390cf1faa10ab547d2dbe7e))
### Code Refactoring
* Internalize processor constructor ([a802d0d](https://github.com/ReVanced/revanced-patcher/commit/a802d0df463695976e85d8391762942eb977920b))
### BREAKING CHANGES
* This gets rid of the public constructor.
# [15.0.0-dev.3](https://github.com/ReVanced/revanced-patcher/compare/v15.0.0-dev.2...v15.0.0-dev.3) (2023-09-06)
### Bug Fixes
* Make `CompatiblePackage.versions` a property ([67b7dff](https://github.com/ReVanced/revanced-patcher/commit/67b7dff67a212b4fc30eb4f0cbe58f0ba09fb09a))
* Use correct module name ([080fbe9](https://github.com/ReVanced/revanced-patcher/commit/080fbe9feb9d4ea9ec4e599ecef296eacd803b05))
* feat Use `Set` as super type for `PatchBundleLoader` ([4b76d19](https://github.com/ReVanced/revanced-patcher/commit/4b76d1959691babf8c99d3d5235df4a4388956f0))
### BREAKING CHANGES
* `PatchBundleLoader` is not a map anymore
* This renames packages and the Maven package.
# [15.0.0-dev.2](https://github.com/ReVanced/revanced-patcher/compare/v15.0.0-dev.1...v15.0.0-dev.2) (2023-09-06) # [15.0.0-dev.2](https://github.com/ReVanced/revanced-patcher/compare/v15.0.0-dev.1...v15.0.0-dev.2) (2023-09-06)
# [15.0.0-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v14.2.2...v15.0.0-dev.1) (2023-09-04) # [15.0.0-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v14.2.2...v15.0.0-dev.1) (2023-09-04)

View File

@@ -1,4 +1,4 @@
org.gradle.parallel = true org.gradle.parallel = true
org.gradle.caching = true org.gradle.caching = true
kotlin.code.style = official kotlin.code.style = official
version = 15.0.0-dev.2 version = 15.0.0-dev.4

View File

@@ -1,10 +1,10 @@
public abstract interface annotation class app/revanced/patcher/patch/annotations/CompatiblePackage : java/lang/annotation/Annotation { public abstract interface annotation class app/revanced/patcher/patch/annotation/CompatiblePackage : java/lang/annotation/Annotation {
public abstract fun name ()Ljava/lang/String; public abstract fun name ()Ljava/lang/String;
public abstract fun versions ()[Ljava/lang/String; public abstract fun versions ()[Ljava/lang/String;
} }
public abstract interface annotation class app/revanced/patcher/patch/annotations/Patch : java/lang/annotation/Annotation { public abstract interface annotation class app/revanced/patcher/patch/annotation/Patch : java/lang/annotation/Annotation {
public abstract fun compatiblePackages ()[Lapp/revanced/patcher/patch/annotations/CompatiblePackage; public abstract fun compatiblePackages ()[Lapp/revanced/patcher/patch/annotation/CompatiblePackage;
public abstract fun dependencies ()[Ljava/lang/Class; public abstract fun dependencies ()[Ljava/lang/Class;
public abstract fun description ()Ljava/lang/String; public abstract fun description ()Ljava/lang/String;
public abstract fun name ()Ljava/lang/String; public abstract fun name ()Ljava/lang/String;
@@ -12,14 +12,13 @@ public abstract interface annotation class app/revanced/patcher/patch/annotation
public abstract fun use ()Z public abstract fun use ()Z
} }
public final class app/revanced/patcher/patch/annotations/processor/PatchProcessor : com/google/devtools/ksp/processing/SymbolProcessor { public final class app/revanced/patcher/patch/annotation/processor/PatchProcessor : com/google/devtools/ksp/processing/SymbolProcessor {
public fun <init> (Lcom/google/devtools/ksp/processing/CodeGenerator;Lcom/google/devtools/ksp/processing/KSPLogger;)V
public fun process (Lcom/google/devtools/ksp/processing/Resolver;)Ljava/util/List; public fun process (Lcom/google/devtools/ksp/processing/Resolver;)Ljava/util/List;
} }
public final class app/revanced/patcher/patch/annotations/processor/PatchProcessorProvider : com/google/devtools/ksp/processing/SymbolProcessorProvider { public final class app/revanced/patcher/patch/annotation/processor/PatchProcessorProvider : com/google/devtools/ksp/processing/SymbolProcessorProvider {
public fun <init> ()V public fun <init> ()V
public fun create (Lcom/google/devtools/ksp/processing/SymbolProcessorEnvironment;)Lapp/revanced/patcher/patch/annotations/processor/PatchProcessor; public fun create (Lcom/google/devtools/ksp/processing/SymbolProcessorEnvironment;)Lapp/revanced/patcher/patch/annotation/processor/PatchProcessor;
public synthetic fun create (Lcom/google/devtools/ksp/processing/SymbolProcessorEnvironment;)Lcom/google/devtools/ksp/processing/SymbolProcessor; public synthetic fun create (Lcom/google/devtools/ksp/processing/SymbolProcessorEnvironment;)Lcom/google/devtools/ksp/processing/SymbolProcessor;
} }

View File

@@ -46,7 +46,7 @@ publishing {
version = project.version.toString() version = project.version.toString()
pom { pom {
name = "ReVanced Patch annotations processor" name = "ReVanced patch annotation processor"
description = "Annotation processor for patches." description = "Annotation processor for patches."
url = "https://revanced.app" url = "https://revanced.app"

View File

@@ -0,0 +1,2 @@
rootProject.name = "revanced-patch-annotation-processor"

View File

@@ -1,4 +1,4 @@
package app.revanced.patcher.patch.annotations package app.revanced.patcher.patch.annotation
import java.lang.annotation.Inherited import java.lang.annotation.Inherited
import kotlin.reflect.KClass import kotlin.reflect.KClass

View File

@@ -1,11 +1,14 @@
package app.revanced.patcher.patch.annotations.processor package app.revanced.patcher.patch.annotation.processor
import app.revanced.patcher.data.BytecodeContext import app.revanced.patcher.data.BytecodeContext
import app.revanced.patcher.data.ResourceContext import app.revanced.patcher.data.ResourceContext
import app.revanced.patcher.patch.BytecodePatch import app.revanced.patcher.patch.BytecodePatch
import app.revanced.patcher.patch.ResourcePatch import app.revanced.patcher.patch.ResourcePatch
import app.revanced.patcher.patch.annotations.Patch import app.revanced.patcher.patch.annotation.Patch
import com.google.devtools.ksp.processing.* import com.google.devtools.ksp.processing.CodeGenerator
import com.google.devtools.ksp.processing.Dependencies
import com.google.devtools.ksp.processing.Resolver
import com.google.devtools.ksp.processing.SymbolProcessor
import com.google.devtools.ksp.symbol.KSAnnotated import com.google.devtools.ksp.symbol.KSAnnotated
import com.google.devtools.ksp.symbol.KSAnnotation import com.google.devtools.ksp.symbol.KSAnnotation
import com.google.devtools.ksp.symbol.KSClassDeclaration import com.google.devtools.ksp.symbol.KSClassDeclaration
@@ -16,9 +19,8 @@ import com.squareup.kotlinpoet.ksp.toClassName
import com.squareup.kotlinpoet.ksp.writeTo import com.squareup.kotlinpoet.ksp.writeTo
import kotlin.reflect.KClass import kotlin.reflect.KClass
class PatchProcessor( class PatchProcessor internal constructor(
private val codeGenerator: CodeGenerator, private val codeGenerator: CodeGenerator,
private val logger: KSPLogger
) : SymbolProcessor { ) : SymbolProcessor {
private fun KSAnnotated.isSubclassOf(cls: KClass<*>): Boolean { private fun KSAnnotated.isSubclassOf(cls: KClass<*>): Boolean {
@@ -31,7 +33,7 @@ class PatchProcessor(
@Suppress("UNCHECKED_CAST") @Suppress("UNCHECKED_CAST")
override fun process(resolver: Resolver): List<KSAnnotated> { override fun process(resolver: Resolver): List<KSAnnotated> {
val executablePatches = buildMap { val patches = buildMap {
resolver.getSymbolsWithAnnotation(Patch::class.qualifiedName!!).filter { resolver.getSymbolsWithAnnotation(Patch::class.qualifiedName!!).filter {
// Do not check here if Patch is super of the class, because it is expensive. // Do not check here if Patch is super of the class, because it is expensive.
// Check it later when processing. // Check it later when processing.
@@ -79,14 +81,14 @@ class PatchProcessor(
dependencies?.map { dependency -> dependency.toClassName() }, dependencies?.map { dependency -> dependency.toClassName() },
compatiblePackages?.map { compatiblePackages?.map {
val packageName = it.property("name") val packageName = it.property("name")
val packageVersions = (it.property("versions") as List<String>) val packageVersions = (it.property("versions") as List<String>).ifEmpty { null }
.joinToString(", ") { version -> "\"$version\"" } ?.joinToString(", ") { version -> "\"$version\"" }
CodeBlock.of( CodeBlock.of(
"%T(%S, setOf(%L))", "%T(%S, %L)",
app.revanced.patcher.patch.Patch.CompatiblePackage::class, app.revanced.patcher.patch.Patch.CompatiblePackage::class,
packageName, packageName,
packageVersions packageVersions?.let { "setOf($packageVersions)" },
) )
}, },
use, use,
@@ -97,13 +99,13 @@ class PatchProcessor(
} }
// If a patch depends on another, that is annotated, the dependency should be replaced with the generated patch, // If a patch depends on another, that is annotated, the dependency should be replaced with the generated patch,
// because the generated patch has all the necessary properties to invoke the super constructor, // because the generated patch has all the necessary properties to invoke the super constructor with,
// unlike the annotated patch. // unlike the annotated patch.
val dependencyResolutionMap = buildMap { val dependencyResolutionMap = buildMap {
executablePatches.values.filter { it.dependencies != null }.flatMap { patches.values.filter { it.dependencies != null }.flatMap {
it.dependencies!! it.dependencies!!
}.distinct().forEach { dependency -> }.distinct().forEach { dependency ->
executablePatches.keys.find { it.qualifiedName?.asString() == dependency.toString() } patches.keys.find { it.qualifiedName?.asString() == dependency.toString() }
?.let { patch -> ?.let { patch ->
this[dependency] = ClassName( this[dependency] = ClassName(
patch.packageName.asString(), patch.packageName.asString(),
@@ -113,7 +115,7 @@ class PatchProcessor(
} }
} }
executablePatches.forEach { (patchDeclaration, patchAnnotation) -> patches.forEach { (patchDeclaration, patchAnnotation) ->
val isBytecodePatch = patchDeclaration.isSubclassOf(BytecodePatch::class) val isBytecodePatch = patchDeclaration.isSubclassOf(BytecodePatch::class)
val superClass = if (isBytecodePatch) { val superClass = if (isBytecodePatch) {
@@ -152,18 +154,18 @@ class PatchProcessor(
) )
} }
patchAnnotation.dependencies?.let { dependencies -> // The generated patch always depends on the source patch.
addSuperclassConstructorParameter( addSuperclassConstructorParameter(
"dependencies = setOf(%L)", "dependencies = setOf(%L)",
buildList { buildList {
addAll(dependencies) patchAnnotation.dependencies?.forEach { dependency ->
// Also add the source class of the generated class so that it is also executed. add("${(dependencyResolutionMap[dependency] ?: dependency)}::class")
add(patchDeclaration.toClassName())
}.joinToString(", ") { dependency ->
"${(dependencyResolutionMap[dependency] ?: dependency)}::class"
} }
)
} add("${patchDeclaration.toClassName()}::class")
}.joinToString(", "),
)
addSuperclassConstructorParameter( addSuperclassConstructorParameter(
"use = %L", patchAnnotation.use "use = %L", patchAnnotation.use
) )
@@ -182,7 +184,7 @@ class PatchProcessor(
.addInitializerBlock( .addInitializerBlock(
CodeBlock.builder() CodeBlock.builder()
.add( .add(
"%T.options.forEach { (key, option) ->", "%T.options.forEach { (_, option) ->",
patchDeclaration.toClassName() patchDeclaration.toClassName()
) )
.addStatement( .addStatement(

View File

@@ -1,9 +1,9 @@
package app.revanced.patcher.patch.annotations.processor package app.revanced.patcher.patch.annotation.processor
import com.google.devtools.ksp.processing.SymbolProcessorEnvironment import com.google.devtools.ksp.processing.SymbolProcessorEnvironment
import com.google.devtools.ksp.processing.SymbolProcessorProvider import com.google.devtools.ksp.processing.SymbolProcessorProvider
class PatchProcessorProvider : SymbolProcessorProvider { class PatchProcessorProvider : SymbolProcessorProvider {
override fun create(environment: SymbolProcessorEnvironment) = override fun create(environment: SymbolProcessorEnvironment) =
PatchProcessor(environment.codeGenerator, environment.logger) PatchProcessor(environment.codeGenerator)
} }

View File

@@ -0,0 +1 @@
app.revanced.patcher.patch.annotation.processor.PatchProcessorProvider

View File

@@ -1,4 +1,4 @@
package app.revanced.patcher.patch.annotations.processor package app.revanced.patcher.patch.annotation.processor
import app.revanced.patcher.patch.Patch import app.revanced.patcher.patch.Patch
import com.tschuchort.compiletesting.KotlinCompilation import com.tschuchort.compiletesting.KotlinCompilation
@@ -21,6 +21,16 @@ class TestPatchAnnotationProcessor {
).loadPatch("$SAMPLE_PACKAGE.processing.ProcessablePatchGenerated").name ).loadPatch("$SAMPLE_PACKAGE.processing.ProcessablePatchGenerated").name
) )
@Test
fun generateNullProperties() = compile(
getSourceFile(
"null", "NullPropertiesPatch"
)
).loadPatch("$SAMPLE_PACKAGE.null.NullPropertiesPatchGenerated").let {
assertNull(it.description) // Because no description was provided.
assertNull(it.compatiblePackages!!.first().versions) // Because no versions were provided.
}
// endregion // endregion
// region Dependencies // region Dependencies
@@ -70,21 +80,23 @@ class TestPatchAnnotationProcessor {
// endregion // endregion
// region Limitations // region Limitations
@Test @Test
fun failingManualDependency() = assertNull( fun failingManualDependency() = assertEquals(
1, // Generated patch is always dependent on source class.
compile( compile(
getSourceFile( getSourceFile(
"limitations/manualdependency", "DependentPatch" "limitations/manualdependency", "DependentPatch"
), getSourceFile( ), getSourceFile(
"limitations/manualdependency", "DependencyPatch" "limitations/manualdependency", "DependencyPatch"
) )
).loadPatch("$SAMPLE_PACKAGE.limitations.manualdependency.DependentPatchGenerated").dependencies ).loadPatch("$SAMPLE_PACKAGE.limitations.manualdependency.DependentPatchGenerated").dependencies!!.size
) )
// endregion // endregion
private companion object Utils { private companion object Utils {
const val SAMPLE_PACKAGE = "app.revanced.patcher.patch.annotations.processor.samples" const val SAMPLE_PACKAGE = "app.revanced.patcher.patch.annotation.processor.samples"
/** /**
* Get a source file from the given sample and class name. * Get a source file from the given sample and class name.
@@ -93,11 +105,16 @@ class TestPatchAnnotationProcessor {
* @param className The name of the class to get the source file from. * @param className The name of the class to get the source file from.
* @return The source file. * @return The source file.
*/ */
fun getSourceFile(sample: String, className: String) = SourceFile.kotlin( fun getSourceFile(sample: String, className: String): SourceFile {
"$className.kt", TestPatchAnnotationProcessor::class.java.classLoader.getResourceAsStream( val resourceName = "app/revanced/patcher/patch/annotation/processor/samples/$sample/$className.kt"
"app/revanced/patcher/patch/annotations/processor/samples/$sample/$className.kt" return SourceFile.kotlin(
)?.readAllBytes()?.toString(Charsets.UTF_8) ?: error("Could not find resource $className") "$className.kt",
) TestPatchAnnotationProcessor::class.java.classLoader.getResourceAsStream(resourceName)
?.readAllBytes()
?.toString(Charsets.UTF_8)
?: error("Could not find resource $resourceName")
)
}
/** /**
* Compile the given source files and return the result. * Compile the given source files and return the result.

View File

@@ -1,8 +1,8 @@
package app.revanced.patcher.patch.annotations.processor.samples.dependencies package app.revanced.patcher.patch.annotation.processor.samples.dependencies
import app.revanced.patcher.data.ResourceContext import app.revanced.patcher.data.ResourceContext
import app.revanced.patcher.patch.ResourcePatch import app.revanced.patcher.patch.ResourcePatch
import app.revanced.patcher.patch.annotations.Patch import app.revanced.patcher.patch.annotation.Patch
@Patch(name = "Dependency patch") @Patch(name = "Dependency patch")
object DependencyPatch : ResourcePatch() { object DependencyPatch : ResourcePatch() {

View File

@@ -1,7 +1,7 @@
package app.revanced.patcher.patch.annotations.processor.samples.dependencies package app.revanced.patcher.patch.annotation.processor.samples.dependencies
import app.revanced.patcher.data.BytecodeContext import app.revanced.patcher.data.BytecodeContext
import app.revanced.patcher.patch.BytecodePatch import app.revanced.patcher.patch.BytecodePatch
import app.revanced.patcher.patch.annotations.Patch import app.revanced.patcher.patch.annotation.Patch
@Patch( @Patch(
name = "Dependent patch", name = "Dependent patch",

View File

@@ -1,8 +1,8 @@
package app.revanced.patcher.patch.annotations.processor.samples.limitations.manualdependency package app.revanced.patcher.patch.annotation.processor.samples.limitations.manualdependency
import app.revanced.patcher.data.ResourceContext import app.revanced.patcher.data.ResourceContext
import app.revanced.patcher.patch.ResourcePatch import app.revanced.patcher.patch.ResourcePatch
import app.revanced.patcher.patch.annotations.Patch import app.revanced.patcher.patch.annotation.Patch
@Patch(name = "Dependency patch") @Patch(name = "Dependency patch")
object DependencyPatch : ResourcePatch() { object DependencyPatch : ResourcePatch() {

View File

@@ -1,7 +1,7 @@
package app.revanced.patcher.patch.annotations.processor.samples.limitations.manualdependency package app.revanced.patcher.patch.annotation.processor.samples.limitations.manualdependency
import app.revanced.patcher.data.BytecodeContext import app.revanced.patcher.data.BytecodeContext
import app.revanced.patcher.patch.BytecodePatch import app.revanced.patcher.patch.BytecodePatch
import app.revanced.patcher.patch.annotations.Patch import app.revanced.patcher.patch.annotation.Patch
@Patch(name = "Dependent patch") @Patch(name = "Dependent patch")
object DependentPatch : BytecodePatch( object DependentPatch : BytecodePatch(

View File

@@ -0,0 +1,14 @@
package app.revanced.patcher.patch.annotation.processor.samples.`null`
import app.revanced.patcher.data.BytecodeContext
import app.revanced.patcher.patch.BytecodePatch
import app.revanced.patcher.patch.annotation.CompatiblePackage
import app.revanced.patcher.patch.annotation.Patch
@Patch(
"Patch with null properties",
compatiblePackages = [CompatiblePackage("com.google.android.youtube")],
)
object NullPropertiesPatch : BytecodePatch() {
override fun execute(context: BytecodeContext) {}
}

View File

@@ -1,8 +1,8 @@
package app.revanced.patcher.patch.annotations.processor.samples.options package app.revanced.patcher.patch.annotation.processor.samples.options
import app.revanced.patcher.data.ResourceContext import app.revanced.patcher.data.ResourceContext
import app.revanced.patcher.patch.ResourcePatch import app.revanced.patcher.patch.ResourcePatch
import app.revanced.patcher.patch.annotations.Patch import app.revanced.patcher.patch.annotation.Patch
import app.revanced.patcher.patch.options.types.StringPatchOption.Companion.stringPatchOption import app.revanced.patcher.patch.options.types.StringPatchOption.Companion.stringPatchOption
@Patch(name = "Options patch") @Patch(name = "Options patch")

View File

@@ -1,8 +1,8 @@
package app.revanced.patcher.patch.annotations.processor.samples.processing package app.revanced.patcher.patch.annotation.processor.samples.processing
import app.revanced.patcher.data.BytecodeContext import app.revanced.patcher.data.BytecodeContext
import app.revanced.patcher.patch.BytecodePatch import app.revanced.patcher.patch.BytecodePatch
import app.revanced.patcher.patch.annotations.Patch import app.revanced.patcher.patch.annotation.Patch
@Patch("Processable patch") @Patch("Processable patch")
object ProcessablePatch : BytecodePatch() { object ProcessablePatch : BytecodePatch() {

View File

@@ -1,2 +0,0 @@
rootProject.name = "revanced-patch-annotations-processor"

View File

@@ -1 +0,0 @@
app.revanced.patcher.patch.annotations.processor.PatchProcessorProvider

View File

@@ -7,46 +7,24 @@ public final class app/revanced/patcher/PackageMetadata {
public final fun getPackageVersion ()Ljava/lang/String; public final fun getPackageVersion ()Ljava/lang/String;
} }
public abstract class app/revanced/patcher/PatchBundleLoader : java/util/Map, kotlin/jvm/internal/markers/KMappedMarker { public abstract class app/revanced/patcher/PatchBundleLoader : java/util/Set, kotlin/jvm/internal/markers/KMappedMarker {
public synthetic fun <init> (Ljava/lang/ClassLoader;[Ljava/io/File;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/internal/DefaultConstructorMarker;)V public synthetic fun <init> (Ljava/lang/ClassLoader;[Ljava/io/File;Lkotlin/jvm/functions/Function1;Ljava/util/Set;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
public fun add (Lapp/revanced/patcher/patch/Patch;)Z
public synthetic fun add (Ljava/lang/Object;)Z
public fun addAll (Ljava/util/Collection;)Z
public fun clear ()V public fun clear ()V
public synthetic fun compute (Ljava/lang/Object;Ljava/util/function/BiFunction;)Ljava/lang/Object; public fun contains (Lapp/revanced/patcher/patch/Patch;)Z
public fun compute (Ljava/lang/String;Ljava/util/function/BiFunction;)Lapp/revanced/patcher/patch/Patch; public final fun contains (Ljava/lang/Object;)Z
public synthetic fun computeIfAbsent (Ljava/lang/Object;Ljava/util/function/Function;)Ljava/lang/Object; public fun containsAll (Ljava/util/Collection;)Z
public fun computeIfAbsent (Ljava/lang/String;Ljava/util/function/Function;)Lapp/revanced/patcher/patch/Patch;
public synthetic fun computeIfPresent (Ljava/lang/Object;Ljava/util/function/BiFunction;)Ljava/lang/Object;
public fun computeIfPresent (Ljava/lang/String;Ljava/util/function/BiFunction;)Lapp/revanced/patcher/patch/Patch;
public final fun containsKey (Ljava/lang/Object;)Z
public fun containsKey (Ljava/lang/String;)Z
public fun containsValue (Lapp/revanced/patcher/patch/Patch;)Z
public final fun containsValue (Ljava/lang/Object;)Z
public final fun entrySet ()Ljava/util/Set;
public final fun get (Ljava/lang/Object;)Lapp/revanced/patcher/patch/Patch;
public final synthetic fun get (Ljava/lang/Object;)Ljava/lang/Object;
public fun get (Ljava/lang/String;)Lapp/revanced/patcher/patch/Patch;
public fun getEntries ()Ljava/util/Set;
public fun getKeys ()Ljava/util/Set;
public fun getSize ()I public fun getSize ()I
public fun getValues ()Ljava/util/Collection;
public fun isEmpty ()Z public fun isEmpty ()Z
public final fun keySet ()Ljava/util/Set; public fun iterator ()Ljava/util/Iterator;
public synthetic fun merge (Ljava/lang/Object;Ljava/lang/Object;Ljava/util/function/BiFunction;)Ljava/lang/Object; public fun remove (Ljava/lang/Object;)Z
public fun merge (Ljava/lang/String;Lapp/revanced/patcher/patch/Patch;Ljava/util/function/BiFunction;)Lapp/revanced/patcher/patch/Patch; public fun removeAll (Ljava/util/Collection;)Z
public synthetic fun put (Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object; public fun retainAll (Ljava/util/Collection;)Z
public fun put (Ljava/lang/String;Lapp/revanced/patcher/patch/Patch;)Lapp/revanced/patcher/patch/Patch;
public fun putAll (Ljava/util/Map;)V
public synthetic fun putIfAbsent (Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;
public fun putIfAbsent (Ljava/lang/String;Lapp/revanced/patcher/patch/Patch;)Lapp/revanced/patcher/patch/Patch;
public fun remove (Ljava/lang/Object;)Lapp/revanced/patcher/patch/Patch;
public synthetic fun remove (Ljava/lang/Object;)Ljava/lang/Object;
public fun remove (Ljava/lang/Object;Ljava/lang/Object;)Z
public synthetic fun replace (Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;
public synthetic fun replace (Ljava/lang/Object;Ljava/lang/Object;Ljava/lang/Object;)Z
public fun replace (Ljava/lang/String;Lapp/revanced/patcher/patch/Patch;)Lapp/revanced/patcher/patch/Patch;
public fun replace (Ljava/lang/String;Lapp/revanced/patcher/patch/Patch;Lapp/revanced/patcher/patch/Patch;)Z
public fun replaceAll (Ljava/util/function/BiFunction;)V
public final fun size ()I public final fun size ()I
public final fun values ()Ljava/util/Collection; public fun toArray ()[Ljava/lang/Object;
public fun toArray ([Ljava/lang/Object;)[Ljava/lang/Object;
} }
public final class app/revanced/patcher/PatchBundleLoader$Dex : app/revanced/patcher/PatchBundleLoader { public final class app/revanced/patcher/PatchBundleLoader$Dex : app/revanced/patcher/PatchBundleLoader {
@@ -352,6 +330,7 @@ public final class app/revanced/patcher/patch/Patch$CompatiblePackage {
public fun <init> (Ljava/lang/String;Ljava/util/Set;)V public fun <init> (Ljava/lang/String;Ljava/util/Set;)V
public synthetic fun <init> (Ljava/lang/String;Ljava/util/Set;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public synthetic fun <init> (Ljava/lang/String;Ljava/util/Set;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun getName ()Ljava/lang/String; public final fun getName ()Ljava/lang/String;
public final fun getVersions ()Ljava/util/Set;
} }
public final class app/revanced/patcher/patch/PatchException : java/lang/Exception { public final class app/revanced/patcher/patch/PatchException : java/lang/Exception {
@@ -428,6 +407,7 @@ public final class app/revanced/patcher/patch/options/PatchOptions : java/util/M
public final fun remove (Ljava/lang/Object;)Lapp/revanced/patcher/patch/options/PatchOption; public final fun remove (Ljava/lang/Object;)Lapp/revanced/patcher/patch/options/PatchOption;
public final synthetic fun remove (Ljava/lang/Object;)Ljava/lang/Object; public final synthetic fun remove (Ljava/lang/Object;)Ljava/lang/Object;
public fun remove (Ljava/lang/String;)Lapp/revanced/patcher/patch/options/PatchOption; public fun remove (Ljava/lang/String;)Lapp/revanced/patcher/patch/options/PatchOption;
public final fun set (Ljava/lang/String;Ljava/lang/Object;)V
public final fun size ()I public final fun size ()I
public final fun values ()Ljava/util/Collection; public final fun values ()Ljava/util/Collection;
} }

View File

@@ -12,7 +12,7 @@ dependencies {
compileOnly(libs.android) compileOnly(libs.android)
testImplementation(project(":revanced-patch-annotations-processor")) testImplementation(project(":revanced-patch-annotation-processor"))
testImplementation(libs.kotlin.test) testImplementation(libs.kotlin.test)
} }

View File

@@ -13,9 +13,9 @@ import java.util.logging.Logger
import kotlin.reflect.KClass import kotlin.reflect.KClass
/** /**
* [Patch]es mapped by their name. * A set of [Patch]es.
*/ */
typealias PatchMap = Map<String, Patch<*>> typealias PatchSet = Set<Patch<*>>
/** /**
* A [Patch] class. * A [Patch] class.
@@ -28,28 +28,30 @@ typealias PatchClass = KClass<out Patch<*>>
* *
* @param getBinaryClassNames A function that returns the binary names of all classes in a patch bundle. * @param getBinaryClassNames A function that returns the binary names of all classes in a patch bundle.
* @param classLoader The [ClassLoader] to use for loading the classes. * @param classLoader The [ClassLoader] to use for loading the classes.
* @param patchBundles A set of patches to initialize this instance with.
*/ */
sealed class PatchBundleLoader private constructor( sealed class PatchBundleLoader private constructor(
classLoader: ClassLoader, classLoader: ClassLoader,
patchBundles: Array<out File>, patchBundles: Array<out File>,
getBinaryClassNames: (patchBundle: File) -> List<String>, getBinaryClassNames: (patchBundle: File) -> List<String>,
) : PatchMap by mutableMapOf() { // This constructor parameter is unfortunately necessary,
// so that a reference to the mutable set is present in the constructor to be able to add patches to it.
// because the instance itself is a PatchSet, which is immutable, that is delegated by the parameter.
private val patchSet: MutableSet<Patch<*>> = mutableSetOf()
) : PatchSet by patchSet {
private val logger = Logger.getLogger(PatchBundleLoader::class.java.name) private val logger = Logger.getLogger(PatchBundleLoader::class.java.name)
init { init {
patchBundles.flatMap(getBinaryClassNames).asSequence().map { patchBundles.flatMap(getBinaryClassNames).asSequence().map {
classLoader.loadClass(it) classLoader.loadClass(it)
}.filter { }.filter {
it.isInstance(Patch::class.java) Patch::class.java.isAssignableFrom(it)
}.mapNotNull { patchClass -> }.mapNotNull { patchClass ->
patchClass.getInstance(logger) patchClass.getInstance(logger, silent = true)
}.filter { }.filter {
it.name != null it.name != null
}.associateBy {
it.name!!
}.let { patches -> }.let { patches ->
@Suppress("UNCHECKED_CAST") patchSet.addAll(patches)
(this as MutableMap<String, Patch<*>>).putAll(patches)
} }
} }
@@ -58,13 +60,14 @@ sealed class PatchBundleLoader private constructor(
* Instantiates a [Patch]. If the class is a singleton, the INSTANCE field will be used. * Instantiates a [Patch]. If the class is a singleton, the INSTANCE field will be used.
* *
* @param logger The [Logger] to use for logging. * @param logger The [Logger] to use for logging.
* @param silent Whether to suppress logging.
* @return The instantiated [Patch] or `null` if the [Patch] could not be instantiated. * @return The instantiated [Patch] or `null` if the [Patch] could not be instantiated.
*/ */
internal fun Class<*>.getInstance(logger: Logger): Patch<*>? { internal fun Class<*>.getInstance(logger: Logger, silent: Boolean = false): Patch<*>? {
return try { return try {
getField("INSTANCE").get(null) getField("INSTANCE").get(null)
} catch (exception: NoSuchFileException) { } catch (exception: NoSuchFieldException) {
logger.fine( if (!silent) logger.fine(
"Patch class '${name}' has no INSTANCE field, therefor not a singleton. " + "Patch class '${name}' has no INSTANCE field, therefor not a singleton. " +
"Will try to instantiate it." "Will try to instantiate it."
) )
@@ -72,7 +75,7 @@ sealed class PatchBundleLoader private constructor(
try { try {
getDeclaredConstructor().newInstance() getDeclaredConstructor().newInstance()
} catch (exception: Exception) { } catch (exception: Exception) {
logger.severe( if (!silent) logger.severe(
"Patch class '${name}' is not singleton and has no suitable constructor, " + "Patch class '${name}' is not singleton and has no suitable constructor, " +
"therefor cannot be instantiated and will be ignored." "therefor cannot be instantiated and will be ignored."
) )

View File

@@ -74,7 +74,7 @@ class Patcher(
} }
// Add all patches and their dependencies to the context. // Add all patches and their dependencies to the context.
for (patch in patches) context.executablePatches.putIfAbsent(patch::class, patch) ?: { for (patch in patches) context.executablePatches.putIfAbsent(patch::class, patch) ?: run {
context.allPatches[patch::class] = patch context.allPatches[patch::class] = patch
patch.dependencies?.forEach { it.putDependenciesRecursively() } patch.dependencies?.forEach { it.putDependenciesRecursively() }
@@ -153,7 +153,7 @@ class Patcher(
patch: Patch<*>, patch: Patch<*>,
executedPatches: LinkedHashMap<Patch<*>, PatchResult> executedPatches: LinkedHashMap<Patch<*>, PatchResult>
): PatchResult { ): PatchResult {
val patchName = patch.name val patchName = patch.name ?: patch.toString()
executedPatches[patch]?.let { patchResult -> executedPatches[patch]?.let { patchResult ->
patchResult.exception ?: return patchResult patchResult.exception ?: return patchResult
@@ -164,14 +164,17 @@ class Patcher(
} }
// Recursively execute all dependency patches. // Recursively execute all dependency patches.
patch.dependencies?.forEach { dependencyName -> patch.dependencies?.forEach { dependencyClass ->
val dependency = context.executablePatches[dependencyName]!! val dependency = context.allPatches[dependencyClass]!!
val result = executePatch(dependency, executedPatches) val result = executePatch(dependency, executedPatches)
result.exception?.let { result.exception?.let {
return PatchResult( return PatchResult(
patch, patch,
PatchException("'$patchName' depends on '${dependency}' that raised an exception: $it") PatchException(
"'$patchName' depends on '${dependency.name ?: dependency}' " +
"that raised an exception:\n${it.stackTraceToString()}"
)
) )
} }
} }
@@ -180,7 +183,7 @@ class Patcher(
// TODO: Implement this in a more polymorphic way. // TODO: Implement this in a more polymorphic way.
when (patch) { when (patch) {
is BytecodePatch -> { is BytecodePatch -> {
patch.fingerprints.toList().resolveUsingLookupMap(context.bytecodeContext) patch.fingerprints.resolveUsingLookupMap(context.bytecodeContext)
patch.execute(context.bytecodeContext) patch.execute(context.bytecodeContext)
} }
is ResourcePatch -> { is ResourcePatch -> {
@@ -208,7 +211,7 @@ class Patcher(
val executedPatches = LinkedHashMap<Patch<*>, PatchResult>() // Key is name. val executedPatches = LinkedHashMap<Patch<*>, PatchResult>() // Key is name.
context.executablePatches.map { it.value }.sortedBy { it.name }.forEach { patch -> context.executablePatches.values.sortedBy { it.name }.forEach { patch ->
val patchResult = executePatch(patch, executedPatches) val patchResult = executePatch(patch, executedPatches)
// If the patch failed, emit the result, even if it is closeable. // If the patch failed, emit the result, even if it is closeable.
@@ -245,7 +248,7 @@ class Patcher(
PatchResult( PatchResult(
patch, patch,
PatchException( PatchException(
"'${patch.name}' raised an exception while being closed: $it", "'${patch.name}' raised an exception while being closed: ${it.stackTraceToString()}",
result.exception result.exception
) )
) )

View File

@@ -159,9 +159,12 @@ abstract class MethodFingerprint(
* - Faster: Specify [accessFlags], [returnType] and [parameters]. * - Faster: Specify [accessFlags], [returnType] and [parameters].
* - Fastest: Specify [strings], with at least one string being an exact (non-partial) match. * - Fastest: Specify [strings], with at least one string being an exact (non-partial) match.
*/ */
internal fun List<MethodFingerprint>.resolveUsingLookupMap(context: BytecodeContext) { internal fun Set<MethodFingerprint>.resolveUsingLookupMap(context: BytecodeContext) {
if (methods.isEmpty()) throw PatchException("lookup map not initialized") if (methods.isEmpty()) throw PatchException("lookup map not initialized")
forEach { fingerprint ->
fingerprint.resolveUsingLookupMap(context)
}
for (fingerprint in this) { for (fingerprint in this) {
fingerprint.resolveUsingLookupMap(context) fingerprint.resolveUsingLookupMap(context)
} }

View File

@@ -65,7 +65,7 @@ sealed class Patch<out T : Context<*>>(
*/ */
class CompatiblePackage( class CompatiblePackage(
val name: String, val name: String,
versions: Set<String>? = null, val versions: Set<String>? = null,
) )
} }

View File

@@ -23,16 +23,18 @@ class PatchOptions internal constructor(
* @param value The value. * @param value The value.
* @throws PatchOptionException.PatchOptionNotFoundException If the option does not exist. * @throws PatchOptionException.PatchOptionNotFoundException If the option does not exist.
*/ */
inline operator fun <reified T: Any> set(key: String, value: T?) { operator fun <T : Any> set(key: String, value: T?) {
val option = this[key] val option = this[key]
if (option.value !is T) throw PatchOptionException.InvalidValueTypeException( try {
T::class.java.name, @Suppress("UNCHECKED_CAST")
option.value?.let { it::class.java.name } ?: "null", (option as PatchOption<T>).value = value
) } catch (e: ClassCastException) {
throw PatchOptionException.InvalidValueTypeException(
@Suppress("UNCHECKED_CAST") value?.let { it::class.java.name } ?: "null",
(option as PatchOption<T>).value = value option.value?.let { it::class.java.name } ?: "null",
)
}
} }
/** /**

View File

@@ -7,8 +7,8 @@ import app.revanced.patcher.extensions.InstructionExtensions.replaceInstruction
import app.revanced.patcher.extensions.or import app.revanced.patcher.extensions.or
import app.revanced.patcher.patch.BytecodePatch import app.revanced.patcher.patch.BytecodePatch
import app.revanced.patcher.patch.PatchException import app.revanced.patcher.patch.PatchException
import app.revanced.patcher.patch.annotations.CompatiblePackage import app.revanced.patcher.patch.annotation.CompatiblePackage
import app.revanced.patcher.patch.annotations.Patch import app.revanced.patcher.patch.annotation.Patch
import app.revanced.patcher.util.proxy.mutableTypes.MutableField.Companion.toMutable import app.revanced.patcher.util.proxy.mutableTypes.MutableField.Companion.toMutable
import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable

View File

@@ -19,4 +19,4 @@ dependencyResolutionManagement {
} }
} }
include("revanced-patch-annotations-processor", "revanced-patcher") include("revanced-patch-annotation-processor", "revanced-patcher")