]> gitweb.stoutner.com Git - PrivacyBrowserAndroid.git/blobdiff - app/src/main/java/com/stoutner/privacybrowser/dialogs/SaveWebpageDialog.java
Allow saving of `data:` URLs. https://redmine.stoutner.com/issues/596
[PrivacyBrowserAndroid.git] / app / src / main / java / com / stoutner / privacybrowser / dialogs / SaveWebpageDialog.java
index 1c24e0bedc6ca95f4414c74ae3c92bd92001c205..57d9baa219777afa489a6991dc5df0a29bf26930 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2019 Soren Stoutner <soren@stoutner.com>.
+ * Copyright © 2019-2020 Soren Stoutner <soren@stoutner.com>.
  *
  * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
  *
@@ -22,18 +22,20 @@ package com.stoutner.privacybrowser.dialogs;
 import android.Manifest;
 import android.annotation.SuppressLint;
 import android.app.Activity;
-import android.app.AlertDialog;
 import android.app.Dialog;
 import android.content.Context;
 import android.content.DialogInterface;
 import android.content.Intent;
 import android.content.SharedPreferences;
 import android.content.pm.PackageManager;
+import android.content.res.Configuration;
+import android.os.AsyncTask;
 import android.os.Build;
 import android.os.Bundle;
 import android.os.Environment;
 import android.provider.DocumentsContract;
 import android.text.Editable;
+import android.text.InputType;
 import android.text.TextWatcher;
 import android.view.View;
 import android.view.WindowManager;
@@ -42,26 +44,31 @@ import android.widget.EditText;
 import android.widget.TextView;
 
 import androidx.annotation.NonNull;
+import androidx.appcompat.app.AlertDialog;
 import androidx.core.content.ContextCompat;
 import androidx.fragment.app.DialogFragment;
 import androidx.preference.PreferenceManager;
 
+import com.google.android.material.textfield.TextInputLayout;
 import com.stoutner.privacybrowser.R;
 import com.stoutner.privacybrowser.activities.MainWebViewActivity;
+import com.stoutner.privacybrowser.asynctasks.GetUrlSize;
+import com.stoutner.privacybrowser.helpers.DownloadLocationHelper;
 
