Merge branch 'main' into feat/implement-auto-suggestion

Author: angrezichatterbox

README.md

@@ -17,7 +17,7 @@
 <!-- <a href='https://play.google.com/store/apps'><img alt='Get it on Google Play' src='https://raw.githubusercontent.com/scribe-org/Organization/main/resources/images/badges/google_play_badge.png' height='60px'/></a>
 <a href='https://f-droid.org/packages/'><img src='https://raw.githubusercontent.com/scribe-org/Organization/main/resources/images/badges/f_droid_badge.png' alt='Get it on F-Droid' height='60px' /></a> -->
 
-### Android app with keyboards for language learners
+### Scribe-Android: Keyboards for language learners & Conjugate-Android: Wikidata based verb conjugation app
 
 #### WIP port of [Scribe-iOS](https://github.com/scribe-org/Scribe-iOS): see [Issues](https://github.com/scribe-org/Scribe-Android/issues)
 

app/src/main/java/be/scri/App.kt

@@ -43,6 +43,7 @@ import be.scri.ui.screens.ThirdPartyScreen
 import be.scri.ui.screens.WikimediaScreen
 import be.scri.ui.screens.about.AboutScreen
 import be.scri.ui.screens.download.CheckUpdateActions
+import be.scri.ui.screens.download.ConjugateDataDownloadViewModel
 import be.scri.ui.screens.download.ConjugateDownloadDataScreen
 import be.scri.ui.screens.download.DataDownloadViewModel
 import be.scri.ui.screens.download.DownloadActions
@@ -85,6 +86,7 @@ fun ScribeApp(
     isIncreaseTextSize: Boolean,
     modifier: Modifier = Modifier,
     downloadViewModel: DataDownloadViewModel = viewModel(),
+    conjugateDownloadViewModel: ConjugateDataDownloadViewModel = viewModel(),
 ) {
     val coroutineScope = rememberCoroutineScope()
     val navBackStackEntry by navController.currentBackStackEntryAsState()
@@ -107,6 +109,26 @@ fun ScribeApp(
             cancelCheckForNewData = downloadViewModel::cancelCheckForNewData,
         )
 
+    // Conjugate-specific download actions
+    val conjugateDownloadStates = conjugateDownloadViewModel.downloadStates
+    val onConjugateDownloadAction = conjugateDownloadViewModel::handleDownloadAction
+    val onConjugateDownloadAll = conjugateDownloadViewModel::handleDownloadAllLanguages
+    val initializeConjugateStates = conjugateDownloadViewModel::initializeStates
+    val conjugateDownloadActions =
+        DownloadActions(
+            downloadStates = conjugateDownloadStates,
+            onDownloadAction = onConjugateDownloadAction,
+            onDownloadAll = onConjugateDownloadAll,
+            initializeStates = initializeConjugateStates,
+        )
+    val conjugateCheckUpdateState by conjugateDownloadViewModel.checkUpdateState.collectAsState()
+    val conjugateCheckUpdateActions =
+        CheckUpdateActions(
+            checkUpdateState = conjugateCheckUpdateState,
+            checkForNewData = conjugateDownloadViewModel::checkForNewData,
+            cancelCheckForNewData = conjugateDownloadViewModel::cancelCheckForNewData,
+        )
+
     val screens = remember(context) { BottomBarScreen.getScreens() }
     ScribeTheme(
         useDarkTheme = isDarkTheme,
@@ -265,8 +287,8 @@ fun ScribeApp(
                             navController.popBackStack()
                         },
                         isDarkTheme = isDarkTheme,
-                        downloadActions = downloadActions,
-                        checkUpdateActions = checkUpdateActions,
+                        downloadActions = conjugateDownloadActions,
+                        checkUpdateActions = conjugateCheckUpdateActions,
                         modifier = Modifier.padding(innerPadding),
                     )
                 }

app/src/main/java/be/scri/data/remote/ConjugateDynamicDbHelper.kt

