Merge pull request #3448 from p1gp1g/unifiedpush

Unifiedpush
element-hq · Jun 1, 2022 · a8d5040 · a8d5040
2 parents d694ea1 + 8b46a22
commit a8d5040
Show file tree

Hide file tree

Showing 28 changed files with 916 additions and 93 deletions.
diff --git a/changelog.d/3448.feature b/changelog.d/3448.feature
@@ -0,0 +1 @@
+Use UnifiedPush and allows user to have push without FCM.
diff --git a/dependencies.gradle b/dependencies.gradle
@@ -40,6 +40,7 @@ ext.libs = [
 
         ],
         jetbrains   : [
+                'kotlinReflect'           : "org.jetbrains.kotlin:kotlin-reflect:$kotlin",
                 'coroutinesCore'          : "org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlinCoroutines",
                 'coroutinesAndroid'       : "org.jetbrains.kotlinx:kotlinx-coroutines-android:$kotlinCoroutines",
                 'coroutinesTest'          : "org.jetbrains.kotlinx:kotlinx-coroutines-test:$kotlinCoroutines"
@@ -82,6 +83,7 @@ ext.libs = [
         ],
         squareup    : [
                 'moshi'                  : "com.squareup.moshi:moshi-adapters:$moshi",
+                'moshiKt'                : "com.squareup.moshi:moshi-kotlin:$moshi",
                 'moshiKotlin'            : "com.squareup.moshi:moshi-kotlin-codegen:$moshi",
                 'retrofit'               : "com.squareup.retrofit2:retrofit:$retrofit",
                 'retrofitMoshi'          : "com.squareup.retrofit2:converter-moshi:$retrofit"

diff --git a/dependencies_groups.gradle b/dependencies_groups.gradle
@@ -12,6 +12,7 @@ ext.groups = [
                         'com.github.vector-im',
                         'com.github.yalantis',
                         'com.github.Zhuinden',
+                        'com.github.UnifiedPush',
                 ]
         ],
         jitsi       : [

diff --git a/vector-config/src/main/res/values/config.xml b/vector-config/src/main/res/values/config.xml
@@ -17,7 +17,11 @@
      -->
 
     <!-- Note: pusher_http_url should have path '/_matrix/push/v1/notify' -->
+    <!-- It is the push gateway for FCM embedded distributor -->
     <string name="pusher_http_url" translatable="false">https://matrix.org/_matrix/push/v1/notify</string>
+    <!-- Note: default_push_gateway_http_url should have path '/_matrix/push/v1/notify' -->
+    <!-- It is the push gateway for UnifiedPush -->
+    <string name="default_push_gateway_http_url" translatable="false">https://matrix.gateway.unifiedpush.org/_matrix/push/v1/notify</string>
     <!-- Note: pusher_app_id cannot exceed 64 chars -->
     <string name="pusher_app_id" translatable="false">im.vector.app.android</string>
 

diff --git a/vector/build.gradle b/vector/build.gradle
@@ -268,6 +268,7 @@ android {
             buildConfigField "boolean", "ALLOW_FCM_USE", "true"
             buildConfigField "String", "SHORT_FLAVOR_DESCRIPTION", "\"G\""
             buildConfigField "String", "FLAVOR_DESCRIPTION", "\"GooglePlay\""
+            buildConfigField "boolean", "ALLOW_EXTERNAL_UNIFIEDPUSH_DISTRIB", "true"
         }
 
         fdroid {
@@ -279,6 +280,7 @@ android {
             buildConfigField "boolean", "ALLOW_FCM_USE", "false"
             buildConfigField "String", "SHORT_FLAVOR_DESCRIPTION", "\"F\""
             buildConfigField "String", "FLAVOR_DESCRIPTION", "\"FDroid\""
+            buildConfigField "boolean", "ALLOW_EXTERNAL_UNIFIEDPUSH_DISTRIB", "true"
         }
     }
 
@@ -334,6 +336,7 @@ dependencies {
     implementation project(":library:multipicker")
     implementation 'androidx.multidex:multidex:2.0.1'
 
+    implementation libs.jetbrains.kotlinReflect
     implementation libs.jetbrains.coroutinesCore
     implementation libs.jetbrains.coroutinesAndroid
 
@@ -350,6 +353,7 @@ dependencies {
     implementation "com.gabrielittner.threetenbp:lazythreetenbp:0.9.0"
 
     implementation libs.squareup.moshi
+    implementation libs.squareup.moshiKt
     kapt libs.squareup.moshiKotlin
 
     // Lifecycle
@@ -453,8 +457,10 @@ dependencies {
     // Analytics
     implementation 'com.posthog.android:posthog:1.1.2'
 
-    // gplay flavor only
-    gplayImplementation('com.google.firebase:firebase-messaging:23.0.0') {
+    // UnifiedPush
+    implementation 'com.github.UnifiedPush:android-connector:2.0.0'
+    // UnifiedPush gplay flavor only
+    gplayImplementation('com.github.UnifiedPush:android-embedded_fcm_distributor:2.0.0') {
         exclude group: 'com.google.firebase', module: 'firebase-core'
         exclude group: 'com.google.firebase', module: 'firebase-analytics'
         exclude group: 'com.google.firebase', module: 'firebase-measurement-connector'

diff --git a/vector/src/fdroid/AndroidManifest.xml b/vector/src/fdroid/AndroidManifest.xml
@@ -28,6 +28,19 @@
             android:enabled="true"
             android:exported="false" />
 
+        <receiver android:name=".fdroid.receiver.KeepInternalDistributor"
+            android:enabled="true"
+            android:exported="false">
+            <intent-filter>
+                <!--
+                This action is checked to track installed and uninstalled distributors.
+                We declare it to keep the background sync as an internal
+                unifiedpush distributor.
+                -->
+                <action android:name="org.unifiedpush.android.distributor.REGISTER" />
+            </intent-filter>
+        </receiver>
+
         <service
             android:name=".fdroid.service.GuardService"
             android:exported="false"

diff --git a/vector/src/fdroid/java/im/vector/app/fdroid/receiver/KeepInternalDistributor.kt b/vector/src/fdroid/java/im/vector/app/fdroid/receiver/KeepInternalDistributor.kt
@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.app.fdroid.receiver
+
+import android.content.BroadcastReceiver
+import android.content.Context
+import android.content.Intent
+
+/**
+ * UnifiedPush lib tracks an action to check installed and uninstalled distributors.
+ * We declare it to keep the background sync as an internal unifiedpush distributor.
+ * This class is used to declare this action.
+ */
+class KeepInternalDistributor : BroadcastReceiver() {
+    override fun onReceive(p0: Context?, p1: Intent?) {
+        return
+    }
+}
diff --git a/vector/src/fdroid/java/im/vector/app/push/fcm/NotificationTroubleshootTestManagerFactory.kt b/vector/src/fdroid/java/im/vector/app/push/fcm/NotificationTroubleshootTestManagerFactory.kt
@@ -16,22 +16,36 @@
 package im.vector.app.push.fcm
 
 import androidx.fragment.app.Fragment
+import im.vector.app.BuildConfig
+import im.vector.app.core.pushers.UnifiedPushHelper
 import im.vector.app.fdroid.features.settings.troubleshoot.TestAutoStartBoot
 import im.vector.app.fdroid.features.settings.troubleshoot.TestBackgroundRestrictions
 import im.vector.app.fdroid.features.settings.troubleshoot.TestBatteryOptimization
 import im.vector.app.features.settings.troubleshoot.NotificationTroubleshootTestManager
 import im.vector.app.features.settings.troubleshoot.TestAccountSettings
+import im.vector.app.features.settings.troubleshoot.TestAvailableUnifiedPushDistributors
+import im.vector.app.features.settings.troubleshoot.TestCurrentUnifiedPushDistributor
 import im.vector.app.features.settings.troubleshoot.TestDeviceSettings
+import im.vector.app.features.settings.troubleshoot.TestEndpointAsTokenRegistration
 import im.vector.app.features.settings.troubleshoot.TestNotification
+import im.vector.app.features.settings.troubleshoot.TestPushFromPushGateway
 import im.vector.app.features.settings.troubleshoot.TestPushRulesSettings
 import im.vector.app.features.settings.troubleshoot.TestSystemSettings
+import im.vector.app.features.settings.troubleshoot.TestUnifiedPushEndpoint
+import im.vector.app.features.settings.troubleshoot.TestUnifiedPushGateway
 import javax.inject.Inject
 
 class NotificationTroubleshootTestManagerFactory @Inject constructor(
         private val testSystemSettings: TestSystemSettings,
         private val testAccountSettings: TestAccountSettings,
         private val testDeviceSettings: TestDeviceSettings,
         private val testPushRulesSettings: TestPushRulesSettings,
+        private val testCurrentUnifiedPushDistributor: TestCurrentUnifiedPushDistributor,
+        private val testUnifiedPushGateway: TestUnifiedPushGateway,
+        private val testUnifiedPushEndpoint: TestUnifiedPushEndpoint,
+        private val testAvailableUnifiedPushDistributors: TestAvailableUnifiedPushDistributors,
+        private val testEndpointAsTokenRegistration: TestEndpointAsTokenRegistration,
+        private val testPushFromPushGateway: TestPushFromPushGateway,
         private val testAutoStartBoot: TestAutoStartBoot,
         private val testBackgroundRestrictions: TestBackgroundRestrictions,
         private val testBatteryOptimization: TestBatteryOptimization,
@@ -44,9 +58,20 @@ class NotificationTroubleshootTestManagerFactory @Inject constructor(
         mgr.addTest(testAccountSettings)
         mgr.addTest(testDeviceSettings)
         mgr.addTest(testPushRulesSettings)
-        mgr.addTest(testAutoStartBoot)
-        mgr.addTest(testBackgroundRestrictions)
-        mgr.addTest(testBatteryOptimization)
+        if (BuildConfig.ALLOW_EXTERNAL_UNIFIEDPUSH_DISTRIB) {
+            mgr.addTest(testAvailableUnifiedPushDistributors)
+            mgr.addTest(testCurrentUnifiedPushDistributor)
+        }
+        if (UnifiedPushHelper.isBackgroundSync(fragment.requireContext())) {
+            mgr.addTest(testAutoStartBoot)
+            mgr.addTest(testBackgroundRestrictions)
+            mgr.addTest(testBatteryOptimization)
+        } else {
+            mgr.addTest(testUnifiedPushGateway)
+            mgr.addTest(testUnifiedPushEndpoint)
+            mgr.addTest(testEndpointAsTokenRegistration)
+            mgr.addTest(testPushFromPushGateway)
+        }
         mgr.addTest(testNotification)
         return mgr
     }

diff --git a/vector/src/gplay/AndroidManifest.xml b/vector/src/gplay/AndroidManifest.xml
@@ -9,13 +9,17 @@
             android:name="firebase_analytics_collection_deactivated"
             android:value="true" />
 
-        <service
-            android:name=".gplay.push.fcm.VectorFirebaseMessagingService"
+        <receiver
+            android:enabled="true"
+            android:name=".push.fcm.EmbeddedFCMDistributor"
             android:exported="false">
+
             <intent-filter>
-                <action android:name="com.google.firebase.MESSAGING_EVENT" />
+                <action android:name="org.unifiedpush.android.distributor.REGISTER"/>
+                <action android:name="org.unifiedpush.android.distributor.UNREGISTER"/>
             </intent-filter>
-        </service>
+
+        </receiver>
 
     </application>
 

diff --git a/vector/src/gplay/java/im/vector/app/push/fcm/EmbeddedFCMDistributor.kt b/vector/src/gplay/java/im/vector/app/push/fcm/EmbeddedFCMDistributor.kt
@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2022 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.app.push.fcm
+
+import android.content.Context
+import org.unifiedpush.android.embedded_fcm_distributor.EmbeddedDistributorReceiver
+
+class EmbeddedFCMDistributor : EmbeddedDistributorReceiver() {
+    override fun getEndpoint(context: Context, token: String, instance: String): String {
+        // Here token is the FCM Token, used by the gateway (sygnal)
+        return token
+    }
+}
diff --git a/vector/src/gplay/java/im/vector/app/push/fcm/FcmHelper.kt b/vector/src/gplay/java/im/vector/app/push/fcm/FcmHelper.kt
@@ -95,9 +95,9 @@ object FcmHelper {
      * it doesn't, display a dialog that allows users to download the APK from
      * the Google Play Store or enable it in the device's system settings.
      */
-    private fun checkPlayServices(activity: Activity): Boolean {
+    fun checkPlayServices(context: Context): Boolean {
         val apiAvailability = GoogleApiAvailability.getInstance()
-        val resultCode = apiAvailability.isGooglePlayServicesAvailable(activity)
+        val resultCode = apiAvailability.isGooglePlayServicesAvailable(context)
         return resultCode == ConnectionResult.SUCCESS
     }
 

diff --git a/vector/src/gplay/java/im/vector/app/push/fcm/NotificationTroubleshootTestManagerFactory.kt b/vector/src/gplay/java/im/vector/app/push/fcm/NotificationTroubleshootTestManagerFactory.kt
@@ -16,26 +16,38 @@
 package im.vector.app.push.fcm
 
 import androidx.fragment.app.Fragment
+import im.vector.app.BuildConfig
+import im.vector.app.core.pushers.UnifiedPushHelper
 import im.vector.app.features.settings.troubleshoot.NotificationTroubleshootTestManager
 import im.vector.app.features.settings.troubleshoot.TestAccountSettings
+import im.vector.app.features.settings.troubleshoot.TestAvailableUnifiedPushDistributors
+import im.vector.app.features.settings.troubleshoot.TestCurrentUnifiedPushDistributor
 import im.vector.app.features.settings.troubleshoot.TestDeviceSettings
+import im.vector.app.features.settings.troubleshoot.TestEndpointAsTokenRegistration
 import im.vector.app.features.settings.troubleshoot.TestNotification
+import im.vector.app.features.settings.troubleshoot.TestPushFromPushGateway
 import im.vector.app.features.settings.troubleshoot.TestPushRulesSettings
 import im.vector.app.features.settings.troubleshoot.TestSystemSettings
+import im.vector.app.features.settings.troubleshoot.TestUnifiedPushEndpoint
+import im.vector.app.features.settings.troubleshoot.TestUnifiedPushGateway
 import im.vector.app.gplay.features.settings.troubleshoot.TestFirebaseToken
 import im.vector.app.gplay.features.settings.troubleshoot.TestPlayServices
-import im.vector.app.gplay.features.settings.troubleshoot.TestPushFromPushGateway
 import im.vector.app.gplay.features.settings.troubleshoot.TestTokenRegistration
 import javax.inject.Inject
 
 class NotificationTroubleshootTestManagerFactory @Inject constructor(
         private val testSystemSettings: TestSystemSettings,
         private val testAccountSettings: TestAccountSettings,
         private val testDeviceSettings: TestDeviceSettings,
-        private val testBingRulesSettings: TestPushRulesSettings,
+        private val testPushRulesSettings: TestPushRulesSettings,
         private val testPlayServices: TestPlayServices,
         private val testFirebaseToken: TestFirebaseToken,
         private val testTokenRegistration: TestTokenRegistration,
+        private val testCurrentUnifiedPushDistributor: TestCurrentUnifiedPushDistributor,
+        private val testUnifiedPushGateway: TestUnifiedPushGateway,
+        private val testUnifiedPushEndpoint: TestUnifiedPushEndpoint,
+        private val testAvailableUnifiedPushDistributors: TestAvailableUnifiedPushDistributors,
+        private val testEndpointAsTokenRegistration: TestEndpointAsTokenRegistration,
         private val testPushFromPushGateway: TestPushFromPushGateway,
         private val testNotification: TestNotification
 ) {
@@ -45,10 +57,20 @@ class NotificationTroubleshootTestManagerFactory @Inject constructor(
         mgr.addTest(testSystemSettings)
         mgr.addTest(testAccountSettings)
         mgr.addTest(testDeviceSettings)
-        mgr.addTest(testBingRulesSettings)
-        mgr.addTest(testPlayServices)
-        mgr.addTest(testFirebaseToken)
-        mgr.addTest(testTokenRegistration)
+        mgr.addTest(testPushRulesSettings)
+        if (BuildConfig.ALLOW_EXTERNAL_UNIFIEDPUSH_DISTRIB) {
+            mgr.addTest(testAvailableUnifiedPushDistributors)
+            mgr.addTest(testCurrentUnifiedPushDistributor)
+        }
+        if (UnifiedPushHelper.isEmbeddedDistributor(fragment.requireContext())) {
+            mgr.addTest(testPlayServices)
+            mgr.addTest(testFirebaseToken)
+            mgr.addTest(testTokenRegistration)
+        } else {
+            mgr.addTest(testUnifiedPushGateway)
+            mgr.addTest(testUnifiedPushEndpoint)
+            mgr.addTest(testEndpointAsTokenRegistration)
+        }
         mgr.addTest(testPushFromPushGateway)
         mgr.addTest(testNotification)
         return mgr

diff --git a/vector/src/main/AndroidManifest.xml b/vector/src/main/AndroidManifest.xml
@@ -409,6 +409,17 @@
             </intent-filter>
         </receiver>
 
+        <!-- UnifiedPush -->
+        <receiver android:exported="true"  android:enabled="true"  android:name=".core.pushers.VectorMessagingReceiver">
+            <intent-filter>
+                <action android:name="org.unifiedpush.android.connector.MESSAGE"/>
+                <action android:name="org.unifiedpush.android.connector.UNREGISTERED"/>
+                <action android:name="org.unifiedpush.android.connector.NEW_ENDPOINT"/>
+                <action android:name="org.unifiedpush.android.connector.REGISTRATION_FAILED"/>
+                <action android:name="org.unifiedpush.android.connector.REGISTRATION_REFUSED"/>
+            </intent-filter>
+        </receiver>
+
         <!-- Providers -->
 
         <!-- Remove WorkManagerInitializer Provider because we are using on-demand initialization of WorkManager-->
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Use UnifiedPush and allows user to have push without FCM.