|
|
|
|
@@ -27,7 +27,7 @@ typealias Package = Pair<PackageName, Set<VersionName>?>
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
* @param dependencies Other patches this patch depends on.
|
|
|
|
|
* @param compatiblePackages The packages the patch is compatible with.
|
|
|
|
|
* If null, the patch is compatible with all packages.
|
|
|
|
|
@@ -87,7 +87,8 @@ sealed class Patch<C : PatchContext<*>>(
|
|
|
|
|
finalizeBlock?.invoke(context)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
override fun toString() = name ?: "Patch@${System.identityHashCode(this)}"
|
|
|
|
|
override fun toString() = name ?:
|
|
|
|
|
"Patch@${System.identityHashCode(this)}"
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
internal fun Patch<*>.anyRecursively(
|
|
|
|
|
@@ -121,7 +122,7 @@ internal fun Iterable<Patch<*>>.forEachRecursively(
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
* @param compatiblePackages The packages the patch is compatible with.
|
|
|
|
|
* If null, the patch is compatible with all packages.
|
|
|
|
|
* @param dependencies Other patches this patch depends on.
|
|
|
|
|
@@ -170,7 +171,7 @@ class BytecodePatch internal constructor(
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
* @param compatiblePackages The packages the patch is compatible with.
|
|
|
|
|
* If null, the patch is compatible with all packages.
|
|
|
|
|
* @param dependencies Other patches this patch depends on.
|
|
|
|
|
@@ -213,7 +214,7 @@ class RawResourcePatch internal constructor(
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
* @param compatiblePackages The packages the patch is compatible with.
|
|
|
|
|
* If null, the patch is compatible with all packages.
|
|
|
|
|
* @param dependencies Other patches this patch depends on.
|
|
|
|
|
@@ -257,7 +258,7 @@ class ResourcePatch internal constructor(
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
* @property compatiblePackages The packages the patch is compatible with.
|
|
|
|
|
* If null, the patch is compatible with all packages.
|
|
|
|
|
* @property dependencies Other patches this patch depends on.
|
|
|
|
|
@@ -374,7 +375,7 @@ private fun <B : PatchBuilder<*>> B.buildPatch(block: B.() -> Unit = {}) = apply
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
* @property extensionInputStream Getter for the extension input stream of the patch.
|
|
|
|
|
* An extension is a precompiled DEX file that is merged into the patched app before this patch is executed.
|
|
|
|
|
*
|
|
|
|
|
@@ -424,7 +425,7 @@ class BytecodePatchBuilder internal constructor(
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
* @param block The block to build the patch.
|
|
|
|
|
*
|
|
|
|
|
* @return The created [BytecodePatch].
|
|
|
|
|
@@ -442,7 +443,7 @@ fun bytecodePatch(
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
*
|
|
|
|
|
* @constructor Create a new [RawResourcePatch] builder.
|
|
|
|
|
*/
|
|
|
|
|
@@ -469,7 +470,7 @@ class RawResourcePatchBuilder internal constructor(
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
* @param block The block to build the patch.
|
|
|
|
|
* @return The created [RawResourcePatch].
|
|
|
|
|
*/
|
|
|
|
|
@@ -486,7 +487,7 @@ fun rawResourcePatch(
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
*
|
|
|
|
|
* @constructor Create a new [ResourcePatch] builder.
|
|
|
|
|
*/
|
|
|
|
|
@@ -513,7 +514,7 @@ class ResourcePatchBuilder internal constructor(
|
|
|
|
|
* @param name The name of the patch.
|
|
|
|
|
* If null, the patch is named "Patch" and will not be loaded by [PatchLoader].
|
|
|
|
|
* @param description The description of the patch.
|
|
|
|
|
* @param use Weather or not the patch should be used.
|
|
|
|
|
* @param use Whether or not the patch should be used.
|
|
|
|
|
* @param block The block to build the patch.
|
|
|
|
|
*
|
|
|
|
|
* @return The created [ResourcePatch].
|
|
|
|
|
@@ -528,11 +529,11 @@ fun resourcePatch(
|
|
|
|
|
/**
|
|
|
|
|
* An exception thrown when patching.
|
|
|
|
|
*
|
|
|
|
|
* @param message The exception message.
|
|
|
|
|
* @param cause The cause of the exception.
|
|
|
|
|
* @param errorMessage The exception message.
|
|
|
|
|
* @param cause The corresponding [Throwable].
|
|
|
|
|
*/
|
|
|
|
|
class PatchException(message: String?, cause: Throwable?) : Exception(message, cause) {
|
|
|
|
|
constructor(message: String) : this(message, null)
|
|
|
|
|
class PatchException(errorMessage: String?, cause: Throwable?) : Exception(errorMessage, cause) {
|
|
|
|
|
constructor(errorMessage: String) : this(errorMessage, null)
|
|
|
|
|
constructor(cause: Throwable) : this(cause.message, cause)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
@@ -542,7 +543,6 @@ class PatchException(message: String?, cause: Throwable?) : Exception(message, c
|
|
|
|
|
* @param patch The [Patch] that was executed.
|
|
|
|
|
* @param exception The [PatchException] thrown, if any.
|
|
|
|
|
*/
|
|
|
|
|
@Deprecated("This class is not used anymore. Instead a callback is used")
|
|
|
|
|
class PatchResult internal constructor(val patch: Patch<*>, val exception: PatchException? = null)
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
@@ -553,47 +553,36 @@ class PatchResult internal constructor(val patch: Patch<*>, val exception: Patch
|
|
|
|
|
*
|
|
|
|
|
* @param byPatchesFile The patches associated by the patches file they were loaded from.
|
|
|
|
|
*/
|
|
|
|
|
sealed class PatchLoader(
|
|
|
|
|
sealed class PatchLoader private constructor(
|
|
|
|
|
val byPatchesFile: Map<File, Set<Patch<*>>>,
|
|
|
|
|
) : Set<Patch<*>> by byPatchesFile.values.flatten().toSet() {
|
|
|
|
|
/**
|
|
|
|
|
* @param patchesFiles A set of JAR or DEX files to load the patches from.
|
|
|
|
|
* @param getBinaryClassNames A function that returns the binary names of all classes accessible by the class loader.
|
|
|
|
|
* @param classLoader The [ClassLoader] to use for loading the classes.
|
|
|
|
|
* @param onLoadPatchesException The callback for patches that could not be loaded.
|
|
|
|
|
*/
|
|
|
|
|
constructor(
|
|
|
|
|
private constructor(
|
|
|
|
|
patchesFiles: Set<File>,
|
|
|
|
|
getBinaryClassNames: (patchesFile: File) -> List<String>,
|
|
|
|
|
classLoader: ClassLoader,
|
|
|
|
|
onLoadPatchesException: (message: String, cause: Throwable) -> Unit
|
|
|
|
|
) : this(
|
|
|
|
|
classLoader.loadPatches(
|
|
|
|
|
patchesFiles.associateWith { getBinaryClassNames(it).toSet() },
|
|
|
|
|
onLoadPatchesException
|
|
|
|
|
)
|
|
|
|
|
)
|
|
|
|
|
) : this(classLoader.loadPatches(patchesFiles.associateWith { getBinaryClassNames(it).toSet() }))
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* A [PatchLoader] for JAR files.
|
|
|
|
|
*
|
|
|
|
|
* @param patchesFiles The JAR files to load the patches from.
|
|
|
|
|
* @param onLoadPatchesException The callback for patches that could not be loaded.
|
|
|
|
|
*
|
|
|
|
|
* @constructor Create a new [PatchLoader] for JAR files.
|
|
|
|
|
*/
|
|
|
|
|
class Jar internal constructor(
|
|
|
|
|
patchesFiles: Set<File>,
|
|
|
|
|
onLoadPatchesException: (message: String, cause: Throwable) -> Unit
|
|
|
|
|
) : PatchLoader(
|
|
|
|
|
patchesFiles,
|
|
|
|
|
{ file ->
|
|
|
|
|
JarFile(file).entries().toList().filter { it.name.endsWith(".class") }
|
|
|
|
|
.map { it.name.substringBeforeLast('.').replace('/', '.') }
|
|
|
|
|
},
|
|
|
|
|
URLClassLoader(patchesFiles.map { it.toURI().toURL() }.toTypedArray()),
|
|
|
|
|
onLoadPatchesException
|
|
|
|
|
)
|
|
|
|
|
class Jar(patchesFiles: Set<File>) :
|
|
|
|
|
PatchLoader(
|
|
|
|
|
patchesFiles,
|
|
|
|
|
{ file ->
|
|
|
|
|
JarFile(file).entries().toList().filter { it.name.endsWith(".class") }
|
|
|
|
|
.map { it.name.substringBeforeLast('.').replace('/', '.') }
|
|
|
|
|
},
|
|
|
|
|
URLClassLoader(patchesFiles.map { it.toURI().toURL() }.toTypedArray()),
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* A [PatchLoader] for [Dex] files.
|
|
|
|
|
@@ -601,30 +590,25 @@ sealed class PatchLoader(
|
|
|
|
|
* @param patchesFiles The DEX files to load the patches from.
|
|
|
|
|
* @param optimizedDexDirectory The directory to store optimized DEX files in.
|
|
|
|
|
* This parameter is deprecated and has no effect since API level 26.
|
|
|
|
|
* @param onLoadPatchesException The callback for patches that could not be loaded.
|
|
|
|
|
*
|
|
|
|
|
* @constructor Create a new [PatchLoader] for [Dex] files.
|
|
|
|
|
*/
|
|
|
|
|
class Dex internal constructor(
|
|
|
|
|
patchesFiles: Set<File>,
|
|
|
|
|
optimizedDexDirectory: File? = null,
|
|
|
|
|
onLoadPatchesException: (message: String, cause: Throwable) -> Unit
|
|
|
|
|
) : PatchLoader(
|
|
|
|
|
patchesFiles,
|
|
|
|
|
{ patchBundle ->
|
|
|
|
|
MultiDexIO.readDexFile(true, patchBundle, BasicDexFileNamer(), null, null).classes
|
|
|
|
|
.map { classDef ->
|
|
|
|
|
classDef.type.substring(1, classDef.length - 1)
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
DexClassLoader(
|
|
|
|
|
patchesFiles.joinToString(File.pathSeparator) { it.absolutePath },
|
|
|
|
|
optimizedDexDirectory?.absolutePath,
|
|
|
|
|
null,
|
|
|
|
|
this::class.java.classLoader,
|
|
|
|
|
),
|
|
|
|
|
onLoadPatchesException
|
|
|
|
|
)
|
|
|
|
|
class Dex(patchesFiles: Set<File>, optimizedDexDirectory: File? = null) :
|
|
|
|
|
PatchLoader(
|
|
|
|
|
patchesFiles,
|
|
|
|
|
{ patchBundle ->
|
|
|
|
|
MultiDexIO.readDexFile(true, patchBundle, BasicDexFileNamer(), null, null).classes
|
|
|
|
|
.map { classDef ->
|
|
|
|
|
classDef.type.substring(1, classDef.length - 1)
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
DexClassLoader(
|
|
|
|
|
patchesFiles.joinToString(File.pathSeparator) { it.absolutePath },
|
|
|
|
|
optimizedDexDirectory?.absolutePath,
|
|
|
|
|
null,
|
|
|
|
|
this::class.java.classLoader,
|
|
|
|
|
),
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// Companion object required for unit tests.
|
|
|
|
|
private companion object {
|
|
|
|
|
@@ -656,24 +640,19 @@ sealed class PatchLoader(
|
|
|
|
|
*
|
|
|
|
|
* @param binaryClassNamesByPatchesFile The binary class name of the classes to load the patches from
|
|
|
|
|
* associated by the patches file.
|
|
|
|
|
* @param onLoadPatchesException The callback for patches that could not be loaded.
|
|
|
|
|
*
|
|
|
|
|
* @return The loaded patches associated by the patches file.
|
|
|
|
|
*/
|
|
|
|
|
private fun ClassLoader.loadPatches(
|
|
|
|
|
binaryClassNamesByPatchesFile: Map<File, Set<String>>,
|
|
|
|
|
onLoadPatchesException: (message: String, cause: Throwable) -> Unit
|
|
|
|
|
) = binaryClassNamesByPatchesFile.mapValues { (_, binaryClassNames) ->
|
|
|
|
|
binaryClassNames.asSequence().mapNotNull {
|
|
|
|
|
runCatching { loadClass(it) }.onFailure { exception ->
|
|
|
|
|
onLoadPatchesException("Failed to load patch class $it", exception)
|
|
|
|
|
}.getOrNull()
|
|
|
|
|
}.flatMap {
|
|
|
|
|
it.patchFields + it.patchMethods
|
|
|
|
|
}.filter {
|
|
|
|
|
it.name != null
|
|
|
|
|
}.toSet()
|
|
|
|
|
}
|
|
|
|
|
private fun ClassLoader.loadPatches(binaryClassNamesByPatchesFile: Map<File, Set<String>>) =
|
|
|
|
|
binaryClassNamesByPatchesFile.mapValues { (_, binaryClassNames) ->
|
|
|
|
|
binaryClassNames.asSequence().map {
|
|
|
|
|
loadClass(it)
|
|
|
|
|
}.flatMap {
|
|
|
|
|
it.patchFields + it.patchMethods
|
|
|
|
|
}.filter {
|
|
|
|
|
it.name != null
|
|
|
|
|
}.toSet()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private fun Member.canAccess(): Boolean {
|
|
|
|
|
if (this is Method && parameterCount != 0) return false
|
|
|
|
|
@@ -689,22 +668,11 @@ sealed class PatchLoader(
|
|
|
|
|
* Patches with no name are not loaded.
|
|
|
|
|
*
|
|
|
|
|
* @param patchesFiles The JAR files to load the patches from.
|
|
|
|
|
* @param onLoadPatchesException The callback for patches that could not be loaded.
|
|
|
|
|
*
|
|
|
|
|
* @return The loaded patches.
|
|
|
|
|
*/
|
|
|
|
|
fun loadPatchesFromJar(
|
|
|
|
|
patchesFiles: Set<File>,
|
|
|
|
|
onLoadPatchesException: ((message: String, cause: Throwable) -> Unit)? = null
|
|
|
|
|
) = PatchLoader.Jar(patchesFiles, onLoadPatchesException ?: { message, cause -> })
|
|
|
|
|
|
|
|
|
|
@Deprecated(
|
|
|
|
|
"Use the function with the onLoadPatchesException overload",
|
|
|
|
|
replaceWith = ReplaceWith("loadPatchesFromJar(patchesFiles, null)")
|
|
|
|
|
)
|
|
|
|
|
fun loadPatchesFromJar(
|
|
|
|
|
patchesFiles: Set<File>
|
|
|
|
|
) = loadPatchesFromJar(patchesFiles, null)
|
|
|
|
|
fun loadPatchesFromJar(patchesFiles: Set<File>) =
|
|
|
|
|
PatchLoader.Jar(patchesFiles)
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Loads patches from DEX files declared as public static fields
|
|
|
|
|
@@ -712,21 +680,8 @@ fun loadPatchesFromJar(
|
|
|
|
|
* Patches with no name are not loaded.
|
|
|
|
|
*
|
|
|
|
|
* @param patchesFiles The DEX files to load the patches from.
|
|
|
|
|
* @param onLoadPatchesException The callback for patches that could not be loaded.
|
|
|
|
|
*
|
|
|
|
|
* @return The loaded patches.
|
|
|
|
|
*/
|
|
|
|
|
fun loadPatchesFromDex(
|
|
|
|
|
patchesFiles: Set<File>,
|
|
|
|
|
optimizedDexDirectory: File? = null,
|
|
|
|
|
onLoadPatchesException: ((message: String, cause: Throwable) -> Unit)? = null
|
|
|
|
|
) = PatchLoader.Dex(patchesFiles, optimizedDexDirectory, onLoadPatchesException ?: { message, cause -> })
|
|
|
|
|
|
|
|
|
|
@Deprecated(
|
|
|
|
|
"Use the function with the onLoadPatchesException overload",
|
|
|
|
|
replaceWith = ReplaceWith("loadPatchesFromJar(patchesFiles, optimizedDexDirectory, null)")
|
|
|
|
|
)
|
|
|
|
|
fun loadPatchesFromDex(
|
|
|
|
|
patchesFiles: Set<File>,
|
|
|
|
|
optimizedDexDirectory: File? = null,
|
|
|
|
|
) = loadPatchesFromDex(patchesFiles, optimizedDexDirectory, null)
|
|
|
|
|
fun loadPatchesFromDex(patchesFiles: Set<File>, optimizedDexDirectory: File? = null) =
|
|
|
|
|
PatchLoader.Dex(patchesFiles, optimizedDexDirectory)
|
|
|
|
|
|
