Merge pull request thunderbird#9792 from wmontwe/uplift-beta-9772-fix-imap-prefix-handling

uplift(beta): fix imap prefix handling

Author: coreycb

backend/api/src/main/java/com/fsck/k9/backend/api/Backend.kt

@@ -5,6 +5,7 @@ import com.fsck.k9.mail.Flag
 import com.fsck.k9.mail.Message
 import com.fsck.k9.mail.Part
 import net.thunderbird.core.common.exception.MessagingException
+import net.thunderbird.feature.mail.folder.api.FolderPathDelimiter
 
 interface Backend {
     val supportsFlags: Boolean
@@ -18,7 +19,7 @@ interface Backend {
     val isPushCapable: Boolean
 
     @Throws(MessagingException::class)
-    fun refreshFolderList()
+    fun refreshFolderList(): FolderPathDelimiter?
 
     // TODO: Add a way to cancel the sync process
     fun sync(folderServerId: String, syncConfig: SyncConfig, listener: SyncListener)

backend/api/src/main/java/com/fsck/k9/backend/api/FolderInfo.kt

@@ -1,5 +1,11 @@
 package com.fsck.k9.backend.api
 
 import com.fsck.k9.mail.FolderType
+import net.thunderbird.feature.mail.folder.api.FolderPathDelimiter
 
-data class FolderInfo(val serverId: String, val name: String, val type: FolderType)
+data class FolderInfo(
+    val serverId: String,
+    val name: String,
+    val type: FolderType,
+    val folderPathDelimiter: FolderPathDelimiter? = null,
+)

backend/demo/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
 
 dependencies {
     api(projects.backend.api)
+    implementation(projects.feature.mail.folder.api)
 
     implementation(libs.kotlinx.serialization.json)
 

backend/demo/src/main/kotlin/app/k9mail/backend/demo/CommandRefreshFolderList.kt

@@ -3,13 +3,15 @@ package app.k9mail.backend.demo
 import com.fsck.k9.backend.api.BackendStorage
 import com.fsck.k9.backend.api.FolderInfo
 import com.fsck.k9.backend.api.updateFolders
+import net.thunderbird.feature.mail.folder.api.FOLDER_DEFAULT_PATH_DELIMITER
+import net.thunderbird.feature.mail.folder.api.FolderPathDelimiter
 
 internal class CommandRefreshFolderList(
     private val backendStorage: BackendStorage,
     private val demoStore: DemoStore,
 ) {
 
-    fun refreshFolderList() {
+    fun refreshFolderList(): FolderPathDelimiter? {
         val localFolderServerIds = backendStorage.getFolderServerIds().toSet()
 
         backendStorage.updateFolders {
@@ -25,5 +27,7 @@ internal class CommandRefreshFolderList(
             val folderServerIdsToRemove = (localFolderServerIds - remoteFolderServerIds).toList()
             deleteFolders(folderServerIdsToRemove)
         }
+
+        return FOLDER_DEFAULT_PATH_DELIMITER
     }
 }

backend/demo/src/main/kotlin/app/k9mail/backend/demo/DemoBackend.kt

@@ -11,6 +11,7 @@ import com.fsck.k9.mail.BodyFactory
 import com.fsck.k9.mail.Flag
 import com.fsck.k9.mail.Message
 import com.fsck.k9.mail.Part
+import net.thunderbird.feature.mail.folder.api.FolderPathDelimiter
 
 class DemoBackend(
     private val backendStorage: BackendStorage,
@@ -31,8 +32,8 @@ class DemoBackend(
     override val supportsFolderSubscriptions: Boolean = false
     override val isPushCapable: Boolean = false
 
-    override fun refreshFolderList() {
-        commandRefreshFolderList.refreshFolderList()
+    override fun refreshFolderList(): FolderPathDelimiter? {
+        return commandRefreshFolderList.refreshFolderList()
     }
 
     override fun sync(folderServerId: String, syncConfig: SyncConfig, listener: SyncListener) {

backend/imap/build.gradle.kts

@@ -13,6 +13,8 @@ dependencies {
     api(projects.mail.protocols.imap)
     api(projects.mail.protocols.smtp)
 
+    implementation(projects.feature.mail.folder.api)
+
     implementation(libs.kotlinx.coroutines.core)
 
     testImplementation(projects.core.logging.testing)

backend/imap/src/main/java/com/fsck/k9/backend/imap/CommandRefreshFolderList.kt

@@ -6,32 +6,49 @@ import com.fsck.k9.backend.api.updateFolders
 import com.fsck.k9.mail.FolderType
 import com.fsck.k9.mail.store.imap.FolderListItem
 import com.fsck.k9.mail.store.imap.ImapStore
+import net.thunderbird.core.logging.Logger
+import net.thunderbird.core.logging.legacy.Log
+import net.thunderbird.feature.mail.folder.api.FolderPathDelimiter
+
+private const val TAG = "CommandRefreshFolderList"
 
 internal class CommandRefreshFolderList(
     private val backendStorage: BackendStorage,
     private val imapStore: ImapStore,
+    private val logger: Logger = Log,
 ) {
-    fun refreshFolderList() {
-        // TODO: Start using the proper server ID.
-        //  For now we still use the old server ID format (decoded, with prefix removed).
-        val foldersOnServer = imapStore.getFolders().toLegacyFolderList()
+
+    private val LegacyFolderListItem.normalizedServerId: String
+        get() = imapStore.combinedPrefix?.let {
+            serverId.removePrefix(prefix = it)
+        } ?: serverId
+
+    fun refreshFolderList(): FolderPathDelimiter? {
+        logger.verbose(TAG) { "refreshFolderList() called" }
+        val folders = imapStore.getFolders()
+        val folderPathDelimiter = folders.firstOrNull { it.folderPathDelimiter != null }?.folderPathDelimiter
+        val foldersOnServer = folders.toLegacyFolderList()
         val oldFolderServerIds = backendStorage.getFolderServerIds()
 
         backendStorage.updateFolders {
             val foldersToCreate = mutableListOf<FolderInfo>()
             for (folder in foldersOnServer) {
-                if (folder.serverId !in oldFolderServerIds) {
-                    foldersToCreate.add(FolderInfo(folder.serverId, folder.name, folder.type))
+                if (folder.normalizedServerId !in oldFolderServerIds) {
+                    foldersToCreate.add(FolderInfo(folder.normalizedServerId, folder.name, folder.type))
                 } else {
-                    changeFolder(folder.serverId, folder.name, folder.type)
+                    changeFolder(folder.normalizedServerId, folder.name, folder.type)
                 }
             }
+
+            logger.verbose(TAG) { "refreshFolderList: foldersToCreate = $foldersToCreate" }
             createFolders(foldersToCreate)
 
-            val newFolderServerIds = foldersOnServer.map { it.serverId }
+            val newFolderServerIds = foldersOnServer.map { it.normalizedServerId }
             val removedFolderServerIds = oldFolderServerIds - newFolderServerIds
+            logger.verbose(TAG) { "refreshFolderList: folders to remove = $removedFolderServerIds" }
             deleteFolders(removedFolderServerIds)
         }
+        return folderPathDelimiter
     }
 }
 

backend/imap/src/main/java/com/fsck/k9/backend/imap/ImapBackend.kt

@@ -14,6 +14,7 @@ import com.fsck.k9.mail.power.PowerManager
 import com.fsck.k9.mail.store.imap.IdleRefreshManager
 import com.fsck.k9.mail.store.imap.ImapStore
 import com.fsck.k9.mail.transport.smtp.SmtpTransport
+import net.thunderbird.feature.mail.folder.api.FolderPathDelimiter
 
 class ImapBackend(
     private val accountName: String,
@@ -48,8 +49,8 @@ class ImapBackend(
     override val supportsFolderSubscriptions = true
     override val isPushCapable = true
 
-    override fun refreshFolderList() {
-        commandRefreshFolderList.refreshFolderList()
+    override fun refreshFolderList(): FolderPathDelimiter? {
+        return commandRefreshFolderList.refreshFolderList()
     }
 
     override fun sync(folderServerId: String, syncConfig: SyncConfig, listener: SyncListener) {

backend/imap/src/test/java/com/fsck/k9/backend/imap/TestImapStore.kt

@@ -8,6 +8,9 @@ import com.fsck.k9.mail.store.imap.ImapStore
 class TestImapStore : ImapStore {
     private val folders = mutableMapOf<String, ImapFolder>()
 
+    override val combinedPrefix: String?
+        get() = throw UnsupportedOperationException("not implemented")
+
     fun addFolder(serverId: String): TestImapFolder {
         require(!folders.containsKey(serverId)) { "Folder '$serverId' already exists" }
 
@@ -44,4 +47,8 @@ class TestImapStore : ImapStore {
     override fun closeAllConnections() {
         throw UnsupportedOperationException("not implemented")
     }
+
+    override fun fetchImapPrefix() {
+        throw UnsupportedOperationException("not implemented")
+    }
 }

backend/imap/src/test/kotlin/net/thunderbird/backend/imap/ImapRemoteFolderCreatorTest.kt

@@ -122,6 +122,9 @@ class ImapRemoteFolderCreatorTest {
 private class FakeImapStore(
     private val folder: TestImapFolder,
 ) : ImapStore {
+    override val combinedPrefix: String?
+        get() = throw NotImplementedError("combinedPrefix not implemented")
+
     override fun checkSettings() {
         throw NotImplementedError("checkSettings not implemented")
     }
@@ -135,4 +138,8 @@ private class FakeImapStore(
     override fun closeAllConnections() {
         throw NotImplementedError("closeAllConnections not implemented")
     }
+
+    override fun fetchImapPrefix() {
+        throw NotImplementedError("fetchImapPrefix not implemented")
+    }
 }