diff --git a/mailbox-cli/src/main/java/org/briarproject/mailbox/cli/Main.kt b/mailbox-cli/src/main/java/org/briarproject/mailbox/cli/Main.kt index cb2abda0e79e9e6fb4f6ea9125b93a18f0bb2d9f..4faab22694a160dea955aac55c330d0304e0ecc9 100644 --- a/mailbox-cli/src/main/java/org/briarproject/mailbox/cli/Main.kt +++ b/mailbox-cli/src/main/java/org/briarproject/mailbox/cli/Main.kt @@ -8,7 +8,7 @@ import com.github.ajalt.clikt.parameters.options.flag import com.github.ajalt.clikt.parameters.options.option import org.briarproject.mailbox.core.CoreEagerSingletons import org.briarproject.mailbox.core.JavaCliEagerSingletons -import org.briarproject.mailbox.core.db.Database +import org.briarproject.mailbox.core.db.TransactionManager import org.briarproject.mailbox.core.lifecycle.LifecycleManager import org.briarproject.mailbox.core.setup.QrCodeEncoder import org.briarproject.mailbox.core.setup.SetupManager @@ -42,7 +42,7 @@ class Main : CliktCommand( internal lateinit var lifecycleManager: LifecycleManager @Inject - internal lateinit var db: Database + internal lateinit var db: TransactionManager @Inject internal lateinit var setupManager: SetupManager diff --git a/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/DatabaseModule.kt b/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/DatabaseModule.kt index e32d0fc766b3d5afeac82f95b08fed3652ef22db..31cf523063750485c5663c5a8f3678203d529051 100644 --- a/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/DatabaseModule.kt +++ b/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/DatabaseModule.kt @@ -17,4 +17,9 @@ internal class DatabaseModule { return H2Database(config, clock) } + @Provides + fun provideTransactionManager(db: Database): TransactionManager { + return db + } + } diff --git a/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/JdbcDatabase.kt b/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/JdbcDatabase.kt index 31c5a8a32ceb0f058db42cb03158b74b0efc6af7..1aad7a74557b8834c50506b76a8d3747e62b0bb1 100644 --- a/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/JdbcDatabase.kt +++ b/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/JdbcDatabase.kt @@ -76,7 +76,7 @@ abstract class JdbcDatabase(private val dbTypes: DatabaseTypes, private val cloc } // Open the database and create the tables and indexes if necessary var compact = false - transaction(false) { txn -> + write { txn -> val connection = txn.unbox() compact = if (reopen) { val s: Settings = getSettings(connection, DB_SETTINGS_NAMESPACE) @@ -101,7 +101,7 @@ abstract class JdbcDatabase(private val dbTypes: DatabaseTypes, private val cloc logDuration(LOG, { "Compacting database" }, start) // Allow the next transaction to reopen the DB synchronized(connectionsLock) { closed = false } - transaction(false) { txn -> + write { txn -> storeLastCompacted(txn.unbox()) } } @@ -604,6 +604,14 @@ abstract class JdbcDatabase(private val dbTypes: DatabaseTypes, private val cloc } } + override fun read(task: (Transaction) -> Unit) { + transaction(true, task) + } + + override fun write(task: (Transaction) -> Unit) { + transaction(false, task) + } + override fun transaction(readOnly: Boolean, task: (Transaction) -> Unit) { val txn = startTransaction(readOnly) try { diff --git a/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/TransactionManager.kt b/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/TransactionManager.kt index d663509b2d682e9d163075dd35ea438eb21f3ac8..edb9d82513ec9adcc1597d3597659e1a23138285 100644 --- a/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/TransactionManager.kt +++ b/mailbox-core/src/main/java/org/briarproject/mailbox/core/db/TransactionManager.kt @@ -2,6 +2,18 @@ package org.briarproject.mailbox.core.db interface TransactionManager { + /** + * Runs the given task within a read-only transaction. + */ + @Throws(DbException::class) + fun read(task: (Transaction) -> Unit) + + /** + * Runs the given task within a read/write transaction. + */ + @Throws(DbException::class) + fun write(task: (Transaction) -> Unit) + /** * Runs the given task within a transaction. */ diff --git a/mailbox-core/src/main/java/org/briarproject/mailbox/core/settings/SettingsManagerImpl.kt b/mailbox-core/src/main/java/org/briarproject/mailbox/core/settings/SettingsManagerImpl.kt index c1ccc66733d9d8efd8f9782d23b742db83d6caf2..0daee2753cd0478411bbd7d8d7a4bd20875ae20e 100644 --- a/mailbox-core/src/main/java/org/briarproject/mailbox/core/settings/SettingsManagerImpl.kt +++ b/mailbox-core/src/main/java/org/briarproject/mailbox/core/settings/SettingsManagerImpl.kt @@ -23,6 +23,6 @@ internal class SettingsManagerImpl @Inject constructor(private val db: Database) @Throws(DbException::class) override fun mergeSettings(s: Settings, namespace: String) { - db.transaction(false) { txn -> db.mergeSettings(txn, s, namespace) } + db.write { txn -> db.mergeSettings(txn, s, namespace) } } } diff --git a/mailbox-core/src/main/java/org/briarproject/mailbox/core/setup/QrCodeEncoder.kt b/mailbox-core/src/main/java/org/briarproject/mailbox/core/setup/QrCodeEncoder.kt index 334482d378562efaa5e64ce376ae791b75c8933c..94647cc3342cbbbe733d907fe8455d8c873bbe4d 100644 --- a/mailbox-core/src/main/java/org/briarproject/mailbox/core/setup/QrCodeEncoder.kt +++ b/mailbox-core/src/main/java/org/briarproject/mailbox/core/setup/QrCodeEncoder.kt @@ -4,8 +4,8 @@ import com.google.zxing.BarcodeFormat.QR_CODE import com.google.zxing.common.BitMatrix import com.google.zxing.qrcode.QRCodeWriter import dev.keiji.util.Base32 -import org.briarproject.mailbox.core.db.Database import org.briarproject.mailbox.core.db.DbException +import org.briarproject.mailbox.core.db.TransactionManager import org.briarproject.mailbox.core.tor.TorPlugin import org.briarproject.mailbox.core.util.LogUtils.logException import org.briarproject.mailbox.core.util.StringUtils.fromHexString @@ -18,7 +18,7 @@ private const val VERSION = 32 private val LOG = getLogger(QrCodeEncoder::class.java) class QrCodeEncoder @Inject constructor( - private val db: Database, + private val db: TransactionManager, private val setupManager: SetupManager, private val torPlugin: TorPlugin, ) { diff --git a/mailbox-core/src/main/java/org/briarproject/mailbox/core/setup/WipeManager.kt b/mailbox-core/src/main/java/org/briarproject/mailbox/core/setup/WipeManager.kt index 3da9b2e0cb39188ef58e20f1e2a6996db7210b3d..c87f4ca2bc9a1a681f850538c8f02420d8f36e98 100644 --- a/mailbox-core/src/main/java/org/briarproject/mailbox/core/setup/WipeManager.kt +++ b/mailbox-core/src/main/java/org/briarproject/mailbox/core/setup/WipeManager.kt @@ -26,7 +26,7 @@ class WipeManager @Inject constructor( val principal = call.principal<MailboxPrincipal>() if (principal !is MailboxPrincipal.OwnerPrincipal) throw AuthException() - db.transaction(false) { txn -> + db.write { txn -> db.clearDatabase(txn) } fileManager.deleteAllFiles() diff --git a/mailbox-core/src/test/java/org/briarproject/mailbox/core/contacts/ContactsManagerIntegrationTest.kt b/mailbox-core/src/test/java/org/briarproject/mailbox/core/contacts/ContactsManagerIntegrationTest.kt index 767df7596aea2d357c3eab15a6749308166c686e..bb11417d6cd8180373c0f2acbf8cf2e3410a4e54 100644 --- a/mailbox-core/src/test/java/org/briarproject/mailbox/core/contacts/ContactsManagerIntegrationTest.kt +++ b/mailbox-core/src/test/java/org/briarproject/mailbox/core/contacts/ContactsManagerIntegrationTest.kt @@ -35,7 +35,7 @@ class ContactsManagerIntegrationTest : IntegrationTest() { @AfterEach fun clearDb() { - db.transaction(false) { txn -> + db.write { txn -> db.clearDatabase(txn) } } @@ -124,7 +124,7 @@ class ContactsManagerIntegrationTest : IntegrationTest() { } assertJson("""{ "contacts": [ 1, 2, 3 ] }""", response2) - db.transaction(true) { txn -> + db.read { txn -> assertEquals(c1, db.getContact(txn, 1)) assertEquals(c2, db.getContact(txn, 2)) assertEquals(c3, db.getContact(txn, 3)) diff --git a/mailbox-core/src/test/java/org/briarproject/mailbox/core/contacts/ContactsManagerMalformedInputIntegrationTest.kt b/mailbox-core/src/test/java/org/briarproject/mailbox/core/contacts/ContactsManagerMalformedInputIntegrationTest.kt index e538c35e3a993db7f96d14ffe087f0725d612d80..677fe04001cf36a224278c5d23c49004725e85ea 100644 --- a/mailbox-core/src/test/java/org/briarproject/mailbox/core/contacts/ContactsManagerMalformedInputIntegrationTest.kt +++ b/mailbox-core/src/test/java/org/briarproject/mailbox/core/contacts/ContactsManagerMalformedInputIntegrationTest.kt @@ -27,7 +27,7 @@ class ContactsManagerMalformedInputIntegrationTest : IntegrationTest(false) { @AfterEach fun clearDb() { val db = testComponent.getDatabase() - db.transaction(false) { txn -> + db.write { txn -> db.clearDatabase(txn) } } @@ -62,7 +62,7 @@ class ContactsManagerMalformedInputIntegrationTest : IntegrationTest(false) { TestUtils.assertJson("""{ "contacts": [ 1, 2, 3 ] }""", response2) val db = testComponent.getDatabase() - db.transaction(true) { txn -> + db.read { txn -> assertEquals(c1, db.getContact(txn, 1)) assertEquals(c2, db.getContact(txn, 2)) assertEquals(c3, db.getContact(txn, 3)) @@ -220,7 +220,7 @@ class ContactsManagerMalformedInputIntegrationTest : IntegrationTest(false) { TestUtils.assertJson("""{ "contacts": [ 1, 2 ] }""", response2) val db = testComponent.getDatabase() - db.transaction(true) { txn -> + db.read { txn -> assertEquals(c1, db.getContact(txn, 1)) assertEquals(c2, db.getContact(txn, 2)) } diff --git a/mailbox-core/src/test/java/org/briarproject/mailbox/core/db/JdbcDatabaseTest.kt b/mailbox-core/src/test/java/org/briarproject/mailbox/core/db/JdbcDatabaseTest.kt index 67b41d18f3238abd45fa8208c10e17615b04e090..d24afe2de61d1b8c71bbc7e5ea5d2ecb72e40769 100644 --- a/mailbox-core/src/test/java/org/briarproject/mailbox/core/db/JdbcDatabaseTest.kt +++ b/mailbox-core/src/test/java/org/briarproject/mailbox/core/db/JdbcDatabaseTest.kt @@ -52,7 +52,7 @@ abstract class JdbcDatabaseTest { outboxId = randomIdManager.getNewRandomId() ) var db: Database = open(false) - db.transaction(false) { txn -> + db.write { txn -> db.addContact(txn, contact1) db.addContact(txn, contact2) @@ -61,7 +61,7 @@ abstract class JdbcDatabaseTest { // Check that the records are still there db = open(true) - db.transaction(false) { txn -> + db.write { txn -> val contact1Reloaded1 = db.getContact(txn, 1) val contact2Reloaded1 = db.getContact(txn, 2) assertEquals(contact1, contact1Reloaded1) @@ -77,7 +77,7 @@ abstract class JdbcDatabaseTest { // Check that the record is gone db = open(true) - db.transaction(true) { txn -> + db.read { txn -> val contact1Reloaded2 = db.getContact(txn, 1) val contact2Reloaded2 = db.getContact(txn, 2) assertNull(contact1Reloaded2) @@ -99,7 +99,7 @@ abstract class JdbcDatabaseTest { merged["baz"] = "qux" val db: Database = open(false) - db.transaction(false) { txn -> + db.write { txn -> // store 'before' db.mergeSettings(txn, before, "namespace") assertEquals(before, db.getSettings(txn, "namespace")) diff --git a/mailbox-core/src/test/java/org/briarproject/mailbox/core/server/IntegrationTest.kt b/mailbox-core/src/test/java/org/briarproject/mailbox/core/server/IntegrationTest.kt index 238b39da86cb3c695f34cbd81a88b9428f083891..54752fac5091fd5ca352b3aa75a29efd6010471f 100644 --- a/mailbox-core/src/test/java/org/briarproject/mailbox/core/server/IntegrationTest.kt +++ b/mailbox-core/src/test/java/org/briarproject/mailbox/core/server/IntegrationTest.kt @@ -62,7 +62,7 @@ abstract class IntegrationTest(private val installJsonFeature: Boolean = true) { protected fun addContact(c: Contact) { val db = testComponent.getDatabase() - db.transaction(false) { txn -> + db.write { txn -> db.addContact(txn, c) } } diff --git a/mailbox-core/src/test/java/org/briarproject/mailbox/core/setup/SetupManagerTest.kt b/mailbox-core/src/test/java/org/briarproject/mailbox/core/setup/SetupManagerTest.kt index 9ee9c88e122bfa60e57210e25dcb1f64074e3888..aa4ad01edf673a4270f07fc2fdc98565a5c4d6e0 100644 --- a/mailbox-core/src/test/java/org/briarproject/mailbox/core/setup/SetupManagerTest.kt +++ b/mailbox-core/src/test/java/org/briarproject/mailbox/core/setup/SetupManagerTest.kt @@ -25,21 +25,21 @@ class SetupManagerTest : IntegrationTest() { @Test fun `restarting setup wipes owner token and creates setup token`() { // initially, there's no setup and no owner token - db.transaction(true) { txn -> + db.read { txn -> assertNull(setupManager.getSetupToken(txn)) assertNull(setupManager.getOwnerToken(txn)) } // setting an owner token stores it in DB setupManager.setToken(null, ownerToken) - db.transaction(true) { txn -> + db.read { txn -> assertNull(setupManager.getSetupToken(txn)) assertEquals(ownerToken, setupManager.getOwnerToken(txn)) } // restarting setup wipes owner token, creates setup token setupManager.restartSetup() - db.transaction(true) { txn -> + db.read { txn -> val setupToken = setupManager.getSetupToken(txn) assertNotNull(setupToken) testComponent.getRandomIdManager().assertIsRandomId(setupToken) @@ -50,7 +50,7 @@ class SetupManagerTest : IntegrationTest() { @Test fun `setup request gets rejected when using non-setup token`() = runBlocking { // initially, there's no setup and no owner token - db.transaction(true) { txn -> + db.read { txn -> assertNull(setupManager.getSetupToken(txn)) assertNull(setupManager.getOwnerToken(txn)) } @@ -91,7 +91,7 @@ class SetupManagerTest : IntegrationTest() { authenticateWithToken(token) } // setup token got wiped and new owner token from response got stored - db.transaction(true) { txn -> + db.read { txn -> assertNull(setupManager.getSetupToken(txn)) assertEquals(setupManager.getOwnerToken(txn), response.token) }