Merge pull request #54 from fgubler/feature/block-calls-from-unknown-numbers

Feature/block calls from unknown numbers

Author: fgubler

app/build.gradle

@@ -33,8 +33,8 @@ android {
         applicationId "ch.abwesend.privatecontacts"
         minSdk 24
         targetSdk 36
-        versionCode 89
-        versionName "5.1.2"
+        versionCode 90
+        versionName "5.2.0"
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
 
@@ -102,9 +102,9 @@ dependencies {
     implementation "org.jetbrains.kotlin:kotlin-reflect:${kotlinVersion}"
 
     // Android Core
-    implementation "androidx.core:core-ktx:1.16.0"
+    implementation "androidx.core:core-ktx:1.17.0"
     implementation "androidx.appcompat:appcompat:1.7.1"
-    implementation "com.google.android.material:material:1.12.0"
+    implementation "com.google.android.material:material:1.13.0"
 
     // Android Lifecycle
     implementation "androidx.lifecycle:lifecycle-runtime-ktx:${androidLifecycleVersion}"
@@ -122,12 +122,12 @@ dependencies {
     implementation "androidx.compose.runtime:runtime:${composeVersion}"
     implementation 'androidx.constraintlayout:constraintlayout:2.2.1'
     debugImplementation "androidx.compose.ui:ui-tooling:${composeVersion}"
-    implementation "androidx.activity:activity-compose:1.10.1"
-    implementation "androidx.navigation:navigation-compose:2.9.0"
+    implementation "androidx.activity:activity-compose:1.11.0"
+    implementation "androidx.navigation:navigation-compose:2.9.6"
     implementation "androidx.constraintlayout:constraintlayout-compose:1.1.1"
 
     // Firebase
-    googlePlayImplementation platform("com.google.firebase:firebase-bom:33.13.0")
+    googlePlayImplementation platform("com.google.firebase:firebase-bom:34.6.0")
     googlePlayImplementation 'com.google.firebase:firebase-crashlytics' // does not need a version because of firebase-bom
     googlePlayImplementation("com.google.firebase:firebase-analytics")
 
@@ -160,7 +160,7 @@ dependencies {
     // ===== Testing =====
     // Unit Tests
     testImplementation "junit:junit:4.13.2"
-    testImplementation "org.assertj:assertj-core:3.21.0"
+    testImplementation "org.assertj:assertj-core:3.27.6"
 
     testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:${coroutinesVersion}"
 
@@ -182,9 +182,9 @@ dependencies {
     testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${junitJupiterVersion}"
 
     // Instrumented Tests
-    androidTestImplementation "org.assertj:assertj-core:3.21.0"
-    androidTestImplementation "androidx.test.ext:junit:1.2.1"
-    androidTestImplementation "androidx.test.espresso:espresso-core:3.6.1"
+    androidTestImplementation "org.assertj:assertj-core:3.27.6"
+    androidTestImplementation "androidx.test.ext:junit:1.3.0"
+    androidTestImplementation "androidx.test.espresso:espresso-core:3.7.0"
     androidTestImplementation "androidx.compose.ui:ui-test-junit4:${composeVersion}"
 
     androidTestImplementation "org.junit.jupiter:junit-jupiter-api:${junitJupiterVersion}"

app/src/main/java/ch/abwesend/privatecontacts/domain/repository/IAndroidContactLoadService.kt

@@ -7,6 +7,7 @@
 package ch.abwesend.privatecontacts.domain.repository
 
 import ch.abwesend.privatecontacts.domain.lib.flow.ResourceFlow
+import ch.abwesend.privatecontacts.domain.model.contact.ContactWithPhoneNumbers
 import ch.abwesend.privatecontacts.domain.model.contact.IContact
 import ch.abwesend.privatecontacts.domain.model.contact.IContactBase
 import ch.abwesend.privatecontacts.domain.model.contact.IContactIdExternal
@@ -19,4 +20,6 @@ interface IAndroidContactLoadService {
     suspend fun resolveContact(contactId: IContactIdExternal): IContact
     suspend fun resolveContacts(contactIds: Set<IContactIdExternal>): List<IContact>
     suspend fun getAllContactGroups(): List<ContactGroup>
+
+    suspend fun findContactsWithPhoneNumber(phoneNumber: String): List<ContactWithPhoneNumbers>
 }

app/src/main/java/ch/abwesend/privatecontacts/domain/service/IncomingCallService.kt

@@ -8,6 +8,7 @@ package ch.abwesend.privatecontacts.domain.service
 
 import ch.abwesend.privatecontacts.domain.lib.logging.logger
 import ch.abwesend.privatecontacts.domain.model.contact.ContactWithPhoneNumbers
+import ch.abwesend.privatecontacts.domain.repository.IAndroidContactLoadService
 import ch.abwesend.privatecontacts.domain.repository.IContactRepository
 import ch.abwesend.privatecontacts.domain.service.interfaces.TelephoneService
 import ch.abwesend.privatecontacts.domain.util.injectAnywhere
@@ -18,14 +19,23 @@ private const val CONSIDER_MATCHING_CONTACTS = 5 // showing more does not make m
 class IncomingCallService {
     private val contactRepository: IContactRepository by injectAnywhere()
     private val telephoneService: TelephoneService by injectAnywhere()
+    private val androidContactLoadService: IAndroidContactLoadService by injectAnywhere()
 
     /**
      * Load contacts corresponding to the given [phoneNumber].
      * Could be several (multiple contacts living together have the same number...)
      */
-    suspend fun findCorrespondingContacts(phoneNumber: String): List<ContactWithPhoneNumbers> {
+    suspend fun findCorrespondingContacts(
+        phoneNumber: String,
+        considerPublicContacts: Boolean = false,
+    ): List<ContactWithPhoneNumbers> {
         val ending = phoneNumber.takeLast(CONSIDER_LAST_DIGITS)
-        val contactCandidates = contactRepository.findContactsWithNumberEndingOn(ending)
+        val secretContactCandidates = contactRepository.findContactsWithNumberEndingOn(ending)
+
+        val contactCandidates = if (considerPublicContacts) {
+            val publicContactCandidates = androidContactLoadService.findContactsWithPhoneNumber(phoneNumber)
+            secretContactCandidates + publicContactCandidates
+        } else secretContactCandidates
 
         logger.debug("Found ${contactCandidates.size} candidate(s) for calling phone-number")
 

app/src/main/java/ch/abwesend/privatecontacts/domain/settings/SettingsRepository.kt

@@ -43,6 +43,7 @@ interface SettingsRepository : ISettingsState {
     override var observeIncomingCalls: Boolean
     override var requestIncomingCallPermissions: Boolean // invisible
     override var showIncomingCallsOnLockScreen: Boolean
+    override var blockIncomingCallsFromUnknownNumbers: Boolean
 
     // Android Contacts
     override var showAndroidContacts: Boolean

app/src/main/java/ch/abwesend/privatecontacts/domain/settings/SettingsState.kt

@@ -56,6 +56,12 @@ interface ISettingsState {
      */
     val showIncomingCallsOnLockScreen: Boolean
 
+    /**
+     * Whether to block incoming calls from unknown numbers.
+     * Depends on [observeIncomingCalls]
+     */
+    val blockIncomingCallsFromUnknownNumbers: Boolean
+
     // Android Contacts
     val showAndroidContacts: Boolean
     val showThirdPartyContactAccounts: Boolean
@@ -97,6 +103,7 @@ data class SettingsState(
     override val requestIncomingCallPermissions: Boolean,
     override val observeIncomingCalls: Boolean,
     override val showIncomingCallsOnLockScreen: Boolean,
+    override val blockIncomingCallsFromUnknownNumbers: Boolean,
 
     override val showAndroidContacts: Boolean,
     override val showThirdPartyContactAccounts: Boolean,
@@ -126,6 +133,7 @@ data class SettingsState(
             secondTabMode = SecondTabMode.ALL_CONTACTS,
             requestIncomingCallPermissions = true,
             observeIncomingCalls = true,
+            blockIncomingCallsFromUnknownNumbers = false,
             showAndroidContacts = true,
             showThirdPartyContactAccounts = false,
             authenticationRequired = false,

app/src/main/java/ch/abwesend/privatecontacts/infrastructure/calldetection/CallerIdentificationService.kt

@@ -6,30 +6,71 @@
 
 package ch.abwesend.privatecontacts.infrastructure.calldetection
 
+import android.content.Context
 import android.os.Build
-import android.telecom.Call
+import android.telecom.Call.Details
 import android.telecom.CallScreeningService
+import ch.abwesend.privatecontacts.domain.lib.logging.debugLocally
 import ch.abwesend.privatecontacts.domain.lib.logging.logger
+import ch.abwesend.privatecontacts.domain.settings.Settings
+import ch.abwesend.privatecontacts.domain.util.applicationScope
 import ch.abwesend.privatecontacts.domain.util.injectAnywhere
+import kotlinx.coroutines.launch
 
 class CallerIdentificationService : CallScreeningService() {
     private val incomingCallHelper: IncomingCallHelper by injectAnywhere()
+    private val context: Context = this
 
-    override fun onScreenCall(callDetails: Call.Details) {
+    override fun onScreenCall(callDetails: Details) {
         logger.debug("Receiving incoming call")
-        val response = CallResponse.Builder().build() // we don't want to interfere with anything here...
-        respondToCall(callDetails, response)
 
         if (shouldHandleCall(callDetails)) {
-            val number: String? = callDetails.handle?.schemeSpecificPart
-            logger.debug("Incoming call from number '$number'")
-            number?.let { incomingCallHelper.handleIncomingCall(baseContext, it) }
-        } else logger.debug("Ignored not-incoming call")
+            handleIncomingCall(callDetails)
+        } else {
+            logger.debug("Ignored not-incoming call")
+        }
     }
 
-    private fun shouldHandleCall(callDetails: Call.Details): Boolean {
+    private fun shouldHandleCall(callDetails: Details): Boolean {
         return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
-            callDetails.callDirection == Call.Details.DIRECTION_INCOMING
+            callDetails.callDirection == Details.DIRECTION_INCOMING
         } else true
     }
+
+    private fun handleIncomingCall(callDetails: Details) = applicationScope.launch {
+        val phoneNumber: String? = callDetails.handle?.schemeSpecificPart
+        logger.debug("Incoming call from number '$phoneNumber'")
+
+        val blockCallsFromUnknownNumbers = Settings.nextOrDefault().blockIncomingCallsFromUnknownNumbers
+        val shouldBlockCall = phoneNumber != null &&
+                blockCallsFromUnknownNumbers &&
+                !incomingCallHelper.matchesAnyKnownContact(phoneNumber)
+
+        if (shouldBlockCall) {
+            blockCall(callDetails, phoneNumber)
+        } else {
+            val response = CallResponse.Builder().build() // we don't want to interfere with anything here...
+            respondToCall(callDetails, response)
+            phoneNumber?.let { incomingCallHelper.handleIncomingCall(baseContext, it) }
+        }
+    }
+
+    private fun blockCall(callDetails: Details, phoneNumber: String?) {
+        logger.info("Blocking incoming call from unknown number")
+        logger.debugLocally("Blocking call with number $phoneNumber")
+
+        val responseBuilder = CallResponse.Builder()
+            .setDisallowCall(true)
+            .setRejectCall(true)
+            .setSkipNotification(true)
+
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+            responseBuilder.setSilenceCall(true)
+        }
+
+        respondToCall(callDetails, responseBuilder.build())
+        phoneNumber?.let {
+            incomingCallHelper.handleBlockedCall(context, phoneNumber)
+        }
+    }
 }

app/src/main/java/ch/abwesend/privatecontacts/infrastructure/calldetection/IncomingCallHelper.kt

@@ -8,6 +8,7 @@ package ch.abwesend.privatecontacts.infrastructure.calldetection
 
 import android.content.Context
 import ch.abwesend.privatecontacts.R
+import ch.abwesend.privatecontacts.domain.lib.logging.debugLocally
 import ch.abwesend.privatecontacts.domain.lib.logging.logger
 import ch.abwesend.privatecontacts.domain.service.IncomingCallService
 import ch.abwesend.privatecontacts.domain.service.interfaces.TelephoneService
@@ -22,25 +23,32 @@ class IncomingCallHelper {
     private val notificationRepository: CallNotificationRepository by injectAnywhere()
     private val toastRepository: ToastRepository by injectAnywhere()
 
-    fun handleIncomingCall(
+    suspend fun matchesAnyKnownContact(phoneNumber: String): Boolean {
+        val matchingContacts = incomingCallService.findCorrespondingContacts(
+            phoneNumber = phoneNumber,
+            considerPublicContacts = true,
+        )
+        logger.debug("Found ${matchingContacts.size} matching contacts")
+        return matchingContacts.isNotEmpty()
+    }
+
+    suspend fun handleIncomingCall(
         context: Context,
         phoneNumber: String,
     ) {
-        applicationScope.launch {
-            val correspondingContacts = incomingCallService
-                .findCorrespondingContacts(phoneNumber)
-                .map { it.displayName }
-                .distinct()
+        val correspondingContacts = incomingCallService
+            .findCorrespondingContacts(phoneNumber)
+            .map { it.displayName }
+            .distinct()
 
-            logger.debug("Found corresponding contacts: $correspondingContacts")
-            val formattedNumber = telephoneService.formatPhoneNumberForDisplay(phoneNumber)
-            val notificationText = createNotificationText(context, formattedNumber, correspondingContacts)
+        logger.debug("Found corresponding contacts: $correspondingContacts")
+        val formattedNumber = telephoneService.formatPhoneNumberForDisplay(phoneNumber)
+        val notificationText = createNotificationText(context, formattedNumber, correspondingContacts)
 
-            notificationText?.let { text ->
-                notificationRepository.showIncomingCallNotification(context, text)
-                toastRepository.showToastNotification(context, text)
-            } ?: logger.debug("No notification text: don't show notification")
-        }
+        notificationText?.let { text ->
+            notificationRepository.showIncomingCallNotification(context, text)
+            toastRepository.showToastNotification(context, text)
+        } ?: logger.debug("No notification text: don't show notification")
     }
 
     private fun createNotificationText(
@@ -63,4 +71,17 @@ class IncomingCallHelper {
                 callerNumber,
             )
         }
+
+    fun handleBlockedCall(
+        context: Context,
+        phoneNumber: String,
+    ) {
+        applicationScope.launch {
+            val formattedNumber = telephoneService.formatPhoneNumberForDisplay(phoneNumber)
+            val notificationText = context.getString(R.string.blocked_call_notification_text, formattedNumber)
+
+            logger.debugLocally("Showing notification for blocked call from $formattedNumber")
+            notificationRepository.showIncomingCallNotification(context, notificationText)
+        }
+    }
 }

app/src/main/java/ch/abwesend/privatecontacts/infrastructure/calldetection/PhoneStateReceiver.kt

@@ -13,8 +13,10 @@ import android.telecom.CallScreeningService
 import android.telephony.TelephonyManager
 import ch.abwesend.privatecontacts.domain.lib.logging.logger
 import ch.abwesend.privatecontacts.domain.settings.SettingsRepository
+import ch.abwesend.privatecontacts.domain.util.applicationScope
 import ch.abwesend.privatecontacts.domain.util.canReadCallingNumberFromPhoneState
 import ch.abwesend.privatecontacts.domain.util.injectAnywhere
+import kotlinx.coroutines.launch
 
 /**
  * Handle an incoming call via broadcast-receiver.
@@ -58,7 +60,11 @@ class PhoneStateReceiver : BroadcastReceiver() {
         if (canReadCallingNumberFromPhoneState) {
             val incomingNumber = intent.getStringExtra(TelephonyManager.EXTRA_INCOMING_NUMBER)
             logger.debug("Receiving a call from $incomingNumber")
-            incomingNumber?.let { incomingCallHelper.handleIncomingCall(context, it) }
+            incomingNumber?.let {
+                applicationScope.launch {
+                    incomingCallHelper.handleIncomingCall(context, it)
+                }
+            }
         }
     }
 

app/src/main/java/ch/abwesend/privatecontacts/infrastructure/repository/androidcontacts/mapping/AndroidContactDataMapper.kt

@@ -42,6 +42,9 @@ class AndroidContactDataMapper {
             getCompanies()
     }
 
+    fun getContactPhoneNumbers(contact: Contact): List<PhoneNumber> =
+        contact.getPhoneNumbers()
+
     private fun Contact.getPhoneNumbers(): List<PhoneNumber> =
         phones.mapIndexed { index, phone ->
             val contactDataId = phone.toContactDataId()

app/src/main/java/ch/abwesend/privatecontacts/infrastructure/repository/androidcontacts/mapping/AndroidContactMapper.kt

@@ -6,12 +6,14 @@ import ch.abwesend.privatecontacts.domain.model.contact.ContactBase
 import ch.abwesend.privatecontacts.domain.model.contact.ContactEditable
 import ch.abwesend.privatecontacts.domain.model.contact.ContactIdAndroid
 import ch.abwesend.privatecontacts.domain.model.contact.ContactType
+import ch.abwesend.privatecontacts.domain.model.contact.ContactWithPhoneNumbers
 import ch.abwesend.privatecontacts.domain.model.contact.IContact
 import ch.abwesend.privatecontacts.domain.model.contact.IContactBase
 import ch.abwesend.privatecontacts.domain.model.contact.IContactEditable
 import ch.abwesend.privatecontacts.domain.model.contactdata.Company
 import ch.abwesend.privatecontacts.domain.model.contactdata.ContactDataCategory
 import ch.abwesend.privatecontacts.domain.model.contactdata.ContactDataType
+import ch.abwesend.privatecontacts.domain.model.contactdata.PhoneNumberValue
 import ch.abwesend.privatecontacts.domain.util.injectAnywhere
 import com.alexstyl.contactstore.Contact
 import com.alexstyl.contactstore.ContactGroup
@@ -32,6 +34,18 @@ class AndroidContactMapper {
             else null
         }
 
+    fun toContactWithPhoneNumbers(contact: Contact, rethrowExceptions: Boolean): ContactWithPhoneNumbers? =
+        try {
+            val contactBase = toContactBase(contact = contact, rethrowExceptions = rethrowExceptions)
+            val phoneNumbers = contactDataFactory.getContactPhoneNumbers(contact)
+                .map { PhoneNumberValue(it.value) }
+            contactBase?.let { ContactWithPhoneNumbers(contactBase, phoneNumbers) }
+        } catch(t: Throwable) {
+            logger.warning("Failed to map android contact with id = ${contact.contactId}", t)
+            if (rethrowExceptions) throw t
+            else null
+        }
+
     fun toContact(
         contact: Contact,
         groups: List<ContactGroup>,