refactor: bundle core native lib version name into BuildConfig

WhiredPlanck · WhiredPlanck · commit 3e3abdd3671e · 2024-12-14T00:01:22.000+08:00
diff --git a/app/src/main/java/com/osfans/trime/core/Rime.kt b/app/src/main/java/com/osfans/trime/core/Rime.kt
@@ -397,9 +397,6 @@ class Rime :
         @JvmStatic
         external fun forgetRimeCandidate(index: Int): Boolean
 
-        @JvmStatic
-        external fun getLibrimeVersion(): String
-
         // module
         @JvmStatic
         external fun runRimeTask(taskName: String?): Boolean
diff --git a/app/src/main/java/com/osfans/trime/data/opencc/OpenCCDictManager.kt b/app/src/main/java/com/osfans/trime/data/opencc/OpenCCDictManager.kt
@@ -115,9 +115,6 @@ object OpenCCDictManager {
         configFileName: String,
     ): String
 
-    @JvmStatic
-    external fun getOpenCCVersion(): String
-
     const val MODE_BIN_TO_TXT = true // OCD(2) to TXT
     const val MODE_TXT_TO_BIN = false // TXT to OCD2
 }
diff --git a/app/src/main/java/com/osfans/trime/ui/fragments/AboutFragment.kt b/app/src/main/java/com/osfans/trime/ui/fragments/AboutFragment.kt
@@ -4,24 +4,18 @@
 
 package com.osfans.trime.ui.fragments
 
-import android.content.ClipData
 import android.content.Intent
 import android.net.Uri
 import android.os.Bundle
-import android.widget.Toast
 import androidx.fragment.app.activityViewModels
 import androidx.navigation.fragment.findNavController
 import androidx.preference.Preference
 import androidx.preference.get
 import com.osfans.trime.R
-import com.osfans.trime.core.Rime
-import com.osfans.trime.data.opencc.OpenCCDictManager
 import com.osfans.trime.ui.components.PaddingPreferenceFragment
 import com.osfans.trime.ui.main.MainViewModel
 import com.osfans.trime.util.Const
 import com.osfans.trime.util.formatDateTime
