Prepare migration to SQLDelight version of libpretixsync

Author: antweb

pretixscan/app/build.gradle

@@ -17,12 +17,12 @@ apply from: '../libpretixsync-repo/libpretixsync/versions.gradle'
 android {
     namespace 'eu.pretix.pretixscan.droid'
 
-    compileSdkVersion 33
+    compileSdkVersion 34
 
     defaultConfig {
         applicationId "eu.pretix.pretixscan.droid"
         minSdkVersion 21
-        targetSdkVersion 33
+        targetSdkVersion 34
         versionCode 94
         versionName "2.8.2"
         vectorDrawables.useSupportLibrary = true
@@ -159,6 +159,7 @@ dependencies {
     implementation "com.fasterxml.jackson.datatype:jackson-datatype-joda:$jackson_kotlin_version"
     implementation "net.i2p.crypto:eddsa:$eddsa_version"
     implementation "com.google.protobuf:protobuf-javalite:$protobuf_version"
+    implementation "app.cash.sqldelight:android-driver:$sqldelight_version"
 
     implementation 'com.facebook.soloader:soloader:0.10.5'
     debugImplementation 'com.facebook.flipper:flipper:0.191.0'

pretixscan/app/src/main/java/eu/pretix/pretixscan/droid/PretixScan.kt

@@ -4,6 +4,8 @@ import android.database.sqlite.SQLiteException
 import android.os.Build
 import androidx.appcompat.app.AppCompatDelegate
 import androidx.multidex.MultiDexApplication
+import androidx.sqlite.db.SupportSQLiteDatabase
+import app.cash.sqldelight.driver.android.AndroidSqliteDriver
 import com.facebook.flipper.android.AndroidFlipperClient
 import com.facebook.flipper.core.FlipperClient
 import com.facebook.soloader.SoLoader
@@ -13,14 +15,21 @@ import eu.pretix.libpretixsync.check.OnlineCheckProvider
 import eu.pretix.libpretixsync.check.ProxyCheckProvider
 import eu.pretix.libpretixsync.check.TicketCheckProvider
 import eu.pretix.libpretixsync.db.Migrations
+import eu.pretix.libpretixsync.sqldelight.AndroidUtilDateAdapter
+import eu.pretix.libpretixsync.sqldelight.BigDecimalAdapter
+import eu.pretix.libpretixsync.sqldelight.SyncDatabase
 import eu.pretix.pretixscan.droid.connectivity.ConnectivityHelper
 import eu.pretix.pretixscan.utils.KeystoreHelper
+import eu.pretix.pretixscan.utils.createSyncDatabase
+import eu.pretix.pretixscan.utils.readVersionPragma
 import io.requery.BlockingEntityStore
 import io.requery.Persistable
 import io.requery.sql.EntityDataStore
 import net.zetetic.database.sqlcipher.SQLiteConnection
 import net.zetetic.database.sqlcipher.SQLiteDatabase
 import net.zetetic.database.sqlcipher.SQLiteDatabaseHook
+import net.zetetic.database.sqlcipher.SupportOpenHelperFactory
+import java.nio.charset.StandardCharsets
 import java.util.concurrent.locks.ReentrantLock
 
 
@@ -105,6 +114,57 @@ class PretixScan : MultiDexApplication() {
             return dataStore!!
         }
 
+    val db: SyncDatabase by lazy {
+        // Access data to init schema through requery if it hasn't been created already
+        data.raw("PRAGMA user_version;").first()
+
+        val dbPass = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) KeystoreHelper.secureValue(KEYSTORE_PASSWORD, true)
+        else KEYSTORE_PASSWORD
+
+        val androidDriver = if (BuildConfig.DEBUG) {
+            AndroidSqliteDriver(
+                schema = SyncDatabase.Schema,
+                context = this.applicationContext,
+                name = "default",
+                callback = object : AndroidSqliteDriver.Callback(SyncDatabase.Schema) {
+                    override fun onOpen(db: SupportSQLiteDatabase) {
+                        db.setForeignKeyConstraintsEnabled(true)
+                    }
+                },
+            )
+        } else {
+            System.loadLibrary("sqlcipher")
+            AndroidSqliteDriver(
+                schema = SyncDatabase.Schema,
+                context = this.applicationContext,
+                name = "default",
+                callback = object : AndroidSqliteDriver.Callback(SyncDatabase.Schema) {
+                    override fun onOpen(db: SupportSQLiteDatabase) {
+                        db.setForeignKeyConstraintsEnabled(true)
+                    }
+                },
+                factory = SupportOpenHelperFactory(dbPass.toByteArray())
+            )
+        }
+
+        // Uncomment LogSqliteDriver for verbose logging
+        val driver = if(BuildConfig.DEBUG) {
+//            LogSqliteDriver(androidDriver) {
+//                Log.d("SQLDelight", it)
+//            }
+            androidDriver
+        } else {
+            androidDriver
+        }
+
+        createSyncDatabase(
+            driver = driver,
+            version = readVersionPragma(driver),
+            dateAdapter = AndroidUtilDateAdapter(),
+            bigDecimalAdapter = BigDecimalAdapter(),
+        )
+    }
+
     override fun onCreate() {
         super.onCreate()
 
@@ -140,7 +200,7 @@ class PretixScan : MultiDexApplication() {
                 }
                 fallback = AsyncCheckProvider(conf, data)
             }
-            return OnlineCheckProvider(conf, AndroidHttpClientFactory(this), data, fileStorage, fallback, fallbackTimeout)
+            return OnlineCheckProvider(conf, AndroidHttpClientFactory(this), data, db, fileStorage, fallback, fallbackTimeout)
         }
     }
 

