feat: use case to change cipher_profile [WPB-14826] (#3163)

* feat: use case to change cipher_profile [WPB-14826] * change cipher_profile value to be platform specific * fix detekt
wireapp · Dec 11, 2024 · 0667f9b · 0667f9b
1 parent abcd037
commit 0667f9b
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 2 deletions.
diff --git a/logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/UserSessionScope.kt b/logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/UserSessionScope.kt
@@ -1831,6 +1831,7 @@ class UserSessionScope internal constructor(
             legalHoldHandler,
             notificationTokenRepository,
             this,
+            userStorage,
             userScopedLogger,
         )
     }

diff --git a/logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/debug/ChangeProfilingUseCase.kt b/logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/debug/ChangeProfilingUseCase.kt
@@ -0,0 +1,32 @@
+/*
+ * Wire
+ * Copyright (C) 2024 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ */
+package com.wire.kalium.logic.feature.debug
+
+import com.wire.kalium.logic.di.UserStorage
+
+class ChangeProfilingUseCase(
+    private val userStorage: UserStorage,
+) {
+    /**
+     * Changes the profiling of the database (cipher_profile) if the profile is specified and the database is encrypted
+     * @param enabled true to enable profiling, false to disable
+     */
+    operator fun invoke(enabled: Boolean) {
+        userStorage.database.changeProfiling(enabled)
+    }
+}
diff --git a/logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/debug/DebugScope.kt b/logic/src/commonMain/kotlin/com/wire/kalium/logic/feature/debug/DebugScope.kt
@@ -40,6 +40,7 @@ import com.wire.kalium.logic.data.prekey.PreKeyRepository
 import com.wire.kalium.logic.data.sync.SlowSyncRepository
 import com.wire.kalium.logic.data.user.UserId
 import com.wire.kalium.logic.data.user.UserRepository
+import com.wire.kalium.logic.di.UserStorage
 import com.wire.kalium.logic.feature.message.MLSMessageCreator
 import com.wire.kalium.logic.feature.message.MLSMessageCreatorImpl
 import com.wire.kalium.logic.feature.message.MessageEnvelopeCreator
@@ -92,6 +93,7 @@ class DebugScope internal constructor(
     private val legalHoldHandler: LegalHoldHandler,
     private val notificationTokenRepository: NotificationTokenRepository,
     private val scope: CoroutineScope,
+    userStorage: UserStorage,
     logger: KaliumLogger,
     internal val dispatcher: KaliumDispatcher = KaliumDispatcherImpl,
 ) {
@@ -224,4 +226,6 @@ class DebugScope internal constructor(
             clientRepository,
             notificationTokenRepository,
         )
+
+    val changeProfiling: ChangeProfilingUseCase = ChangeProfilingUseCase(userStorage)
 }
diff --git a/persistence/src/androidMain/kotlin/com/wire/kalium/persistence/db/UserDatabase.kt b/persistence/src/androidMain/kotlin/com/wire/kalium/persistence/db/UserDatabase.kt
@@ -51,7 +51,14 @@ actual fun userDatabaseBuilder(
     ) {
         isWALEnabled = enableWAL
     }
-    return UserDatabaseBuilder(userId, driver, dispatcher, platformDatabaseData, isEncryptionEnabled)
+    return UserDatabaseBuilder(
+        userId = userId,
+        sqlDriver = driver,
+        dispatcher = dispatcher,
+        platformDatabaseData = platformDatabaseData,
+        isEncrypted = isEncryptionEnabled,
+        cipherProfile = "logcat",
+    )
 }
 
 actual fun userDatabaseDriverByPath(

diff --git a/persistence/src/commonMain/kotlin/com/wire/kalium/persistence/db/UserDatabaseBuilder.kt b/persistence/src/commonMain/kotlin/com/wire/kalium/persistence/db/UserDatabaseBuilder.kt
@@ -112,13 +112,15 @@ internal expect fun userDatabaseDriverByPath(
     enableWAL: Boolean
 ): SqlDriver
 
+@Suppress("LongParameterList")
 class UserDatabaseBuilder internal constructor(
     private val userId: UserIDEntity,
     internal val sqlDriver: SqlDriver,
     dispatcher: CoroutineDispatcher,
     private val platformDatabaseData: PlatformDatabaseData,
     private val isEncrypted: Boolean,
-    private val queriesContext: CoroutineContext = KaliumDispatcherImpl.io
+    private val queriesContext: CoroutineContext = KaliumDispatcherImpl.io,
+    private val cipherProfile: String? = null,
 ) {
 
     internal val database: UserDatabase = UserDatabase(
@@ -316,6 +318,25 @@ class UserDatabaseBuilder internal constructor(
      */
     fun dbFileLocation(): String? = getDatabaseAbsoluteFileLocation(platformDatabaseData, userId)
 
+    /**
+     * Changes the profiling of the database (cipher_profile) if the profile is specified and the database is encrypted
+     * @param enabled true to enable profiling, false to disable
+     */
+    fun changeProfiling(enabled: Boolean) {
+        if (isEncrypted && cipherProfile != null) {
+            val cipherProfileValue = if (enabled) cipherProfile else "off"
+            sqlDriver.executeQuery(
+                identifier = null,
+                sql = "PRAGMA cipher_profile='$cipherProfileValue'",
+                mapper = {
+                    it.next()
+                    it.getLong(0).let { QueryResult.Value<Long?>(it) }
+                },
+                parameters = 0,
+            )
+        }
+    }
+
     /**
      * drops DB connection and delete the DB file
      */