-public class SaveWebpageDialog extends DialogFragment {
-    // Define the save type constants.
-    public static final int ARCHIVE = 0;
-    public static final int IMAGE = 1;
+import java.io.File;
 
+public class SaveWebpageDialog extends DialogFragment {
     // Define the save webpage listener.
     private SaveWebpageListener saveWebpageListener;
 
     // The public interface is used to send information back to the parent activity.
     public interface SaveWebpageListener {
-        void onSaveWebpage(int saveType, DialogFragment dialogFragment);
+        void onSaveWebpage(int saveType, String originalUrlString, DialogFragment dialogFragment);
     }
 
+    // Define the get URL size AsyncTask.  This allows previous instances of the task to be cancelled if a new one is run.
+    private AsyncTask getUrlSize;
+
     @Override
     public void onAttach(@NonNull Context context) {
         // Run the default commands.
@@ -71,12 +78,17 @@ public class SaveWebpageDialog extends DialogFragment {
         saveWebpageListener = (SaveWebpageListener) context;
     }
 
-    public static SaveWebpageDialog saveWebpage(int saveType) {
+    public static SaveWebpageDialog saveWebpage(int saveType, String urlString, String fileSizeString, String contentDispositionFileNameString, String userAgentString, boolean cookiesEnabled) {
         // Create an arguments bundle.
         Bundle argumentsBundle = new Bundle();
 
-        // Store the save type in the bundle.
+        // Store the arguments in the bundle.
         argumentsBundle.putInt("save_type", saveType);
+        argumentsBundle.putString("url_string", urlString);
+        argumentsBundle.putString("file_size_string", fileSizeString);
+        argumentsBundle.putString("content_disposition_file_name_string", contentDispositionFileNameString);
+        argumentsBundle.putString("user_agent_string", userAgentString);
+        argumentsBundle.putBoolean("cookies_enabled", cookiesEnabled);
 
         // Create a new instance of the save webpage dialog.
         SaveWebpageDialog saveWebpageDialog = new SaveWebpageDialog();
@@ -88,7 +100,7 @@ public class SaveWebpageDialog extends DialogFragment {
         return saveWebpageDialog;
     }
 
-    // `@SuppressLing("InflateParams")` removes the warning about using null as the parent view group when inflating the alert dialog.
+    // `@SuppressLint("InflateParams")` removes the warning about using null as the parent view group when inflating the alert dialog.
     @SuppressLint("InflateParams")
     @Override
     @NonNull
@@ -99,71 +111,74 @@ public class SaveWebpageDialog extends DialogFragment {
         // Remove the incorrect lint warning that the arguments might be null.
         assert arguments != null;
 
-        // Get the save type.
+        // Get the arguments from the bundle.
         int saveType = arguments.getInt("save_type");
+        String urlString = arguments.getString("url_string");
+        String fileSizeString = arguments.getString("file_size_string");
+        String contentDispositionFileNameString = arguments.getString("content_disposition_file_name_string");
+        String userAgentString = arguments.getString("user_agent_string");
+        boolean cookiesEnabled = arguments.getBoolean("cookies_enabled");
 
         // Get a handle for the activity and the context.
-        Activity activity = getActivity();
-        Context context = getContext();
-
-        // Remove the incorrect lint warnings below that the activity and context might be null.
-        assert activity != null;
-        assert context != null;
-
-        // Get a handle for the shared preferences.
-        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
-
-        // Get the screenshot and theme preferences.
-        boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
-        boolean allowScreenshots = sharedPreferences.getBoolean("allow_screenshots", false);
+        Activity activity = requireActivity();
+        Context context = requireContext();
 
         // Use an alert dialog builder to create the alert dialog.
-        AlertDialog.Builder dialogBuilder;
+        AlertDialog.Builder dialogBuilder = new AlertDialog.Builder(context, R.style.PrivacyBrowserAlertDialog);
 
-        // Set the style and icon according to the theme.
-        if (darkTheme) {
-            // Set the style.
-            dialogBuilder = new AlertDialog.Builder(activity, R.style.PrivacyBrowserAlertDialogDark);
+        // Get the current theme status.
+        int currentThemeStatus = getResources().getConfiguration().uiMode & Configuration.UI_MODE_NIGHT_MASK;
 
+        // Set the icon according to the theme.
+        if (currentThemeStatus == Configuration.UI_MODE_NIGHT_YES) {  // The night theme is enabled.
             // Set the icon according to the save type.
             switch (saveType) {
-                case ARCHIVE:
-                    dialogBuilder.setIcon(R.drawable.dom_storage_cleared_dark);
+                case StoragePermissionDialog.SAVE_URL:
+                    dialogBuilder.setIcon(R.drawable.copy_enabled_night);
                     break;
 
-                case IMAGE:
-                    dialogBuilder.setIcon(R.drawable.images_enabled_dark);
+                case StoragePermissionDialog.SAVE_ARCHIVE:
+                    dialogBuilder.setIcon(R.drawable.dom_storage_cleared_night);
                     break;
-            }
-        } else {
-            // Set the style.
-            dialogBuilder = new AlertDialog.Builder(activity, R.style.PrivacyBrowserAlertDialogLight);
 
+                case StoragePermissionDialog.SAVE_IMAGE:
+                    dialogBuilder.setIcon(R.drawable.images_enabled_night);
+                    break;
+            }
+        } else {  // The day theme is enabled.
             // Set the icon according to the save type.
             switch (saveType) {
-                case ARCHIVE:
-                    dialogBuilder.setIcon(R.drawable.dom_storage_cleared_light);
+                case StoragePermissionDialog.SAVE_URL:
+                    dialogBuilder.setIcon(R.drawable.copy_enabled_day);
+                    break;
+
+                case StoragePermissionDialog.SAVE_ARCHIVE:
+                    dialogBuilder.setIcon(R.drawable.dom_storage_cleared_day);
                     break;
 
-                case IMAGE:
-                    dialogBuilder.setIcon(R.drawable.images_enabled_light);
+                case StoragePermissionDialog.SAVE_IMAGE:
+                    dialogBuilder.setIcon(R.drawable.images_enabled_day);
                     break;
             }
         }
 
         // Set the title according to the type.
         switch (saveType) {
-            case ARCHIVE:
+            case StoragePermissionDialog.SAVE_URL:
+                dialogBuilder.setTitle(R.string.save);
+                break;
+
+            case StoragePermissionDialog.SAVE_ARCHIVE:
                 dialogBuilder.setTitle(R.string.save_archive);
                 break;
 
-            case IMAGE:
+            case StoragePermissionDialog.SAVE_IMAGE:
                 dialogBuilder.setTitle(R.string.save_image);
                 break;
         }
 
         // Set the view.  The parent view is null because it will be assigned by the alert dialog.
-        dialogBuilder.setView(activity.getLayoutInflater().inflate(R.layout.save_dialog, null));
+        dialogBuilder.setView(activity.getLayoutInflater().inflate(R.layout.save_url_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);
@@ -171,15 +186,21 @@ public class SaveWebpageDialog extends DialogFragment {
         // Set the save button listener.
         dialogBuilder.setPositiveButton(R.string.save, (DialogInterface dialog, int which) -> {
             // Return the dialog fragment to the parent activity.
-            saveWebpageListener.onSaveWebpage(saveType, this);
+            saveWebpageListener.onSaveWebpage(saveType, urlString, this);
         });
 
         // Create an alert dialog from the builder.
         AlertDialog alertDialog = dialogBuilder.create();
 
-        // Remove the incorrect lint warning below that `getWindow()` might be null.
+        // Remove the incorrect lint warning below that the window might be null.
         assert alertDialog.getWindow() != null;
 
+        // Get a handle for the shared preferences.
+        SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(context);
+
+        // Get the screenshot preference.
+        boolean allowScreenshots = sharedPreferences.getBoolean("allow_screenshots", false);
+
         // Disable screenshots if not allowed.
         if (!allowScreenshots) {
             alertDialog.getWindow().addFlags(WindowManager.LayoutParams.FLAG_SECURE);
@@ -189,40 +210,85 @@ public class SaveWebpageDialog extends DialogFragment {
         alertDialog.show();
 
         // Get handles for the layout items.
+        TextInputLayout urlTextInputLayout = alertDialog.findViewById(R.id.url_textinputlayout);
+        EditText urlEditText = alertDialog.findViewById(R.id.url_edittext);
         EditText fileNameEditText = alertDialog.findViewById(R.id.file_name_edittext);
         Button browseButton = alertDialog.findViewById(R.id.browse_button);
+        TextView fileSizeTextView = alertDialog.findViewById(R.id.file_size_textview);
+        TextView fileExistsWarningTextView = alertDialog.findViewById(R.id.file_exists_warning_textview);
         TextView storagePermissionTextView = alertDialog.findViewById(R.id.storage_permission_textview);
         Button saveButton = alertDialog.getButton(AlertDialog.BUTTON_POSITIVE);
 
-        // Create a default file name string.
-        String defaultFileName = "";
-
-        // Set the default file name according to the type.
-        switch (saveType) {
-            case ARCHIVE:
-                defaultFileName = getString(R.string.webpage_mht);
-                break;
-
-            case IMAGE:
-                defaultFileName = getString(R.string.webpage_png);
-                break;
-        }
-
-        // Create a string for the default file path.
-        String defaultFilePath;
+        // Remove the incorrect warnings that the views might be null.
+        assert urlTextInputLayout != null;
+        assert urlEditText != null;
+        assert fileNameEditText != null;
+        assert browseButton != null;
+        assert fileSizeTextView != null;
+        assert fileExistsWarningTextView != null;
+        assert storagePermissionTextView != null;
+
+        // Set the file size text view.
+        fileSizeTextView.setText(fileSizeString);
+
+        // Modify the layout based on the save type.
+        if (saveType == StoragePermissionDialog.SAVE_URL) {  // A URL is being saved.
+            // Remove the incorrect lint error below that the URL string might be null.
+            assert urlString != null;
+
+            // 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 (urlString.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.
+                String urlSubstring = urlString.substring(0, 100) + "…";
+
+                // Populate the URL edit text with the truncated URL.
+                urlEditText.setText(urlSubstring);
+
+                // Disable the editing of the URL edit text.
+                urlEditText.setInputType(InputType.TYPE_NULL);
+            } else {  // The URL contains a reference to the location of the data.
+                // Populate the URL edit text with the full URL.
+                urlEditText.setText(urlString);
+            }
 
-        // Set the default file path according to the storage permission state.
-        if (ContextCompat.checkSelfPermission(context, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) {  // The storage permission has been granted.
-            // Set the default file path to use the external public directory.
-            defaultFilePath = Environment.getExternalStorageDirectory() + "/" + defaultFileName;
-        } else {  // The storage permission has not been granted.
-            // Set the default file path to use the external private directory.
-            defaultFilePath = context.getExternalFilesDir(null) + "/" + defaultFileName;
+            // Update the file size and the status of the save button when the URL changes.
+            urlEditText.addTextChangedListener(new TextWatcher() {
+                @Override
+                public void beforeTextChanged(CharSequence charSequence, int i, int i1, int i2) {
+                    // Do nothing.
+                }
+
+                @Override
+                public void onTextChanged(CharSequence charSequence, int i, int i1, int i2) {
+                    // Do nothing.
+                }
+
+                @Override
+                public void afterTextChanged(Editable editable) {
+                    // Cancel the get URL size AsyncTask if it is running.
+                    if ((getUrlSize != null)) {
+                        getUrlSize.cancel(true);
+                    }
+
+                    // Get the current URL to save.
+                    String urlToSave = urlEditText.getText().toString();
+
+                    // Wipe the file size text view.
+                    fileSizeTextView.setText("");
+
+                    // Get the file size for the current URL.
+                    getUrlSize = new GetUrlSize(context, alertDialog, userAgentString, cookiesEnabled).execute(urlToSave);
+
+                    // Enable the save button if the URL and file name are populated.
+                    saveButton.setEnabled(!urlToSave.isEmpty() && !fileNameEditText.getText().toString().isEmpty());
+                }
+            });
+        } else {  // An archive or an image is being saved.
+            // Hide the URL edit text and the file size text view.
+            urlTextInputLayout.setVisibility(View.GONE);
+            fileSizeTextView.setVisibility(View.GONE);
         }
 
-        // Display the default file path.
-        fileNameEditText.setText(defaultFilePath);
-
         // Update the status of the save button when the file name changes.
         fileNameEditText.addTextChangedListener(new TextWatcher() {
             @Override
@@ -237,11 +303,68 @@ public class SaveWebpageDialog extends DialogFragment {
 
             @Override
             public void afterTextChanged(Editable s) {
-                // // Enable the save button if a file name exists.
-                saveButton.setEnabled(!fileNameEditText.getText().toString().isEmpty());
+                // Get the current file name.
+                String fileNameString = fileNameEditText.getText().toString();
+
+                // Convert the file name string to a file.
+                File file = new File(fileNameString);
+
+                // Check to see if the file exists.
+                if (file.exists()) {
+                    // Show the file exists warning.
+                    fileExistsWarningTextView.setVisibility(View.VISIBLE);
+                } else {
+                    // Hide the file exists warning.
+                    fileExistsWarningTextView.setVisibility(View.GONE);
+                }
+
+                // Enable the save button based on the save type.
+                if (saveType == StoragePermissionDialog.SAVE_URL) {  // A URL is being saved.
+                    // Enable the save button if the file name and the URL is populated.
+                    saveButton.setEnabled(!fileNameString.isEmpty() && !urlEditText.getText().toString().isEmpty());
+                } else {  // An archive or an image is being saved.
+                    // Enable the save button if the file name is populated.
+                    saveButton.setEnabled(!fileNameString.isEmpty());
+                }
             }
         });
 
+        // Create a file name string.
+        String fileName = "";
+
+        // Set the file name according to the type.
+        switch (saveType) {
+            case StoragePermissionDialog.SAVE_URL:
+                // Use the file name from the content disposition.
+                fileName = contentDispositionFileNameString;
+                break;
+
+            case StoragePermissionDialog.SAVE_ARCHIVE:
+                // Use an archive name ending in `.mht`.
+                fileName = getString(R.string.webpage_mht);
+                break;
+
+            case StoragePermissionDialog.SAVE_IMAGE:
+                // Use a file name ending in `.png`.
+                fileName = getString(R.string.webpage_png);
+                break;
+        }
+
+        // Save the file name as the default file name.  This must be final to be used in the lambda below.
+        final String defaultFileName = fileName;
+
+        // Instantiate the download location helper.
+        DownloadLocationHelper downloadLocationHelper = new DownloadLocationHelper();
+
+        // Get the default file path.
+        String defaultFilePath = downloadLocationHelper.getDownloadLocation(context) + "/" + defaultFileName;
+
+        // Populate the file name edit text.
+        fileNameEditText.setText(defaultFilePath);
+
+        // Move the cursor to the end of the default file path.
+        fileNameEditText.setSelection(defaultFilePath.length());
+
         // Handle clicks on the browse button.
         browseButton.setOnClickListener((View view) -> {
             // Create the file picker intent.
@@ -251,15 +374,7 @@ public class SaveWebpageDialog extends DialogFragment {
             browseIntent.setType("*/*");
 
             // Set the initial file name according to the type.
-            switch (saveType) {
-                case ARCHIVE:
-                    browseIntent.putExtra(Intent.EXTRA_TITLE, getString(R.string.webpage_mht));
-                    break;
-
-                case IMAGE:
-                    browseIntent.putExtra(Intent.EXTRA_TITLE, getString(R.string.webpage_png));
-                    break;
-            }
+            browseIntent.putExtra(Intent.EXTRA_TITLE, defaultFileName);
 
             // Set the initial directory if the minimum API >= 26.
             if (Build.VERSION.SDK_INT >= 26) {
@@ -273,8 +388,8 @@ public class SaveWebpageDialog extends DialogFragment {
             activity.startActivityForResult(browseIntent, MainWebViewActivity.BROWSE_SAVE_WEBPAGE_REQUEST_CODE);
         });
 
-        // Hide the storage permission text view on API < 23 as permissions on older devices are automatically granted.
-        if (Build.VERSION.SDK_INT < 23) {
+        // Hide the storage permission text view if the permission has already been granted.
+        if (ContextCompat.checkSelfPermission(context, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) {
             storagePermissionTextView.setVisibility(View.GONE);
         }