-import com.osfans.trime.util.toast
-import splitties.systemservices.clipboardManager
 
 class AboutFragment : PaddingPreferenceFragment() {
     private val viewModel: MainViewModel by activityViewModels()
@@ -33,40 +27,35 @@ class AboutFragment : PaddingPreferenceFragment() {
         setPreferencesFromResource(R.xml.about_preference, rootKey)
         with(preferenceScreen) {
             get<Preference>("about__changelog")?.apply {
-                summary = Const.displayVersionName
+                summary = Const.VERSION_NAME
                 isCopyingEnabled = true
                 intent =
                     Intent(
                         Intent.ACTION_VIEW,
-                        Uri.parse("${Const.currentGitRepo}/commits/${Const.buildCommitHash}"),
+                        Uri.parse("${Const.GIT_REPO}/commits/${Const.BUILD_COMMIT_HASH}"),
                     )
             }
             get<Preference>("about__build_info")?.apply {
                 summary =
                     requireContext().getString(
                         R.string.about__build_info_format,
-                        Const.builder,
-                        Const.currentGitRepo,
-                        Const.buildCommitHash,
-                        formatDateTime(Const.buildTimestamp),
+                        Const.BUILDER,
+                        Const.GIT_REPO,
+                        Const.BUILD_COMMIT_HASH,
+                        formatDateTime(Const.BUILD_TIMESTAMP),
                     )
-                setOnPreferenceClickListener {
-                    val info = ClipData.newPlainText("BuildInfo", summary)
-                    clipboardManager.setPrimaryClip(info)
-                    context.toast(R.string.copy_done, Toast.LENGTH_LONG)
-                    true
-                }
+                isCopyingEnabled = true
             }
             get<Preference>("about__librime_version")?.apply {
-                val code = Rime.getLibrimeVersion()
+                val code = Const.LIBRIME_VERSION
                 val hash = extractCommitHash(code)
                 summary = code
                 intent?.data?.also {
                     intent!!.data = Uri.withAppendedPath(it, "commit/$hash")
                 }
             }
             get<Preference>("about__opencc_version")?.apply {
-                val code = OpenCCDictManager.getOpenCCVersion()
+                val code = Const.OPENCC_VERSION
                 val hash = extractCommitHash(code)
                 summary = code
                 intent?.data?.also {
@@ -92,7 +81,7 @@ class AboutFragment : PaddingPreferenceFragment() {
         private val COMMON_PATTERN = Regex("^([^-]*)(-.*)$")
 
         private fun extractCommitHash(versionCode: String): String =
-            DASH_G_PATTERN.find(versionCode)?.groupValues?.get(1)
+            DASH_G_PATTERN.find(versionCode)?.groupValues?.get(2)
                 ?: COMMON_PATTERN.find(versionCode)?.groupValues?.get(1)
                 ?: versionCode
     }
diff --git a/app/src/main/java/com/osfans/trime/util/Const.kt b/app/src/main/java/com/osfans/trime/util/Const.kt
@@ -7,10 +7,12 @@ package com.osfans.trime.util
 import com.osfans.trime.BuildConfig
 
 object Const {
-    val builder = BuildConfig.BUILDER
-    val buildTimestamp = BuildConfig.BUILD_TIMESTAMP
-    val buildCommitHash = BuildConfig.BUILD_COMMIT_HASH
-    val displayVersionName = "${BuildConfig.BUILD_VERSION_NAME}-${BuildConfig.BUILD_TYPE}"
-    val originalGitRepo = "https://github.com/osfans/trime"
-    val currentGitRepo = BuildConfig.BUILD_GIT_REPO
+    const val BUILDER = BuildConfig.BUILDER
+    const val BUILD_TIMESTAMP = BuildConfig.BUILD_TIMESTAMP
+    const val BUILD_COMMIT_HASH = BuildConfig.BUILD_COMMIT_HASH
+    const val VERSION_NAME = "${BuildConfig.BUILD_VERSION_NAME}-${BuildConfig.BUILD_TYPE}"
+    const val GIT_REPO = BuildConfig.BUILD_GIT_REPO
+
+    const val LIBRIME_VERSION = BuildConfig.LIBRIME_VERSION
+    const val OPENCC_VERSION = BuildConfig.OPENCC_VERSION
 }
diff --git a/app/src/main/java/com/osfans/trime/util/DeviceInfo.kt b/app/src/main/java/com/osfans/trime/util/DeviceInfo.kt
@@ -39,10 +39,10 @@ object DeviceInfo {
             )
             appendLine("--------- Build Info")
             appendLine("Package Name: ${BuildConfig.APPLICATION_ID}")
-            appendLine("Builder: ${Const.builder}")
+            appendLine("Builder: ${Const.BUILDER}")
             appendLine("Version Code: ${BuildConfig.VERSION_CODE}")
-            appendLine("Version Name: ${Const.displayVersionName}")
-            appendLine("Build Time: ${iso8601UTCDateTime(Const.buildTimestamp)}")
-            appendLine("Build Git Hash: ${Const.buildCommitHash}")
+            appendLine("Version Name: ${Const.VERSION_NAME}")
+            appendLine("Build Time: ${iso8601UTCDateTime(Const.BUILD_TIMESTAMP)}")
+            appendLine("Build Git Hash: ${Const.BUILD_COMMIT_HASH}")
         }
 }
diff --git a/app/src/main/jni/librime_jni/CMakeLists.txt b/app/src/main/jni/librime_jni/CMakeLists.txt
@@ -26,20 +26,6 @@ execute_process(
 )
 string(STRIP ${TRIME_VERSION} TRIME_VERSION)
 
-execute_process(
-  COMMAND git --git-dir ${CMAKE_SOURCE_DIR}/OpenCC/.git describe --tags
-  OUTPUT_VARIABLE OPENCC_VERSION
-)
-string(STRIP ${OPENCC_VERSION} OPENCC_VERSION)
-
-execute_process(
-  COMMAND git --git-dir ${CMAKE_SOURCE_DIR}/librime/.git describe --tags --exclude "latest"
-  OUTPUT_VARIABLE LIBRIME_VERSION
-)
-string(STRIP ${LIBRIME_VERSION} LIBRIME_VERSION)
-
 target_compile_definitions(rime_jni PRIVATE
   TRIME_VERSION="${TRIME_VERSION}"
-  OPENCC_VERSION="${OPENCC_VERSION}"
-  LIBRIME_VERSION="${LIBRIME_VERSION}"
 )
diff --git a/app/src/main/jni/librime_jni/opencc.cc b/app/src/main/jni/librime_jni/opencc.cc
@@ -12,12 +12,6 @@
 
 // opencc
 
-extern "C" JNIEXPORT jstring JNICALL
-Java_com_osfans_trime_data_opencc_OpenCCDictManager_getOpenCCVersion(
-    JNIEnv *env, jclass clazz) {
-  return env->NewStringUTF(OPENCC_VERSION);
-}
-
 extern "C" JNIEXPORT jstring JNICALL
 Java_com_osfans_trime_data_opencc_OpenCCDictManager_openCCLineConv(
     JNIEnv *env, jclass clazz, jstring input, jstring config_file_name) {
diff --git a/app/src/main/jni/librime_jni/rime_jni.cc b/app/src/main/jni/librime_jni/rime_jni.cc
@@ -474,12 +474,6 @@ Java_com_osfans_trime_core_Rime_forgetRimeCandidate(JNIEnv *env,
   return Rime::Instance().forgetCandidate(index);
 }
 
-extern "C" JNIEXPORT jstring JNICALL
-Java_com_osfans_trime_core_Rime_getLibrimeVersion(JNIEnv *env,
-                                                  jclass /* thiz */) {
-  return env->NewStringUTF(LIBRIME_VERSION);
-}
-
 extern "C" JNIEXPORT jboolean JNICALL
 Java_com_osfans_trime_core_Rime_runRimeTask(JNIEnv *env, jclass /* thiz */,
                                             jstring task_name) {
diff --git a/build-logic/convention/src/main/kotlin/NativeAppConventionPlugin.kt b/build-logic/convention/src/main/kotlin/NativeAppConventionPlugin.kt
@@ -7,6 +7,20 @@ import org.gradle.api.Project
 import org.gradle.kotlin.dsl.configure
 
 class NativeAppConventionPlugin : NativeBaseConventionPlugin() {
+    private val Project.librimeVersion: String
+        get() =
+            runCmd(
+                "git describe --tags --long --always --exclude 'latest'",
+                workingDir = file("src/main/jni/librime"),
+            )
+
+    private val Project.openccVersion: String
+        get() =
+            runCmd(
+                "git describe --tags --long --always",
+                workingDir = file("src/main/jni/OpenCC"),
+            )
+
     override fun apply(target: Project) {
         super.apply(target)
 
@@ -16,6 +30,10 @@ class NativeAppConventionPlugin : NativeBaseConventionPlugin() {
                     useLegacyPackaging = true
                 }
             }
+            defaultConfig {
+                buildConfigField("String", "LIBRIME_VERSION", "\"${target.librimeVersion}\"")
+                buildConfigField("String", "OPENCC_VERSION", "\"${target.openccVersion}\"")
+            }
         }
     }
 }
diff --git a/build-logic/convention/src/main/kotlin/ProjectExtensions.kt b/build-logic/convention/src/main/kotlin/ProjectExtensions.kt
@@ -10,14 +10,22 @@ import java.io.File
 import kotlin.io.encoding.Base64
 import kotlin.io.encoding.ExperimentalEncodingApi
 
-fun Project.runCmd(cmd: String): String =
-    ByteArrayOutputStream().use {
-        project.exec {
-            commandLine = cmd.split(" ")
-            standardOutput = it
+fun Project.runCmd(
+    cmd: String,
+    default: String = "",
+    workingDir: File? = null,
+): String {
+    val stdout = ByteArrayOutputStream()
+    val result =
+        stdout.use {
+            project.exec {
+                commandLine = cmd.split(" ")
+                standardOutput = stdout
+                workingDir?.let { this.workingDir = it }
+            }
         }
-        it.toString().trim()
-    }
+    return if (result.exitValue == 0) stdout.toString().trim() else default
+}
 
 val Project.assetsDir: File
     get() = file("src/main/assets").also { it.mkdirs() }
@@ -44,8 +52,7 @@ val Project.buildGitRepo
     get() =
         envOrProp("BUILD_GIT_REPO", "buildGitRepo") {
             runCmd("git remote get-url origin")
-                .replaceFirst("^git@github\\.com:", "https://github.com/")
-                .replaceFirst("\\.git\$", "")
+                .replace("git@([^:]+):(.+)/(.+)\\.git".toRegex(), "https://$1/$2/$3")
         }
 
 val Project.buildVersionName

Original file line number	Diff line number	Diff line change
`@@ -115,9 +115,6 @@ object OpenCCDictManager {`
`115`	`115`	`configFileName: String,`
`116`	`116`	`): String`
`117`	`117`
`118`		`- @JvmStatic`
`119`		`- external fun getOpenCCVersion(): String`
`120`		`-`
`121`	`118`	`const val MODE_BIN_TO_TXT = true // OCD(2) to TXT`
`122`	`119`	`const val MODE_TXT_TO_BIN = false // TXT to OCD2`
`123`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,10 +39,10 @@ object DeviceInfo {`
`39`	`39`	`)`
`40`	`40`	`appendLine("--------- Build Info")`
`41`	`41`	`appendLine("Package Name: ${BuildConfig.APPLICATION_ID}")`
`42`		`- appendLine("Builder: ${Const.builder}")`
	`42`	`+ appendLine("Builder: ${Const.BUILDER}")`
`43`	`43`	`appendLine("Version Code: ${BuildConfig.VERSION_CODE}")`
`44`		`- appendLine("Version Name: ${Const.displayVersionName}")`
`45`		`- appendLine("Build Time: ${iso8601UTCDateTime(Const.buildTimestamp)}")`
`46`		`- appendLine("Build Git Hash: ${Const.buildCommitHash}")`
	`44`	`+ appendLine("Version Name: ${Const.VERSION_NAME}")`
	`45`	`+ appendLine("Build Time: ${iso8601UTCDateTime(Const.BUILD_TIMESTAMP)}")`
	`46`	`+ appendLine("Build Git Hash: ${Const.BUILD_COMMIT_HASH}")`
`47`	`47`	`}`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,20 @@ import org.gradle.api.Project`
`7`	`7`	`import org.gradle.kotlin.dsl.configure`
`8`	`8`
`9`	`9`	`class NativeAppConventionPlugin : NativeBaseConventionPlugin() {`
	`10`	`+ private val Project.librimeVersion: String`
	`11`	`+ get() =`
	`12`	`+ runCmd(`
	`13`	`+ "git describe --tags --long --always --exclude 'latest'",`
	`14`	`+ workingDir = file("src/main/jni/librime"),`
	`15`	`+ )`
	`16`	`+`
	`17`	`+ private val Project.openccVersion: String`
	`18`	`+ get() =`
	`19`	`+ runCmd(`
	`20`	`+ "git describe --tags --long --always",`
	`21`	`+ workingDir = file("src/main/jni/OpenCC"),`
	`22`	`+ )`
	`23`	`+`
`10`	`24`	`override fun apply(target: Project) {`
`11`	`25`	`super.apply(target)`
`12`	`26`
`@@ -16,6 +30,10 @@ class NativeAppConventionPlugin : NativeBaseConventionPlugin() {`
`16`	`30`	`useLegacyPackaging = true`
`17`	`31`	`}`
`18`	`32`	`}`
	`33`	`+ defaultConfig {`
	`34`	`+ buildConfigField("String", "LIBRIME_VERSION", "\"${target.librimeVersion}\"")`
	`35`	`+ buildConfigField("String", "OPENCC_VERSION", "\"${target.openccVersion}\"")`
	`36`	`+ }`
`19`	`37`	`}`
`20`	`38`	`}`
`21`	`39`	`}`