@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+package be.scri.data.remote
+
+import android.content.ContentValues
+import android.content.Context
+import android.database.sqlite.SQLiteDatabase
+import android.database.sqlite.SQLiteException
+import android.database.sqlite.SQLiteOpenHelper
+import android.util.Log
+import be.scri.data.model.DataResponse
+
+/**
+ * Helper class for managing dynamic SQLite databases for conjugate data (verbs only).
+ * It creates only the verbs table and inserts verb data according to the provided DataResponse.
+ */
+class ConjugateDynamicDbHelper(
+    context: Context,
+    language: String,
+) : SQLiteOpenHelper(context, "${language.uppercase()}ConjugateData.sqlite", null, 1) {
+    override fun onCreate(db: SQLiteDatabase) {
+        // Tables are created dynamically via syncConjugateDatabase from API contract.
+    }
+
+    override fun onUpgrade(
+        db: SQLiteDatabase,
+        old: Int,
+        new: Int,
+    ) {
+        // Dynamic schema updates are handled via syncConjugateDatabase.
+    }
+
+    /**
+     * Synchronizes the conjugate database schema and data based on the provided DataResponse.
+     * Only creates the verbs table and inserts verb data, ignoring other data types.
+     * @param response The data response containing the contract and data to be inserted.
+     */
+    fun syncConjugateDatabase(response: DataResponse) {
+        val db = writableDatabase
+        try {
+            db.beginTransaction()
+
+            // Check if verbs table exists in the contract
+            val verbsColumns = response.contract.fields["verbs"]
+            if (verbsColumns != null) {
+                // Create verbs table
+                val colDefinition = verbsColumns.keys.joinToString(", ") { "$it TEXT" }
+                db.execSQL("DROP TABLE IF EXISTS verbs")
+                db.execSQL(
+                    "CREATE TABLE verbs " +
+                        "(id INTEGER PRIMARY KEY AUTOINCREMENT, $colDefinition)",
+                )
+
+                // Insert verbs data
+                val verbsData = response.data["verbs"]
+                if (verbsData != null) {
+                    val cv = ContentValues()
+                    verbsData.forEach { row ->
+                        cv.clear()
+                        row.forEach { (key, value) ->
+                            cv.put(key, value?.toString() ?: "")
+                        }
+                        db.insert("verbs", null, cv)
+                    }
+                    Log.i("CONJUGATE_DB", "Successfully synced ${verbsData.size} verb records for ${response.language}")
+                } else {
+                    Log.w("CONJUGATE_DB", "No verbs data found in response for ${response.language}")
+                }
+            } else {
+                Log.e("CONJUGATE_DB", "No verbs table found in contract for ${response.language}")
+            }
+
+            db.setTransactionSuccessful()
+        } catch (e: SQLiteException) {
+            Log.e("CONJUGATE_DB", "Error during conjugate database sync: ${e.message}")
+            throw e
+        } finally {
+            db.endTransaction()
+            db.close()
+        }
+    }
+}

app/src/main/java/be/scri/helpers/DatabaseFileManager.kt

@@ -63,6 +63,31 @@ class DatabaseFileManager(
         return getDatabase(dbName, "data/$dbName")
     }
 
+    /**
+     * Retrieves a read-only [SQLiteDatabase] instance for conjugate data (verbs only).
+     * This database is created specifically for the Conjugate app and contains only verb data.
+     *
+     * @param language The language code (e.g., "DE", "FR") used to determine the database filename.
+     *
+     * @return An open, read-only [SQLiteDatabase] instance, or `null` on failure.
+     */
+    fun getConjugateDatabase(language: String): SQLiteDatabase? {
+        val dbName = "${language}ConjugateData.sqlite"
+        val dbFile = context.getDatabasePath(dbName)
+
+        if (!dbFile.exists()) {
+            Log.w(TAG, "Conjugate database $dbName not found. User needs to download conjugate data first")
+            return null
+        }
+
+        return try {
+            SQLiteDatabase.openDatabase(dbFile.path, null, SQLiteDatabase.OPEN_READONLY)
+        } catch (e: SQLiteException) {
+            Log.e(TAG, "Failed to open conjugate database $dbName", e)
+            null
+        }
+    }
+
     /**
      * A generic function to get a database. It ensures the database file exists in the app's
      * private storage (copying it from assets if necessary) and then opens a read-only connection.

app/src/main/java/be/scri/helpers/KeyHandler.kt

@@ -20,9 +20,9 @@ import be.scri.services.GeneralKeyboardIME.ScribeState
 class KeyHandler(
     private val ime: GeneralKeyboardIME,
 ) {
-    private val suggestionHandler = SuggestionHandler(ime)
+    private val suggestionHandler = ime.suggestionHandler
     private val spaceKeyProcessor = SpaceKeyProcessor(ime, suggestionHandler)
-    private val autocompletionHandler = AutocompletionHandler(ime)
+    private val autocompletionHandler = ime.autocompletionHandler
 
     /** Tracks if the last key pressed was a space, used for "period on double space" logic. */
     private var wasLastKeySpace: Boolean = false

app/src/main/java/be/scri/helpers/data/ConjugateDataManager.kt

