Replace StorageManager with DatabaseFilesProvider

thunderbird · Dec 15, 2024 · decf6b6 · decf6b6
1 parent 511c013
commit decf6b6
Show file tree

Hide file tree

Showing 17 changed files with 106 additions and 393 deletions.
diff --git a/legacy/core/src/main/java/com/fsck/k9/mailstore/AndroidDatabaseFilesProvider.kt b/legacy/core/src/main/java/com/fsck/k9/mailstore/AndroidDatabaseFilesProvider.kt
@@ -0,0 +1,17 @@
+package com.fsck.k9.mailstore
+
+import android.content.Context
+import java.io.File
+
+internal class AndroidDatabaseFilesProvider(
+    private val context: Context,
+    private val accountId: String,
+) : DatabaseFilesProvider {
+    override fun getDatabaseFile(): File {
+        return context.getDatabasePath("$accountId.db")
+    }
+
+    override fun getAttachmentDirectory(): File {
+        return context.getDatabasePath("$accountId.db_att")
+    }
+}
diff --git a/legacy/core/src/main/java/com/fsck/k9/mailstore/AndroidDatabaseFilesProviderFactory.kt b/legacy/core/src/main/java/com/fsck/k9/mailstore/AndroidDatabaseFilesProviderFactory.kt
@@ -0,0 +1,11 @@
+package com.fsck.k9.mailstore
+
+import android.content.Context
+
+class AndroidDatabaseFilesProviderFactory(
+    private val context: Context,
+) : DatabaseFilesProviderFactory {
+    override fun createDatabaseFilesProvider(accountId: String): DatabaseFilesProvider {
+        return AndroidDatabaseFilesProvider(context, accountId)
+    }
+}
diff --git a/legacy/core/src/main/java/com/fsck/k9/mailstore/DatabaseFilesProvider.kt b/legacy/core/src/main/java/com/fsck/k9/mailstore/DatabaseFilesProvider.kt
@@ -0,0 +1,15 @@
+package com.fsck.k9.mailstore
+
+import java.io.File
+
+interface DatabaseFilesProvider {
+    /**
+     * Returns the file that should be used for the message store database.
+     */
+    fun getDatabaseFile(): File
+
+    /**
+     * Returns the directory under which to store attachments.
+     */
+    fun getAttachmentDirectory(): File
+}
diff --git a/legacy/core/src/main/java/com/fsck/k9/mailstore/DatabaseFilesProviderFactory.kt b/legacy/core/src/main/java/com/fsck/k9/mailstore/DatabaseFilesProviderFactory.kt
@@ -0,0 +1,5 @@
+package com.fsck.k9.mailstore
+
+interface DatabaseFilesProviderFactory {
+    fun createDatabaseFilesProvider(accountId: String): DatabaseFilesProvider
+}
diff --git a/legacy/core/src/main/java/com/fsck/k9/mailstore/KoinModule.kt b/legacy/core/src/main/java/com/fsck/k9/mailstore/KoinModule.kt
@@ -15,7 +15,7 @@ val mailStoreModule = module {
         )
     }
     single { MessageViewInfoExtractorFactory(get(), get(), get()) }
