Implement simple read-only mode

FliegendeWurst · FliegendeWurst · commit 0ef246682bd4 · 2025-04-23T14:28:12.000+02:00
See #81
diff --git a/README.md b/README.md
@@ -66,9 +66,7 @@ If you're any good at Android app development using Kotlin, feel free to contrib
 
 ### Testing
 
-- `app/test/setup-test-server.sh`
-- Gradle action `pixel9api35DebugAndroidTest`
-- `app/test/compare-test-images.sh`
+The app is tested using both unit tests and emulator tests ([details](./app/test/release-testing.md)).
 
 ## License
 
diff --git a/app/src/androidTest/kotlin/eu/fliegendewurst/triliumdroid/InitialSyncTest.kt b/app/src/androidTest/kotlin/eu/fliegendewurst/triliumdroid/InitialSyncTest.kt
@@ -137,6 +137,7 @@ class InitialSyncTest {
 			val id = Notes.getNotesByType("canvas")[0]
 			Preferences.setCanvasViewportOverride(id, CanvasNoteViewport(12.7F, 307.4F, 0.6F))
 		}
+		Thread.sleep(2000) // wait until ready
 
 		openActionBarOverflowOrOptionsMenu(getInstrumentation().targetContext)
 		onView(withText(R.string.jump_to_dialog))
