/*
- * Copyright © 2016-2021 Soren Stoutner <soren@stoutner.com>.
+ * Copyright 2019-2024 Soren Stoutner <soren@stoutner.com>.
*
- * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
+ * This file is part of Privacy Browser Android <https://www.stoutner.com/privacy-browser-android>.
*
- * Privacy Browser is free software: you can redistribute it and/or modify
+ * Privacy Browser Android 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,
+ * Privacy Browser Android 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/>.
+ * along with Privacy Browser Android. If not, see <http://www.gnu.org/licenses/>.
*/
package com.stoutner.privacybrowser.dialogs
-import android.Manifest
-import android.annotation.SuppressLint
-import android.os.Bundle
import android.app.Dialog
import android.content.Context
import android.content.DialogInterface
-import android.content.Intent
-import android.content.pm.PackageManager
-import android.content.res.Configuration
+import android.os.Bundle
+import android.text.Editable
+import android.text.InputType
+import android.text.TextWatcher
import android.view.View
import android.view.WindowManager
-import android.widget.Button
import android.widget.EditText
+import android.widget.LinearLayout
import android.widget.TextView
-import android.text.TextWatcher
-import android.text.Editable
import androidx.appcompat.app.AlertDialog
-import androidx.core.content.ContextCompat
+import androidx.core.view.isVisible
import androidx.fragment.app.DialogFragment
import androidx.preference.PreferenceManager
import com.stoutner.privacybrowser.R
-import com.stoutner.privacybrowser.helpers.DownloadLocationHelper
+import com.stoutner.privacybrowser.helpers.UrlHelper
-import java.io.File
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withContext
-// Declare the class constants.
-private const val SAVE_TYPE = "save_type"
+// Define the private class constants.
+private const val URL_STRING = "A"
+private const val FILE_SIZE_STRING = "B"
+private const val FILE_NAME_STRING = "C"
+private const val USER_AGENT_STRING = "D"
+private const val COOKIES_ENABLED = "E"
class SaveDialog : DialogFragment() {
- // Declare the class variables.
- private lateinit var saveListener: SaveListener
- private lateinit var fileName: String
-
- // The public interface is used to send information back to the parent activity.
- interface SaveListener {
- fun onSave(saveType: Int, dialogFragment: DialogFragment)
- }
-
- override fun onAttach(context: Context) {
- // Run the default commands.
- super.onAttach(context)
-
- // Get a handle for the save listener from the launching context.
- saveListener = context as SaveListener
- }
-
companion object {
- // Declare the companion object constants. These can be moved to class constants once all of the code has transitioned to Kotlin.
- const val SAVE_LOGCAT = 0
- const val SAVE_ABOUT_VERSION_TEXT = 1
- const val SAVE_ABOUT_VERSION_IMAGE = 2
-
- // `@JvmStatic` will no longer be required once all the code has transitioned to Kotlin.
- @JvmStatic
- fun save(saveType: Int): SaveDialog {
+ fun saveUrl(urlString: String, fileNameString: String, fileSizeString: String, userAgentString: String, cookiesEnabled: Boolean): SaveDialog {
// Create an arguments bundle.
val argumentsBundle = Bundle()
// Store the arguments in the bundle.
- argumentsBundle.putInt(SAVE_TYPE, saveType)
+ argumentsBundle.putString(URL_STRING, urlString)
+ argumentsBundle.putString(FILE_NAME_STRING, fileNameString)
+ argumentsBundle.putString(FILE_SIZE_STRING, fileSizeString)
+ argumentsBundle.putString(USER_AGENT_STRING, userAgentString)
+ argumentsBundle.putBoolean(COOKIES_ENABLED, cookiesEnabled)
- // Create a new instance of the save dialog.
+ // Create a new instance of the save webpage dialog.
val saveDialog = SaveDialog()
- // Add the arguments bundle to the dialog.
+ // Add the arguments bundle to the new dialog.
saveDialog.arguments = argumentsBundle
// Return the new dialog.
}
}
- // `@SuppressLint("InflateParams")` removes the warning about using null as the parent view group when inflating the alert dialog.
- @SuppressLint("InflateParams")
+ // Declare the class variables.
+ private lateinit var saveListener: SaveListener
+
+ // The public interface is used to send information back to the parent activity.
+ interface SaveListener {
+ // Save with Android's download manager.
+ fun saveWithAndroidDownloadManager(dialogFragment: DialogFragment)
+
+ // Save with Privacy Browser.
+ fun saveWithPrivacyBrowser(originalUrlString: String, fileNameString: String, dialogFragment: DialogFragment)
+ }
+
+ override fun onAttach(context: Context) {
+ // Run the default commands.
+ super.onAttach(context)
+
+ // Get a handle for the save webpage listener from the launching context.
+ saveListener = context as SaveListener
+ }
+
override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
- // Get the arguments from the bundle.
- val saveType = requireArguments().getInt(SAVE_TYPE)
+ // Get the arguments
+ val arguments = requireArguments()
- // Use an alert dialog builder to create the alert dialog.
- val dialogBuilder = AlertDialog.Builder(requireContext(), R.style.PrivacyBrowserAlertDialog)
+ // Get the arguments from the bundle.
+ val originalUrlString = arguments.getString(URL_STRING)!!
+ var fileNameString = arguments.getString(FILE_NAME_STRING)!!
+ val fileSizeString = arguments.getString(FILE_SIZE_STRING)!!
+ val userAgentString = arguments.getString(USER_AGENT_STRING)!!
+ val cookiesEnabled = arguments.getBoolean(COOKIES_ENABLED)
- // Get the current theme status.
- val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
+ // Get the download provider entry values string array.
+ val downloadProviderEntryValuesStringArray = resources.getStringArray(R.array.download_provider_entry_values)
- // Set the title and the icon according to the save type.
- when (saveType) {
- SAVE_LOGCAT -> {
- // Set the title.
- dialogBuilder.setTitle(R.string.save_logcat)
+ // Get a handle for the shared preferences.
+ val sharedPreferences = PreferenceManager.getDefaultSharedPreferences(requireContext())
- // Set the icon according to the theme.
- if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) {
- dialogBuilder.setIcon(R.drawable.save_dialog_day)
- } else {
- dialogBuilder.setIcon(R.drawable.save_dialog_night)
- }
- }
+ // Get the preference.
+ val allowScreenshots = sharedPreferences.getBoolean(getString(R.string.allow_screenshots_key), false)
+ val downloadProvider = sharedPreferences.getString(getString(R.string.download_provider_key), getString(R.string.download_provider_default_value))!!
- SAVE_ABOUT_VERSION_TEXT -> {
- // Set the title.
- dialogBuilder.setTitle(R.string.save_text)
+ // Determine the download provider.
+ val privacyBrowserDownloadProvider = downloadProvider == downloadProviderEntryValuesStringArray[0]
- // Set the icon according to the theme.
- if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) {
- dialogBuilder.setIcon(R.drawable.save_text_blue_day)
- } else {
- dialogBuilder.setIcon(R.drawable.save_text_blue_night)
- }
- }
+ // Use an alert dialog builder to create the alert dialog.
+ val dialogBuilder = AlertDialog.Builder(requireContext(), R.style.PrivacyBrowserAlertDialog)
- SAVE_ABOUT_VERSION_IMAGE -> {
- // Set the title.
- dialogBuilder.setTitle(R.string.save_image)
+ // Set the title.
+ dialogBuilder.setTitle(R.string.save_url)
- // Set the icon according to the theme.
- if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) {
- dialogBuilder.setIcon(R.drawable.images_enabled_day)
- } else {
- dialogBuilder.setIcon(R.drawable.images_enabled_night)
- }
- }
- }
+ // Set the icon.
+ dialogBuilder.setIcon(R.drawable.download)
- // Set the view. The parent view is null because it will be assigned by the alert dialog.
- dialogBuilder.setView(requireActivity().layoutInflater.inflate(R.layout.save_dialog, null))
+ // Set the view.
+ dialogBuilder.setView(R.layout.save_dialog)
// 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.
- saveListener.onSave(saveType, this)
+ dialogBuilder.setPositiveButton(R.string.save) { _: DialogInterface, _: Int ->
+ // Save the URL with the selected download provider.
+ if (privacyBrowserDownloadProvider) // Download with Privacy Browser.
+ saveListener.saveWithPrivacyBrowser(originalUrlString, fileNameString, this)
+ else // Download with Android's download manager.
+ saveListener.saveWithAndroidDownloadManager(this)
}
// Create an alert dialog from the 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)
alertDialog.show()
// Get handles for the layout items.
- val fileNameEditText = alertDialog.findViewById<EditText>(R.id.file_name_edittext)!!
- val browseButton = alertDialog.findViewById<Button>(R.id.browse_button)!!
- val fileExistsWarningTextView = alertDialog.findViewById<TextView>(R.id.file_exists_warning_textview)!!
- val storagePermissionTextView = alertDialog.findViewById<TextView>(R.id.storage_permission_textview)!!
+ val urlEditText = alertDialog.findViewById<EditText>(R.id.url_edittext)!!
+ val fileSizeTextView = alertDialog.findViewById<TextView>(R.id.file_size_textview)!!
+ val blobUrlWarningTextView = alertDialog.findViewById<TextView>(R.id.blob_url_warning_textview)!!
+ val dataUrlWarningTextView = alertDialog.findViewById<TextView>(R.id.data_url_warning_textview)!!
+ val androidDownloadManagerLinearLayout = alertDialog.findViewById<LinearLayout>(R.id.android_download_manager_linearlayout)!!
+ val fileNameEditText = alertDialog.findViewById<TextView>(R.id.file_name_edittext)!!
val saveButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE)
- // Update the status of the save button when the file name changes.
- fileNameEditText.addTextChangedListener(object : TextWatcher {
- override fun beforeTextChanged(s: CharSequence, start: Int, count: Int, after: Int) {
+ // Display the extra views if using Android's download manager.
+ if (!privacyBrowserDownloadProvider)
+ androidDownloadManagerLinearLayout.visibility = View.VISIBLE
+
+ // Populate the views.
+ fileSizeTextView.text = fileSizeString
+ fileNameEditText.text = fileNameString
+
+ // Populate the URL edit text according to the type. This must be done before the text change listener is created below so that the file size isn't requested again.
+ if (originalUrlString.startsWith("data:")) { // The URL contains the entire data of an image.
+ // Get a substring of the data URL with the first 100 characters. Otherwise, the user interface will freeze while trying to layout the edit text.
+ val urlSubstring = originalUrlString.substring(0, 100) + "…"
+
+ // Populate the URL edit text with the truncated URL.
+ urlEditText.setText(urlSubstring)
+
+ // Disable the editing of the URL edit text.
+ urlEditText.inputType = InputType.TYPE_NULL
+
+ // Display the warning if using Android's download manager.
+ if (!privacyBrowserDownloadProvider) {
+ // Display the data URL warning.
+ dataUrlWarningTextView.visibility = View.VISIBLE
+
+ // Disable the save button.
+ saveButton.isEnabled = false
+ }
+ } else { // The URL contains a reference to the location of the data.
+ // Populate the URL edit text with the full URL.
+ urlEditText.setText(originalUrlString)
+ }
+
+ // Handle blob URLs.
+ if (originalUrlString.startsWith("blob:")) {
+ // Display the blob URL warning.
+ blobUrlWarningTextView.visibility = View.VISIBLE
+
+ // Disable the save button.
+ saveButton.isEnabled = false
+ }
+
+ // Update the UI when the URL changes.
+ urlEditText.addTextChangedListener(object : TextWatcher {
+ override fun beforeTextChanged(charSequence: CharSequence?, start: Int, count: Int, after: Int) {
// Do nothing.
}
- override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {
+ override fun onTextChanged(charSequence: CharSequence?, start: Int, before: Int, count: Int) {
// Do nothing.
}
- override fun afterTextChanged(s: Editable) {
- // Get the current file name.
- val fileNameString = fileNameEditText.text.toString()
+ override fun afterTextChanged(editable: Editable?) {
+ // Get the contents of the edit texts.
+ val urlToSave = urlEditText.text.toString()
+ val fileName = fileNameEditText.text.toString()
- // Convert the file name string to a file.
- val file = File(fileNameString)
+ // Determine if this is a blob URL.
+ val blobUrl = urlToSave.startsWith("blob:")
- // Check to see if the file exists.
- if (file.exists()) {
- // Show the file exists warning.
- fileExistsWarningTextView.visibility = View.VISIBLE
- } else {
- // Hide the file exists warning.
- fileExistsWarningTextView.visibility = View.GONE
- }
+ // Set the display status of the blob warning.
+ if (blobUrl)
+ blobUrlWarningTextView.visibility = View.VISIBLE
+ else
+ blobUrlWarningTextView.visibility = View.GONE
- // Enable the save button if the file name is populated.
- saveButton.isEnabled = fileNameString.isNotEmpty()
- }
- })
+ // Enable the save button if the edit texts are populated and this isn't a blob URL.
+ saveButton.isEnabled = urlToSave.isNotBlank() && fileName.isNotBlank() && !blobUrl
- // Set the file name according to the type.
- when (saveType) {
- SAVE_LOGCAT -> fileName = getString(R.string.privacy_browser_logcat_txt)
- SAVE_ABOUT_VERSION_TEXT -> fileName = getString(R.string.privacy_browser_version_txt)
- SAVE_ABOUT_VERSION_IMAGE -> fileName = getString(R.string.privacy_browser_version_png)
- }
+ // Determine if this is a data URL.
+ val dataUrl = urlToSave.startsWith("data:")
- // Instantiate the download location helper.
- val downloadLocationHelper = DownloadLocationHelper()
+ // Only process the URL if it is not a data URL.
+ if (!dataUrl) {
+ CoroutineScope(Dispatchers.Main).launch {
+ // Create a URL size string.
+ var fileNameAndSize: Pair<String, String>
- // Get the default file path.
- val defaultFilePath = downloadLocationHelper.getDownloadLocation(context) + "/" + fileName
+ // Get the URL size on the IO thread.
+ withContext(Dispatchers.IO) {
+ // Get the updated file name and size.
+ fileNameAndSize = UrlHelper.getNameAndSize(requireContext(), urlToSave, userAgentString, cookiesEnabled)
- // Display the default file path.
- fileNameEditText.setText(defaultFilePath)
+ // Save the updated file name.
+ fileNameString = fileNameAndSize.first
+ }
- // Hide the storage permission text view if the permission has already been granted.
- if (ContextCompat.checkSelfPermission(requireContext(), Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) {
- storagePermissionTextView.visibility = View.GONE
- }
+ // Display the updated file size.
+ fileSizeTextView.text = fileNameAndSize.second
+ }
+ }
+ }
+ })
- // Handle clicks on the browse button.
- browseButton.setOnClickListener {
- // Create the file picker intent.
- val browseIntent = Intent(Intent.ACTION_CREATE_DOCUMENT)
+ // Update the UI when the file name changes.
+ fileNameEditText.addTextChangedListener(object : TextWatcher {
+ override fun beforeTextChanged(charSequence: CharSequence?, start: Int, count: Int, after: Int) {
+ // Do nothing.
+ }
- // Set the intent MIME type to include all files so that everything is visible.
- browseIntent.type = "*/*"
+ override fun onTextChanged(charSequence: CharSequence?, start: Int, before: Int, count: Int) {
+ // Do nothing.
+ }
- // Set the initial file name.
- browseIntent.putExtra(Intent.EXTRA_TITLE, fileName)
+ override fun afterTextChanged(editable: Editable?) {
+ // Get the contents of the edit texts.
+ val urlToSave = urlEditText.text.toString()
+ val fileName = fileNameEditText.text.toString()
- // Request a file that can be opened.
- browseIntent.addCategory(Intent.CATEGORY_OPENABLE)
+ // Determine if this is a blob URL.
+ val blobUrl = urlToSave.startsWith("blob:")
- // Launch the file picker. There is only one `startActivityForResult()`, so the request code is simply set to 0, but it must be run under `activity` so the request code is correct.
- requireActivity().startActivityForResult(browseIntent, 0)
- }
+ // Enable the save button if the edit texts are populated and this isn't a blob URL (or a data URL using Android's download manager).
+ saveButton.isEnabled = urlToSave.isNotBlank() && fileName.isNotBlank() && !blobUrl && !dataUrlWarningTextView.isVisible
+ }
+ })
// Return the alert dialog.
return alertDialog
}
-}
\ No newline at end of file
+}
projects / PrivacyBrowserAndroid.git / blobdiff