@@ -91,7 +91,7 @@ class ConjugateDataManager(
         language: String,
     ): String {
         if (form.isNullOrEmpty()) return ""
-        return fileManager.getLanguageDatabase(language)?.use { db ->
+        return fileManager.getConjugateDatabase(language)?.use { db ->
             if (!db.tableExists("verbs")) {
                 return ""
             }
@@ -170,7 +170,7 @@ class ConjugateDataManager(
 
                 val targetForm = words.first()
 
-                val db = fileManager.getLanguageDatabase(language = language)
+                val db = fileManager.getConjugateDatabase(language = language)
                 var auxResult = ""
 
                 val auxCursor =

app/src/main/java/be/scri/helpers/ui/KeyboardUIManager.kt

@@ -62,13 +62,17 @@ class KeyboardUIManager(
 
         fun getKeyboardLayoutXML(): Int
 
+        fun getCurrentKeyboardLayoutXML(): Int
+
         fun getCurrentEnterKeyType(): Int
 
         fun commitText(text: String)
 
         fun onKeyboardActionListener(): KeyboardView.OnKeyboardActionListener
 
         fun processLinguisticSuggestions(word: String)
+
+        fun isNumericKeyboardActive(): Boolean
     }
 
     var keyboardView: KeyboardView = binding.keyboardView
@@ -159,7 +163,12 @@ class KeyboardUIManager(
         val isUserDarkMode = getIsDarkModeOrNot(context)
 
         when (currentState) {
-            ScribeState.IDLE -> setupIdleView(language, emojiAutoSuggestionEnabled, autoSuggestEmojis)
+            ScribeState.IDLE ->
+                setupIdleView(
+                    language,
+                    emojiAutoSuggestionEnabled,
+                    autoSuggestEmojis,
+                )
             ScribeState.SELECT_COMMAND -> setupSelectCommandView(language)
             ScribeState.INVALID -> setupInvalidView(language, invalidCommandSource)
             ScribeState.TRANSLATE -> {
@@ -184,7 +193,7 @@ class KeyboardUIManager(
         emojiAutoSuggestionEnabled: Boolean,
         autoSuggestEmojis: MutableList<String>?,
     ) {
-        binding.commandOptionsBar.visibility = View.VISIBLE
+        binding.commandOptionsBar.visibility = if (listener.isNumericKeyboardActive()) View.GONE else View.VISIBLE
         binding.toolbarBar.visibility = View.GONE
 
         val isUserDarkMode = getIsDarkModeOrNot(context)
@@ -226,7 +235,11 @@ class KeyboardUIManager(
 
         binding.scribeKeyOptions.foreground = AppCompatResources.getDrawable(context, R.drawable.ic_scribe_icon_vector)
 
-        initializeKeyboard(listener.getKeyboardLayoutXML())
+        val keyboardXml = listener.getCurrentKeyboardLayoutXML()
+        initializeKeyboard(keyboardXml)
+        if (keyboardXml == R.xml.keys_symbols) {
+            setupCurrencySymbol(language)
+        }
 
         updateButtonVisibility(ScribeState.IDLE, emojiAutoSuggestionEnabled, autoSuggestEmojis)
         updateEmojiSuggestion(ScribeState.IDLE, emojiAutoSuggestionEnabled, autoSuggestEmojis)
@@ -239,7 +252,7 @@ class KeyboardUIManager(
      * (Translate, Conjugate, Plural).
      */
     private fun setupSelectCommandView(language: String) {
-        binding.commandOptionsBar.visibility = View.VISIBLE
+        binding.commandOptionsBar.visibility = if (listener.isNumericKeyboardActive()) View.GONE else View.VISIBLE
         binding.toolbarBar.visibility = View.GONE
 
         val isUserDarkMode = getIsDarkModeOrNot(context)
@@ -786,6 +799,8 @@ class KeyboardUIManager(
      * Disables all auto-suggestions and resets the suggestion buttons to their default, inactive state.
      */
     fun disableAutoSuggest(language: String) {
+        val isNumericKeyboard = listener.getCurrentKeyboardLayoutXML() == R.xml.keys_numeric
+
         binding.translateBtnRight.visibility = View.INVISIBLE
         binding.translateBtnLeft.visibility = View.INVISIBLE
         binding.translateBtn.visibility = View.VISIBLE
@@ -801,9 +816,20 @@ class KeyboardUIManager(
         binding.translateBtn.background = null
         binding.translateBtn.setOnClickListener(createSuggestionClickListener(suggestion1))
 
-        val suggestion2 = suggestions.getOrNull(1) ?: ""
-        binding.conjugateBtn.text = suggestion2
-        binding.conjugateBtn.setOnClickListener(createSuggestionClickListener(suggestion2))
+        if (isNumericKeyboard) {
+            binding.conjugateBtn.text = ""
+            binding.conjugateBtn.setOnClickListener(null)
+            binding.conjugateBtn.visibility = View.GONE
+            binding.separator2.visibility = View.GONE
+            binding.separator3.visibility = View.GONE
+        } else {
+            val suggestion2 = suggestions.getOrNull(1) ?: ""
+            binding.conjugateBtn.visibility = View.VISIBLE
+            binding.conjugateBtn.text = suggestion2
+            binding.conjugateBtn.setOnClickListener(createSuggestionClickListener(suggestion2))
+            binding.separator2.visibility = View.VISIBLE
+            binding.separator3.visibility = View.VISIBLE
+        }
 
         val suggestion3 = suggestions.getOrNull(2) ?: ""
         binding.pluralBtn.text = suggestion3

app/src/main/java/be/scri/services/EnglishKeyboardIME.kt

@@ -32,7 +32,6 @@ class EnglishKeyboardIME : GeneralKeyboardIME("English") {
     override var inputTypeClass: Int = InputType.TYPE_CLASS_TEXT
     override var enterKeyType: Int = IME_ACTION_NONE
     override var switchToLetters: Boolean = false
-    override var hasTextBeforeCursor: Boolean = false
 
     private val keyHandler by lazy { KeyHandler(this) }