]> gitweb.stoutner.com Git - PrivacyBrowserAndroid.git/blob - app/src/main/java/com/stoutner/privacybrowser/dialogs/CreateHomeScreenShortcutDialog.kt
Change the night access color to light violet. https://redmine.stoutner.com/issues/572
[PrivacyBrowserAndroid.git] / app / src / main / java / com / stoutner / privacybrowser / dialogs / CreateHomeScreenShortcutDialog.kt
1 /*
2  * Copyright © 2015-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
20 package com.stoutner.privacybrowser.dialogs
21
22 import android.annotation.SuppressLint
23 import android.app.Dialog
24 import android.content.DialogInterface
25 import android.content.Intent
26 import android.graphics.Bitmap
27 import android.graphics.BitmapFactory
28 import android.graphics.drawable.BitmapDrawable
29 import android.graphics.drawable.Drawable
30 import android.net.Uri
31 import android.os.Bundle
32 import android.text.Editable
33 import android.text.TextWatcher
34 import android.view.KeyEvent
35 import android.view.View
36 import android.view.WindowManager
37 import android.widget.Button
38 import android.widget.EditText
39 import android.widget.RadioButton
40
41 import androidx.appcompat.app.AlertDialog
42 import androidx.core.content.pm.ShortcutInfoCompat
43 import androidx.core.content.pm.ShortcutManagerCompat
44 import androidx.core.graphics.drawable.IconCompat
45 import androidx.fragment.app.DialogFragment
46 import androidx.preference.PreferenceManager
47
48 import com.stoutner.privacybrowser.BuildConfig
49 import com.stoutner.privacybrowser.R
50
51 import java.io.ByteArrayOutputStream
52
53 class CreateHomeScreenShortcutDialog: DialogFragment() {
54     // Define the class variables.
55     private lateinit var shortcutNameEditText: EditText
56     private lateinit var urlEditText: EditText
57     private lateinit var openWithPrivacyBrowserRadioButton: RadioButton
58
59     companion object {
60         // `@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.
61         @JvmStatic
62         fun createDialog(shortcutName: String, urlString: String, favoriteIconBitmap: Bitmap): CreateHomeScreenShortcutDialog {
63             // Create a favorite icon byte array output stream.
64             val favoriteIconByteArrayOutputStream = ByteArrayOutputStream()
65
66             // 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).
67             favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream)
68
69             // Convert the byte array output stream to a byte array.
70             val favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray()
71
72             // Create an arguments bundle.
73             val argumentsBundle = Bundle()
74
75             // Store the variables in the bundle.
76             argumentsBundle.putString("shortcut_name", shortcutName)
77             argumentsBundle.putString("url_string", urlString)
78             argumentsBundle.putByteArray("favorite_icon_byte_array", favoriteIconByteArray)
79
80             // Create a new instance of the dialog.
81             val createHomeScreenShortcutDialog = CreateHomeScreenShortcutDialog()
82
83             // Add the bundle to the dialog.
84             createHomeScreenShortcutDialog.arguments = argumentsBundle
85
86             // Return the new dialog.
87             return createHomeScreenShortcutDialog
88         }
89     }
90
91     // `@SuppressLing("InflateParams")` removes the warning about using `null` as the parent view group when inflating the `AlertDialog`.
92     @SuppressLint("InflateParams")
93     override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
94         // Get the arguments.
95         val arguments = requireArguments()
96
97         // Get the strings from the arguments.
98         val initialShortcutName = arguments.getString("shortcut_name")
99         val initialUrlString = arguments.getString("url_string")
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         // Create a drawable version of the favorite icon.
111         val favoriteIconDrawable: Drawable = BitmapDrawable(resources, favoriteIconBitmap)
112
113         // Set the title and icon.
114         dialogBuilder.setTitle(R.string.create_shortcut)
115         dialogBuilder.setIcon(favoriteIconDrawable)
116
117         // Set the view.  The parent view is null because it will be assigned by the alert dialog.
118         dialogBuilder.setView(requireActivity().layoutInflater.inflate(R.layout.create_home_screen_shortcut_dialog, null))
119
120         // Set a listener on the close button.  Using null closes the dialog without doing anything else.
121         dialogBuilder.setNegativeButton(R.string.cancel, null)
122
123         // Set a listener on the create button.
124         dialogBuilder.setPositiveButton(R.string.create) { _: DialogInterface, _: Int ->
125             // Create the home screen shortcut.
126             createHomeScreenShortcut(favoriteIconBitmap)
127         }
128
129         // Create an alert dialog from the alert dialog builder.
130         val alertDialog = dialogBuilder.create()
131
132         // Get a handle for the shared preferences.
133         val sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context)
134
135         // Get the screenshot preference.
136         val allowScreenshots = sharedPreferences.getBoolean("allow_screenshots", false)
137
138         // Disable screenshots if not allowed.
139         if (!allowScreenshots) {
140             alertDialog.window!!.addFlags(WindowManager.LayoutParams.FLAG_SECURE)
141         }
142
143         // The alert dialog must be shown before the contents can be modified.
144         alertDialog.show()
145
146         // Get handles for the views.
147         shortcutNameEditText = alertDialog.findViewById(R.id.shortcut_name_edittext)!!
148         urlEditText = alertDialog.findViewById(R.id.url_edittext)!!
149         openWithPrivacyBrowserRadioButton = alertDialog.findViewById(R.id.open_with_privacy_browser_radiobutton)!!
150         val createButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE)
151
152         // Populate the edit texts.
153         shortcutNameEditText.setText(initialShortcutName)
154         urlEditText.setText(initialUrlString)
155
156         // Add a text change listener to the shortcut name edit text.
157         shortcutNameEditText.addTextChangedListener(object: TextWatcher {
158             override fun beforeTextChanged(s: CharSequence, start: Int, count: Int, after: Int) {
159                 // Do nothing.
160             }
161
162             override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {
163                 // Do nothing.
164             }
165
166             override fun afterTextChanged(s: Editable) {
167                 // Update the create button.
168                 updateCreateButton(createButton)
169             }
170         })
171
172         // Add a text change listener to the URL edit text.
173         urlEditText.addTextChangedListener(object : TextWatcher {
174             override fun beforeTextChanged(s: CharSequence, start: Int, count: Int, after: Int) {
175                 // Do nothing.
176             }
177
178             override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {
179                 // Do nothing.
180             }
181
182             override fun afterTextChanged(s: Editable) {
183                 // Update the create button.
184                 updateCreateButton(createButton)
185             }
186         })
187
188         // Allow the enter key on the keyboard to create the shortcut when editing the name.
189         shortcutNameEditText.setOnKeyListener { _: View?, keyCode: Int, keyEvent: KeyEvent ->
190             // Check the key code, event, and button status.
191             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.
192                 // Create the home screen shortcut.
193                 createHomeScreenShortcut(favoriteIconBitmap)
194
195                 // Manually dismiss the alert dialog.
196                 alertDialog.dismiss()
197
198                 // Consume the event.
199                 return@setOnKeyListener true
200             } else {  // Some other key was pressed or the create button is disabled.
201                 // Do not consume the event.
202                 return@setOnKeyListener false
203             }
204         }
205
206         // Set the enter key on the keyboard to create the shortcut when editing the URL.
207         urlEditText.setOnKeyListener { _: View?, keyCode: Int, keyEvent: KeyEvent ->
208             // Check the key code, event, and button status.
209             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.
210                 // Create the home screen shortcut.
211                 createHomeScreenShortcut(favoriteIconBitmap)
212
213                 // Manually dismiss the alert dialog.
214                 alertDialog.dismiss()
215
216                 // Consume the event.
217                 return@setOnKeyListener true
218             } else {  // Some other key was pressed or the create button is disabled.
219                 // Do not consume the event.
220                 return@setOnKeyListener false
221             }
222         }
223
224         // Return the alert dialog.
225         return alertDialog
226     }
227
228     private fun updateCreateButton(createButton: Button) {
229         // Get the contents of the edit texts.
230         val shortcutName = shortcutNameEditText.text.toString()
231         val urlString = urlEditText.text.toString()
232
233         // Enable the create button if both the shortcut name and the URL are not empty.
234         createButton.isEnabled = shortcutName.isNotEmpty() && urlString.isNotEmpty()
235     }
236
237     private fun createHomeScreenShortcut(favoriteIconBitmap: Bitmap) {
238         // Get the strings from the edit texts.
239         val shortcutName = shortcutNameEditText.text.toString()
240         val urlString = urlEditText.text.toString()
241
242         // Convert the favorite icon bitmap to an icon.  `IconCompat` must be used until the minimum API >= 26.
243         val favoriteIcon = IconCompat.createWithBitmap(favoriteIconBitmap)
244
245         // Create a shortcut intent.
246         val shortcutIntent = Intent(Intent.ACTION_VIEW)
247
248         // Check to see if the shortcut should open up Privacy Browser explicitly.
249         if (openWithPrivacyBrowserRadioButton.isChecked) {
250             // Set the current application ID as the target package.
251             shortcutIntent.setPackage(BuildConfig.APPLICATION_ID)
252         }
253
254         // Add the URL to the intent.
255         shortcutIntent.data = Uri.parse(urlString)
256
257         // Create a shortcut info builder.  The shortcut name becomes the shortcut ID.
258         val shortcutInfoBuilder = ShortcutInfoCompat.Builder(requireContext(), shortcutName)
259
260         // Add the required fields to the shortcut info builder.
261         shortcutInfoBuilder.setIcon(favoriteIcon)
262         shortcutInfoBuilder.setIntent(shortcutIntent)
263         shortcutInfoBuilder.setShortLabel(shortcutName)
264
265         // Add the shortcut to the home screen.  `ShortcutManagerCompat` can be switched to `ShortcutManager` once the minimum API >= 26.
266         ShortcutManagerCompat.requestPinShortcut(requireContext(), shortcutInfoBuilder.build(), null)
267     }
268 }