Remove unlinked data as database preference #684

2025-12-04 15:49:33 +01:00 · 2020-09-14 12:13:26 +02:00
parent 097feb6437
commit 44d175dd40
8 changed files with 214 additions and 17 deletions
--- a/app/src/main/java/com/kunzisoft/keepass/database/action/ProgressDatabaseTaskProvider.kt
+++ b/app/src/main/java/com/kunzisoft/keepass/database/action/ProgressDatabaseTaskProvider.kt
@@ -23,7 +23,6 @@ import android.content.*
 import android.content.Context.BIND_ABOVE_CLIENT
 import android.content.Context.BIND_NOT_FOREGROUND
 import android.net.Uri
-import android.os.Build
 import android.os.Bundle
 import android.os.IBinder
 import androidx.fragment.app.FragmentActivity
@@ -46,6 +45,7 @@ import com.kunzisoft.keepass.notifications.DatabaseTaskNotificationService.Compa
 import com.kunzisoft.keepass.notifications.DatabaseTaskNotificationService.Companion.ACTION_DATABASE_DELETE_NODES_TASK
 import com.kunzisoft.keepass.notifications.DatabaseTaskNotificationService.Companion.ACTION_DATABASE_LOAD_TASK
 import com.kunzisoft.keepass.notifications.DatabaseTaskNotificationService.Companion.ACTION_DATABASE_MOVE_NODES_TASK
+import com.kunzisoft.keepass.notifications.DatabaseTaskNotificationService.Companion.ACTION_DATABASE_REMOVE_UNLINKED_DATA_TASK
 import com.kunzisoft.keepass.notifications.DatabaseTaskNotificationService.Companion.ACTION_DATABASE_RESTORE_ENTRY_HISTORY
 import com.kunzisoft.keepass.notifications.DatabaseTaskNotificationService.Companion.ACTION_DATABASE_SAVE
 import com.kunzisoft.keepass.notifications.DatabaseTaskNotificationService.Companion.ACTION_DATABASE_UPDATE_COLOR_TASK
@@ -463,6 +463,13 @@ class ProgressDatabaseTaskProvider(private val activity: FragmentActivity) {
                , ACTION_DATABASE_UPDATE_COMPRESSION_TASK)
    }

+    fun startDatabaseRemoveUnlinkedData(save: Boolean) {
+        start(Bundle().apply {
+            putBoolean(DatabaseTaskNotificationService.SAVE_DATABASE_KEY, save)
+        }
+                , ACTION_DATABASE_REMOVE_UNLINKED_DATA_TASK)
+    }
+
    fun startDatabaseSaveMaxHistoryItems(oldMaxHistoryItems: Int,
                                         newMaxHistoryItems: Int,
                                         save: Boolean) {
--- a/app/src/main/java/com/kunzisoft/keepass/database/action/RemoveUnlinkedDataDatabaseRunnable.kt
+++ b/app/src/main/java/com/kunzisoft/keepass/database/action/RemoveUnlinkedDataDatabaseRunnable.kt
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2020 Jeremy Jamet / Kunzisoft.
+ *     
+ * This file is part of KeePassDX.
+ *
+ *  KeePassDX is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  KeePassDX is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with KeePassDX.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+package com.kunzisoft.keepass.database.action
+
+import android.content.Context
+import com.kunzisoft.keepass.database.element.Database
+
+class RemoveUnlinkedDataDatabaseRunnable (
+        context: Context,
+        database: Database,
+        saveDatabase: Boolean)
+    : SaveDatabaseRunnable(context, database, saveDatabase) {
+
+    override fun onActionRun() {
+        try {
+            database.removeUnlinkedAttachments()
+        } catch (e: Exception) {
+            setError(e)
+        }
+
+        super.onActionRun()
+    }
+}
--- a/app/src/main/java/com/kunzisoft/keepass/notifications/DatabaseTaskNotificationService.kt
+++ b/app/src/main/java/com/kunzisoft/keepass/notifications/DatabaseTaskNotificationService.kt
@@ -141,6 +141,7 @@ open class DatabaseTaskNotificationService : LockNotificationService(), Progress
            ACTION_DATABASE_RESTORE_ENTRY_HISTORY -> buildDatabaseRestoreEntryHistoryActionTask(intent)
            ACTION_DATABASE_DELETE_ENTRY_HISTORY -> buildDatabaseDeleteEntryHistoryActionTask(intent)
            ACTION_DATABASE_UPDATE_COMPRESSION_TASK -> buildDatabaseUpdateCompressionActionTask(intent)
+            ACTION_DATABASE_REMOVE_UNLINKED_DATA_TASK -> buildDatabaseRemoveUnlinkedDataActionTask(intent)
            ACTION_DATABASE_UPDATE_NAME_TASK,
            ACTION_DATABASE_UPDATE_DESCRIPTION_TASK,
            ACTION_DATABASE_UPDATE_DEFAULT_USERNAME_TASK,
@@ -711,6 +712,22 @@ open class DatabaseTaskNotificationService : LockNotificationService(), Progress
        }
    }

