X-Git-Url: https://gitweb.stoutner.com/?p=PrivacyBrowserAndroid.git;a=blobdiff_plain;f=app%2Fsrc%2Fmain%2Fjava%2Fcom%2Fstoutner%2Fprivacybrowser%2Fasynctasks%2FSaveUrl.java;h=aaa4ce2bf67c171fc96e73eefc60491f3e5f2831;hp=1eb50323f096afdcfb70fabc64e4564636e89588;hb=484f0b0f0143c53a4722cee3a31e714df0c8c49a;hpb=4d51aa9acb8daaec1326f14e5025fde6d1f0dcd8 diff --git a/app/src/main/java/com/stoutner/privacybrowser/asynctasks/SaveUrl.java b/app/src/main/java/com/stoutner/privacybrowser/asynctasks/SaveUrl.java index 1eb50323..aaa4ce2b 100644 --- a/app/src/main/java/com/stoutner/privacybrowser/asynctasks/SaveUrl.java +++ b/app/src/main/java/com/stoutner/privacybrowser/asynctasks/SaveUrl.java @@ -1,5 +1,5 @@ /* - * Copyright © 2020 Soren Stoutner . + * Copyright © 2020-2021 Soren Stoutner . * * This file is part of Privacy Browser . * @@ -21,7 +21,12 @@ package com.stoutner.privacybrowser.asynctasks; import android.app.Activity; import android.content.Context; +import android.database.Cursor; +import android.net.Uri; import android.os.AsyncTask; +import android.os.Build; +import android.provider.OpenableColumns; +import android.util.Base64; import android.webkit.CookieManager; import com.google.android.material.snackbar.Snackbar; @@ -30,40 +35,59 @@ 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 { - // Define a weak references for the calling context and activities. - private WeakReference contextWeakReference; - private WeakReference activityWeakReference; +public class SaveUrl extends AsyncTask { + // Declare the weak references. + private final WeakReference contextWeakReference; + private final WeakReference activityWeakReference; // Define a success string constant. private final String SUCCESS = "Success"; - // Define the class variables. - private String filePathString; - private String userAgent; - private boolean cookiesEnabled; + // Declare the class variables. + private final Uri fileUri; + private final String userAgent; + private final boolean cookiesEnabled; private Snackbar savingFileSnackbar; + private long fileSize; + private String formattedFileSize; + private final String fileNameString; // The public constructor. - public SaveUrl(Context context, Activity activity, String filePathString, String userAgent, boolean cookiesEnabled) { + public SaveUrl(Context context, Activity activity, Uri fileUri, 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. - this.filePathString = filePathString; + this.fileUri = fileUri; this.userAgent = userAgent; this.cookiesEnabled = cookiesEnabled; + + // Query the exact file name if the API >= 26. + if (Build.VERSION.SDK_INT >= 26) { + // Get a cursor from the content resolver. + Cursor contentResolverCursor = activity.getContentResolver().query(fileUri, null, null, null); + + // Move to the first row. + contentResolverCursor.moveToFirst(); + + // Get the file name from the cursor. + fileNameString = contentResolverCursor.getString(contentResolverCursor.getColumnIndexOrThrow(OpenableColumns.DISPLAY_NAME)); + + // Close the cursor. + contentResolverCursor.close(); + } else { + // Use the file URI last path segment as the file name string. + fileNameString = fileUri.getLastPathSegment(); + } } // `onPreExecute()` operates on the UI thread. @@ -81,7 +105,7 @@ public class SaveUrl extends AsyncTask { 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% - " + fileNameString, Snackbar.LENGTH_INDEFINITE); // Display the saving file snackbar. savingFileSnackbar.show(); @@ -89,7 +113,7 @@ public class SaveUrl extends AsyncTask { @Override protected String doInBackground(String... urlToSave) { - // Get a handle for the context and activity. + // Get handles for the context and activity. Context context = contextWeakReference.get(); Activity activity = activityWeakReference.get(); @@ -101,81 +125,104 @@ public class SaveUrl extends AsyncTask { // 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]); + // Get the URL string. + String urlString = urlToSave[0]; - // Instantiate the proxy helper. - ProxyHelper proxyHelper = new ProxyHelper(); + try { + // Open an output stream. + OutputStream outputStream = activity.getContentResolver().openOutputStream(fileUri); - // Get the current proxy. - Proxy proxy = proxyHelper.getCurrentProxy(context); + // 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); - // Open a connection to the URL. No data is actually sent at this point. - HttpURLConnection httpUrlConnection = (HttpURLConnection) url.openConnection(proxy); + // Decode the Base64 string to a byte array. + byte[] base64DecodedDataByteArray = Base64.decode(base64DataString, Base64.DEFAULT); - // Add the user agent to the header property. - httpUrlConnection.setRequestProperty("User-Agent", userAgent); + // 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); - // Add the cookies if they are enabled. - if (cookiesEnabled) { - // Get the cookies for the current domain. - String cookiesString = CookieManager.getInstance().getCookie(url.toString()); + // Instantiate the proxy helper. + ProxyHelper proxyHelper = new ProxyHelper(); - // Only add the cookies if they are not null. - if (cookiesString != null) { - // Add the cookies to the header property. - httpUrlConnection.setRequestProperty("Cookie", cookiesString); - } - } + // Get the current proxy. + Proxy proxy = proxyHelper.getCurrentProxy(context); - // 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(); + // Open a connection to the URL. No data is actually sent at this point. + HttpURLConnection httpUrlConnection = (HttpURLConnection) url.openConnection(proxy); - // Get the response body stream. - InputStream inputStream = new BufferedInputStream(httpUrlConnection.getInputStream()); + // Add the user agent to the header property. + httpUrlConnection.setRequestProperty("User-Agent", userAgent); - // Get the file. - File file = new File(filePathString); + // Add the cookies if they are enabled. + if (cookiesEnabled) { + // Get the cookies for the current domain. + String cookiesString = CookieManager.getInstance().getCookie(url.toString()); - // Delete the file if it exists. - if (file.exists()) { - //noinspection ResultOfMethodCallIgnored - file.delete(); + // 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(); - - // 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); + // 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"); + + // 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); + + // 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; + } + + // Get the response body stream. + InputStream inputStream = new BufferedInputStream(httpUrlConnection.getInputStream()); + + // Initialize the conversion buffer byte array. + // This is set to a megabyte so that frequent updating of the snackbar doesn't freeze the interface on download. + byte[] conversionBufferByteArray = new byte[1048576]; + + // Initialize the downloaded kilobytes counter. + long downloadedKilobytesCounter = 0; + + // 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 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(); } - - // Close the input stream. - inputStream.close(); - - // Close the output stream. - outputStream.close(); - } finally { - // Disconnect the HTTP URL connection. - httpUrlConnection.disconnect(); } - } catch (IOException exception) { + + // Close the output stream. + outputStream.close(); + } catch (Exception exception) { // Store the error in the save disposition string. saveDisposition = exception.toString(); } @@ -184,10 +231,38 @@ public class SaveUrl extends AsyncTask { 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) + " - " + fileNameString); + } 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) + " - " + fileNameString); + } + } + // `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. @@ -203,8 +278,10 @@ public class SaveUrl extends AsyncTask { // 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) + " " + fileNameString, 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(); } }