]> gitweb.stoutner.com Git - PrivacyBrowserAndroid.git/blobdiff - app/src/main/java/com/stoutner/privacybrowser/dialogs/EditBookmarkFolderDialog.kt
Migrate five dialogs to Kotlin. https://redmine.stoutner.com/issues/604
[PrivacyBrowserAndroid.git] / app / src / main / java / com / stoutner / privacybrowser / dialogs / EditBookmarkFolderDialog.kt
diff --git a/app/src/main/java/com/stoutner/privacybrowser/dialogs/EditBookmarkFolderDialog.kt b/app/src/main/java/com/stoutner/privacybrowser/dialogs/EditBookmarkFolderDialog.kt
new file mode 100644 (file)
index 0000000..5ff29c5
--- /dev/null
@@ -0,0 +1,258 @@
+/*
+ * Copyright © 2016-2020 Soren Stoutner <soren@stoutner.com>.
+ *
+ * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
+ *
+ * Privacy Browser 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.
+ *
+ * Privacy Browser 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 Privacy Browser.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.stoutner.privacybrowser.dialogs
+
+import android.annotation.SuppressLint
+import android.app.Dialog
+import android.content.Context
+import android.content.DialogInterface
+import android.graphics.Bitmap
+import android.graphics.BitmapFactory
+import android.os.Bundle
+import android.text.Editable
+import android.text.TextWatcher
+import android.view.KeyEvent
+import android.view.View
+import android.view.WindowManager
+import android.widget.Button
+import android.widget.EditText
+import android.widget.ImageView
+import android.widget.RadioButton
+import android.widget.RadioGroup
+
+import androidx.appcompat.app.AlertDialog
+import androidx.fragment.app.DialogFragment
+import androidx.preference.PreferenceManager
+
+import com.stoutner.privacybrowser.R
+import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper
+
+import java.io.ByteArrayOutputStream
+
+// Declare the class constants.
+private const val DATABASE_ID = "database_id"
+private const val FAVORITE_ICON_BYTE_ARRAY = "favorite_icon_byte_array"
+
+class EditBookmarkFolderDialog: DialogFragment() {
+    // The public interface is used to send information back to the parent activity.
+    interface EditBookmarkFolderListener {
+        fun onSaveBookmarkFolder(dialogFragment: DialogFragment?, selectedFolderDatabaseId: Int, favoriteIconBitmap: Bitmap?)
+    }
+
+    // Declare the class variables.
+    private lateinit var editBookmarkFolderListener: EditBookmarkFolderListener
+    private lateinit var bookmarksDatabaseHelper: BookmarksDatabaseHelper
+    private lateinit var currentFolderName: String
+
+    // Declare the class views.
+    private lateinit var currentIconRadioButton: RadioButton
+    private lateinit var folderNameEditText: EditText
+    private lateinit var saveButton: Button
+
+    override fun onAttach(context: Context) {
+        // Run the default commands.
+        super.onAttach(context)
+
+        // Get a handle for the edit bookmark folder listener from the launching context.
+        editBookmarkFolderListener = context as EditBookmarkFolderListener
+    }
+
+    companion object {
+        // `@JvmStatic` will no longer be required once all the code has transitioned to Kotlin.  Also, the function can then be moved out of a companion object and just become a package-level function.
+        @JvmStatic
+        fun folderDatabaseId(databaseId: Int, favoriteIconBitmap: Bitmap): EditBookmarkFolderDialog {
+            // Create a favorite icon byte array output stream.
+            val favoriteIconByteArrayOutputStream = ByteArrayOutputStream()
+
+            // Convert the favorite icon to a PNG and place it in the byte array output stream.  `0` is for lossless compression (the only option for a PNG).
+            favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream)
+
+            // Convert the byte array output stream to a byte array.
+            val favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray()
+
+            // Create an arguments bundle
+            val argumentsBundle = Bundle()
+
+            // Store the variables in the bundle.
+            argumentsBundle.putInt(DATABASE_ID, databaseId)
+            argumentsBundle.putByteArray(FAVORITE_ICON_BYTE_ARRAY, favoriteIconByteArray)
+
+            // Create a new instance of the dialog.
+            val editBookmarkFolderDialog = EditBookmarkFolderDialog()
+
+            // Add the arguments bundle to the dialog.
+            editBookmarkFolderDialog.arguments = argumentsBundle
+
+            // Return the new dialog.
+            return editBookmarkFolderDialog
+        }
+    }
+
+    // `@SuppressLint("InflateParams")` removes the warning about using `null` as the parent view group when inflating the alert dialog.
+    @SuppressLint("InflateParams")
+    override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
+        // Get a handle for the arguments.
+        val arguments = requireArguments()
+
+        // Get the variables from the arguments.
+        val selectedFolderDatabaseId = arguments.getInt(DATABASE_ID)
+        val favoriteIconByteArray = arguments.getByteArray(FAVORITE_ICON_BYTE_ARRAY)!!
+
+        // Convert the favorite icon byte array to a bitmap.
+        val favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.size)
+
+        // Initialize the database helper.  The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
+        bookmarksDatabaseHelper = BookmarksDatabaseHelper(context, null, null, 0)
+
+        // Get a cursor with the selected folder.
+        val folderCursor = bookmarksDatabaseHelper.getBookmark(selectedFolderDatabaseId)
+
+        // Move the cursor to the first position.
+        folderCursor.moveToFirst()
+
+        // Use an alert dialog builder to create the alert dialog.
+        val dialogBuilder = AlertDialog.Builder(requireContext(), R.style.PrivacyBrowserAlertDialog)
+
+        // Set the title.
+        dialogBuilder.setTitle(R.string.edit_folder)
+
+        // Set the view.  The parent view is `null` because it will be assigned by `AlertDialog`.
+        dialogBuilder.setView(requireActivity().layoutInflater.inflate(R.layout.edit_bookmark_folder_dialog, null))
+
+        // Set the cancel button listener.  Using `null` as the listener closes the dialog without doing anything else.
+        dialogBuilder.setNegativeButton(R.string.cancel, null)
+
+        // Set the save button listener.
+        dialogBuilder.setPositiveButton(R.string.save) { _: DialogInterface?, _: Int ->
+            // Return the dialog fragment to the parent activity on save.
+            editBookmarkFolderListener.onSaveBookmarkFolder(this, selectedFolderDatabaseId, favoriteIconBitmap)
+        }
+
+        // Create an alert dialog from the alert dialog builder.
+        val alertDialog = dialogBuilder.create()
+
+        // Get a handle for the shared preferences.
+        val sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context)
+
+        // Get the screenshot preference.
+        val allowScreenshots = sharedPreferences.getBoolean(getString(R.string.allow_screenshots_key), false)
+
+        // Disable screenshots if not allowed.
+        if (!allowScreenshots) {
+            alertDialog.window!!.addFlags(WindowManager.LayoutParams.FLAG_SECURE)
+        }
+
+        // The alert dialog must be shown before items in the layout can be modified.
+        alertDialog.show()
+
+        // Get handles for the views in the alert dialog.
+        val iconRadioGroup = alertDialog.findViewById<RadioGroup>(R.id.edit_folder_icon_radio_group)!!
+        currentIconRadioButton = alertDialog.findViewById(R.id.edit_folder_current_icon_radiobutton)!!
+        val currentIconImageView = alertDialog.findViewById<ImageView>(R.id.edit_folder_current_icon_imageview)!!
+        val webPageFavoriteIconImageView = alertDialog.findViewById<ImageView>(R.id.edit_folder_web_page_favorite_icon_imageview)!!
+        folderNameEditText = alertDialog.findViewById(R.id.edit_folder_name_edittext)!!
+        saveButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE)
+
+        // Get the current favorite icon byte array from the cursor.
+        val currentIconByteArray = folderCursor.getBlob(folderCursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON))
+
+        // Convert the byte array to a bitmap beginning at the first byte and ending at the last.
+        val currentIconBitmap = BitmapFactory.decodeByteArray(currentIconByteArray, 0, currentIconByteArray.size)
+
+        // Display the current icon bitmap.
+        currentIconImageView.setImageBitmap(currentIconBitmap)
+
+        // Set the new favorite icon bitmap.
+        webPageFavoriteIconImageView.setImageBitmap(favoriteIconBitmap)
+
+        // Get the current folder name.
+        currentFolderName = folderCursor.getString(folderCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME))
+
+        // Display the current folder name.
+        folderNameEditText.setText(currentFolderName)
+
+        // Initially disable the save button.
+        saveButton.isEnabled = false
+
+        // Update the status of the save button when the folder name is changed.
+        folderNameEditText.addTextChangedListener(object: TextWatcher {
+            override fun beforeTextChanged(s: CharSequence, start: Int, count: Int, after: Int) {
+                // Do nothing.
+            }
+
+            override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {
+                // Do nothing.
+            }
+
+            override fun afterTextChanged(s: Editable) {
+                // Update the save button.
+                updateSaveButton()
+            }
+        })
+
+        // Update the status of the save button when the icon is changed.
+        iconRadioGroup.setOnCheckedChangeListener { _: RadioGroup?, _: Int ->
+            // Update the save button.
+            updateSaveButton()
+        }
+
+        // Allow the enter key on the keyboard to save the bookmark from the edit bookmark name edit text.
+        folderNameEditText.setOnKeyListener { _: View?, keyCode: Int, event: KeyEvent ->
+            // Check the key code, event, and button status.
+            if (event.action == KeyEvent.ACTION_DOWN && keyCode == KeyEvent.KEYCODE_ENTER && saveButton.isEnabled) {  // The enter key was pressed and the save button is enabled.
+                // Trigger the listener and return the dialog fragment to the parent activity.
+                editBookmarkFolderListener.onSaveBookmarkFolder(this, selectedFolderDatabaseId, favoriteIconBitmap)
+
+                // Manually dismiss the the alert dialog.
+                alertDialog.dismiss()
+
+                // Consume the event.
+                return@setOnKeyListener true
+            } else {  // If any other key was pressed, or if the save button is currently disabled, do not consume the event.
+                return@setOnKeyListener false
+            }
+        }
+
+        // Return the alert dialog.
+        return alertDialog
+    }
+
+    private fun updateSaveButton() {
+        // Get the new folder name.
+        val newFolderName = folderNameEditText.text.toString()
+
+        // Get a cursor for the new folder name if it exists.
+        val folderExistsCursor = bookmarksDatabaseHelper.getFolder(newFolderName)
+
+        // Is the new folder name empty?
+        val folderNameEmpty = newFolderName.isEmpty()
+
+        // Does the folder name already exist?
+        val folderNameAlreadyExists = (newFolderName != currentFolderName) && folderExistsCursor.count > 0
+
+        // Has the folder been renamed?
+        val folderRenamed = (newFolderName != currentFolderName) && !folderNameAlreadyExists
+
+        // Has the favorite icon changed?
+        val iconChanged = !currentIconRadioButton.isChecked && !folderNameAlreadyExists
+
+        // Enable the save button if something has been edited and the new folder name is valid.
+        saveButton.isEnabled = !folderNameEmpty && (folderRenamed || iconChanged)
+    }
+}
\ No newline at end of file