refactor: [8/n] Extract git-based versioning logic

For the unprivileged case, the barebones base classes should be usable
directly.

app-common/build.gradle

@@ -30,8 +30,6 @@ android {
 }
 
 dependencies {
-    compileOnly project(':libs:hidden-apis-stub')
-    implementation project(':libs:hidden-apis-shim')
     implementation project(":libs:lpac-jni")
     implementation 'androidx.core:core-ktx:1.12.0'
     implementation 'androidx.appcompat:appcompat:1.6.1'

app-common/src/main/AndroidManifest.xml

@@ -1,16 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:tools="http://schemas.android.com/tools"
-    xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:android="http://schemas.android.com/apk/res/android">
-    tools:ignore="ProtectedPermissions">
-    <uses-feature
-        android:name="android.hardware.telephony"
-        android:required="true" />
 
-    <uses-permission android:name="android.permission.MODIFY_PHONE_STATE" />
+    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
-    <uses-permission android:name="android.permission.READ_PRIVILEGED_PHONE_STATE" />
-    <uses-permission android:name="android.permission.WRITE_EMBEDDED_SUBSCRIPTIONS" />
     <uses-permission android:name="android.permission.INTERNET" />
-    <uses-permission android:name="android.permission.SECURE_ELEMENT_PRIVILEGED_OPERATION" />
 
     <application
         android:networkSecurityConfig="@xml/network_security_config">

app-common/src/main/java/im/angry/openeuicc/OpenEuiccApplication.kt

@@ -3,14 +3,16 @@ package im.angry.openeuicc
 import android.app.Application
 import android.telephony.SubscriptionManager
 import android.telephony.TelephonyManager
-import im.angry.openeuicc.core.BaseEuiccChannelManager
+import im.angry.openeuicc.core.EuiccChannelManager
 
-abstract class BaseOpenEuiccApplication : Application() {
+open class OpenEuiccApplication : Application() {
     val telephonyManager by lazy {
         getSystemService(TelephonyManager::class.java)!!
     }
 
-    abstract val euiccChannelManager: BaseEuiccChannelManager
+    open val euiccChannelManager: EuiccChannelManager by lazy {
+        EuiccChannelManager(this)
+    }
 
     val subscriptionManager by lazy {
         getSystemService(SubscriptionManager::class.java)!!

app-common/src/main/java/im/angry/openeuicc/core/EuiccChannelManager.kt

@@ -6,7 +6,7 @@ import android.os.HandlerThread
 import android.se.omapi.SEService
 import android.telephony.UiccCardInfo
 import android.util.Log
-import im.angry.openeuicc.BaseOpenEuiccApplication
+import im.angry.openeuicc.OpenEuiccApplication
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.sync.Mutex
@@ -16,9 +16,9 @@ import java.lang.IllegalArgumentException
 import kotlin.coroutines.resume
 import kotlin.coroutines.suspendCoroutine
 
-abstract class BaseEuiccChannelManager(private val context: Context) {
+open class EuiccChannelManager(protected val context: Context) {
     companion object {
-        const val TAG = "BaseEuiccChannelManager"
+        const val TAG = "EuiccChannelManager"
     }
 
     private val channels = mutableListOf<EuiccChannel>()
@@ -28,7 +28,7 @@ abstract class BaseEuiccChannelManager(private val context: Context) {
     private val lock = Mutex()
 
     protected val tm by lazy {
-        (context.applicationContext as BaseOpenEuiccApplication).telephonyManager
+        (context.applicationContext as OpenEuiccApplication).telephonyManager
     }
 
     private val handler = Handler(HandlerThread("BaseEuiccChannelManager").also { it.start() }.looper)
@@ -48,7 +48,10 @@ abstract class BaseEuiccChannelManager(private val context: Context) {
          }
     }
 
-    abstract fun tryOpenEuiccChannelPrivileged(uiccInfo: UiccCardInfo, channelInfo: EuiccChannelInfo): EuiccChannel?
+    open fun tryOpenEuiccChannelPrivileged(uiccInfo: UiccCardInfo, channelInfo: EuiccChannelInfo): EuiccChannel? {
+        // No-op when unprivileged
+        return null
+    }
 
     private suspend fun tryOpenEuiccChannel(uiccInfo: UiccCardInfo): EuiccChannel? {
         lock.withLock {
@@ -125,4 +128,8 @@ abstract class BaseEuiccChannelManager(private val context: Context) {
         seService?.shutdown()
         seService = null
     }
+
+    open fun notifyEuiccProfilesChanged(slotId: Int) {
+        // No-op for unprivileged
+    }
 }

app-common/src/main/java/im/angry/openeuicc/ui/EuiccChannelFragmentUtils.kt

@@ -2,7 +2,7 @@ package im.angry.openeuicc.ui
 
 import android.os.Bundle
 import androidx.fragment.app.Fragment
-import im.angry.openeuicc.core.BaseEuiccChannelManager
+import im.angry.openeuicc.core.EuiccChannelManager
 import im.angry.openeuicc.core.EuiccChannel
 import im.angry.openeuicc.util.openEuiccApplication
 
@@ -19,7 +19,7 @@ fun <T> newInstanceEuicc(clazz: Class<T>, slotId: Int): T where T: Fragment, T:
 val <T> T.slotId: Int where T: Fragment, T: EuiccFragmentMarker
     get() = requireArguments().getInt("slotId")
 
-val <T> T.euiccChannelManager: BaseEuiccChannelManager where T: Fragment, T: EuiccFragmentMarker
+val <T> T.euiccChannelManager: EuiccChannelManager where T: Fragment, T: EuiccFragmentMarker
     get() = openEuiccApplication.euiccChannelManager
 
 val <T> T.channel: EuiccChannel where T: Fragment, T: EuiccFragmentMarker

app-common/src/main/java/im/angry/openeuicc/ui/EuiccManagementFragment.kt

@@ -82,7 +82,7 @@ class EuiccManagementFragment : Fragment(), EuiccFragmentMarker, EuiccProfilesCh
 
         lifecycleScope.launch {
             val profiles = withContext(Dispatchers.IO) {
-                openEuiccApplication.subscriptionManager.tryRefreshCachedEuiccInfo(channel.cardId)
+                euiccChannelManager.notifyEuiccProfilesChanged(slotId)
                 channel.lpa.profiles
             }
 

app-common/src/main/java/im/angry/openeuicc/ui/MainActivity.kt

@@ -4,27 +4,25 @@ import android.os.Bundle
 import android.telephony.TelephonyManager
 import android.util.Log
 import android.view.Menu
-import android.view.MenuItem
 import android.view.View
 import android.widget.AdapterView
 import android.widget.ArrayAdapter
 import android.widget.Spinner
-import android.widget.Toast
 import androidx.appcompat.app.AppCompatActivity
 import androidx.lifecycle.lifecycleScope
 import im.angry.openeuicc.common.R
-import im.angry.openeuicc.core.BaseEuiccChannelManager
+import im.angry.openeuicc.core.EuiccChannelManager
 import im.angry.openeuicc.util.*
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 
-class MainActivity : AppCompatActivity() {
+open class MainActivity : AppCompatActivity() {
     companion object {
         const val TAG = "MainActivity"
     }
 
-    private lateinit var manager: BaseEuiccChannelManager
+    protected lateinit var manager: EuiccChannelManager
 
     private lateinit var spinnerAdapter: ArrayAdapter<String>
     private lateinit var spinner: Spinner
@@ -33,7 +31,7 @@ class MainActivity : AppCompatActivity() {
 
     private lateinit var noEuiccPlaceholder: View
 
-    private lateinit var tm: TelephonyManager
+    protected lateinit var tm: TelephonyManager
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
@@ -71,32 +69,19 @@ class MainActivity : AppCompatActivity() {
 
         }
 
-        if (tm.supportsDSDS) {
-            val dsds = menu.findItem(R.id.dsds)
-            dsds.isVisible = true
-            dsds.isChecked = tm.dsdsEnabled
-        }
-
         return true
     }
 
-    override fun onOptionsItemSelected(item: MenuItem): Boolean = when (item.itemId) {
-        R.id.dsds -> {
-            tm.dsdsEnabled = !item.isChecked
-            Toast.makeText(this, R.string.toast_dsds_switched, Toast.LENGTH_LONG).show()
-            finish()
-            true
-        }
-        else -> false
-    }
-
     private suspend fun init() {
         withContext(Dispatchers.IO) {
             manager.enumerateEuiccChannels()
             manager.knownChannels.forEach {
                 Log.d(TAG, it.name)
                 Log.d(TAG, it.lpa.eID)
-                openEuiccApplication.subscriptionManager.tryRefreshCachedEuiccInfo(it.cardId)
+                // Request the system to refresh the list of profiles every time we start
+                // Note that this is currently supposed to be no-op when unprivileged,
+                // but it could change in the future
+                manager.notifyEuiccProfilesChanged(it.slotId)
             }
         }
 

app-common/src/main/java/im/angry/openeuicc/util/TelephonyUtils.kt

@@ -1,28 +1,6 @@
 package im.angry.openeuicc.util
 
-import android.telephony.SubscriptionManager
-import android.telephony.TelephonyManager
 import net.typeblog.lpac_jni.LocalProfileInfo
-import java.lang.Exception
-
-val TelephonyManager.supportsDSDS: Boolean
-    get() = supportedModemCount == 2
-
-var TelephonyManager.dsdsEnabled: Boolean
-    get() = activeModemCount >= 2
-    set(value) {
-        switchMultiSimConfig(if (value) { 2 } else {1})
-    }
-
-fun SubscriptionManager.tryRefreshCachedEuiccInfo(cardId: Int) {
-    if (cardId != 0) {
-        try {
-            requestEmbeddedSubscriptionInfoListRefresh(cardId)
-        } catch (e: Exception) {
-            // Ignore
-        }
-    }
-}
 
 val LocalProfileInfo.displayName: String
     get() = nickName.ifEmpty { name }

app-common/src/main/java/im/angry/openeuicc/util/UiUtils.kt

@@ -6,12 +6,12 @@ import android.graphics.Rect
 import android.view.ViewGroup
 import androidx.fragment.app.DialogFragment
 import androidx.fragment.app.Fragment
-import im.angry.openeuicc.BaseOpenEuiccApplication
+import im.angry.openeuicc.OpenEuiccApplication
 
-val Activity.openEuiccApplication: BaseOpenEuiccApplication
+val Activity.openEuiccApplication: OpenEuiccApplication
-    get() = application as BaseOpenEuiccApplication
+    get() = application as OpenEuiccApplication
 
-val Fragment.openEuiccApplication: BaseOpenEuiccApplication
+val Fragment.openEuiccApplication: OpenEuiccApplication
     get() = requireActivity().openEuiccApplication
 
 // Source: <https://stackoverflow.com/questions/12478520/how-to-set-dialogfragments-width-and-height>

app-common/src/main/res/menu/activity_main.xml

@@ -7,11 +7,4 @@
         app:actionViewClass="android.widget.Spinner"
         android:background="?android:attr/colorPrimary"
         app:showAsAction="always" />
-
-    <item
-        android:id="@+id/dsds"
-        android:title="@string/dsds"
-        android:checkable="true"
-        android:visible="false"
-        app:showAsAction="never" />
 </menu>

app-common/src/main/res/values/strings.xml

@@ -1,8 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
-    <string name="no_euicc">No eUICC found on this device.\nOn some devices, you may need to enable dual SIM first in the menu of this app.</string>
+    <string name="no_euicc">No eUICC card on this device is accessible by this app.\nYou may want to try out the privileged OpenEUICC app instead.</string>
-
-    <string name="dsds">Dual SIM</string>
 
     <string name="enabled">Enabled</string>
     <string name="disabled">Disabled</string>
@@ -17,7 +15,6 @@
     <string name="toast_profile_enabled">eSIM profile switched. Please wait for a while when the card is restarting.</string>
     <string name="toast_profile_enable_failed">Cannot switch to new eSIM profile.</string>
     <string name="toast_profile_name_too_long">Nickname cannot be longer than 64 characters</string>
-    <string name="toast_dsds_switched">DSDS state switched. Please wait until the modem restarts.</string>
 
     <string name="profile_download">New eSIM</string>
     <string name="profile_download_server">Server (RSP / SM-DP+)</string>

app/build.gradle

@@ -3,33 +3,7 @@ plugins {
     id 'org.jetbrains.kotlin.android'
 }
 
-def getVersionCode = { ->
+apply from: '../helpers.gradle'
-    try {
-        def stdout = new ByteArrayOutputStream()
-        exec {
-            commandLine 'git', 'rev-list', '--first-parent', '--count', 'master'
-            standardOutput = stdout
-        }
-        return Integer.parseInt(stdout.toString().trim())
-    }
-    catch (ignored) {
-        return -1;
-    }
-}
-
-def getVersionName = { ->
-    try {
-        def stdout = new ByteArrayOutputStream()
-        exec {
-            commandLine 'git', 'describe', '--always', '--tags', '--dirty'
-            standardOutput = stdout
-        }
-        return stdout.toString().trim()
-    }
-    catch (ignored) {
-        return null;
-    }
-}
 
 // Signing config, mainly intended for debug builds
 def keystorePropertiesFile = rootProject.file("keystore.properties");
@@ -43,8 +17,8 @@ android {
         applicationId "im.angry.openeuicc"
         minSdk 30
         targetSdk 31
-        versionCode getVersionCode()
+        versionCode getGitVersionCode()
-        versionName getVersionName()
+        versionName getGitVersionName()
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
@@ -67,7 +41,7 @@ android {
             signingConfig signingConfigs.config
         }
     }
-    applicationVariants.all { variant ->
+    applicationVariants.configureEach { variant ->
         if (variant.name == "debug") {
             variant.outputs.each { o -> o.versionCodeOverride = System.currentTimeSeconds() }
         }

app/src/main/AndroidManifest.xml

@@ -3,6 +3,14 @@
     xmlns:tools="http://schemas.android.com/tools"
     tools:ignore="ProtectedPermissions"
     package="im.angry.openeuicc">
+    <uses-feature
+        android:name="android.hardware.telephony"
+        android:required="true" />
+
+    <uses-permission android:name="android.permission.MODIFY_PHONE_STATE" />
+    <uses-permission android:name="android.permission.READ_PRIVILEGED_PHONE_STATE" />
+    <uses-permission android:name="android.permission.WRITE_EMBEDDED_SUBSCRIPTIONS" />
+    <uses-permission android:name="android.permission.SECURE_ELEMENT_PRIVILEGED_OPERATION" />
 
     <application
         android:name=".PrivilegedOpenEuiccApplication"
@@ -13,7 +21,7 @@
         android:supportsRtl="true"
         android:theme="@style/Theme.OpenEUICC">
         <activity
-            android:name=".ui.MainActivity"
+            android:name=".ui.PrivilegedMainActivity"
             android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />

app/src/main/java/im/angry/openeuicc/PrivilegedOpenEuiccApplication.kt

@@ -1,10 +1,10 @@
 package im.angry.openeuicc
 
-import im.angry.openeuicc.core.BaseEuiccChannelManager
+import im.angry.openeuicc.core.EuiccChannelManager
 import im.angry.openeuicc.core.PrivilegedEuiccChannelManager
 
-class PrivilegedOpenEuiccApplication: BaseOpenEuiccApplication() {
+class PrivilegedOpenEuiccApplication: OpenEuiccApplication() {
-    override val euiccChannelManager: BaseEuiccChannelManager by lazy {
+    override val euiccChannelManager: EuiccChannelManager by lazy {
         PrivilegedEuiccChannelManager(this)
     }
 

app/src/main/java/im/angry/openeuicc/core/PrivilegedEuiccChannelManager.kt

@@ -3,11 +3,12 @@ package im.angry.openeuicc.core
 import android.content.Context
 import android.telephony.UiccCardInfo
 import android.util.Log
+import im.angry.openeuicc.OpenEuiccApplication
 import im.angry.openeuicc.util.*
 import java.lang.Exception
 import java.lang.IllegalArgumentException
 
-class PrivilegedEuiccChannelManager(context: Context): BaseEuiccChannelManager(context) {
+class PrivilegedEuiccChannelManager(context: Context): EuiccChannelManager(context) {
     override fun tryOpenEuiccChannelPrivileged(uiccInfo: UiccCardInfo, channelInfo: EuiccChannelInfo): EuiccChannel? {
         if (uiccInfo.isEuicc && !uiccInfo.isRemovable) {
             Log.d(TAG, "Using TelephonyManager for slot ${uiccInfo.slotIndex}")
@@ -35,4 +36,12 @@ class PrivilegedEuiccChannelManager(context: Context): BaseEuiccChannelManager(c
             }
         }
     }
+
+    override fun notifyEuiccProfilesChanged(slotId: Int) {
+        (context.applicationContext as OpenEuiccApplication).subscriptionManager.apply {
+            findEuiccChannelBySlotBlocking(slotId)?.let {
+                tryRefreshCachedEuiccInfo(it.cardId)
+            }
+        }
+    }
 }

app/src/main/java/im/angry/openeuicc/service/OpenEuiccService.kt

@@ -4,13 +4,13 @@ import android.service.euicc.*
 import android.telephony.euicc.DownloadableSubscription
 import android.telephony.euicc.EuiccInfo
 import net.typeblog.lpac_jni.LocalProfileInfo
-import im.angry.openeuicc.BaseOpenEuiccApplication
+import im.angry.openeuicc.OpenEuiccApplication
 import im.angry.openeuicc.core.EuiccChannel
 import im.angry.openeuicc.util.*
 
 class OpenEuiccService : EuiccService() {
     private val openEuiccApplication
-        get() = application as BaseOpenEuiccApplication
+        get() = application as OpenEuiccApplication
 
     private fun findChannel(slotId: Int): EuiccChannel? =
         openEuiccApplication.euiccChannelManager

app/src/main/java/im/angry/openeuicc/ui/LuiActivity.kt

@@ -6,7 +6,7 @@ import androidx.appcompat.app.AppCompatActivity
 class LuiActivity : AppCompatActivity() {
     override fun onStart() {
         super.onStart()
-        startActivity(Intent(this, MainActivity::class.java))
+        startActivity(Intent(this, PrivilegedMainActivity::class.java))
         finish()
     }
 }

app/src/main/java/im/angry/openeuicc/ui/PrivilegedMainActivity.kt

@@ -0,0 +1,32 @@
+package im.angry.openeuicc.ui
+
+import android.view.Menu
+import android.view.MenuItem
+import android.widget.Toast
+import im.angry.openeuicc.R
+import im.angry.openeuicc.util.*
+
+class PrivilegedMainActivity : MainActivity() {
+    override fun onCreateOptionsMenu(menu: Menu): Boolean {
+        super.onCreateOptionsMenu(menu)
+        menuInflater.inflate(R.menu.activity_main_privileged, menu)
+
+        if (tm.supportsDSDS) {
+            val dsds = menu.findItem(R.id.dsds)
+            dsds.isVisible = true
+            dsds.isChecked = tm.dsdsEnabled
+        }
+
+        return true
+    }
+
+    override fun onOptionsItemSelected(item: MenuItem): Boolean = when (item.itemId) {
+        R.id.dsds -> {
+            tm.dsdsEnabled = !item.isChecked
+            Toast.makeText(this, R.string.toast_dsds_switched, Toast.LENGTH_LONG).show()
+            finish()
+            true
+        }
+        else -> super.onOptionsItemSelected(item)
+    }
+}

app/src/main/java/im/angry/openeuicc/util/PrivilegedTelephonyUtils.kt

@@ -0,0 +1,24 @@
+package im.angry.openeuicc.util
+
+import android.telephony.SubscriptionManager
+import android.telephony.TelephonyManager
+import java.lang.Exception
+
+val TelephonyManager.supportsDSDS: Boolean
+    get() = supportedModemCount == 2
+
+var TelephonyManager.dsdsEnabled: Boolean
+    get() = activeModemCount >= 2
+    set(value) {
+        switchMultiSimConfig(if (value) { 2 } else {1})
+    }
+
+fun SubscriptionManager.tryRefreshCachedEuiccInfo(cardId: Int) {
+    if (cardId != 0) {
+        try {
+            requestEmbeddedSubscriptionInfoListRefresh(cardId)
+        } catch (e: Exception) {
+            // Ignore
+        }
+    }
+}

app/src/main/res/menu/activity_main_privileged.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<menu xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto">
+    <item
+        android:id="@+id/dsds"
+        android:title="@string/dsds"
+        android:checkable="true"
+        android:visible="false"
+        app:showAsAction="never" />
+</menu>

app/src/main/res/values/strings.xml

@@ -1,3 +1,8 @@
 <resources>
     <string name="app_name">OpenEUICC</string>
+    <string name="no_euicc">No eUICC found on this device.\nOn some devices, you may need to enable dual SIM first in the menu of this app.</string>
+
+    <string name="dsds">Dual SIM</string>
+
+    <string name="toast_dsds_switched">DSDS state switched. Please wait until the modem restarts.</string>
 </resources>

helpers.gradle

@@ -0,0 +1,27 @@
+ext.getGitVersionCode = { ->
+    try {
+        def stdout = new ByteArrayOutputStream()
+        exec {
+            commandLine 'git', 'rev-list', '--first-parent', '--count', 'master'
+            standardOutput = stdout
+        }
+        return Integer.parseInt(stdout.toString().trim())
+    }
+    catch (ignored) {
+        return -1;
+    }
+}
+
+ext.getGitVersionName = { ->
+    try {
+        def stdout = new ByteArrayOutputStream()
+        exec {
+            commandLine 'git', 'describe', '--always', '--tags', '--dirty'
+            standardOutput = stdout
+        }
+        return stdout.toString().trim()
+    }
+    catch (ignored) {
+        return null;
+    }
+}