pretixscan/app/src/main/java/eu/pretix/pretixscan/droid/db/SqlCipherConnection.kt

@@ -107,12 +107,12 @@ internal class SqlCipherConnection(val database: SQLiteDatabase) : BaseConnectio
 
     @Throws(SQLException::class)
     override fun isClosed(): Boolean {
-        return !database.isOpen()
+        return !database.isOpen
     }
 
     @Throws(SQLException::class)
     override fun isReadOnly(): Boolean {
-        return database.isReadOnly()
+        return database.isReadOnly
     }
 
     @Throws(SQLException::class)

pretixscan/app/src/main/java/eu/pretix/pretixscan/droid/db/SqlCipherDatabaseSource.kt

@@ -18,9 +18,9 @@
 package eu.pretix.pretixscan.droid.db
 
 import android.content.Context
+import eu.pretix.pretixscan.utils.DatabaseProvider
 import io.requery.android.DefaultMapping
 import io.requery.android.LoggingListener
-import io.requery.android.sqlite.DatabaseProvider
 import io.requery.android.sqlite.SchemaUpdater
 import io.requery.meta.EntityModel
 import io.requery.sql.Configuration
@@ -81,17 +81,18 @@ open class SqlCipherDatabaseSource(context: Context,
         }
     }
 
-    override fun getConfiguration(): Configuration {
-        if (_configuration == null) {
-            val builder = ConfigurationBuilder(this, model)
-                .setMapping(mapping)
-                .setPlatform(platform)
-                .setBatchUpdateSize(1000)
-            onConfigure(builder)
-            _configuration = builder.build()
+    override val configuration: Configuration
+        get() {
+            if (_configuration == null) {
+                val builder = ConfigurationBuilder(this, model)
+                    .setMapping(mapping)
+                    .setPlatform(platform)
+                    .setBatchUpdateSize(1000)
+                onConfigure(builder)
+                _configuration = builder.build()
+            }
+            return _configuration!!
         }
-        return _configuration!!
-    }
 
     override fun onCreate(db: SQLiteDatabase) {
         this.db = db
@@ -117,7 +118,7 @@ open class SqlCipherDatabaseSource(context: Context,
     override fun getConnection(): Connection {
         synchronized(this) {
             if (db == null) {
-                db = getWritableDatabase()
+                db = writableDatabase
             }
             return getConnection(db!!)
         }

pretixscan/app/src/main/java/eu/pretix/pretixscan/droid/ui/CheckInListSelectActivity.kt

@@ -54,6 +54,7 @@ class CheckInListSelectActivity : MorphingDialogActivity() {
                     api,
                     AndroidSentryImplementation(),
                     (application as PretixScan).data,
+                    (application as PretixScan).db,
                     (application as PretixScan).fileStorage,
                     1000L,
                     1000L,

pretixscan/app/src/main/java/eu/pretix/pretixscan/droid/ui/MainActivity.kt

@@ -535,6 +535,7 @@ class MainActivity : AppCompatActivity(), ReloadableActivity, ScannerView.Result
                 api,
                 AndroidSentryImplementation(),
                 (application as PretixScan).data,
+                (application as PretixScan).db,
                 (application as PretixScan).fileStorage,
                 60000L,
                 5 * 60000L,

pretixscan/app/src/main/java/eu/pretix/pretixscan/utils/DatabaseProvider.kt

@@ -0,0 +1,63 @@
+package eu.pretix.pretixscan.utils
+
+import io.requery.sql.Configuration
+import io.requery.sql.ConnectionProvider
+import io.requery.sql.TableCreationMode
+
+/**
+ * Converted copy of io.requery.android.sqlite.DatabaseProvider.
+ *
+ * The original is written in Java and causes platform declaration clashes with newer
+ * androidx.sqlite versions.
+ */
+interface DatabaseProvider<T> : ConnectionProvider, AutoCloseable {
+    open fun setLoggingEnabled(enable: Boolean)
+
+    /**
+     * Sets the [TableCreationMode] to use when the database is created or upgraded.
+     *
+     * @param mode to use
+     */
+    open fun setTableCreationMode(mode: TableCreationMode)
+
+    /**
+     * @return [Configuration] used by the provider
+     */
+    val configuration: Configuration
+
+    /**
+     * Callback for when the database schema is to be created.
+     *
+     * @param db instance
+     */
+    fun onCreate(db: T)
+
+    /**
+     * Callback for when the database should be configured.
+     *
+     * @param db instance
+     */
+    fun onConfigure(db: T)
+
+    /**
+     * Callback for when the database should be upgraded from an previous version to a new version.
+     *
+     * @param db instance
+     */
+    fun onUpgrade(db: T, oldVersion: Int, newVersion: Int)
+
+    /**
+     * @return read only database instance
+     */
+    val readableDatabase: T
+
+    /**
+     * @return readable and writable database instance
+     */
+    val writableDatabase: T
+
+    /**
+     * closes the database.
+     */
+    override fun close()
+}

pretixscan/app/src/main/java/eu/pretix/pretixscan/utils/SqlDelightUtils.kt

@@ -0,0 +1,93 @@
+package eu.pretix.pretixscan.utils
+
+import app.cash.sqldelight.ColumnAdapter
+import app.cash.sqldelight.TransacterImpl
+import app.cash.sqldelight.db.QueryResult
+import app.cash.sqldelight.db.SqlDriver
+import eu.pretix.libpretixsync.sqldelight.CheckIn
+import eu.pretix.libpretixsync.sqldelight.Closing
+import eu.pretix.libpretixsync.sqldelight.Event
+import eu.pretix.libpretixsync.sqldelight.Receipt
+import eu.pretix.libpretixsync.sqldelight.ReceiptLine
+import eu.pretix.libpretixsync.sqldelight.ReceiptPayment
+import eu.pretix.libpretixsync.sqldelight.SubEvent
+import eu.pretix.libpretixsync.sqldelight.SyncDatabase
+import java.math.BigDecimal
+import java.util.Date
+
+fun createSyncDatabase(
+    driver: SqlDriver,
+    version: Long?,
+    dateAdapter: ColumnAdapter<Date, String>,
+    bigDecimalAdapter: ColumnAdapter<BigDecimal, Double>,
+): SyncDatabase {
+    // TODO: Check DB migrations
+    if (version == null || version == 0L) {
+        try {
+            val t = object : TransacterImpl(driver) {}
+            t.transaction {
+                SyncDatabase.Schema.create(driver)
+            }
+        } catch (e: Throwable) {
+            e.printStackTrace()
+            throw e
+        }
+    }
+
+    return SyncDatabase(
+        driver = driver,
+        CheckInAdapter =
+        CheckIn.Adapter(
+            datetimeAdapter = dateAdapter,
+        ),
+        ClosingAdapter =
+        Closing.Adapter(
+            cash_countedAdapter = bigDecimalAdapter,
+            datetimeAdapter = dateAdapter,
+            payment_sumAdapter = bigDecimalAdapter,
+            payment_sum_cashAdapter = bigDecimalAdapter,
+        ),
+        EventAdapter =
+        Event.Adapter(
+            date_fromAdapter = dateAdapter,
+            date_toAdapter = dateAdapter,
+        ),
+        ReceiptLineAdapter =
+        ReceiptLine.Adapter(
+            cart_expiresAdapter = dateAdapter,
+            createdAdapter = dateAdapter,
+            custom_price_inputAdapter = bigDecimalAdapter,
+            listed_priceAdapter = bigDecimalAdapter,
+            priceAdapter = bigDecimalAdapter,
+            price_after_voucherAdapter = bigDecimalAdapter,
+            tax_rateAdapter = bigDecimalAdapter,
+            tax_valueAdapter = bigDecimalAdapter,
+        ),
+        ReceiptAdapter =
+        Receipt.Adapter(
+            datetime_closedAdapter = dateAdapter,
+            datetime_openedAdapter = dateAdapter,
+        ),
+        ReceiptPaymentAdapter =
+        ReceiptPayment.Adapter(
+            amountAdapter = bigDecimalAdapter,
+        ),
+        SubEventAdapter =
+        SubEvent.Adapter(
+            date_fromAdapter = dateAdapter,
+            date_toAdapter = dateAdapter,
+        ),
+    )
+}
+
+fun readVersionPragma(driver: SqlDriver): Long? {
+    return driver.executeQuery(
+        identifier = null,
+        sql = "PRAGMA user_version;",
+        mapper = { cursor ->
+            cursor.next()
+            QueryResult.Value(cursor.getLong(0))
+        },
+        parameters = 0,
+    ).value
+}

pretixscan/build.gradle

@@ -3,6 +3,7 @@ plugins {
     id 'com.android.application' version '8.4.2' apply false
     id 'org.jetbrains.kotlin.android' version "1.9.23" apply false
     id 'com.google.protobuf' version '0.9.4' apply false
+    id 'app.cash.sqldelight' version '2.0.2' apply false
 }
 
 allprojects {