From c8d1017b1532b49c6c18dc3c59294e06937a2224 Mon Sep 17 00:00:00 2001 From: Jean-Luc Makiola Date: Sat, 14 Nov 2026 04:35:56 +0100 Subject: [PATCH] fix(#38): too-large reads through BackupFiles, plain "w" for the fresh temp file --- .../clockula/backup/BackupFiles.kt | 5 ++++- .../clockula/backup/android/SafBackupFiles.kt | 19 +++++++++++++++---- .../clockula/data/backup/BackupCodec.kt | 1 - .../clockula/data/backup/BackupDto.kt | 6 ------ .../clockula/ui/settings/BackupViewModel.kt | 4 ++-- .../ui/settings/BackupViewModelTest.kt | 16 ++++++++++++++++ docs/BACKUP.md | 5 +++-- floret-kit | 2 +- 8 files changed, 41 insertions(+), 17 deletions(-) diff --git a/app/src/main/java/de/jeanlucmakiola/clockula/backup/BackupFiles.kt b/app/src/main/java/de/jeanlucmakiola/clockula/backup/BackupFiles.kt index 4ffd1f5..4ed66fb 100644 --- a/app/src/main/java/de/jeanlucmakiola/clockula/backup/BackupFiles.kt +++ b/app/src/main/java/de/jeanlucmakiola/clockula/backup/BackupFiles.kt @@ -3,6 +3,9 @@ package de.jeanlucmakiola.clockula.backup /** The fixed filename a backup is written to inside the user-chosen folder (`docs/PLAN.md` §7). */ const val BACKUP_FILE_NAME: String = "clockula-backup-v1.json" +/** The picked document is larger than a backup can be. */ +class BackupTooLargeException : java.io.IOException("backup exceeds the 8 MiB limit") + /** * The on-device side of export/import: writing/reading the JSON text through * SAF. [BackupEngine] does not know this is SAF — it only knows these two @@ -12,6 +15,6 @@ interface BackupFiles { /** Writes [content] as [BACKUP_FILE_NAME] inside the folder [treeUri] names, overwriting any existing one. */ suspend fun write(treeUri: String, content: String): Result - /** Reads whatever text is at [documentUri]. */ + /** Reads whatever text is at [documentUri]; fails with [BackupTooLargeException] past the size limit. */ suspend fun read(documentUri: String): Result } diff --git a/app/src/main/java/de/jeanlucmakiola/clockula/backup/android/SafBackupFiles.kt b/app/src/main/java/de/jeanlucmakiola/clockula/backup/android/SafBackupFiles.kt index ad315da..46d9524 100644 --- a/app/src/main/java/de/jeanlucmakiola/clockula/backup/android/SafBackupFiles.kt +++ b/app/src/main/java/de/jeanlucmakiola/clockula/backup/android/SafBackupFiles.kt @@ -6,7 +6,8 @@ import androidx.documentfile.provider.DocumentFile import dagger.hilt.android.qualifiers.ApplicationContext import de.jeanlucmakiola.clockula.backup.BACKUP_FILE_NAME import de.jeanlucmakiola.clockula.backup.BackupFiles -import de.jeanlucmakiola.clockula.data.backup.MAX_BACKUP_BYTES +import de.jeanlucmakiola.clockula.backup.BackupTooLargeException +import de.jeanlucmakiola.floret.android.DocumentTooLargeException import de.jeanlucmakiola.floret.android.readDocumentBytes import de.jeanlucmakiola.floret.android.writeDocumentBytes import de.jeanlucmakiola.floret.di.IoDispatcher @@ -32,14 +33,15 @@ class SafBackupFiles @Inject constructor( override suspend fun write(treeUri: String, content: String): Result = withContext(io) { runCatching { val bytes = content.toByteArray(Charsets.UTF_8) - if (bytes.size > MAX_BACKUP_BYTES) throw IOException("backup exceeds the 8 MiB limit") + if (bytes.size > MAX_BACKUP_BYTES) throw BackupTooLargeException() val tree = DocumentFile.fromTreeUri(context, treeUri.toUri()) ?: error("could not open the chosen folder") val temporary = tree.createFile("application/json", "$BACKUP_FILE_NAME.${UUID.randomUUID()}.tmp") ?: throw IOException("could not create a temporary backup") var keepTemporary = false try { - context.contentResolver.writeDocumentBytes(temporary.uri, bytes) + // Just created and empty: plain "w", as before, works on every provider. + context.contentResolver.writeDocumentBytes(temporary.uri, bytes, truncate = false) val existing = tree.findFile(BACKUP_FILE_NAME) if (existing != null && !existing.delete()) throw IOException("could not remove the previous backup") // Some SAF providers cannot rename. Once the old file has been @@ -57,7 +59,16 @@ class SafBackupFiles @Inject constructor( override suspend fun read(documentUri: String): Result = withContext(io) { runCatching { - context.contentResolver.readDocumentBytes(documentUri.toUri(), MAX_BACKUP_BYTES).toString(Charsets.UTF_8) + val bytes = try { + context.contentResolver.readDocumentBytes(documentUri.toUri(), MAX_BACKUP_BYTES) + } catch (e: DocumentTooLargeException) { + throw BackupTooLargeException() + } + bytes.toString(Charsets.UTF_8) } } + + private companion object { + const val MAX_BACKUP_BYTES = 8 * 1024 * 1024 + } } diff --git a/app/src/main/java/de/jeanlucmakiola/clockula/data/backup/BackupCodec.kt b/app/src/main/java/de/jeanlucmakiola/clockula/data/backup/BackupCodec.kt index 012e9b0..690560e 100644 --- a/app/src/main/java/de/jeanlucmakiola/clockula/data/backup/BackupCodec.kt +++ b/app/src/main/java/de/jeanlucmakiola/clockula/data/backup/BackupCodec.kt @@ -53,7 +53,6 @@ object BackupCodec { name = BACKUP_FORMAT, version = BACKUP_VERSION, minVersion = BACKUP_MIN_VERSION, - maxChars = MAX_BACKUP_CHARS, ) private const val MAX_ALARMS = 10_000 private const val MAX_TIMERS = 10_000 diff --git a/app/src/main/java/de/jeanlucmakiola/clockula/data/backup/BackupDto.kt b/app/src/main/java/de/jeanlucmakiola/clockula/data/backup/BackupDto.kt index 6b763d5..bdc4857 100644 --- a/app/src/main/java/de/jeanlucmakiola/clockula/data/backup/BackupDto.kt +++ b/app/src/main/java/de/jeanlucmakiola/clockula/data/backup/BackupDto.kt @@ -12,12 +12,6 @@ const val BACKUP_VERSION: Int = 2 /** The oldest version this build still reads. v1 is v2 without the alarm dates. */ const val BACKUP_MIN_VERSION: Int = 1 -/** The longest backup Clockula decodes, in characters. */ -const val MAX_BACKUP_CHARS: Int = 8 * 1024 * 1024 - -/** The largest backup file Clockula reads or writes, in bytes. */ -const val MAX_BACKUP_BYTES: Int = 8 * 1024 * 1024 - /** * The wire shape of `clockula-backup-v1.json`. `format`, `version` and * `exportedAt` are floret core-backup's envelope keys and checked by its diff --git a/app/src/main/java/de/jeanlucmakiola/clockula/ui/settings/BackupViewModel.kt b/app/src/main/java/de/jeanlucmakiola/clockula/ui/settings/BackupViewModel.kt index 92ab7e0..0787d2b 100644 --- a/app/src/main/java/de/jeanlucmakiola/clockula/ui/settings/BackupViewModel.kt +++ b/app/src/main/java/de/jeanlucmakiola/clockula/ui/settings/BackupViewModel.kt @@ -5,8 +5,8 @@ import androidx.lifecycle.viewModelScope import dagger.hilt.android.lifecycle.HiltViewModel import de.jeanlucmakiola.clockula.backup.BackupEngine import de.jeanlucmakiola.clockula.backup.BackupFiles +import de.jeanlucmakiola.clockula.backup.BackupTooLargeException import de.jeanlucmakiola.clockula.data.backup.BackupCodec -import de.jeanlucmakiola.floret.android.DocumentTooLargeException import de.jeanlucmakiola.floret.backup.BackupProblem import de.jeanlucmakiola.floret.backup.BackupResult import kotlinx.coroutines.channels.Channel @@ -75,7 +75,7 @@ class BackupViewModel @Inject internal constructor( } else { val failure = result.exceptionOrNull() if (failure is CancellationException) throw failure - val problem = if (failure is DocumentTooLargeException) BackupProblem.TOO_LARGE else BackupProblem.UNREADABLE + val problem = if (failure is BackupTooLargeException) BackupProblem.TOO_LARGE else BackupProblem.UNREADABLE BackupEvent.ImportFailed(problem) } _events.trySend(event) diff --git a/app/src/test/java/de/jeanlucmakiola/clockula/ui/settings/BackupViewModelTest.kt b/app/src/test/java/de/jeanlucmakiola/clockula/ui/settings/BackupViewModelTest.kt index 98bfdfe..d218894 100644 --- a/app/src/test/java/de/jeanlucmakiola/clockula/ui/settings/BackupViewModelTest.kt +++ b/app/src/test/java/de/jeanlucmakiola/clockula/ui/settings/BackupViewModelTest.kt @@ -2,6 +2,7 @@ package de.jeanlucmakiola.clockula.ui.settings import com.google.common.truth.Truth.assertThat import de.jeanlucmakiola.clockula.backup.BackupFiles +import de.jeanlucmakiola.clockula.backup.BackupTooLargeException import de.jeanlucmakiola.clockula.data.backup.BackupCodec import de.jeanlucmakiola.floret.backup.BackupProblem import de.jeanlucmakiola.clockula.testing.MainDispatcherExtension @@ -53,4 +54,19 @@ class BackupViewModelTest { assertThat(viewModel.events.first()).isEqualTo(BackupEvent.ImportFailed(BackupProblem.NOT_APPLIED)) assertThat(viewModel.busy.value).isFalse() } + + @Test + fun `an oversized file is reported as too large`(@TempDir tempDir: Path) = runTest(main.dispatcher) { + val harness = backupHarness(tempDir) + val files = object : BackupFiles { + override suspend fun write(treeUri: String, content: String): Result = error("unused") + + override suspend fun read(documentUri: String): Result = Result.failure(BackupTooLargeException()) + } + val viewModel = BackupViewModel(harness.backupEngine, files) + + viewModel.onImportFilePicked("content://backup") + + assertThat(viewModel.events.first()).isEqualTo(BackupEvent.ImportFailed(BackupProblem.TOO_LARGE)) + } } diff --git a/docs/BACKUP.md b/docs/BACKUP.md index 0a2cbac..d9b1e38 100644 --- a/docs/BACKUP.md +++ b/docs/BACKUP.md @@ -6,8 +6,9 @@ own data, written to (and read from) a user-chosen folder via SAF (`data/backup/BackupDto.kt`, `BackupCodec.kt`) implements exactly what is written here. The envelope keys (`format`, `version`, `exportedAt`) and the format, version and size rules are floret-kit `core-backup`'s `BackupFormat`, -shared with Calendula's settings backup; the file is still decoded in one -streaming pass into Clockula's own classes. +shared with Calendula's settings backup. The file is still decoded in one +streaming pass into Clockula's own classes, which also accept a number +written as a string where floret's tree reader would not. ## Top level diff --git a/floret-kit b/floret-kit index 236674a..066c2f8 160000 --- a/floret-kit +++ b/floret-kit @@ -1 +1 @@ -Subproject commit 236674ab9954ebec03e069c7c4e32c0c258381c1 +Subproject commit 066c2f84306e5d8d9d527f975149a81d60799ce5