/*
- * Copyright © 2020 Soren Stoutner <soren@stoutner.com>.
+ * Copyright © 2020-2021 Soren Stoutner <soren@stoutner.com>.
*
* This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
*
package com.stoutner.privacybrowser.asynctasks;
import android.app.Activity;
+import android.content.Context;
+import android.net.Uri;
import android.os.AsyncTask;
+import android.util.Base64;
import android.webkit.CookieManager;
import com.google.android.material.snackbar.Snackbar;
import com.stoutner.privacybrowser.R;
+import com.stoutner.privacybrowser.helpers.ProxyHelper;
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.Proxy;
import java.net.URL;
+import java.text.NumberFormat;
-public class SaveUrl extends AsyncTask<String, Void, String> {
- // Define a weak reference to the calling activity.
- private WeakReference<Activity> activityWeakReference;
+public class SaveUrl extends AsyncTask<String, Long, String> {
+ // Define a weak references.
+ private final WeakReference<Context> contextWeakReference;
+ private final 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 final String filePathString;
+ private final String userAgent;
+ private final boolean cookiesEnabled;
private Snackbar savingFileSnackbar;
+ private long fileSize;
+ private String formattedFileSize;
+ private String urlString = "";
// The public constructor.
- public SaveUrl(Activity activity, String filePathString, String userAgent, boolean cookiesEnabled) {
- // Populate the weak reference to the calling activity.
+ public SaveUrl(Context context, Activity activity, String filePathString, String userAgent, boolean cookiesEnabled) {
+ // Populate weak references to the calling context and activity.
+ contextWeakReference = new WeakReference<>(context);
activityWeakReference = new WeakReference<>(activity);
// Store the class variables.
NoSwipeViewPager noSwipeViewPager = activity.findViewById(R.id.webviewpager);
// Create a saving file snackbar.
- savingFileSnackbar = Snackbar.make(noSwipeViewPager, R.string.saving_file, Snackbar.LENGTH_INDEFINITE);
+ savingFileSnackbar = Snackbar.make(noSwipeViewPager, activity.getString(R.string.saving_file) + " 0% - " + urlString, Snackbar.LENGTH_INDEFINITE);
// Display the saving file snackbar.
savingFileSnackbar.show();
@Override
protected String doInBackground(String... urlToSave) {
- // Get a handle for the activity.
+ // Get handles for the context and activity.
+ Context context = contextWeakReference.get();
Activity activity = activityWeakReference.get();
// Abort if the activity is gone.
// 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`.
+ // Get the URL string.
+ urlString = urlToSave[0];
+
try {
- // Get the URL from the main activity.
- URL url = new URL(urlToSave[0]);
+ // Open an output stream.
+ OutputStream outputStream = activity.getContentResolver().openOutputStream(Uri.parse(filePathString));
- // Open a connection to the URL. No data is actually sent at this point.
- HttpURLConnection httpUrlConnection = (HttpURLConnection) url.openConnection();
+ // Save the URL.
+ if (urlString.startsWith("data:")) { // The URL contains the entire data of an image.
+ // Get the Base64 data, which begins after a `,`.
+ String base64DataString = urlString.substring(urlString.indexOf(",") + 1);
- // Add the user agent to the header property.
- httpUrlConnection.setRequestProperty("User-Agent", userAgent);
+ // Decode the Base64 string to a byte array.
+ byte[] base64DecodedDataByteArray = Base64.decode(base64DataString, Base64.DEFAULT);
- // Add the cookies if they are enabled.
- if (cookiesEnabled) {
- // Get the cookies for the current domain.
- String cookiesString = CookieManager.getInstance().getCookie(url.toString());
+ // Write the Base64 byte array to the output stream.
+ outputStream.write(base64DecodedDataByteArray);
+ } else { // The URL points to the data location on the internet.
+ // Get the URL from the calling activity.
+ URL url = new URL(urlString);
- // Only add the cookies if they are not null.
- if (cookiesString != null) {
- // Add the cookies to the header property.
- httpUrlConnection.setRequestProperty("Cookie", cookiesString);
- }
- }
+ // Instantiate the proxy helper.
+ ProxyHelper proxyHelper = new ProxyHelper();
- // 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 current proxy.
+ Proxy proxy = proxyHelper.getCurrentProxy(context);
- // Get the response body stream.
- InputStream inputStream = new BufferedInputStream(httpUrlConnection.getInputStream());
+ // Open a connection to the URL. No data is actually sent at this point.
+ HttpURLConnection httpUrlConnection = (HttpURLConnection) url.openConnection(proxy);
- // Get the file.
- File file = new File(filePathString);
+ // Add the user agent to the header property.
+ httpUrlConnection.setRequestProperty("User-Agent", userAgent);
- // Delete the file if it exists.
- if (file.exists()) {
- //noinspection ResultOfMethodCallIgnored
- file.delete();
+ // 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);
+ }
}
- // Create a new file.
- //noinspection ResultOfMethodCallIgnored
- file.createNewFile();
+ // 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 content length header, which causes the connection to the server to be made.
+ String contentLengthString = httpUrlConnection.getHeaderField("Content-Length");
- // Create an output file stream.
- OutputStream outputStream = new FileOutputStream(file);
+ // Make sure the content length isn't null.
+ if (contentLengthString != null) { // The content length isn't null.
+ // Convert the content length to an long.
+ fileSize = Long.parseLong(contentLengthString);
- // Initialize the conversion buffer byte array.
- byte[] conversionBufferByteArray = new byte[1024];
+ // Format the file size for display.
+ formattedFileSize = NumberFormat.getInstance().format(fileSize);
+ } else { // The content length is null.
+ // Set the file size to be `-1`.
+ fileSize = -1;
+ }
- // Define the buffer length variable.
- int bufferLength;
+ // Get the response body stream.
+ InputStream inputStream = new BufferedInputStream(httpUrlConnection.getInputStream());
- // 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);
- }
+ // Initialize the conversion buffer byte array.
+ byte[] conversionBufferByteArray = new byte[1024];
+
+ // Initialize the downloaded kilobytes counter.
+ long downloadedKilobytesCounter = 0;
- // Close the input stream.
- inputStream.close();
+ // Define the buffer length variable.
+ int bufferLength;
- // Close the output stream.
- outputStream.close();
- } finally {
- // Disconnect the HTTP URL connection.
- httpUrlConnection.disconnect();
+ // 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 file output stream.
+ outputStream.write(conversionBufferByteArray, 0, bufferLength);
+
+ // Update the downloaded kilobytes counter.
+ downloadedKilobytesCounter = downloadedKilobytesCounter + bufferLength;
+
+ // Update the file download progress snackbar.
+ publishProgress(downloadedKilobytesCounter);
+ }
+
+ // Close the input stream.
+ inputStream.close();
+ } finally {
+ // Disconnect the HTTP URL connection.
+ httpUrlConnection.disconnect();
+ }
}
- } catch (IOException exception) {
+
+ // Flush the output stream.
+ outputStream.flush();
+
+ // Close the output stream.
+ outputStream.close();
+ } catch (Exception exception) {
// Store the error in the save disposition string.
saveDisposition = exception.toString();
}
return saveDisposition;
}
+ // `onProgressUpdate()` operates on the UI thread.
+ @Override
+ protected void onProgressUpdate(Long... numberOfBytesDownloaded) {
+ // Get a handle for the activity.
+ Activity activity = activityWeakReference.get();
+
+ // Abort if the activity is gone.
+ if ((activity == null) || activity.isFinishing()) {
+ return;
+ }
+
+ // Format the number of bytes downloaded.
+ String formattedNumberOfBytesDownloaded = NumberFormat.getInstance().format(numberOfBytesDownloaded[0]);
+
+ // Check to see if the file size is known.
+ if (fileSize == -1) { // The size of the download file is not known.
+ // Update the snackbar.
+ savingFileSnackbar.setText(activity.getString(R.string.saving_file) + " " + formattedNumberOfBytesDownloaded + " " + activity.getString(R.string.bytes) + " - " + urlString);
+ } else { // The size of the download file is known.
+ // Calculate the download percentage.
+ long downloadPercentage = (numberOfBytesDownloaded[0] * 100) / fileSize;
+
+ // Update the snackbar.
+ savingFileSnackbar.setText(activity.getString(R.string.saving_file) + " " + downloadPercentage + "% - " + formattedNumberOfBytesDownloaded + " " + activity.getString(R.string.bytes) + " / " + formattedFileSize + " " +
+ activity.getString(R.string.bytes) + " - " + urlString);
+ }
+ }
+
// `onPostExecute()` operates on the UI thread.
@Override
protected void onPostExecute(String saveDisposition) {
- // Get a handle for the activity.
+ // Get handles for the context and activity.
Activity activity = activityWeakReference.get();
// Abort if the activity is gone.
// Display a save disposition snackbar.
if (saveDisposition.equals(SUCCESS)) {
- Snackbar.make(noSwipeViewPager, R.string.file_saved, Snackbar.LENGTH_SHORT).show();
+ // Display the file saved snackbar.
+ Snackbar.make(noSwipeViewPager, activity.getString(R.string.file_saved) + " " + urlString, Snackbar.LENGTH_LONG).show();
} else {
+ // Display the file saving error.
Snackbar.make(noSwipeViewPager, activity.getString(R.string.error_saving_file) + " " + saveDisposition, Snackbar.LENGTH_INDEFINITE).show();
}
}
projects / PrivacyBrowserAndroid.git / blobdiff