Make autofill-parser API explicit and refactor (#1182)

(cherry picked from commit 73648b3)

Author: FabianHenneke

app/src/main/java/com/zeapo/pwdstore/autofill/oreo/AutofillResponseBuilder.kt

@@ -37,8 +37,7 @@ class AutofillResponseBuilder(form: FillableForm) {
     private val clientState = form.toClientState()
 
     // We do not offer save when the only relevant field is a username field or there is no field.
-    private val scenarioSupportsSave =
-        scenario.fieldsToSave.minus(listOfNotNull(scenario.username)).isNotEmpty()
+    private val scenarioSupportsSave = scenario.hasPasswordFieldsToSave
     private val canBeSaved = saveFlags != null && scenarioSupportsSave
 
     private fun makePlaceholderDataset(
@@ -54,29 +53,29 @@ class AutofillResponseBuilder(form: FillableForm) {
     }
 
     private fun makeMatchDataset(context: Context, file: File): Dataset? {
-        if (scenario.fieldsToFillOn(AutofillAction.Match).isEmpty()) return null
+        if (scenario.hasFieldsToFillOn(AutofillAction.Match)) return null
         val remoteView = makeFillMatchRemoteView(context, file, formOrigin)
         val intentSender = AutofillDecryptActivity.makeDecryptFileIntentSender(file, context)
         return makePlaceholderDataset(remoteView, intentSender, AutofillAction.Match)
     }
 
     private fun makeSearchDataset(context: Context): Dataset? {
-        if (scenario.fieldsToFillOn(AutofillAction.Search).isEmpty()) return null
+        if (scenario.hasFieldsToFillOn(AutofillAction.Search)) return null
         val remoteView = makeSearchAndFillRemoteView(context, formOrigin)
         val intentSender =
             AutofillFilterView.makeMatchAndDecryptFileIntentSender(context, formOrigin)
         return makePlaceholderDataset(remoteView, intentSender, AutofillAction.Search)
     }
 
     private fun makeGenerateDataset(context: Context): Dataset? {
-        if (scenario.fieldsToFillOn(AutofillAction.Generate).isEmpty()) return null
+        if (scenario.hasFieldsToFillOn(AutofillAction.Generate)) return null
         val remoteView = makeGenerateAndFillRemoteView(context, formOrigin)
         val intentSender = AutofillSaveActivity.makeSaveIntentSender(context, null, formOrigin)
         return makePlaceholderDataset(remoteView, intentSender, AutofillAction.Generate)
     }
 
     private fun makeFillOtpFromSmsDataset(context: Context): Dataset? {
-        if (scenario.fieldsToFillOn(AutofillAction.FillOtpFromSms).isEmpty()) return null
+        if (scenario.hasFieldsToFillOn(AutofillAction.FillOtpFromSms)) return null
         if (!AutofillSmsActivity.shouldOfferFillFromSms(context)) return null
         val remoteView = makeFillOtpFromSmsRemoteView(context, formOrigin)
         val intentSender = AutofillSmsActivity.makeFillOtpFromSmsIntentSender(context)
@@ -115,10 +114,10 @@ class AutofillResponseBuilder(form: FillableForm) {
     private fun makeSaveInfo(): SaveInfo? {
         if (!canBeSaved) return null
         check(saveFlags != null)
-        val idsToSave = scenario.fieldsToSave.map { it.autofillId }.toTypedArray()
+        val idsToSave = scenario.fieldsToSave.toTypedArray()
         if (idsToSave.isEmpty()) return null
         var saveDataTypes = SaveInfo.SAVE_DATA_TYPE_PASSWORD
-        if (scenario.username != null) {
+        if (scenario.hasUsername) {
             saveDataTypes = saveDataTypes or SaveInfo.SAVE_DATA_TYPE_USERNAME
         }
         return SaveInfo.Builder(saveDataTypes, idsToSave).run {
@@ -179,7 +178,7 @@ class AutofillResponseBuilder(form: FillableForm) {
             action: AutofillAction
         ): Dataset {
             val remoteView = makePlaceholderRemoteView(context)
-            val scenario = AutofillScenario.fromBundle(clientState)
+            val scenario = AutofillScenario.fromClientState(clientState)
             // Before Android P, Datasets used for fill-in had to come with a RemoteViews, even
             // though they are never shown.
             val builder = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {

app/src/main/java/com/zeapo/pwdstore/autofill/oreo/OreoAutofillService.kt

@@ -102,7 +102,7 @@ class OreoAutofillService : AutofillService() {
             callback.onFailure(getString(R.string.oreo_autofill_save_internal_error))
             return
         }
-        val scenario = AutofillScenario.fromBundle(clientState)?.recoverNodes(structure) ?: run {
+        val scenario = AutofillScenario.fromClientState(clientState)?.recoverNodes(structure) ?: run {
             e { "Failed to recover client state or nodes from client state" }
             callback.onFailure(getString(R.string.oreo_autofill_save_internal_error))
             return

autofill-parser/api/autofill-parser.api

@@ -21,10 +21,20 @@ fun getCredential(type: String): String {
 
 android {
     defaultConfig {
-        versionCode = 1
-        versionName = "1.0"
+        versionCode = 2
+        versionName = "2.0"
         consumerProguardFiles("consumer-rules.pro")
     }
+
+    kotlin {
+        explicitApi()
+    }
+
+    kotlinOptions {
+        freeCompilerArgs = freeCompilerArgs + listOf(
+            "-Xexplicit-api=strict"
+        )
+    }
 }
 
 afterEvaluate {

autofill-parser/build.gradle.kts

@@ -17,17 +17,17 @@ import com.github.ajalt.timberkt.d
 /**
  * A unique identifier for either an Android app (package name) or a website (origin minus port).
  */
-sealed class FormOrigin(open val identifier: String) {
+public sealed class FormOrigin(public open val identifier: String) {
 
-    data class Web(override val identifier: String) : FormOrigin(identifier)
-    data class App(override val identifier: String) : FormOrigin(identifier)
+    public data class Web(override val identifier: String) : FormOrigin(identifier)
+    public data class App(override val identifier: String) : FormOrigin(identifier)
 
-    companion object {
+    public companion object {
 
         private const val BUNDLE_KEY_WEB_IDENTIFIER = "webIdentifier"
         private const val BUNDLE_KEY_APP_IDENTIFIER = "appIdentifier"
 
-        fun fromBundle(bundle: Bundle): FormOrigin? {
+        public fun fromBundle(bundle: Bundle): FormOrigin? {
             val webIdentifier = bundle.getString(BUNDLE_KEY_WEB_IDENTIFIER)
             if (webIdentifier != null) {
                 return Web(webIdentifier)
@@ -37,18 +37,19 @@ sealed class FormOrigin(open val identifier: String) {
         }
     }
 
-    fun getPrettyIdentifier(context: Context, untrusted: Boolean = true) = when (this) {
-        is Web -> identifier
-        is App -> {
-            val info = context.packageManager.getApplicationInfo(
-                identifier, PackageManager.GET_META_DATA
-            )
-            val label = context.packageManager.getApplicationLabel(info)
-            if (untrusted) "“$label”" else "$label"
+    public fun getPrettyIdentifier(context: Context, untrusted: Boolean = true): String =
+        when (this) {
+            is Web -> identifier
+            is App -> {
+                val info = context.packageManager.getApplicationInfo(
+                    identifier, PackageManager.GET_META_DATA
+                )
+                val label = context.packageManager.getApplicationLabel(info)
+                if (untrusted) "“$label”" else "$label"
+            }
         }
-    }
 
-    fun toBundle() = Bundle().apply {
+    public fun toBundle(): Bundle = Bundle().apply {
         when (this@FormOrigin) {
             is Web -> putString(BUNDLE_KEY_WEB_IDENTIFIER, identifier)
             is App -> putString(BUNDLE_KEY_APP_IDENTIFIER, identifier)
@@ -183,36 +184,36 @@ private class AutofillFormParser(
     }
 }
 
-data class Credentials(val username: String?, val password: String?, val otp: String?)
+public data class Credentials(val username: String?, val password: String?, val otp: String?)
 
 /**
  * Represents a collection of fields in a specific app that can be filled or saved. This is the
  * entry point to all fill and save features.
  */
 @RequiresApi(Build.VERSION_CODES.O)
-class FillableForm private constructor(
-    val formOrigin: FormOrigin,
-    val scenario: AutofillScenario<FormField>,
-    val ignoredIds: List<AutofillId>,
-    val saveFlags: Int?
+public class FillableForm private constructor(
+    public val formOrigin: FormOrigin,
+    public val scenario: AutofillScenario<AutofillId>,
+    public val ignoredIds: List<AutofillId>,
+    public val saveFlags: Int?
 ) {
-    companion object {
+    public companion object {
         /**
          * Returns a [FillableForm] if a login form could be detected in [structure].
          */
-        fun parseAssistStructure(
+        public fun parseAssistStructure(
             context: Context,
             structure: AssistStructure,
             isManualRequest: Boolean,
             customSuffixes: Sequence<String> = emptySequence(),
         ): FillableForm? {
             val form = AutofillFormParser(context, structure, isManualRequest, customSuffixes)
             if (form.formOrigin == null || form.scenario == null) return null
-            return FillableForm(form.formOrigin, form.scenario, form.ignoredIds, form.saveFlags)
+            return FillableForm(form.formOrigin, form.scenario.map { it.autofillId }, form.ignoredIds, form.saveFlags)
         }
     }
 
-    fun toClientState() = scenario.toBundle().apply {
+    public fun toClientState(): Bundle = scenario.toBundle().apply {
         putAll(formOrigin.toBundle())
     }
 }

autofill-parser/src/main/java/com/github/androidpasswordstore/autofillparser/AutofillFormParser.kt

@@ -42,7 +42,7 @@ private fun stableHash(array: Collection<ByteArray>): String {
  * In most cases apps will only have a single certificate. If there are multiple, this functions
  * returns all of them in sorted order and separated with `;`.
  */
-fun computeCertificatesHash(context: Context, appPackage: String): String {
+public fun computeCertificatesHash(context: Context, appPackage: String): String {
     // The warning does not apply since 1) we are specifically hashing **all** signatures and 2) it
     // no longer applies to Android 4.4+.
     // Even though there is a new way to get the certificates as of Android Pie, we need to keep
@@ -68,18 +68,18 @@ fun computeCertificatesHash(context: Context, appPackage: String): String {
  * Returns the "origin" (without port information) of the [AssistStructure.ViewNode] derived from
  * its `webDomain` and `webScheme`, if available.
  */
-val AssistStructure.ViewNode.webOrigin: String?
+internal val AssistStructure.ViewNode.webOrigin: String?
     @RequiresApi(Build.VERSION_CODES.O) get() = webDomain?.let { domain ->
         val scheme = (if (Build.VERSION.SDK_INT >= 28) webScheme else null) ?: "https"
         "$scheme://$domain"
     }
 
 @RequiresApi(Build.VERSION_CODES.O)
-class FixedSaveCallback(context: Context, private val callback: SaveCallback) {
+public class FixedSaveCallback(context: Context, private val callback: SaveCallback) {
 
     private val applicationContext = context.applicationContext
 
-    fun onFailure(message: CharSequence) {
+    public fun onFailure(message: CharSequence) {
         callback.onFailure(message)
         // When targeting SDK 29, the message is no longer shown as a toast.
         // See https://developer.android.com/reference/android/service/autofill/SaveCallback#onFailure(java.lang.CharSequence)
@@ -88,7 +88,7 @@ class FixedSaveCallback(context: Context, private val callback: SaveCallback) {
         }
     }
 
-    fun onSuccess(intentSender: IntentSender) {
+    public fun onSuccess(intentSender: IntentSender) {
         if (Build.VERSION.SDK_INT >= 28) {
             callback.onSuccess(intentSender)
         } else {
@@ -117,7 +117,7 @@ private fun visitViewNode(
 }
 
 @RequiresApi(Build.VERSION_CODES.O)
-fun AssistStructure.findNodeByAutofillId(autofillId: AutofillId): AssistStructure.ViewNode? {
+internal fun AssistStructure.findNodeByAutofillId(autofillId: AutofillId): AssistStructure.ViewNode? {
     var node: AssistStructure.ViewNode? = null
     visitViewNodes(this) {
         if (it.autofillId == autofillId)