PhoneNumber: Do not allow empty strings

Otherwise, performing a contact lookup will fail with an obscure error due to a missing path component in the lookup URI. Fixes: #455 Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
chenxiaolong · Mar 3, 2024 · b8afb56 · b8afb56
1 parent 5c924c7
commit b8afb56
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 10 deletions.
diff --git a/app/src/main/java/com/chiller3/bcr/Contact.kt b/app/src/main/java/com/chiller3/bcr/Contact.kt
@@ -5,6 +5,7 @@ import android.content.Context
 import android.net.Uri
 import android.provider.ContactsContract
 import androidx.annotation.RequiresPermission
+import com.chiller3.bcr.output.PhoneNumber
 
 private val PROJECTION = arrayOf(
     ContactsContract.PhoneLookup.LOOKUP_KEY,
@@ -17,12 +18,14 @@ data class ContactInfo(
 )
 
 @RequiresPermission(Manifest.permission.READ_CONTACTS)
-fun findContactsByPhoneNumber(context: Context, number: String): Iterator<ContactInfo> {
+fun findContactsByPhoneNumber(context: Context, number: PhoneNumber): Iterator<ContactInfo> {
+    val rawNumber = number.toString()
+
     // Same heuristic as InCallUI's PhoneNumberHelper.isUriNumber()
-    val numberIsSip = number.contains("@") || number.contains("%40")
+    val numberIsSip = rawNumber.contains("@") || rawNumber.contains("%40")
 
     val uri = ContactsContract.PhoneLookup.ENTERPRISE_CONTENT_FILTER_URI.buildUpon()
-        .appendPath(number)
+        .appendPath(rawNumber)
         .appendQueryParameter(
             ContactsContract.PhoneLookup.QUERY_PARAMETER_SIP_ADDRESS,
             numberIsSip.toString())

diff --git a/app/src/main/java/com/chiller3/bcr/RecorderThread.kt b/app/src/main/java/com/chiller3/bcr/RecorderThread.kt
@@ -29,6 +29,7 @@ import com.chiller3.bcr.output.OutputDirUtils
 import com.chiller3.bcr.output.OutputFile
 import com.chiller3.bcr.output.OutputFilenameGenerator
 import com.chiller3.bcr.output.OutputPath
+import com.chiller3.bcr.output.PhoneNumber
 import com.chiller3.bcr.output.Retention
 import com.chiller3.bcr.rule.RecordRule
 import org.json.JSONObject
@@ -153,14 +154,14 @@ class RecorderThread(
             return
         }
 
-        val numbers = hashSetOf<String>()
+        val numbers = hashSetOf<PhoneNumber>()
 
         if (parentCall.details.hasProperty(Call.Details.PROPERTY_CONFERENCE)) {
             for (childCall in parentCall.children) {
-                childCall.details?.phoneNumber?.let { numbers.add(it.toString()) }
+                childCall.details?.phoneNumber?.let { numbers.add(it) }
             }
         } else {
-            parentCall.details?.phoneNumber?.let { numbers.add(it.toString()) }
+            parentCall.details?.phoneNumber?.let { numbers.add(it) }
         }
 
         Log.i(tag, "Evaluating record rules for ${numbers.size} phone number(s)")

diff --git a/app/src/main/java/com/chiller3/bcr/extension/CallDetailsExtensions.kt b/app/src/main/java/com/chiller3/bcr/extension/CallDetailsExtensions.kt
@@ -4,4 +4,10 @@ import android.telecom.Call
 import com.chiller3.bcr.output.PhoneNumber
 
 val Call.Details.phoneNumber: PhoneNumber?
-    get() = handle?.phoneNumber?.let { PhoneNumber(it) }
+    get() = handle?.phoneNumber?.let {
+        try {
+            PhoneNumber(it)
+        } catch (e: IllegalArgumentException) {
+            null
+        }
+    }
diff --git a/app/src/main/java/com/chiller3/bcr/output/CallMetadataCollector.kt b/app/src/main/java/com/chiller3/bcr/output/CallMetadataCollector.kt
@@ -55,7 +55,7 @@ class CallMetadataCollector(
 
         Log.d(TAG, "Performing manual contact lookup")
 
-        for (contact in findContactsByPhoneNumber(context, number.toString())) {
+        for (contact in findContactsByPhoneNumber(context, number)) {
             Log.d(TAG, "Found contact display name via manual lookup")
             return contact.displayName
         }
@@ -144,7 +144,12 @@ class CallMetadataCollector(
                         if (index != -1) {
                             number = cursor.getStringOrNull(index)?.let {
                                 Log.d(TAG, "${prefix}Found call log phone number")
-                                PhoneNumber(it)
+                                try {
+                                    PhoneNumber(it)
+                                } catch (e: IllegalArgumentException) {
+                                    Log.w(TAG, "${prefix}Invalid call log phone number", e)
+                                    null
+                                }
                             }
                         } else {
                             Log.d(TAG, "${prefix}Call log entry has no phone number")

diff --git a/app/src/main/java/com/chiller3/bcr/output/PhoneNumber.kt b/app/src/main/java/com/chiller3/bcr/output/PhoneNumber.kt
@@ -7,6 +7,10 @@ import android.util.Log
 import java.util.Locale
 
 data class PhoneNumber(private val number: String) {
+    init {
+        require(number.isNotEmpty()) { "Number cannot be empty" }
+    }
+
     fun format(context: Context, format: Format) = when (format) {
         Format.DIGITS_ONLY -> number.filter { Character.digit(it, 10) != -1 }
         Format.COUNTRY_SPECIFIC -> {

diff --git a/app/src/main/java/com/chiller3/bcr/rule/RecordRule.kt b/app/src/main/java/com/chiller3/bcr/rule/RecordRule.kt
@@ -6,6 +6,7 @@ import android.content.SharedPreferences
 import android.content.pm.PackageManager
 import android.util.Log
 import com.chiller3.bcr.findContactsByPhoneNumber
+import com.chiller3.bcr.output.PhoneNumber
 
 sealed class RecordRule {
     abstract val record: Boolean
@@ -105,7 +106,7 @@ sealed class RecordRule {
          * @throws IllegalArgumentException if [rules] does not contain [AllCalls]
          */
         fun evaluate(context: Context, rules: List<RecordRule>,
-                     numbers: Collection<String>): Boolean {
+                     numbers: Collection<PhoneNumber>): Boolean {
             val contactsAllowed = context.checkSelfPermission(Manifest.permission.READ_CONTACTS) ==
                     PackageManager.PERMISSION_GRANTED
             val contactLookupKeys = if (contactsAllowed) {