Migrate five dialogs to Kotlin. https://redmine.stoutner.com/issues/604
[PrivacyBrowser.git] / app / src / main / java / com / stoutner / privacybrowser / dialogs / CreateBookmarkFolderDialog.kt
1 /*
2  * Copyright © 2016-2020 Soren Stoutner <soren@stoutner.com>.
3  *
4  * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
5  *
6  * Privacy Browser is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * Privacy Browser is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Privacy Browser.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 package com.stoutner.privacybrowser.dialogs
20
21 import android.annotation.SuppressLint
22 import android.app.Dialog
23 import android.content.Context
24 import android.content.DialogInterface
25 import android.graphics.Bitmap
26 import android.graphics.BitmapFactory
27 import android.os.Bundle
28 import android.text.Editable
29 import android.text.TextWatcher
30 import android.view.KeyEvent
31 import android.view.View
32 import android.view.WindowManager
33 import android.widget.EditText
34 import android.widget.ImageView
35 import androidx.appcompat.app.AlertDialog
36
37 import androidx.fragment.app.DialogFragment
38 import androidx.preference.PreferenceManager
39
40 import com.stoutner.privacybrowser.R
41 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper
42
43 import java.io.ByteArrayOutputStream
44
45 // Declare the class constants.
46 private const val FAVORITE_ICON_BYTE_ARRAY = "favorite_icon_byte_array"
47
48 class CreateBookmarkFolderDialog: DialogFragment() {
49     // The public interface is used to send information back to the parent activity.
50     interface CreateBookmarkFolderListener {
51         fun onCreateBookmarkFolder(dialogFragment: DialogFragment, favoriteIconBitmap: Bitmap)
52     }
53
54     // Declare the class variables.
55     private lateinit var createBookmarkFolderListener: CreateBookmarkFolderListener
56
57     override fun onAttach(context: Context) {
58         // Run the default commands.
59         super.onAttach(context)
60
61         // Get a handle for the create bookmark folder listener from the launching context.
62         createBookmarkFolderListener = context as CreateBookmarkFolderListener
63     }
64
65     companion object {
66         // `@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.
67         @JvmStatic
68         fun createBookmarkFolder(favoriteIconBitmap: Bitmap): CreateBookmarkFolderDialog {
69             // Create a favorite icon byte array output stream.
70             val favoriteIconByteArrayOutputStream = ByteArrayOutputStream()
71
72             // 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).
73             favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream)
74
75             // Convert the byte array output stream to a byte array.
76             val favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray()
77
78             // Create an arguments bundle.
79             val argumentsBundle = Bundle()
80
81             // Store the favorite icon in the bundle.
82             argumentsBundle.putByteArray(FAVORITE_ICON_BYTE_ARRAY, favoriteIconByteArray)
83
84             // Create a new instance of the dialog.
85             val createBookmarkFolderDialog = CreateBookmarkFolderDialog()
86
87             // Add the bundle to the dialog.
88             createBookmarkFolderDialog.arguments = argumentsBundle
89
90             // Return the new dialog.
91             return createBookmarkFolderDialog
92         }
93     }
94
95     // `@SuppressLint("InflateParams")` removes the warning about using `null` as the parent view group when inflating the alert dialog.
96     @SuppressLint("InflateParams")
97     override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
98         // Get the arguments.
99         val arguments = requireArguments()
100
101         // Get the favorite icon byte array.
102         val favoriteIconByteArray = arguments.getByteArray(FAVORITE_ICON_BYTE_ARRAY)!!
103
104         // Convert the favorite icon byte array to a bitmap.
105         val favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.size)
106
107         // Use an alert dialog builder to create the dialog.
108         val dialogBuilder = AlertDialog.Builder(requireContext(), R.style.PrivacyBrowserAlertDialog)
109
110         // Set the title.
111         dialogBuilder.setTitle(R.string.create_folder)
112
113         // Set the view.  The parent view is null because it will be assigned by the alert dialog.
114         dialogBuilder.setView(requireActivity().layoutInflater.inflate(R.layout.create_bookmark_folder_dialog, null))
115
116         // Set a listener on the cancel button.  Using `null` as the listener closes the dialog without doing anything else.
117         dialogBuilder.setNegativeButton(R.string.cancel, null)
118
119         // Set a listener on the create button.
120         dialogBuilder.setPositiveButton(R.string.create) { _: DialogInterface, _: Int ->
121             // Return the dialog fragment to the parent activity on create.
122             createBookmarkFolderListener.onCreateBookmarkFolder(this, favoriteIconBitmap)
123         }
124
125         // Create an alert dialog from the builder.
126         val alertDialog = dialogBuilder.create()
127
128         // Get a handle for the shared preferences.
129         val sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context)
130
131         // Get the screenshot preference.
132         val allowScreenshots = sharedPreferences.getBoolean(getString(R.string.allow_screenshots_key), false)
133
134         // Disable screenshots if not allowed.
135         if (!allowScreenshots) {
136             alertDialog.window!!.addFlags(WindowManager.LayoutParams.FLAG_SECURE)
137         }
138
139         // Display the keyboard.
140         alertDialog.window!!.setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_STATE_VISIBLE)
141
142         // The alert dialog must be shown before the content can be modified.
143         alertDialog.show()
144
145         // Get handles for the views in the dialog.
146         val webPageIconImageView = alertDialog.findViewById<ImageView>(R.id.create_folder_web_page_icon)!!
147         val folderNameEditText = alertDialog.findViewById<EditText>(R.id.create_folder_name_edittext)!!
148         val createButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE)
149
150         // Display the current favorite icon.
151         webPageIconImageView.setImageBitmap(favoriteIconBitmap)
152
153         // Initially disable the create button.
154         createButton.isEnabled = false
155
156         // Initialize the database helper.  The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
157         val bookmarksDatabaseHelper = BookmarksDatabaseHelper(context, null, null, 0)
158
159         // Enable the create button if the new folder name is unique.
160         folderNameEditText.addTextChangedListener(object: TextWatcher {
161             override fun beforeTextChanged(s: CharSequence, start: Int, count: Int, after: Int) {
162                 // Do nothing.
163             }
164
165             override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {
166                 // Do nothing.
167             }
168
169             override fun afterTextChanged(editable: Editable) {
170                 // Convert the current text to a string.
171                 val folderName = editable.toString()
172
173                 // Check if a folder with the name already exists.
174                 val folderExistsCursor = bookmarksDatabaseHelper.getFolder(folderName)
175
176                 // Enable the create button if the new folder name is not empty and doesn't already exist.
177                 createButton.isEnabled = folderName.isNotEmpty() && (folderExistsCursor.count == 0)
178             }
179         })
180
181         // Set the enter key on the keyboard to create the folder from the edit text.
182         folderNameEditText.setOnKeyListener { _: View?, keyCode: Int, keyEvent: KeyEvent ->
183             // Check the key code, event, and button status.
184             if (keyEvent.action == KeyEvent.ACTION_DOWN && keyCode == KeyEvent.KEYCODE_ENTER && createButton.isEnabled) {  // The event is a key-down on the enter key and the create button is enabled.
185                 // Trigger the create bookmark folder listener and return the dialog fragment to the parent activity.
186                 createBookmarkFolderListener.onCreateBookmarkFolder(this, favoriteIconBitmap)
187
188                 // Manually dismiss the alert dialog.
189                 alertDialog.dismiss()
190
191                 // Consume the event.
192                 return@setOnKeyListener true
193             } else {  // Some other key was pressed or the create button is disabled.
194                 return@setOnKeyListener false
195             }
196         }
197
198         // Return the alert dialog.
199         return alertDialog
200     }
201 }