@@ -153,6 +154,7 @@ class InitialSyncTest {
 
 	@Test
 	fun test_011_jumpToNote() {
+		Thread.sleep(2000) // wait until ready
 		openActionBarOverflowOrOptionsMenu(getInstrumentation().targetContext)
 		onView(withText(R.string.jump_to_dialog))
 			.perform(click())
@@ -195,6 +197,7 @@ class InitialSyncTest {
 
 	@Test
 	fun test_012_globalNoteMap() {
+		Thread.sleep(2000) // wait until ready
 		onView(withId(R.id.drawer_layout))
 			.perform(DrawerActions.open(Gravity.START))
 		onView(withText(R.string.sidebar_tab_2))
diff --git a/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/activity/SetupActivity.kt b/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/activity/SetupActivity.kt
@@ -3,6 +3,7 @@ package eu.fliegendewurst.triliumdroid.activity
 import android.app.Activity
 import android.content.Intent
 import android.os.Bundle
+import android.widget.Toast
 import androidx.activity.result.contract.ActivityResultContracts
 import androidx.appcompat.app.AlertDialog
 import androidx.appcompat.app.AppCompatActivity
@@ -17,6 +18,7 @@ import eu.fliegendewurst.triliumdroid.dialog.ConfigureSyncDialog
 import eu.fliegendewurst.triliumdroid.dialog.YesNoDialog
 import eu.fliegendewurst.triliumdroid.service.Option
 import eu.fliegendewurst.triliumdroid.sync.ConnectionUtil
+import eu.fliegendewurst.triliumdroid.util.Preferences
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
 import java.io.File
@@ -181,6 +183,8 @@ class SetupActivity : AppCompatActivity() {
 				binding.status.setText(R.string.status_unknown)
 			}
 		}
+
+		binding.checkboxReadOnly.isChecked = Preferences.readOnlyMode()
 	}
 
 	override fun onStop() {
@@ -195,6 +199,12 @@ class SetupActivity : AppCompatActivity() {
 				Option.revisionIntervalUpdate(newInterval)
 			}
 		}
+
+		val newReadOnly = binding.checkboxReadOnly.isChecked
+		if (newReadOnly != Preferences.readOnlyMode()) {
+			Toast.makeText(this, R.string.hint_read_only_restart, Toast.LENGTH_LONG).show()
+		}
+		Preferences.setReadOnlyMode(newReadOnly)
 	}
 
 	private fun setText() {
diff --git a/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/activity/main/MainActivity.kt b/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/activity/main/MainActivity.kt
@@ -124,6 +124,8 @@ class MainActivity : AppCompatActivity() {
 		binding = ActivityMainBinding.inflate(layoutInflater)
 		setContentView(binding.root)
 
+		val readOnly = Preferences.readOnlyMode()
+
 		val toolbar = binding.toolbar
 		toolbar.title = ""
 		setSupportActionBar(toolbar)
@@ -227,15 +229,27 @@ class MainActivity : AppCompatActivity() {
 			findViewById<Spinner>(R.id.widget_basic_properties_type_content).adapter = adapter
 		}
 
-		binding.root.findViewById<Button>(R.id.button_labels_modify).setOnClickListener {
+		val btnLabelsModify = binding.root.findViewById<Button>(R.id.button_labels_modify)
+		btnLabelsModify.setOnClickListener {
 			ModifyLabelsDialog.showDialog(this, getNoteLoaded() ?: return@setOnClickListener)
 		}
-		binding.root.findViewById<Button>(R.id.button_relations_edit).setOnClickListener {
+		val btnRelationsEdit = binding.root.findViewById<Button>(R.id.button_relations_edit)
+		btnRelationsEdit.setOnClickListener {
 			ModifyRelationsDialog.showDialog(this, getNoteLoaded() ?: return@setOnClickListener)
 		}
-		binding.root.findViewById<Button>(R.id.button_note_paths_add).setOnClickListener {
+		val btnAddNotePath = binding.root.findViewById<Button>(R.id.button_note_paths_add)
+		btnAddNotePath.setOnClickListener {
 			controller.addNotePath(this)
 		}
+		if (readOnly) {
+			btnLabelsModify.visibility = View.GONE
+			btnRelationsEdit.visibility = View.GONE
+			btnAddNotePath.visibility = View.GONE
+		} else {
+			btnLabelsModify.visibility = View.VISIBLE
+			btnRelationsEdit.visibility = View.VISIBLE
+			btnAddNotePath.visibility = View.VISIBLE
+		}
 
 		binding.fab.setOnClickListener {
 			val action = ConfigureFabsDialog.getRightAction()
@@ -379,6 +393,7 @@ class MainActivity : AppCompatActivity() {
 		}
 		val frag = getFragment()
 		val item = menu.findItem(R.id.action_edit)
+		item.isVisible = !Preferences.readOnlyMode()
 		if (frag is NoteEditFragment) {
 			item?.setIcon(R.drawable.bx_save)
 		} else {
diff --git a/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/controller/MainController.kt b/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/controller/MainController.kt
@@ -301,6 +301,9 @@ class MainController {
 		}
 
 		R.id.action_edit -> run {
+			if (Preferences.readOnlyMode()) {
+				return@run true
+			}
 			when (val fragment = activity.getFragment()) {
 				is NoteFragment -> {
 					val id = fragment.getNoteId() ?: return true
@@ -378,7 +381,10 @@ class MainController {
 			true
 		}
 
-		R.id.action_delete -> {
+		R.id.action_delete -> run {
+			if (Preferences.readOnlyMode()) {
+				return@run true
+			}
 			val note = activity.getNoteLoaded()
 			if (note == null || note.id == Notes.ROOT) {
 				Toast.makeText(
@@ -530,6 +536,9 @@ class MainController {
 	 * User clicked on the note icon in the toolbar.
 	 */
 	fun titleIconClicked(activity: MainActivity) {
+		if (Preferences.readOnlyMode()) {
+			return
+		}
 		val note = activity.getNoteLoaded() ?: return
 		NoteIconDialog.showDialogReturningIcon(activity) {
 			activity.lifecycleScope.launch {
@@ -544,6 +553,9 @@ class MainController {
 	 * User clicked on the note title in the action bar.
 	 */
 	fun titleClicked(activity: MainActivity) {
+		if (Preferences.readOnlyMode()) {
+			return
+		}
 		val note = activity.getNoteLoaded() ?: return
 		if (note.isProtected && !ProtectedSession.isActive()) {
 			return
diff --git a/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/database/Blobs.kt b/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/database/Blobs.kt
@@ -11,6 +11,7 @@ import eu.fliegendewurst.triliumdroid.data.RevisionId
 import eu.fliegendewurst.triliumdroid.database.Cache.dateModified
 import eu.fliegendewurst.triliumdroid.database.Cache.utcDateModified
 import eu.fliegendewurst.triliumdroid.service.ProtectedSession
+import eu.fliegendewurst.triliumdroid.util.Preferences
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import java.security.MessageDigest
@@ -118,6 +119,10 @@ object Blobs {
 	 * @return whether the blob was deleted
 	 */
 	suspend fun delete(id: BlobId) = withContext(Dispatchers.IO) {
+		if (Preferences.readOnlyMode()) {
+			Log.w(TAG, "read-only mode ignoring blob delete!")
+			return@withContext false
+		}
 		if (notesWithBlob(id).isNotEmpty() || attachmentsWithBlob(id).isNotEmpty() ||
 			revisionsWithBlob(id).isNotEmpty()
 		) {
diff --git a/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/database/Cache.kt b/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/database/Cache.kt
@@ -46,6 +46,10 @@ object Cache {
 		toHash: List<ByteArray?>,
 		isErased: Boolean = false
 	) = withContext(Dispatchers.IO) {
+		if (Preferences.readOnlyMode()) {
+			Log.w(TAG, "read-only mode ignoring entity change!")
+			return@withContext
+		}
 		val utc = utcDateModified()
 		// https://github.com/TriliumNext/Notes/blob/v0.93.0/src/becca/entities/abstract_becca_entity.ts#L63-L76
 		val md = MessageDigest.getInstance("SHA-1")
diff --git a/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/database/DB.kt b/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/database/DB.kt
@@ -32,7 +32,14 @@ object DB {
 
 	var lastSync: Long? = null
 
+	/**
+	 * @return -1 on error
+	 */
 	suspend fun insert(table: String, vararg columns: Pair<String, Any?>): Long {
+		if (Preferences.readOnlyMode()) {
+			Log.w(TAG, "read-only mode ignoring database insert!")
+			return 0
+		}
 		ensureDatabase()
 		val cv = valuesFromPairs(columns)
 		return withContext(Dispatchers.IO) {
@@ -48,6 +55,10 @@ object DB {
 		onConflict: Int,
 		vararg columns: Pair<String, Any?>
 	): Long {
+		if (Preferences.readOnlyMode()) {
+			Log.w(TAG, "read-only mode ignoring database insert!")
+			return 0
+		}
 		ensureDatabase()
 		val cv = valuesFromPairs(columns)
 		return withContext(Dispatchers.IO) {
@@ -70,6 +81,10 @@ object DB {
 
 	suspend fun delete(table: String, primaryKey: String, selectionArgs: Array<String>) =
 		withContext(Dispatchers.IO) {
+			if (Preferences.readOnlyMode()) {
+				Log.w(TAG, "read-only mode ignoring database delete!")
+				return@withContext 0
+			}
 			ensureDatabase()
 			db!!.delete(table, "$primaryKey = ?", selectionArgs)
 		}
@@ -83,6 +98,10 @@ object DB {
 		columnName: String,
 		generator: () -> String
 	): String = withContext(Dispatchers.IO) {
+		if (Preferences.readOnlyMode()) {
+			Log.w(TAG, "read-only mode ignoring database ID generation!")
+			return@withContext "INVALID"
+		}
 		ensureDatabase()
 		while (true) {
 			val candidate = generator.invoke()
@@ -113,6 +132,11 @@ object DB {
 		return db!!.rawQueryWithFactory(factory, sql, selectionArgs, editTable)
 	}
 
+	/**
+	 * Make sure to respect [Preferences.readOnlyMode] when using the handle.
+	 *
+	 * @return raw database handle
+	 */
 	suspend fun internalGetDatabase(): SQLiteDatabase? {
 		ensureDatabase()
 		return db
diff --git a/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/sync/Sync.kt b/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/sync/Sync.kt
@@ -97,6 +97,7 @@ object Sync {
 			val utc =
 				DateTimeFormatter.ISO_INSTANT.format(OffsetDateTime.now(ZoneOffset.UTC))
 					.replace('T', ' ')
+			// read-only mode: sync must still work
 			DB.internalGetDatabase()!!.execSQL(
 				"INSERT OR REPLACE INTO options (name, value, isSynced, utcDateModified) VALUES (?, ?, 0, ?)",
 				arrayOf("lastSyncedPush", largestId.toString(), utc)
@@ -295,6 +296,7 @@ object Sync {
 									}
 								}
 							}
+							// read-only mode: should still receive database updates
 							DB.internalGetDatabase()!!.insertWithOnConflict(
 								entityName,
 								null,
diff --git a/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/util/Preferences.kt b/app/src/main/kotlin/eu/fliegendewurst/triliumdroid/util/Preferences.kt
@@ -27,6 +27,7 @@ object Preferences {
 	private const val DB_MIGRATION = "dbMigration"
 	private const val DATABASE_VERSION = "databaseVersion"
 	private const val WEB_ASSETS_VERSION = "webAssetsVersion"
+	private const val READ_ONLY_MODE = "readOnlyMode"
 
 	fun init(applicationContext: Context) {
 		prefs = PreferenceManager.getDefaultSharedPreferences(applicationContext)
@@ -89,6 +90,8 @@ object Preferences {
 		return CanvasNoteViewport(x, y, zoom)
 	}
 
+	fun readOnlyMode(): Boolean = prefs.getBoolean(READ_ONLY_MODE, false)
+
 	fun isLeftAction(action: String) = prefs.getBoolean("fab_${action}_left", false)
 	fun isRightAction(action: String) = prefs.getBoolean("fab_${action}_right", false)
 
@@ -117,6 +120,8 @@ object Preferences {
 		putFloat(keyZoom, view.zoom)
 	}
 
+	fun setReadOnlyMode(readOnly: Boolean) = prefs.edit { putBoolean(READ_ONLY_MODE, readOnly) }
+
 	fun setWebAssetsVersion(version: Int) = prefs.edit { putInt(WEB_ASSETS_VERSION, version) }
 
 	fun clearMTLS() = prefs.edit { remove(MTLS_CERT) }
diff --git a/app/src/main/res/layout/activity_setup.xml b/app/src/main/res/layout/activity_setup.xml
@@ -341,6 +341,23 @@
                 android:layout_height="@dimen/divider_height"
                 android:layout_marginBottom="2dp" />
 
+            <CheckBox
+                android:id="@+id/checkbox_read_only"
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:layout_marginStart="@dimen/settings_label_start_margin"
+                android:layout_marginTop="@dimen/normal_margin"
+                android:layout_marginEnd="@dimen/settings_label_start_margin"
+                android:layout_marginBottom="@dimen/normal_margin"
+                android:text="@string/read_only_mode"
+                android:textSize="@dimen/big_text_size" />
+
+            <include
+                layout="@layout/divider"
+                android:layout_width="match_parent"
+                android:layout_height="@dimen/divider_height"
+                android:layout_marginBottom="2dp" />
+
             <!--
             <TextView
                 style="@style/SettingsSectionLabelStyle"
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -157,6 +157,8 @@
     <string name="action_share_note">Share note</string>
     <string name="action_local_note_map">Show local note map</string>
     <string name="label_promoted">Promoted</string>
+    <string name="read_only_mode">Read-only mode</string>
+    <string name="hint_read_only_restart">Read-only mode needs app restart to fully apply</string>
     <!-- FAB IDs: showNoteTree", "jumpToNote", "noteNavigation", "editNote", "shareNote", "deleteNote", "noteMap", "sync" -->
     <string-array name="fabs">
         <item>@string/action_show_note_tree</item>
diff --git a/app/test/release-testing.md b/app/test/release-testing.md
@@ -9,6 +9,8 @@ Check CI status, or run tests locally:
 - Run Gradle task `:app:pixel9api35DebugAndroidTest`
 - Run `./app/test/compare-test-images.sh`
 
+Run `:app:jacocoTestReport` to get a coverage report, if desired.
+
 #### Manual tests
 
 ##### (if database version is incremented)
@@ -19,6 +21,6 @@ Check that the migration works correctly.
 
 - Check that sync pull works.
 - Check that synced changes show up correctly.
-- Make a trivial change: text note / canvas note.
+- Make a trivial change: text note / canvas note / protected text note.
 - Check that sync push works.
 - Check that synced changes show up correctly.
diff --git a/fastlane/metadata/android/en-US/changelogs/14.txt b/fastlane/metadata/android/en-US/changelogs/14.txt
@@ -1,3 +1,7 @@
+Features
+- Read-only mode, disabling all database changes
+
+Bugfixes
 - Fixed bug where the note tree may disappear until restart
 - Fixed error when modifying the same entity twice
 - Fixed NPE when viewing a deleted note

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ package eu.fliegendewurst.triliumdroid.activity`
`3`	`3`	`import android.app.Activity`
`4`	`4`	`import android.content.Intent`
`5`	`5`	`import android.os.Bundle`
	`6`	`+import android.widget.Toast`
`6`	`7`	`import androidx.activity.result.contract.ActivityResultContracts`
`7`	`8`	`import androidx.appcompat.app.AlertDialog`
`8`	`9`	`import androidx.appcompat.app.AppCompatActivity`
`@@ -17,6 +18,7 @@ import eu.fliegendewurst.triliumdroid.dialog.ConfigureSyncDialog`
`17`	`18`	`import eu.fliegendewurst.triliumdroid.dialog.YesNoDialog`
`18`	`19`	`import eu.fliegendewurst.triliumdroid.service.Option`
`19`	`20`	`import eu.fliegendewurst.triliumdroid.sync.ConnectionUtil`
	`21`	`+import eu.fliegendewurst.triliumdroid.util.Preferences`
`20`	`22`	`import kotlinx.coroutines.launch`
`21`	`23`	`import kotlinx.coroutines.runBlocking`
`22`	`24`	`import java.io.File`
`@@ -181,6 +183,8 @@ class SetupActivity : AppCompatActivity() {`
`181`	`183`	`binding.status.setText(R.string.status_unknown)`
`182`	`184`	`}`
`183`	`185`	`}`
	`186`	`+`
	`187`	`+ binding.checkboxReadOnly.isChecked = Preferences.readOnlyMode()`
`184`	`188`	`}`
`185`	`189`
`186`	`190`	`override fun onStop() {`
`@@ -195,6 +199,12 @@ class SetupActivity : AppCompatActivity() {`
`195`	`199`	`Option.revisionIntervalUpdate(newInterval)`
`196`	`200`	`}`
`197`	`201`	`}`
	`202`	`+`
	`203`	`+ val newReadOnly = binding.checkboxReadOnly.isChecked`
	`204`	`+ if (newReadOnly != Preferences.readOnlyMode()) {`
	`205`	`+ Toast.makeText(this, R.string.hint_read_only_restart, Toast.LENGTH_LONG).show()`
	`206`	`+ }`
	`207`	`+ Preferences.setReadOnlyMode(newReadOnly)`
`198`	`208`	`}`
`199`	`209`
`200`	`210`	`private fun setText() {`
Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,7 @@ object Sync {`
`97`	`97`	`val utc =`
`98`	`98`	`DateTimeFormatter.ISO_INSTANT.format(OffsetDateTime.now(ZoneOffset.UTC))`
`99`	`99`	`.replace('T', ' ')`
	`100`	`+ // read-only mode: sync must still work`
`100`	`101`	`DB.internalGetDatabase()!!.execSQL(`
`101`	`102`	`"INSERT OR REPLACE INTO options (name, value, isSynced, utcDateModified) VALUES (?, ?, 0, ?)",`
`102`	`103`	`arrayOf("lastSyncedPush", largestId.toString(), utc)`
`@@ -295,6 +296,7 @@ object Sync {`
`295`	`296`	`}`
`296`	`297`	`}`
`297`	`298`	`}`
	`299`	`+ // read-only mode: should still receive database updates`
`298`	`300`	`DB.internalGetDatabase()!!.insertWithOnConflict(`
`299`	`301`	`entityName,`
`300`	`302`	`null,`