-    single { StorageManager.getInstance(get()) }
+    single<DatabaseFilesProviderFactory> { AndroidDatabaseFilesProviderFactory(context = get()) }
     single { SpecialFolderSelectionStrategy() }
     single {
         K9BackendStorageFactory(

diff --git a/legacy/core/src/main/java/com/fsck/k9/mailstore/LocalStore.java b/legacy/core/src/main/java/com/fsck/k9/mailstore/LocalStore.java
@@ -46,7 +46,6 @@
 import com.fsck.k9.mailstore.LocalFolder.DataLocation;
 import com.fsck.k9.mailstore.LockableDatabase.DbCallback;
 import com.fsck.k9.mailstore.LockableDatabase.SchemaDefinition;
-import com.fsck.k9.mailstore.StorageManager.InternalStorageProvider;
 import com.fsck.k9.message.extractors.AttachmentInfoExtractor;
 import app.k9mail.legacy.search.LocalSearch;
 import app.k9mail.legacy.search.api.SearchAttribute;
@@ -160,9 +159,9 @@ public class LocalStore {
      */
     private static final int THREAD_FLAG_UPDATE_BATCH_SIZE = 500;
 
-    private final Context context;
     private final PendingCommandSerializer pendingCommandSerializer;
     private final AttachmentInfoExtractor attachmentInfoExtractor;
+    private final DatabaseFilesProvider databaseFilesProvider;
 
     private final Account account;
     private final LockableDatabase database;
@@ -177,18 +176,18 @@ static LocalStore createInstance(Account account, Context context) throws Messag
      * This constructor is only used by {@link LocalStoreProvider#getInstance(Account)}
      */
     private LocalStore(final Account account, final Context context) throws MessagingException {
-        this.context = context;
-
         pendingCommandSerializer = PendingCommandSerializer.getInstance();
         attachmentInfoExtractor = DI.get(AttachmentInfoExtractor.class);
+        DatabaseFilesProviderFactory databaseFilesProviderFactory = DI.get(DatabaseFilesProviderFactory.class);
+        databaseFilesProvider = databaseFilesProviderFactory.createDatabaseFilesProvider(account.getUuid());
 
         this.account = account;
 
         SchemaDefinitionFactory schemaDefinitionFactory = DI.get(SchemaDefinitionFactory.class);
         RealMigrationsHelper migrationsHelper = new RealMigrationsHelper();
         SchemaDefinition schemaDefinition = schemaDefinitionFactory.createSchemaDefinition(migrationsHelper);
 
-        database = new LockableDatabase(context, account.getUuid(), schemaDefinition);
+        database = new LockableDatabase(context, databaseFilesProvider, schemaDefinition);
         database.open();
 
         Clock clock = DI.get(Clock.class);
@@ -650,9 +649,7 @@ public void close() {
     }
 
     File getAttachmentFile(String attachmentId) {
-        final StorageManager storageManager = StorageManager.getInstance(context);
-        final File attachmentDirectory = storageManager.getAttachmentDirectory(
-                account.getUuid(), database.getStorageProviderId());
+        File attachmentDirectory = databaseFilesProvider.getAttachmentDirectory();
         return new File(attachmentDirectory, attachmentId);
     }
 

diff --git a/legacy/core/src/main/java/com/fsck/k9/mailstore/LockableDatabase.java b/legacy/core/src/main/java/com/fsck/k9/mailstore/LockableDatabase.java
@@ -13,7 +13,6 @@
 import com.fsck.k9.K9;
 import com.fsck.k9.helper.FileHelper;
 import com.fsck.k9.mail.MessagingException;
-import com.fsck.k9.mailstore.StorageManager.InternalStorageProvider;
 import timber.log.Timber;
 
 import static java.lang.System.currentTimeMillis;
@@ -65,6 +64,7 @@ public interface SchemaDefinition {
     }
 
     private Context context;
+    private final DatabaseFilesProvider databaseFilesProvider;
 
     /**
      * {@link ThreadLocal} to check whether a DB transaction is occurring in the
@@ -76,30 +76,13 @@ public interface SchemaDefinition {
 
     private SchemaDefinition mSchemaDefinition;
 
-    private String uUid;
-
-    /**
-     * @param context
-     *            Never <code>null</code>.
-     * @param uUid
-     *            Never <code>null</code>.
-     * @param schemaDefinition
-     *            Never <code>null</code>.
-     */
-    public LockableDatabase(final Context context, final String uUid, final SchemaDefinition schemaDefinition) {
+    public LockableDatabase(Context context, DatabaseFilesProvider databaseFilesProvider,
+            SchemaDefinition schemaDefinition) {
         this.context = context;
-        this.uUid = uUid;
+        this.databaseFilesProvider = databaseFilesProvider;
         this.mSchemaDefinition = schemaDefinition;
     }
 
-    public String getStorageProviderId() {
-        return InternalStorageProvider.ID;
-    }
-
-    private StorageManager getStorageManager() {
-        return StorageManager.getInstance(context);
-    }
-
     /**
      * Lock the storage for shared operations (concurrent threads are allowed to
      * run simultaneously).
@@ -230,10 +213,7 @@ private void doOpenOrCreateDb(final File databaseFile) {
     }
 
     protected File prepareStorage() {
-        String providerId = getStorageProviderId();
-        final StorageManager storageManager = getStorageManager();
-
-        final File databaseFile = storageManager.getDatabase(uUid, providerId);
+        final File databaseFile = databaseFilesProvider.getDatabaseFile();
         final File databaseParentDir = databaseFile.getParentFile();
         if (databaseParentDir.isFile()) {
             // should be safe to unconditionally delete clashing file: user is not supposed to mess with our directory
@@ -247,7 +227,7 @@ protected File prepareStorage() {
             FileHelper.touchFile(databaseParentDir, ".nomedia");
         }
 
-        final File attachmentDir = storageManager.getAttachmentDirectory(uUid, providerId);
+        final File attachmentDir = databaseFilesProvider.getAttachmentDirectory();
         final File attachmentParentDir = attachmentDir.getParentFile();
         if (!attachmentParentDir.exists()) {
             // noinspection ResultOfMethodCallIgnored, TODO maybe throw UnavailableStorageException?
@@ -275,15 +255,13 @@ public void delete() {
     private void delete(final boolean recreate) {
         lockWrite();
         try {
-            String storageProviderId = getStorageProviderId();
             try {
                 mDb.close();
             } catch (Exception e) {
                 Timber.d("Exception caught in DB close: %s", e.getMessage());
             }
-            final StorageManager storageManager = getStorageManager();
             try {
-                final File attachmentDirectory = storageManager.getAttachmentDirectory(uUid, storageProviderId);
+                final File attachmentDirectory = databaseFilesProvider.getAttachmentDirectory();
                 final File[] attachments = attachmentDirectory.listFiles();
                 for (File attachment : attachments) {
                     if (attachment.exists()) {
@@ -303,7 +281,7 @@ private void delete(final boolean recreate) {
                 Timber.d("Exception caught in clearing attachments: %s", e.getMessage());
             }
             try {
-                deleteDatabase(storageManager.getDatabase(uUid, storageProviderId));
+                deleteDatabase(databaseFilesProvider.getDatabaseFile());
             } catch (Exception e) {
                 Timber.i(e, "LockableDatabase: delete(): Unable to delete backing DB file");
             }