Import some stuff about Push and notification from Element Android - WIP

libraries/push/api/src/main/AndroidManifest.xml

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="utf-8"?><!--
+~ Copyright (c) 2023 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.
+-->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+
+    <application>
+
+        <!-- Firebase components -->
+        <meta-data
+            android:name="firebase_analytics_collection_deactivated"
+            android:value="true" />
+
+        <service
+            android:name="VectorFirebaseMessagingService"
+            android:exported="false">
+            <intent-filter>
+                <action android:name="com.google.firebase.MESSAGING_EVENT" />
+            </intent-filter>
+        </service>
+
+        <!-- UnifiedPush -->
+        <receiver
+            android:name="VectorUnifiedPushMessagingReceiver"
+            android:enabled="true"
+            android:exported="true">
+            <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>
+
+        <receiver
+            android:name="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>
+    </application>
+</manifest>

libraries/push/api/src/main/kotlin/io/element/android/libraries/push/api/PushService.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.push.api
+
+interface PushService {
+    fun setCurrentRoom(roomId: String?)
+    fun setCurrentThread(threadId: String?)
+    fun notificationStyleChanged()
+}

libraries/push/api/src/main/kotlin/io/element/android/libraries/push/api/model/BackgroundSyncMode.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.push.api.model
+
+/**
+ * Different strategies for Background sync, only applicable to F-Droid version of the app.
+ */
+enum class BackgroundSyncMode {
+    /**
+     * In this mode background syncs are scheduled via Workers, meaning that the system will have control on the periodicity
+     * of syncs when battery is low or when the phone is idle (sync will occur in allowed maintenance windows). After completion
+     * the sync work will schedule another one.
+     */
+    FDROID_BACKGROUND_SYNC_MODE_FOR_BATTERY,
+
+    /**
+     * This mode requires the app to be exempted from battery optimization. Alarms will be launched and will wake up the app
+     * in order to perform the background sync as a foreground service. After completion the service will schedule another alarm
+     */
+    FDROID_BACKGROUND_SYNC_MODE_FOR_REALTIME,
+
+    /**
+     * The app won't sync in background.
+     */
+    FDROID_BACKGROUND_SYNC_MODE_DISABLED;
+
+    companion object {
+        const val DEFAULT_SYNC_DELAY_SECONDS = 60
+        const val DEFAULT_SYNC_TIMEOUT_SECONDS = 6
+
+        fun fromString(value: String?): BackgroundSyncMode = values().firstOrNull { it.name == value }
+                ?: FDROID_BACKGROUND_SYNC_MODE_DISABLED
+    }
+}

libraries/push/api/src/main/kotlin/io/element/android/libraries/push/api/store/PushDataStore.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2023 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 io.element.android.libraries.push.api.store
+
+import io.element.android.libraries.push.api.model.BackgroundSyncMode
+import kotlinx.coroutines.flow.Flow
+
+interface PushDataStore {
+    val pushCounterFlow: Flow<Int>
+
+    fun areNotificationEnabledForDevice(): Boolean
+    fun setNotificationEnabledForDevice(enabled: Boolean)
+
+    fun backgroundSyncTimeOut(): Int
+    fun setBackgroundSyncTimeout(timeInSecond: Int)
+    fun backgroundSyncDelay(): Int
+    fun setBackgroundSyncDelay(timeInSecond: Int)
+    fun isBackgroundSyncEnabled(): Boolean
+    fun setFdroidSyncBackgroundMode(mode: BackgroundSyncMode)
+    fun getFdroidSyncBackgroundMode(): BackgroundSyncMode
+
+    /**
+     * Return true if Pin code is disabled, or if user set the settings to see full notification content.
+     */
+    fun useCompleteNotificationFormat(): Boolean
+}