From 12a5593d2547504d76a9f1ceacacd16b0b071e1f Mon Sep 17 00:00:00 2001 From: Fankesyooni Date: Tue, 8 Feb 2022 04:19:11 +0800 Subject: [PATCH] ... --- .../YukiHookXposedProcessor.kt | 160 +++++++++++------- .../highcapable/yukihookapi/YukiHookAPI.kt | 10 -- .../xposed/InjectYukiHookWithXposed.kt | 21 ++- .../xposed/proxy/YukiHookXposedInitProxy.kt | 2 - 4 files changed, 108 insertions(+), 85 deletions(-) diff --git a/yukihookapi-ksp-xposed/src/api/kotlin/com/highcapable/yukihookapi_ksp_xposed/YukiHookXposedProcessor.kt b/yukihookapi-ksp-xposed/src/api/kotlin/com/highcapable/yukihookapi_ksp_xposed/YukiHookXposedProcessor.kt index 97ff8cea..5d00f731 100644 --- a/yukihookapi-ksp-xposed/src/api/kotlin/com/highcapable/yukihookapi_ksp_xposed/YukiHookXposedProcessor.kt +++ b/yukihookapi-ksp-xposed/src/api/kotlin/com/highcapable/yukihookapi_ksp_xposed/YukiHookXposedProcessor.kt @@ -38,7 +38,7 @@ import com.highcapable.yukihookapi.annotation.xposed.InjectYukiHookWithXposed import java.io.File /** - * 这是 YukiHook API 的自动生成处理类 - 核心基于 KSP + * 这是 YukiHookAPI 的自动生成处理类 - 核心基于 KSP * * 可以帮你快速生成 Xposed 入口类和包名 * @@ -65,9 +65,22 @@ class YukiHookXposedProcessor : SymbolProcessorProvider { /** * 创建一个环境方法体方便调用 + * @param ignoredError 是否忽略错误 - 默认否 * @param env 方法体 */ - private fun environment(env: SymbolProcessorEnvironment.() -> Unit) = runCatching { environment.apply(env) } + private fun environment(ignoredError: Boolean = false, env: SymbolProcessorEnvironment.() -> Unit) { + if (ignoredError) runCatching { environment.apply(env) } + else environment.apply(env) + } + + /** + * 终止并报错 + * @param msg 错误消息 + */ + private fun SymbolProcessorEnvironment.error(msg: String) { + logger.error(msg) + throw RuntimeException(msg) + } override fun process(resolver: Resolver) = emptyList().let { injectProcess(resolver) @@ -80,80 +93,102 @@ class YukiHookXposedProcessor : SymbolProcessorProvider { */ private fun injectProcess(resolver: Resolver) = environment { var injectOnce = true - resolver.getSymbolsWithAnnotation(InjectYukiHookWithXposed::class.java.name) - .asSequence() - .filterIsInstance().forEach { - if (injectOnce) - if (it.superName == "YukiHookXposedInitProxy") { - injectAssets( - codePath = (it.location as? FileLocation?)?.filePath ?: "", - packageName = it.packageName.asString(), - className = it.simpleName.asString() - ) - injectClass(it.packageName.asString(), it.simpleName.asString()) - } else logger.error(message = "HookEntryClass \"${it.simpleName.asString()}\" must be implements YukiHookXposedInitProxy") - else logger.error(message = "@InjectYukiHookWithXposed only can be use in once times") - /** 仅处理第一个标记的类 - 再次处理将拦截并报错 */ - injectOnce = false + resolver.getSymbolsWithAnnotation(InjectYukiHookWithXposed::class.java.name).apply { + /** + * 检索需要注入的类 + * @param sourcePath 指定的 source 路径 + * @param modulePackageName 模块包名 + */ + fun fetchKSClassDeclaration(sourcePath: String, modulePackageName: String) { + asSequence().filterIsInstance().forEach { + if (injectOnce) + if (it.superName == "YukiHookXposedInitProxy") { + injectAssets( + codePath = (it.location as? FileLocation?)?.filePath ?: "", + sourcePath = sourcePath, + packageName = it.packageName.asString(), + className = it.simpleName.asString(), + ) + injectClass(it.packageName.asString(), it.simpleName.asString(), modulePackageName) + } else error(msg = "HookEntryClass \"${it.simpleName.asString()}\" must be implements YukiHookXposedInitProxy") + else error(msg = "@InjectYukiHookWithXposed only can be use in once times") + /** 仅处理第一个标记的类 - 再次处理将拦截并报错 */ + injectOnce = false + } } + forEach { + it.annotations.forEach { e -> + val sourcePath = e.arguments[0].value.toString() + val modulePackageName = e.arguments[1].value.toString() + if ((modulePackageName.startsWith(".") || + modulePackageName.endsWith(".") || + !modulePackageName.contains(".") || + modulePackageName.contains("..")) && + modulePackageName.isNotEmpty() + ) error(msg = "Invalid Module Package name \"$modulePackageName\"") + else fetchKSClassDeclaration(sourcePath, modulePackageName) + } + } + } } /** * 自动生成 Xposed assets 入口文件 * @param codePath 注释类的完整代码文件路径 + * @param sourcePath 指定的 source 路径 * @param packageName 包名 * @param className 类名 */ - private fun injectAssets(codePath: String, packageName: String, className: String) = environment { - runCatching { + private fun injectAssets(codePath: String, sourcePath: String, packageName: String, className: String) = + environment { if (codePath.isBlank()) error("Project CodePath is empty") val projectPath = when (File.separator) { - "\\" -> { - if (codePath.contains("\\src\\main\\")) - codePath.split("\\src\\main\\")[0] + "\\src\\main\\" - else error("Project source path must be ..\\src\\main\\..") - } - "/" -> { - if (codePath.contains("/src/main/")) - codePath.split("/src/main/")[0] + "/src/main/" - else error("Project source path must be ../src/main/..") - } - else -> error("Unix File Separator unknown") + "\\" -> sourcePath.replace("/", "\\") + "/" -> sourcePath.replace("\\", "/") + else -> kotlin.error("Unix File Separator unknown") + }.let { + if (codePath.contains(it)) + codePath.split(it)[0] + it + else error(msg = "Project Source Path \"$it\" not matched") } File("$projectPath${File.separator}assets").also { assFile -> - if (!assFile.exists() || !assFile.isDirectory) { - assFile.delete() - assFile.mkdirs() - } - File("${assFile.absolutePath}${File.separator}xposed_init") - .writeText(text = "$packageName.$className$xposedClassShortName") + if (File("$projectPath${File.separator}AndroidManifest.xml").exists()) { + if (!assFile.exists() || !assFile.isDirectory) { + assFile.delete() + assFile.mkdirs() + } + File("${assFile.absolutePath}${File.separator}xposed_init") + .writeText(text = "$packageName.$className$xposedClassShortName") + } else error(msg = "Project Source Path \"$sourcePath\" verify failed! Is this an Android Project?") } - }.onFailure { - logger.error(message = "Inject XposedAssets Failed! $it") } - } /** * 注入并生成指定类 * @param packageName 包名 * @param className 类名 + * @param modulePackageName 模块包名 */ - private fun injectClass(packageName: String, className: String) = environment { - var realPackageName = "unknown" - if (packageName.contains(".hook.")) - realPackageName = packageName.split(".hook.")[0] - else logger.warn(message = "YukiHook cannot identify your App's package name,please refer to the wiki https://github.com/fankes/YukiHookAPI/wiki to fix the package name or manually configure the package name") - codeGenerator.createNewFile(Dependencies.ALL_FILES, packageName, fileName = "$className$xposedClassShortName") - .apply { - /** 🤡 由于插入的代码量不大就不想用工具生成了 */ + private fun injectClass(packageName: String, className: String, modulePackageName: String) = + environment(ignoredError = true) { + if (modulePackageName.isNotBlank()) logger.warn(message = "You set the customize module package name to \"$modulePackageName\",please check for yourself if it is correct") + val realPackageName = + modulePackageName.ifBlank { + if (packageName.contains(".hook.")) + packageName.split(".hook.")[0] + else error(msg = "YukiHook cannot identify your App's package name,please refer to the wiki https://github.com/fankes/YukiHookAPI/wiki to fix the package name or manually configure the package name") + } + codeGenerator.createNewFile( + Dependencies.ALL_FILES, + packageName, + fileName = "$className$xposedClassShortName" + ).apply { + /** 插入 xposed_init 代码 */ write( - ("@file:Suppress(\"EXPERIMENTAL_API_USAGE\")\n" + - "\n" + - "package $packageName\n" + + ("package $packageName\n" + "\n" + "import androidx.annotation.Keep\n" + "import com.highcapable.yukihookapi.YukiHookAPI\n" + - "import com.highcapable.yukihookapi.YukiHookAPI.Configs\n" + "import com.highcapable.yukihookapi.hook.xposed.YukiHookModuleStatus\n" + "import com.highcapable.yukihookapi.hook.log.loggerE\n" + "import de.robv.android.xposed.IXposedHookLoadPackage\n" + @@ -181,19 +216,14 @@ class YukiHookXposedProcessor : SymbolProcessorProvider { " }.onFailure {\n" + " loggerE(tag = \"YukiHookAPI\", msg = \"YukiHookAPI try to load HookEntryClass failed\", e = it)\n" + " }\n" + - " YukiHookAPI.Configs.modulePackageName.ifEmpty {\n" + - " YukiHookAPI.Configs.modulePackageName = \"$realPackageName\"\n" + - " \"$realPackageName\"\n" + - " }.also {\n" + - " if (lpparam.packageName == it)\n" + - " XposedHelpers.findAndHookMethod(\n" + - " YukiHookModuleStatus::class.java.name,\n" + - " lpparam.classLoader,\n" + - " \"isActive\",\n" + - " object : XC_MethodReplacement() {\n" + - " override fun replaceHookedMethod(param: MethodHookParam?) = true\n" + - " })\n" + - " }\n" + + " if (lpparam.packageName == \"$realPackageName\")\n" + + " XposedHelpers.findAndHookMethod(\n" + + " YukiHookModuleStatus::class.java.name,\n" + + " lpparam.classLoader,\n" + + " \"isActive\",\n" + + " object : XC_MethodReplacement() {\n" + + " override fun replaceHookedMethod(param: MethodHookParam?) = true\n" + + " })\n" + " YukiHookAPI.onXposedLoaded(lpparam)\n" + " }\n" + "}").toByteArray() @@ -201,6 +231,6 @@ class YukiHookXposedProcessor : SymbolProcessorProvider { flush() close() } - } + } } } \ No newline at end of file diff --git a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/YukiHookAPI.kt b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/YukiHookAPI.kt index f3d26d2c..512a9f3b 100644 --- a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/YukiHookAPI.kt +++ b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/YukiHookAPI.kt @@ -40,7 +40,6 @@ import com.highcapable.yukihookapi.hook.factory.processName import com.highcapable.yukihookapi.hook.log.loggerE import com.highcapable.yukihookapi.hook.param.PackageParam import com.highcapable.yukihookapi.hook.param.wrapper.PackageParamWrapper -import com.highcapable.yukihookapi.hook.xposed.YukiHookModuleStatus import de.robv.android.xposed.XposedBridge import de.robv.android.xposed.callbacks.XC_LoadPackage @@ -82,15 +81,6 @@ object YukiHookAPI { * 请过滤 [debugTag] 即可找到每条日志 */ var isDebug = true - - /** - * Xposed Hook API 绑定的模块包名 - * - * - 用于 [YukiHookModuleStatus] 判断模块激活状态 - * - * 未写将自动生成 - */ - var modulePackageName = "" } /** diff --git a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.kt b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.kt index 8829cf63..080f68fa 100644 --- a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.kt +++ b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/annotation/xposed/InjectYukiHookWithXposed.kt @@ -29,15 +29,16 @@ package com.highcapable.yukihookapi.annotation.xposed -import com.highcapable.yukihookapi.YukiHookAPI import com.highcapable.yukihookapi.hook.xposed.proxy.YukiHookXposedInitProxy /** * 标识 YukiHook 注入 Xposed 入口的类注释 * - * - ⚡你的项目 source 目录必须为 ../src/main/ 后方内容根据你自行喜好定义即可 - 否则编译会报错 + * - 你的项目 source 目录默认为 "src/main/" 可在 [sourcePath] 中进行自定义 - 自动处理程序将只检查 ..app/[sourcePath]/java.. 中间部分 * - * - 你的 Hook 入口类(HookEntryClass) 需要按照此格式创建 --> 你的模块APP包名/hook/...可允许子包名存在.../你的入口类 + * - 自动处理程序将自动在 ../[sourcePath]/assets/ 下建立 xposed_init 文件 + * + * - 你的 Hook 入口类(HookEntryClass) 需要按照此格式创建 --> 你的模块 APP 包名/hook/...可允许子包名存在.../你的入口类 * * 例子：com.example.module.hook.MainHook、com.example.module.hook.inject.MainInject、com.example.module.hook.custom.CustomClass * @@ -47,15 +48,19 @@ import com.highcapable.yukihookapi.hook.xposed.proxy.YukiHookXposedInitProxy * * - 你的模块包名将被这样识别：|com.example.module|.hook... * - * - 若你不喜欢这样创建类 - 没问题 - 请在 [YukiHookAPI.Configs.modulePackageName] 填写模块包名即可 - 但不按照规则定义包名你将会收到编译警告 + * - 若你不喜欢这样创建类 - 没问题 - 请在 [modulePackageName] 填写你的模块包名即可 - 默认会按照标准识别 - 失败编译会报错 * - * - ⚡最后这一点很重要：请不要随意修改项目 ../src/main/assets/xposed_init 中的内容 - 否则可能会导致模块装载发生错误 + * - 为了防止模块包名无法正常被识别 - 自定义 [modulePackageName] 会在编译时产生警告 * - * 你必须将被注释的类继承于 [YukiHookXposedInitProxy] 接口实现 [YukiHookXposedInitProxy.onHook] 方法 - 否则编译会报错 + * - ⚡最后这一点很重要：请不要随意修改项目 ../[sourcePath]/assets/xposed_init 中的内容 - 否则可能会导致模块无法装载 * - * 只能拥有一个 Hook 入口 - 若存在多个注释编译会报错 + * - ⚡你必须将被注释的类继承于 [YukiHookXposedInitProxy] 接口实现 [YukiHookXposedInitProxy.onHook] 方法 - 否则编译会报错 + * + * - ⚡只能拥有一个 Hook 入口 - 若存在多个注释编译会报错 * * 详情请参考 [YukiHookAPI Wiki](https://github.com/fankes/YukiHookAPI/wiki) + * @param sourcePath 你的项目 source 相对路径 - 默认为 ..src/main.. + * @param modulePackageName 模块包名 - 使用标准路径可不填会自动生成 */ @Target(AnnotationTarget.CLASS) -annotation class InjectYukiHookWithXposed \ No newline at end of file +annotation class InjectYukiHookWithXposed(val sourcePath: String = "src/main", val modulePackageName: String = "") \ No newline at end of file diff --git a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/proxy/YukiHookXposedInitProxy.kt b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/proxy/YukiHookXposedInitProxy.kt index 173d6f82..c9a21b84 100644 --- a/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/proxy/YukiHookXposedInitProxy.kt +++ b/yukihookapi/src/api/kotlin/com/highcapable/yukihookapi/hook/xposed/proxy/YukiHookXposedInitProxy.kt @@ -50,8 +50,6 @@ import com.highcapable.yukihookapi.hook.factory.encase * * ....debugTag = "自定义 TAG" * - * ....modulePackageName = "模块包名/可选" - * * ....isDebug = true * * }