Allow try again or restart when no backups found

grote · grote · commit f209ee9d270e · 2025-03-20T16:53:09.000-03:00
diff --git a/app/src/main/java/com/stevesoltys/seedvault/backend/BackendManager.kt b/app/src/main/java/com/stevesoltys/seedvault/backend/BackendManager.kt
@@ -101,6 +101,21 @@ class BackendManager(
         // TODO not critical, but nice to have: clear also local snapshot cache
     }
 
+    /**
+     * Clears the storage plugins and current [BackendProperties].
+     *
+     * IMPORTANT: Do no call this while current plugins are being used,
+     *            e.g. while backup/restore operation is still running.
+     */
+    @WorkerThread
+    @Synchronized
+    fun removePlugins() {
+        settingsManager.clearStorageBackend()
+        mBackend = null
+        mBackendProperties = null
+        blobCache.clearLocalCache()
+    }
+
     /**
      * Check if we are able to do backups now by examining possible pre-conditions
      * such as plugged-in flash drive or internet access.
diff --git a/app/src/main/java/com/stevesoltys/seedvault/crypto/KeyManager.kt b/app/src/main/java/com/stevesoltys/seedvault/crypto/KeyManager.kt
@@ -57,6 +57,11 @@ interface KeyManager : org.calyxos.seedvault.core.crypto.KeyManager {
      * because the key can not leave the [KeyStore]'s hardware security module.
      */
     fun getBackupKey(): SecretKey