+    private fun buildDatabaseRemoveUnlinkedDataActionTask(intent: Intent): ActionRunnable? {
+        return if (intent.hasExtra(SAVE_DATABASE_KEY)) {
+
+            return RemoveUnlinkedDataDatabaseRunnable(this,
+                    mDatabase,
+                    intent.getBooleanExtra(SAVE_DATABASE_KEY, false)
+            ).apply {
+                mAfterSaveDatabase = { result ->
+                    result.data = intent.extras
+                }
+            }
+        } else {
+            null
+        }
+    }
+
    private fun buildDatabaseUpdateElementActionTask(intent: Intent): ActionRunnable? {
        return if (intent.hasExtra(SAVE_DATABASE_KEY)) {
            return SaveDatabaseRunnable(this,
@@ -760,6 +777,7 @@ open class DatabaseTaskNotificationService : LockNotificationService(), Progress
        const val ACTION_DATABASE_UPDATE_DEFAULT_USERNAME_TASK = "ACTION_DATABASE_UPDATE_DEFAULT_USERNAME_TASK"
        const val ACTION_DATABASE_UPDATE_COLOR_TASK = "ACTION_DATABASE_UPDATE_COLOR_TASK"
        const val ACTION_DATABASE_UPDATE_COMPRESSION_TASK = "ACTION_DATABASE_UPDATE_COMPRESSION_TASK"
+        const val ACTION_DATABASE_REMOVE_UNLINKED_DATA_TASK = "ACTION_DATABASE_REMOVE_UNLINKED_DATA_TASK"
        const val ACTION_DATABASE_UPDATE_MAX_HISTORY_ITEMS_TASK = "ACTION_DATABASE_UPDATE_MAX_HISTORY_ITEMS_TASK"
        const val ACTION_DATABASE_UPDATE_MAX_HISTORY_SIZE_TASK = "ACTION_DATABASE_UPDATE_MAX_HISTORY_SIZE_TASK"
        const val ACTION_DATABASE_UPDATE_ENCRYPTION_TASK = "ACTION_DATABASE_UPDATE_ENCRYPTION_TASK"
--- a/app/src/main/java/com/kunzisoft/keepass/settings/NestedDatabaseSettingsFragment.kt
+++ b/app/src/main/java/com/kunzisoft/keepass/settings/NestedDatabaseSettingsFragment.kt
@@ -30,7 +30,6 @@ import androidx.preference.SwitchPreference
 import com.kunzisoft.androidclearchroma.ChromaUtil
 import com.kunzisoft.keepass.R
 import com.kunzisoft.keepass.activities.dialogs.AssignMasterKeyDialogFragment
-import com.kunzisoft.keepass.activities.dialogs.RemoveUnlinkedAttachmentsDialogFragment
 import com.kunzisoft.keepass.activities.helpers.ReadOnlyHelper
 import com.kunzisoft.keepass.crypto.keyDerivation.KdfEngine
 import com.kunzisoft.keepass.database.element.Database
@@ -42,8 +41,7 @@ import com.kunzisoft.keepass.settings.preferencedialogfragment.*
 import com.kunzisoft.keepass.tasks.ActionRunnable
 import com.kunzisoft.keepass.utils.MenuUtil

-class NestedDatabaseSettingsFragment : NestedSettingsFragment(),
-    RemoveUnlinkedAttachmentsDialogFragment.ActionChooseListener {
+class NestedDatabaseSettingsFragment : NestedSettingsFragment() {

    private var mDatabase: Database = Database.getInstance()
    private var mDatabaseReadOnly: Boolean = false
@@ -151,14 +149,6 @@ class NestedDatabaseSettingsFragment : NestedSettingsFragment(),
            val dbRecycleBinPrefCategory: PreferenceCategory? = findPreference(getString(R.string.database_category_recycle_bin_key))
            recycleBinGroupPref = findPreference(getString(R.string.recycle_bin_group_key))

-            val removeUnlinkedAttachments: Preference? = findPreference(getString(R.string.database_data_remove_unlinked_attachments_key))
-            removeUnlinkedAttachments?.setOnPreferenceClickListener {
-                RemoveUnlinkedAttachmentsDialogFragment.build().apply {
-                    setTargetFragment(this@NestedDatabaseSettingsFragment, 0)
-                }.show(parentFragmentManager, "remove_unlinked_dialog")
-                true
-            }
-
            // Recycle bin
            if (mDatabase.allowConfigurableRecycleBin) {
                val recycleBinEnablePref: SwitchPreference? = findPreference(getString(R.string.recycle_bin_enable_key))
@@ -209,10 +199,6 @@ class NestedDatabaseSettingsFragment : NestedSettingsFragment(),
        }
    }

-    override fun onValidateRemoveUnlinkedAttachments() {
-        mDatabase.removeUnlinkedAttachments()
-    }
-
    private fun refreshRecycleBinGroup() {
        recycleBinGroupPref?.apply {
            if (mDatabase.isRecycleBinEnabled) {
@@ -496,6 +482,9 @@ class NestedDatabaseSettingsFragment : NestedSettingsFragment(),
            getString(R.string.database_data_compression_key) -> {
                dialogFragment = DatabaseDataCompressionPreferenceDialogFragmentCompat.newInstance(preference.key)
            }
+            getString(R.string.database_data_remove_unlinked_attachments_key) -> {
+                dialogFragment = DatabaseRemoveUnlinkedDataPreferenceDialogFragmentCompat.newInstance(preference.key)
+            }
            getString(R.string.max_history_items_key) -> {
                dialogFragment = MaxHistoryItemsPreferenceDialogFragmentCompat.newInstance(preference.key)
            }
--- a/app/src/main/java/com/kunzisoft/keepass/settings/preference/TextPreference.kt
+++ b/app/src/main/java/com/kunzisoft/keepass/settings/preference/TextPreference.kt
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2019 Jeremy Jamet / Kunzisoft.
+ *
+ * This file is part of KeePassDX.
+ *
+ *  KeePassDX is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  KeePassDX is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with KeePassDX.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+package com.kunzisoft.keepass.settings.preference
+
+import android.content.Context
+import androidx.preference.DialogPreference
+import android.util.AttributeSet
+
+import com.kunzisoft.keepass.R
+
+open class TextPreference @JvmOverloads constructor(context: Context,
+                                                    attrs: AttributeSet? = null,
+                                                    defStyleAttr: Int = R.attr.dialogPreferenceStyle,
+                                                    defStyleRes: Int = defStyleAttr)
+    : DialogPreference(context, attrs, defStyleAttr, defStyleRes) {
+
+    override fun getDialogLayoutResource(): Int {
+        return R.layout.pref_dialog_text
+    }
+}
--- a/app/src/main/java/com/kunzisoft/keepass/settings/preferencedialogfragment/DatabaseRemoveUnlinkedDataPreferenceDialogFragmentCompat.kt
+++ b/app/src/main/java/com/kunzisoft/keepass/settings/preferencedialogfragment/DatabaseRemoveUnlinkedDataPreferenceDialogFragmentCompat.kt
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2019 Jeremy Jamet / Kunzisoft.
+ *
+ * This file is part of KeePassDX.
+ *
+ *  KeePassDX is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  KeePassDX is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with KeePassDX.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+package com.kunzisoft.keepass.settings.preferencedialogfragment
+
+import android.os.Bundle
+import android.text.SpannableStringBuilder
+import android.view.View
+import com.kunzisoft.keepass.R
+
+class DatabaseRemoveUnlinkedDataPreferenceDialogFragmentCompat : DatabaseSavePreferenceDialogFragmentCompat() {
+
+    override fun onBindDialogView(view: View) {
+        super.onBindDialogView(view)
+
+        explanationText = SpannableStringBuilder().apply {
+            append(getString(R.string.warning_remove_unlinked_attachment))
+            append("\n\n")
+            append(getString(R.string.warning_sure_remove_data))
+        }.toString()
+    }
+
+    override fun onDialogClosed(positiveResult: Boolean) {
+        database?.let { _ ->
+            if (positiveResult) {
+                mProgressDatabaseTaskProvider?.startDatabaseRemoveUnlinkedData(mDatabaseAutoSaveEnable)
+            }
+        }
+    }
+
+    companion object {
+
+        fun newInstance(key: String): DatabaseRemoveUnlinkedDataPreferenceDialogFragmentCompat {
+            val fragment = DatabaseRemoveUnlinkedDataPreferenceDialogFragmentCompat()
+            val bundle = Bundle(1)
+            bundle.putString(ARG_KEY, key)
+            fragment.arguments = bundle
+
+            return fragment
+        }
+    }
+}
--- a/app/src/main/res/layout/pref_dialog_text.xml
+++ b/app/src/main/res/layout/pref_dialog_text.xml
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ Copyright 2019 Jeremy Jamet / Kunzisoft.
+     
+ This file is part of KeePassDX.
+
+  KeePassDX is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  KeePassDX is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with KeePassDX.  If not, see <http://www.gnu.org/licenses/>.
+-->
+<androidx.constraintlayout.widget.ConstraintLayout
+	xmlns:android="http://schemas.android.com/apk/res/android"
+	xmlns:tools="http://schemas.android.com/tools"
+	xmlns:app="http://schemas.android.com/apk/res-auto"
+	android:id="@+id/edit"
+	android:padding="20dp"
+	android:orientation="vertical"
+	android:layout_width="match_parent"
+	android:layout_height="match_parent"
+	android:importantForAutofill="noExcludeDescendants"
+	tools:targetApi="o">
+	<androidx.appcompat.widget.AppCompatTextView
+		android:id="@+id/explanation_text"
+		android:layout_height="wrap_content"
+		android:layout_width="0dp"
+		android:layout_marginBottom="8dp"
+		app:layout_constraintTop_toTopOf="parent"
+		app:layout_constraintStart_toStartOf="parent"
+		app:layout_constraintEnd_toEndOf="parent"
+		style="@style/KeepassDXStyle.TextAppearance.SmallTitle"/>
+	<androidx.appcompat.widget.SwitchCompat
+		android:id="@+id/switch_element"
+		android:layout_width="wrap_content"
+		android:layout_height="wrap_content"
+		android:text="@string/enable"
+		app:layout_constraintTop_toBottomOf="@+id/explanation_text"
+		app:layout_constraintStart_toStartOf="parent"
+		android:minHeight="48dp"/>
+</androidx.constraintlayout.widget.ConstraintLayout>
--- a/app/src/main/res/xml/preferences_database.xml
+++ b/app/src/main/res/xml/preferences_database.xml
@@ -67,7 +67,7 @@
            android:persistent="false"
            android:title="@string/database_data_compression_title"/>

-        <Preference
+        <com.kunzisoft.keepass.settings.preference.TextPreference
            android:key="@string/database_data_remove_unlinked_attachments_key"
            android:persistent="false"
            android:title="@string/database_data_remove_unlinked_attachments_title"