2 * Copyright © 2019-2020 Soren Stoutner <soren@stoutner.com>.
4 * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
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.
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.
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/>.
20 package com.stoutner.privacybrowser.dialogs;
22 import android.Manifest;
23 import android.annotation.SuppressLint;
24 import android.app.Activity;
25 import android.app.AlertDialog;
26 import android.app.Dialog;
27 import android.content.Context;
28 import android.content.DialogInterface;
29 import android.content.Intent;
30 import android.content.SharedPreferences;
31 import android.content.pm.PackageManager;
32 import android.net.Uri;
33 import android.os.AsyncTask;
34 import android.os.Build;
35 import android.os.Bundle;
36 import android.os.Environment;
37 import android.provider.DocumentsContract;
38 import android.text.Editable;
39 import android.text.TextWatcher;
40 import android.view.View;
41 import android.view.WindowManager;
42 import android.widget.Button;
43 import android.widget.EditText;
44 import android.widget.TextView;
46 import androidx.annotation.NonNull;
47 import androidx.core.content.ContextCompat;
48 import androidx.fragment.app.DialogFragment;
49 import androidx.preference.PreferenceManager;
51 import com.stoutner.privacybrowser.R;
52 import com.stoutner.privacybrowser.activities.MainWebViewActivity;
53 import com.stoutner.privacybrowser.asynctasks.GetUrlSize;
54 import com.stoutner.privacybrowser.helpers.DownloadLocationHelper;
58 public class SaveDialog extends DialogFragment {
59 // Define the save webpage listener.
60 private SaveWebpageListener saveWebpageListener;
62 // The public interface is used to send information back to the parent activity.
63 public interface SaveWebpageListener {
64 void onSaveWebpage(int saveType, DialogFragment dialogFragment);
67 // Define the get URL size AsyncTask. This allows previous instances of the task to be cancelled if a new one is run.
68 private AsyncTask getUrlSize;
71 public void onAttach(@NonNull Context context) {
72 // Run the default commands.
73 super.onAttach(context);
75 // Get a handle for the save webpage listener from the launching context.
76 saveWebpageListener = (SaveWebpageListener) context;
79 public static SaveDialog saveUrl(int saveType, String url, String userAgent, boolean cookiesEnabled) {
80 // Create an arguments bundle.
81 Bundle argumentsBundle = new Bundle();
83 // Store the arguments in the bundle.
84 argumentsBundle.putInt("save_type", saveType);
85 argumentsBundle.putString("url", url);
86 argumentsBundle.putString("user_agent", userAgent);
87 argumentsBundle.putBoolean("cookies_enabled", cookiesEnabled);
89 // Create a new instance of the save webpage dialog.
90 SaveDialog saveWebpageDialog = new SaveDialog();
92 // Add the arguments bundle to the new dialog.
93 saveWebpageDialog.setArguments(argumentsBundle);
95 // Return the new dialog.
96 return saveWebpageDialog;
99 // `@SuppressLint("InflateParams")` removes the warning about using null as the parent view group when inflating the alert dialog.
100 @SuppressLint("InflateParams")
103 public Dialog onCreateDialog(Bundle savedInstanceState) {
104 // Get a handle for the arguments.
105 Bundle arguments = getArguments();
107 // Remove the incorrect lint warning that the arguments might be null.
108 assert arguments != null;
110 // Get the arguments from the bundle.
111 int saveType = arguments.getInt("save_type");
112 String url = arguments.getString("url");
113 String userAgent = arguments.getString("user_agent");
114 boolean cookiesEnabled = arguments.getBoolean("cookies_enabled");
116 // Get a handle for the activity and the context.
117 Activity activity = getActivity();
118 Context context = getContext();
120 // Remove the incorrect lint warnings below that the activity and context might be null.
121 assert activity != null;
122 assert context != null;
124 // Get a handle for the shared preferences.
125 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
127 // Get the screenshot and theme preferences.
128 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
129 boolean allowScreenshots = sharedPreferences.getBoolean("allow_screenshots", false);
131 // Use an alert dialog builder to create the alert dialog.
132 AlertDialog.Builder dialogBuilder;
134 // Set the style and icon according to the theme.
137 dialogBuilder = new AlertDialog.Builder(activity, R.style.PrivacyBrowserAlertDialogDark);
139 // Set the icon according to the save type.
141 case StoragePermissionDialog.SAVE_URL:
142 dialogBuilder.setIcon(R.drawable.copy_enabled_dark);
145 case StoragePermissionDialog.SAVE_AS_ARCHIVE:
146 dialogBuilder.setIcon(R.drawable.dom_storage_cleared_dark);
149 case StoragePermissionDialog.SAVE_AS_IMAGE:
150 dialogBuilder.setIcon(R.drawable.images_enabled_dark);
155 dialogBuilder = new AlertDialog.Builder(activity, R.style.PrivacyBrowserAlertDialogLight);
157 // Set the icon according to the save type.
159 case StoragePermissionDialog.SAVE_URL:
160 dialogBuilder.setIcon(R.drawable.copy_enabled_light);
163 case StoragePermissionDialog.SAVE_AS_ARCHIVE:
164 dialogBuilder.setIcon(R.drawable.dom_storage_cleared_light);
167 case StoragePermissionDialog.SAVE_AS_IMAGE:
168 dialogBuilder.setIcon(R.drawable.images_enabled_light);
173 // Set the title according to the type.
175 case StoragePermissionDialog.SAVE_URL:
176 dialogBuilder.setTitle(R.string.save);
179 case StoragePermissionDialog.SAVE_AS_ARCHIVE:
180 dialogBuilder.setTitle(R.string.save_archive);
183 case StoragePermissionDialog.SAVE_AS_IMAGE:
184 dialogBuilder.setTitle(R.string.save_image);
188 // Set the view. The parent view is null because it will be assigned by the alert dialog.
189 dialogBuilder.setView(activity.getLayoutInflater().inflate(R.layout.save_dialog, null));
191 // Set the cancel button listener. Using `null` as the listener closes the dialog without doing anything else.
192 dialogBuilder.setNegativeButton(R.string.cancel, null);
194 // Set the save button listener.
195 dialogBuilder.setPositiveButton(R.string.save, (DialogInterface dialog, int which) -> {
196 // Return the dialog fragment to the parent activity.
197 saveWebpageListener.onSaveWebpage(saveType, this);
200 // Create an alert dialog from the builder.
201 AlertDialog alertDialog = dialogBuilder.create();
203 // Remove the incorrect lint warning below that the window might be null.
204 assert alertDialog.getWindow() != null;
206 // Disable screenshots if not allowed.
207 if (!allowScreenshots) {
208 alertDialog.getWindow().addFlags(WindowManager.LayoutParams.FLAG_SECURE);
211 // The alert dialog must be shown before items in the layout can be modified.
214 // Get handles for the layout items.
215 EditText urlEditText = alertDialog.findViewById(R.id.url_edittext);
216 EditText fileNameEditText = alertDialog.findViewById(R.id.file_name_edittext);
217 Button browseButton = alertDialog.findViewById(R.id.browse_button);
218 TextView fileSizeTextView = alertDialog.findViewById(R.id.file_size_textview);
219 TextView fileExistsWarningTextView = alertDialog.findViewById(R.id.file_exists_warning_textview);
220 TextView storagePermissionTextView = alertDialog.findViewById(R.id.storage_permission_textview);
221 Button saveButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE);
223 // Modify the layout based on the save type.
224 if (saveType == StoragePermissionDialog.SAVE_URL) { // A URL is being saved.
225 // Update the status of the save button whe the URL changes.
226 urlEditText.addTextChangedListener(new TextWatcher() {
228 public void beforeTextChanged(CharSequence charSequence, int i, int i1, int i2) {
233 public void onTextChanged(CharSequence charSequence, int i, int i1, int i2) {
238 public void afterTextChanged(Editable editable) {
239 // Cancel the get URL size AsyncTask if it is running.
240 if ((getUrlSize != null)) {
241 getUrlSize.cancel(true);
244 // Get the current URL to save.
245 String urlToSave = urlEditText.getText().toString();
247 // Wipe the file size text view.
248 fileSizeTextView.setText("");
250 // Get the file size for the current URL.
251 getUrlSize = new GetUrlSize(context, alertDialog, userAgent, cookiesEnabled).execute(urlToSave);
253 // Enable the save button if the URL and file name are populated.
254 saveButton.setEnabled(!urlToSave.isEmpty() && !fileNameEditText.getText().toString().isEmpty());
258 // Populate the URL edit text.
259 urlEditText.setText(url);
260 } else { // An archive or an image is being saved.
261 // Hide the URL edit text and the file size text view.
262 urlEditText.setVisibility(View.GONE);
263 fileSizeTextView.setVisibility(View.GONE);
266 // Update the status of the save button when the file name changes.
267 fileNameEditText.addTextChangedListener(new TextWatcher() {
269 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
274 public void onTextChanged(CharSequence s, int start, int before, int count) {
279 public void afterTextChanged(Editable s) {
280 // Get the current file name.
281 String fileNameString = fileNameEditText.getText().toString();
283 // Convert the file name string to a file.
284 File file = new File(fileNameString);
286 // Check to see if the file exists.
288 // Show the file exists warning.
289 fileExistsWarningTextView.setVisibility(View.VISIBLE);
291 // Hide the file exists warning.
292 fileExistsWarningTextView.setVisibility(View.GONE);
295 // Enable the save button based on the save type.
296 if (saveType == StoragePermissionDialog.SAVE_URL) { // A URL is being saved.
297 // Enable the save button if the file name and the URL is populated.
298 saveButton.setEnabled(!fileNameString.isEmpty() && !urlEditText.getText().toString().isEmpty());
299 } else { // An archive or an image is being saved.
300 // Enable the save button if the file name is populated.
301 saveButton.setEnabled(!fileNameString.isEmpty());
306 // Create a file name string.
307 String fileName = "";
309 // Set the file name according to the type.
311 case StoragePermissionDialog.SAVE_URL:
312 // Convert the URL to a URI.
313 Uri uri = Uri.parse(url);
315 // Get the last path segment.
316 String lastPathSegment = uri.getLastPathSegment();
318 // Use a default file name if the last path segment is null.
319 if (lastPathSegment == null) {
320 lastPathSegment = getString(R.string.file);
323 // Use the last path segment as the file name.
324 fileName = lastPathSegment;
327 case StoragePermissionDialog.SAVE_AS_ARCHIVE:
328 fileName = getString(R.string.webpage_mht);
331 case StoragePermissionDialog.SAVE_AS_IMAGE:
332 fileName = getString(R.string.webpage_png);
336 // Save the file name as the default file name. This must be final to be used in the lambda below.
337 final String defaultFileName = fileName;
339 // Instantiate the download location helper.
340 DownloadLocationHelper downloadLocationHelper = new DownloadLocationHelper();
342 // Get the default file path.
343 String defaultFilePath = downloadLocationHelper.getDownloadLocation(context) + "/" + defaultFileName;
345 // Hide the storage permission text view if the permission has already been granted.
346 if (ContextCompat.checkSelfPermission(context, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) {
347 storagePermissionTextView.setVisibility(View.GONE);
350 // Populate the file name edit text.
351 fileNameEditText.setText(defaultFilePath);
353 // Move the cursor to the end of the default file path.
354 fileNameEditText.setSelection(defaultFilePath.length());
356 // Handle clicks on the browse button.
357 browseButton.setOnClickListener((View view) -> {
358 // Create the file picker intent.
359 Intent browseIntent = new Intent(Intent.ACTION_CREATE_DOCUMENT);
361 // Set the intent MIME type to include all files so that everything is visible.
362 browseIntent.setType("*/*");
364 // Set the initial file name according to the type.
365 browseIntent.putExtra(Intent.EXTRA_TITLE, defaultFileName);
367 // Set the initial directory if the minimum API >= 26.
368 if (Build.VERSION.SDK_INT >= 26) {
369 browseIntent.putExtra(DocumentsContract.EXTRA_INITIAL_URI, Environment.getExternalStorageDirectory());
372 // Request a file that can be opened.
373 browseIntent.addCategory(Intent.CATEGORY_OPENABLE);
375 // Start the file picker. This must be started under `activity` so that the request code is returned correctly.
376 activity.startActivityForResult(browseIntent, MainWebViewActivity.BROWSE_SAVE_WEBPAGE_REQUEST_CODE);
379 // Return the alert dialog.