+
+    /**
+     * Removes the backup key from the [KeyStore]. Use with care!
+     */
+    fun removeBackupKey()
 }
 
 internal class KeyManagerImpl(
@@ -86,6 +91,10 @@ internal class KeyManagerImpl(
         return ksEntry.secretKey
     }
 
+    override fun removeBackupKey() {
+        keyStore.deleteEntry(KEY_ALIAS_BACKUP)
+    }
+
     override fun getMainKey(): SecretKey {
         val ksEntry = keyStore.getEntry(KEY_ALIAS_MAIN, null) as SecretKeyEntry
         return ksEntry.secretKey
diff --git a/app/src/main/java/com/stevesoltys/seedvault/restore/RestoreSetFragment.kt b/app/src/main/java/com/stevesoltys/seedvault/restore/RestoreSetFragment.kt
@@ -6,17 +6,22 @@
 package com.stevesoltys.seedvault.restore
 
 import android.os.Bundle
+import android.text.method.ScrollingMovementMethod
 import android.view.LayoutInflater
 import android.view.View
 import android.view.View.INVISIBLE
 import android.view.View.VISIBLE
 import android.view.ViewGroup
+import android.widget.Button
 import android.widget.ProgressBar
 import android.widget.TextView
 import androidx.fragment.app.Fragment
+import androidx.lifecycle.lifecycleScope
 import androidx.recyclerview.widget.RecyclerView
+import androidx.transition.TransitionManager.beginDelayedTransition
 import com.stevesoltys.seedvault.R
 import com.stevesoltys.seedvault.transport.restore.RestorableBackup
+import kotlinx.coroutines.launch
 import org.koin.androidx.viewmodel.ext.android.activityViewModel
 
 class RestoreSetFragment : Fragment() {
@@ -26,6 +31,8 @@ class RestoreSetFragment : Fragment() {
     private lateinit var listView: RecyclerView
     private lateinit var progressBar: ProgressBar
     private lateinit var errorView: TextView
+    private lateinit var tryAgainButton: Button
+    private lateinit var restartButton: Button
     private lateinit var skipView: TextView
 
     override fun onCreateView(
@@ -38,6 +45,8 @@ class RestoreSetFragment : Fragment() {
         listView = v.requireViewById(R.id.listView)
         progressBar = v.requireViewById(R.id.progressBar)
         errorView = v.requireViewById(R.id.errorView)
+        tryAgainButton = v.requireViewById(R.id.tryAgainButton)
+        restartButton = v.requireViewById(R.id.restartButton)
         skipView = v.requireViewById(R.id.skipView)
 
         return v
@@ -65,12 +74,19 @@ class RestoreSetFragment : Fragment() {
     private fun onRestoreResultsLoaded(results: RestoreSetResult) {
         if (results.hasError()) {
             errorView.visibility = VISIBLE
+            tryAgainButton.visibility = VISIBLE
+            if (viewModel.isSetupWizard) restartButton.visibility = VISIBLE
             listView.visibility = INVISIBLE
             progressBar.visibility = INVISIBLE
 
             errorView.text = results.errorMsg
+            errorView.movementMethod = ScrollingMovementMethod()
+            tryAgainButton.setOnClickListener { tryAgain() }
+            restartButton.setOnClickListener { restart() }
         } else {
             errorView.visibility = INVISIBLE
+            tryAgainButton.visibility = INVISIBLE
+            restartButton.visibility = INVISIBLE
             listView.visibility = VISIBLE
             progressBar.visibility = INVISIBLE
 
@@ -81,6 +97,26 @@ class RestoreSetFragment : Fragment() {
         }
     }
 
+    private fun tryAgain() {
+        beginDelayedTransition(view as ViewGroup)
+
+        progressBar.visibility = VISIBLE
+        listView.visibility = VISIBLE
+
+        errorView.visibility = INVISIBLE
+        tryAgainButton.visibility = INVISIBLE
+        restartButton.visibility = INVISIBLE
+
+        viewModel.loadRestoreSets()
+    }
+
+    private fun restart() {
+        lifecycleScope.launch {
+            viewModel.restartRestore()
+            requireActivity().recreate()
+        }
+    }
+
 }
 
 internal interface RestorableBackupClickListener {
diff --git a/app/src/main/java/com/stevesoltys/seedvault/restore/RestoreViewModel.kt b/app/src/main/java/com/stevesoltys/seedvault/restore/RestoreViewModel.kt
@@ -48,6 +48,7 @@ import kotlinx.coroutines.DelicateCoroutinesApi
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
 import org.calyxos.backup.storage.api.SnapshotItem
 import org.calyxos.backup.storage.api.StorageBackup
 import org.calyxos.backup.storage.api.StoredSnapshot
@@ -116,6 +117,8 @@ internal class RestoreViewModel(
             is ErrorResult -> {
                 val msg = if (backups.e == null) {
                     app.getString(R.string.restore_set_empty_result)
+                } else if (backups.e.message?.contains("BAD_DECRYPT") == true) {
+                    app.getString(R.string.restore_set_bad_decrypt)
                 } else {
                     app.getString(R.string.restore_set_error) + "\n\n${backups.e}"
                 }
@@ -180,6 +183,11 @@ internal class RestoreViewModel(
         GlobalScope.launch(ioDispatcher) { iconManager.removeIcons() }
     }
 
+    internal suspend fun restartRestore() = withContext(ioDispatcher) {
+        keyManager.removeBackupKey()
+        backendManager.removePlugins()
+    }
+
     @UiThread
     internal fun onFinishClickedAfterRestoringAppData() {
         val backup = chosenRestorableBackup.value
diff --git a/app/src/main/java/com/stevesoltys/seedvault/settings/SettingsManager.kt b/app/src/main/java/com/stevesoltys/seedvault/settings/SettingsManager.kt
@@ -8,8 +8,9 @@ package com.stevesoltys.seedvault.settings
 import android.content.Context
 import android.content.SharedPreferences.OnSharedPreferenceChangeListener
 import android.hardware.usb.UsbDevice
-import android.net.Uri
 import androidx.annotation.UiThread
+import androidx.core.content.edit
+import androidx.core.net.toUri
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.MutableLiveData
 import androidx.preference.PreferenceManager
@@ -81,13 +82,13 @@ class SettingsManager(private val context: Context) {
     var token: Long? = null
         private set(newToken) {
             if (newToken == null) {
-                prefs.edit()
-                    .remove(PREF_KEY_TOKEN)
-                    .apply()
+                prefs.edit {
+                    remove(PREF_KEY_TOKEN)
+                }
             } else {
-                prefs.edit()
-                    .putLong(PREF_KEY_TOKEN, newToken)
-                    .apply()
+                prefs.edit {
+                    putLong(PREF_KEY_TOKEN, newToken)
+                }
             }
             field = newToken
         }
@@ -105,9 +106,9 @@ class SettingsManager(private val context: Context) {
                 // check if this is an existing user that needs to be migrated
                 // this check could be removed after a reasonable migration time (added 2024)
                 if (prefs.getString(PREF_KEY_STORAGE_URI, null) != null) {
-                    prefs.edit()
-                        .putString(PREF_KEY_STORAGE_PLUGIN, StoragePluginType.SAF.name)
-                        .apply()
+                    prefs.edit {
+                        putString(PREF_KEY_STORAGE_PLUGIN, StoragePluginType.SAF.name)
+                    }
                     StoragePluginType.SAF
                 } else null
             } else savedType.let {
@@ -130,7 +131,7 @@ class SettingsManager(private val context: Context) {
     fun onSuccessfulBackupCompleted(token: Long) {
         this.token = token
         val now = System.currentTimeMillis()
-        prefs.edit().putLong(PREF_KEY_LAST_BACKUP, now).apply()
+        prefs.edit { putLong(PREF_KEY_LAST_BACKUP, now) }
         mLastBackupTime.postValue(now)
     }
 
@@ -140,24 +141,30 @@ class SettingsManager(private val context: Context) {
             BackendId.WEBDAV -> StoragePluginType.WEB_DAV
             else -> error("Unsupported plugin: ${plugin::class.java.simpleName}")
         }.name
-        prefs.edit()
-            .putString(PREF_KEY_STORAGE_PLUGIN, value)
-            .apply()
+        prefs.edit {
+            putString(PREF_KEY_STORAGE_PLUGIN, value)
+        }
+    }
+
+    fun clearStorageBackend() {
+        prefs.edit {
+            putString(PREF_KEY_STORAGE_PLUGIN, null)
+        }
     }
 
     fun setSafProperties(safProperties: SafProperties) {
-        prefs.edit()
-            .putString(PREF_KEY_STORAGE_URI, safProperties.uri.toString())
-            .putString(PREF_KEY_STORAGE_ROOT_ID, safProperties.rootId)
-            .putString(PREF_KEY_STORAGE_NAME, safProperties.name)
-            .putBoolean(PREF_KEY_STORAGE_IS_USB, safProperties.isUsb)
-            .putBoolean(PREF_KEY_STORAGE_REQUIRES_NETWORK, safProperties.requiresNetwork)
-            .apply()
+        prefs.edit {
+            putString(PREF_KEY_STORAGE_URI, safProperties.uri.toString())
+            putString(PREF_KEY_STORAGE_ROOT_ID, safProperties.rootId)
+            putString(PREF_KEY_STORAGE_NAME, safProperties.name)
+            putBoolean(PREF_KEY_STORAGE_IS_USB, safProperties.isUsb)
+            putBoolean(PREF_KEY_STORAGE_REQUIRES_NETWORK, safProperties.requiresNetwork)
+        }
     }
 
     fun getSafProperties(): SafProperties? {
         val uriStr = prefs.getString(PREF_KEY_STORAGE_URI, null) ?: return null
-        val uri = Uri.parse(uriStr)
+        val uri = uriStr.toUri()
         val name = prefs.getString(PREF_KEY_STORAGE_NAME, null)
             ?: throw IllegalStateException("no storage name")
         val isUsb = prefs.getBoolean(PREF_KEY_STORAGE_IS_USB, false)
@@ -168,19 +175,19 @@ class SettingsManager(private val context: Context) {
 
     fun setFlashDrive(usb: FlashDrive?) {
         if (usb == null) {
-            prefs.edit()
-                .remove(PREF_KEY_FLASH_DRIVE_NAME)
-                .remove(PREF_KEY_FLASH_DRIVE_SERIAL_NUMBER)
-                .remove(PREF_KEY_FLASH_DRIVE_VENDOR_ID)
-                .remove(PREF_KEY_FLASH_DRIVE_PRODUCT_ID)
-                .apply()
+            prefs.edit {
+                remove(PREF_KEY_FLASH_DRIVE_NAME)
+                remove(PREF_KEY_FLASH_DRIVE_SERIAL_NUMBER)
+                remove(PREF_KEY_FLASH_DRIVE_VENDOR_ID)
+                remove(PREF_KEY_FLASH_DRIVE_PRODUCT_ID)
+            }
         } else {
-            prefs.edit()
-                .putString(PREF_KEY_FLASH_DRIVE_NAME, usb.name)
-                .putString(PREF_KEY_FLASH_DRIVE_SERIAL_NUMBER, usb.serialNumber)
-                .putInt(PREF_KEY_FLASH_DRIVE_VENDOR_ID, usb.vendorId)
-                .putInt(PREF_KEY_FLASH_DRIVE_PRODUCT_ID, usb.productId)
-                .apply()
+            prefs.edit {
+                putString(PREF_KEY_FLASH_DRIVE_NAME, usb.name)
+                putString(PREF_KEY_FLASH_DRIVE_SERIAL_NUMBER, usb.serialNumber)
+                putInt(PREF_KEY_FLASH_DRIVE_VENDOR_ID, usb.vendorId)
+                putInt(PREF_KEY_FLASH_DRIVE_PRODUCT_ID, usb.productId)
+            }
         }
     }
 
@@ -203,11 +210,11 @@ class SettingsManager(private val context: Context) {
         }
 
     fun saveWebDavConfig(config: WebDavConfig) {
-        prefs.edit()
-            .putString(PREF_KEY_WEBDAV_URL, config.url)
-            .putString(PREF_KEY_WEBDAV_USER, config.username)
-            .putString(PREF_KEY_WEBDAV_PASS, config.password)
-            .apply()
+        prefs.edit {
+            putString(PREF_KEY_WEBDAV_URL, config.url)
+            putString(PREF_KEY_WEBDAV_USER, config.username)
+            putString(PREF_KEY_WEBDAV_PASS, config.password)
+        }
     }
 
     fun backupApks(): Boolean {
@@ -231,7 +238,7 @@ class SettingsManager(private val context: Context) {
      */
     fun disableBackup(packageName: String) {
         if (blacklistedApps.add(packageName)) {
-            prefs.edit().putStringSet(PREF_KEY_BACKUP_APP_BLACKLIST, blacklistedApps).apply()
+            prefs.edit { putStringSet(PREF_KEY_BACKUP_APP_BLACKLIST, blacklistedApps) }
         }
     }
 
@@ -241,7 +248,7 @@ class SettingsManager(private val context: Context) {
     fun onAppBackupStatusChanged(status: AppStatus) {
         if (status.enabled) blacklistedApps.remove(status.packageName)
         else blacklistedApps.add(status.packageName)
-        prefs.edit().putStringSet(PREF_KEY_BACKUP_APP_BLACKLIST, blacklistedApps).apply()
+        prefs.edit { putStringSet(PREF_KEY_BACKUP_APP_BLACKLIST, blacklistedApps) }
     }
 
     val quota: Long = 3L * 1024 * 1024 * 1024 // 3 GiB for now
diff --git a/app/src/main/res/layout/fragment_restore_set.xml b/app/src/main/res/layout/fragment_restore_set.xml
@@ -1,5 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!--
+<?xml version="1.0" encoding="utf-8"?><!--
   SPDX-FileCopyrightText: 2020 The Calyx Institute
   SPDX-License-Identifier: Apache-2.0
   -->
@@ -57,23 +56,55 @@
         style="@style/SudContent"
         android:layout_width="0dp"
         android:layout_height="wrap_content"
+        android:scrollbars="vertical"
         android:textColor="?android:colorError"
         android:textSize="18sp"
         android:visibility="invisible"
-        app:layout_constraintBottom_toTopOf="@+id/skipView"
+        app:layout_constrainedHeight="true"
+        app:layout_constraintBottom_toTopOf="@+id/tryAgainButton"
         app:layout_constraintEnd_toEndOf="parent"
         app:layout_constraintStart_toStartOf="parent"
         app:layout_constraintTop_toBottomOf="@+id/titleView"
-        tools:text="@string/restore_set_empty_result"
+        app:layout_constraintVertical_bias="0.25"
+        tools:text="wlsjdfsdfljsdflkjsdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf\nsdf;lmsdf;lmsd;flmsdf;msdf"
+        tools:visibility="visible" />
+
+    <Button
+        android:id="@+id/tryAgainButton"
+        style="@style/Widget.Material3.Button.OutlinedButton"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_marginTop="16dp"
+        android:text="@string/restore_set_button_try_again"
+        android:visibility="invisible"
+        app:layout_constraintEnd_toEndOf="@+id/errorView"
+        app:layout_constraintStart_toStartOf="@+id/errorView"
+        app:layout_constraintTop_toBottomOf="@+id/errorView"
+        tools:visibility="visible" />
+
+    <Button
+        android:id="@+id/restartButton"
+        style="@style/Widget.Material3.Button.OutlinedButton"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_marginTop="16dp"
+        android:layout_marginBottom="16dp"
+        android:text="@string/restore_set_button_restart"
+        android:visibility="invisible"
+        app:layout_constraintBottom_toTopOf="@+id/skipView"
+        app:layout_constraintEnd_toEndOf="@+id/errorView"
+        app:layout_constraintStart_toStartOf="@+id/errorView"
+        app:layout_constraintTop_toBottomOf="@+id/tryAgainButton"
+        app:layout_constraintVertical_bias="0"
         tools:visibility="visible" />
 
     <TextView
         android:id="@+id/skipView"
         style="@style/SudSecondaryButton"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
-        android:background="?android:selectableItemBackground"
         android:layout_marginStart="40dp"
+        android:background="?android:selectableItemBackground"
         android:text="@string/restore_skip_apps"
         app:layout_constraintBottom_toBottomOf="parent"
         app:layout_constraintStart_toStartOf="parent"
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
