]> gitweb.stoutner.com Git - PrivacyBrowserAndroid.git/blobdiff - app/src/main/java/com/stoutner/privacybrowser/asynctasks/SaveUrl.java
Add an option to save a raw URL. https://redmine.stoutner.com/issues/463
[PrivacyBrowserAndroid.git] / app / src / main / java / com / stoutner / privacybrowser / asynctasks / SaveUrl.java
diff --git a/app/src/main/java/com/stoutner/privacybrowser/asynctasks/SaveUrl.java b/app/src/main/java/com/stoutner/privacybrowser/asynctasks/SaveUrl.java
new file mode 100644 (file)
index 0000000..fd72db4
--- /dev/null
@@ -0,0 +1,199 @@
+/*
+ * Copyright © 2020 Soren Stoutner <soren@stoutner.com>.
+ *
+ * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
+ *
+ * Privacy Browser 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,
+ * 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/>.
+ */
+
+package com.stoutner.privacybrowser.asynctasks;
+
+import android.app.Activity;
+import android.os.AsyncTask;
+import android.webkit.CookieManager;
+
+import com.google.android.material.snackbar.Snackbar;
+import com.stoutner.privacybrowser.R;
+import com.stoutner.privacybrowser.views.NoSwipeViewPager;
+
+import java.io.BufferedInputStream;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.lang.ref.WeakReference;
+import java.net.HttpURLConnection;
+import java.net.URL;
+
+public class SaveUrl extends AsyncTask<String, Void, String> {
+    // Define a weak reference to the calling activity.
+    private WeakReference<Activity> activityWeakReference;
+
+    // Define a success string constant.
+    private final String SUCCESS = "Success";
+
+    // Define the class variables.
+    private String filePathString;
+    private String userAgent;
+    private boolean cookiesEnabled;
+    private Snackbar savingFileSnackbar;
+
+    // The public constructor.
+    public SaveUrl(Activity activity, String filePathString, String userAgent, boolean cookiesEnabled) {
+        // Populate the weak reference to the calling activity.
+        activityWeakReference = new WeakReference<>(activity);
+
+        // Store the class variables.
+        this.filePathString = filePathString;
+        this.userAgent = userAgent;
+        this.cookiesEnabled = cookiesEnabled;
+    }
+
+    // `onPreExecute()` operates on the UI thread.
+    @Override
+    protected void onPreExecute() {
+        // Get a handle for the activity.
+        Activity activity = activityWeakReference.get();
+
+        // Abort if the activity is gone.
+        if ((activity==null) || activity.isFinishing()) {
+            return;
+        }
+
+        // Get a handle for the no swipe view pager.
+        NoSwipeViewPager noSwipeViewPager = activity.findViewById(R.id.webviewpager);
+
+        // Create a saving file snackbar.
+        savingFileSnackbar = Snackbar.make(noSwipeViewPager, R.string.saving_file, Snackbar.LENGTH_INDEFINITE);
+
+        // Display the saving file snackbar.
+        savingFileSnackbar.show();
+    }
+
+    @Override
+    protected String doInBackground(String... urlToSave) {
+        // Get a handle for the activity.
+        Activity activity = activityWeakReference.get();
+
+        // Abort if the activity is gone.
+        if ((activity == null) || activity.isFinishing()) {
+            return null;
+        }
+
+        // Define a save disposition string.
+        String saveDisposition = SUCCESS;
+
+        // Because everything relating to requesting data from a webserver can throw errors, the entire section must catch `IOExceptions`.
+        try {
+            // Get the URL from the main activity.
+            URL url = new URL(urlToSave[0]);
+
+            // Open a connection to the URL.  No data is actually sent at this point.
+            HttpURLConnection httpUrlConnection = (HttpURLConnection) url.openConnection();
+
+            // Add the user agent to the header property.
+            httpUrlConnection.setRequestProperty("User-Agent", userAgent);
+
+            // Add the cookies if they are enabled.
+            if (cookiesEnabled) {
+                // Get the cookies for the current domain.
+                String cookiesString = CookieManager.getInstance().getCookie(url.toString());
+
+                // Only add the cookies if they are not null.
+                if (cookiesString != null) {
+                    // Add the cookies to the header property.
+                    httpUrlConnection.setRequestProperty("Cookie", cookiesString);
+                }
+            }
+
+            // The actual network request is in a `try` bracket so that `disconnect()` is run in the `finally` section even if an error is encountered in the main block.
+            try {
+                // Get the response code, which causes the connection to the server to be made.
+                httpUrlConnection.getResponseCode();
+
+                // Get the response body stream.
+                InputStream inputStream = new BufferedInputStream(httpUrlConnection.getInputStream());
+
+                // Get the file.
+                File file = new File(filePathString);
+
+                // Delete the file if it exists.
+                if (file.exists()) {
+                    //noinspection ResultOfMethodCallIgnored
+                    file.delete();
+                }
+
+                // Create a new file.
+                //noinspection ResultOfMethodCallIgnored
+                file.createNewFile();
+
+                // Create an output file stream.
+                OutputStream outputStream = new FileOutputStream(file);
+
+                // Initialize the conversion buffer byte array.
+                byte[] conversionBufferByteArray = new byte[1024];
+
+                // Define the buffer length variable.
+                int bufferLength;
+
+                // Attempt to read data from the input stream and store it in the output stream.  Also store the amount of data read in the buffer length variable.
+                while ((bufferLength = inputStream.read(conversionBufferByteArray)) > 0) {  // Proceed while the amount of data stored in the buffer in > 0.
+                    // Write the contents of the conversion buffer to the output stream.
+                    outputStream.write(conversionBufferByteArray, 0, bufferLength);
+                }
+
+                // Close the input stream.
+                inputStream.close();
+
+                // Close the output stream.
+                outputStream.close();
+            } finally {
+                // Disconnect the HTTP URL connection.
+                httpUrlConnection.disconnect();
+            }
+        } catch (IOException exception) {
+            // Store the error in the save disposition string.
+            saveDisposition = exception.toString();
+        }
+
+        // Return the save disposition string.
+        return saveDisposition;
+    }
+
+    // `onPostExecute()` operates on the UI thread.
+    @Override
+    protected void onPostExecute(String saveDisposition) {
+        // Get a handle for the activity.
+        Activity activity = activityWeakReference.get();
+
+        // Abort if the activity is gone.
+        if ((activity == null) || activity.isFinishing()) {
+            return;
+        }
+
+        // Get a handle for the no swipe view pager.
+        NoSwipeViewPager noSwipeViewPager = activity.findViewById(R.id.webviewpager);
+
+        // Dismiss the saving file snackbar.
+        savingFileSnackbar.dismiss();
+
+        // Display a save disposition snackbar.
+        if (saveDisposition.equals(SUCCESS)) {
+            Snackbar.make(noSwipeViewPager, R.string.file_saved, Snackbar.LENGTH_SHORT).show();
+        } else {
+            Snackbar.make(noSwipeViewPager, activity.getString(R.string.error_saving_file) + "  " + saveDisposition, Snackbar.LENGTH_INDEFINITE).show();
+        }
+    }
+}
\ No newline at end of file