/*
- * 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.ActivityNotFoundException;
-import android.content.ContentResolver;
import android.content.Context;
-import android.content.Intent;
+import android.database.Cursor;
import android.net.Uri;
import android.os.AsyncTask;
import android.os.Build;
-import android.view.View;
+import android.provider.OpenableColumns;
+import android.util.Base64;
import android.webkit.CookieManager;
-import android.webkit.MimeTypeMap;
-
-import androidx.core.content.FileProvider;
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.InputStream;
import java.io.OutputStream;
import java.lang.ref.WeakReference;
import java.text.NumberFormat;
public class SaveUrl extends AsyncTask<String, Long, String> {
- // Define a weak references for the calling context and activity.
- private WeakReference<Context> contextWeakReference;
- private WeakReference<Activity> activityWeakReference;
+ // Declare the 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;
+ // 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.
NoSwipeViewPager noSwipeViewPager = activity.findViewById(R.id.webviewpager);
// Create a saving file snackbar.
- savingFileSnackbar = Snackbar.make(noSwipeViewPager, activity.getString(R.string.saving_file) + " 0% - " + filePathString, 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();
// 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.
+ String urlString = urlToSave[0];
+
try {
- // Get the URL from the calling activity.
- URL url = new URL(urlToSave[0]);
+ // Open an output stream.
+ OutputStream outputStream = activity.getContentResolver().openOutputStream(fileUri);
- // Instantiate the proxy helper.
- ProxyHelper proxyHelper = new ProxyHelper();
+ // 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);
- // Get the current proxy.
- Proxy proxy = proxyHelper.getCurrentProxy(context);
+ // Decode the Base64 string to a byte array.
+ byte[] base64DecodedDataByteArray = Base64.decode(base64DataString, Base64.DEFAULT);
- // Open a connection to the URL. No data is actually sent at this point.
- HttpURLConnection httpUrlConnection = (HttpURLConnection) url.openConnection(proxy);
+ // 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 user agent to the header property.
- httpUrlConnection.setRequestProperty("User-Agent", userAgent);
+ // Instantiate the proxy helper.
+ ProxyHelper proxyHelper = new ProxyHelper();
- // Add the cookies if they are enabled.
- if (cookiesEnabled) {
- // Get the cookies for the current domain.
- String cookiesString = CookieManager.getInstance().getCookie(url.toString());
+ // Get the current proxy.
+ Proxy proxy = proxyHelper.getCurrentProxy(context);
- // Only add the cookies if they are not null.
- if (cookiesString != null) {
- // Add the cookies to the header property.
- httpUrlConnection.setRequestProperty("Cookie", cookiesString);
- }
- }
+ // Open a connection to the URL. No data is actually sent at this point.
+ HttpURLConnection httpUrlConnection = (HttpURLConnection) url.openConnection(proxy);
- // 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");
-
- // Define the file size long.
- long fileSize;
-
- // 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);
- } 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());
+ // 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);
+ // 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;
+ }
- // Initialize the conversion buffer byte array.
- byte[] conversionBufferByteArray = new byte[1024];
+ // Get the response body stream.
+ InputStream inputStream = new BufferedInputStream(httpUrlConnection.getInputStream());
- // Initialize the downloaded kilobytes counter.
- long downloadedKilobytesCounter = 0;
+ // 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. <https://redmine.stoutner.com/issues/709>
+ byte[] conversionBufferByteArray = new byte[1048576];
- // Define the buffer length variable.
- int bufferLength;
+ // Initialize the downloaded kilobytes counter.
+ long downloadedKilobytesCounter = 0;
- // 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);
+ // Define the buffer length variable.
+ int bufferLength;
- // Update the file download progress snackbar.
- if (fileSize == -1) { // The file size is unknown.
- // Negatively update the downloaded kilobytes counter.
- downloadedKilobytesCounter = downloadedKilobytesCounter - 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);
- publishProgress(downloadedKilobytesCounter);
- } else { // The file size is known.
// Update the downloaded kilobytes counter.
downloadedKilobytesCounter = downloadedKilobytesCounter + bufferLength;
- // Calculate the download percentage.
- long downloadPercentage = (downloadedKilobytesCounter * 100) / fileSize;
-
- // Update the download percentage.
- publishProgress(downloadPercentage);
+ // Update the file download progress snackbar.
+ publishProgress(downloadedKilobytesCounter);
}
- }
- // Close the input stream.
- inputStream.close();
-
- // Close the output stream.
- outputStream.close();
-
- // Create a media scanner intent, which adds items like pictures to Android's recent file list.
- Intent mediaScannerIntent = new Intent(Intent.ACTION_MEDIA_SCANNER_SCAN_FILE);
-
- // Add the URI to the media scanner intent.
- mediaScannerIntent.setData(Uri.fromFile(file));
-
- // Make it so.
- activity.sendBroadcast(mediaScannerIntent);
- } finally {
- // Disconnect the HTTP URL connection.
- httpUrlConnection.disconnect();
+ // Close the input stream.
+ inputStream.close();
+ } finally {
+ // Disconnect the HTTP URL connection.
+ httpUrlConnection.disconnect();
+ }
}
+
+ // Close the output stream.
+ outputStream.close();
} catch (Exception exception) {
// Store the error in the save disposition string.
saveDisposition = exception.toString();
// `onProgressUpdate()` operates on the UI thread.
@Override
- protected void onProgressUpdate(Long... downloadPercentage) {
+ protected void onProgressUpdate(Long... numberOfBytesDownloaded) {
// Get a handle for the activity.
Activity activity = activityWeakReference.get();
return;
}
- // Check to see if a download percentage has been calculated.
- if (downloadPercentage[0] < 0) { // There is no download percentage. The negative number represents the raw downloaded kilobytes.
- // Calculate the number of bytes downloaded. When the `downloadPercentage` is negative, it is actually the raw number of kilobytes downloaded.
- long numberOfBytesDownloaded = 0 - downloadPercentage[0];
-
- // Format the number of bytes downloaded.
- String formattedNumberOfBytesDownloaded = NumberFormat.getInstance().format(numberOfBytesDownloaded);
+ // 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) + " - " + filePathString);
- } else { // There is a download percentage.
+ 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[0] + "% - " + filePathString);
+ savingFileSnackbar.setText(activity.getString(R.string.saving_file) + " " + downloadPercentage + "% - " + formattedNumberOfBytesDownloaded + " " + activity.getString(R.string.bytes) + " / " +
+ formattedFileSize + " " + activity.getString(R.string.bytes) + " - " + fileNameString);
}
}
@Override
protected void onPostExecute(String saveDisposition) {
// Get handles for the context and activity.
- Context context = contextWeakReference.get();
Activity activity = activityWeakReference.get();
// Abort if the activity is gone.
// Display a save disposition snackbar.
if (saveDisposition.equals(SUCCESS)) {
- // Create a file saved snackbar.
- Snackbar fileSavedSnackbar = Snackbar.make(noSwipeViewPager, activity.getString(R.string.file_saved) + " " + filePathString, Snackbar.LENGTH_LONG);
-
- // Add an open action if the file is not an APK on API >= 26 (that scenario requires the REQUEST_INSTALL_PACKAGES permission).
- if (!(Build.VERSION.SDK_INT >= 26 && filePathString.endsWith(".apk"))) {
- fileSavedSnackbar.setAction(R.string.open, (View v) -> {
- // Get a file for the file path string.
- File file = new File(filePathString);
-
- // Define a file URI variable
- Uri fileUri;
-
- // Get the URI for the file according to the Android version.
- if (Build.VERSION.SDK_INT >= 24) { // Use a file provider.
- fileUri = FileProvider.getUriForFile(context, activity.getString(R.string.file_provider), file);
- } else { // Get the raw file path URI.
- fileUri = Uri.fromFile(file);
- }
-
- // Get a handle for the content resolver.
- ContentResolver contentResolver = context.getContentResolver();
-
- // Create an open intent with `ACTION_VIEW`.
- Intent openIntent = new Intent(Intent.ACTION_VIEW);
-
- // Set the URI and the MIME type.
- if (filePathString.endsWith("apk") || filePathString.endsWith("APK")) { // Force detection of APKs.
- openIntent.setDataAndType(fileUri, MimeTypeMap.getSingleton().getMimeTypeFromExtension("apk"));
- } else { // Autodetect the MIME type.
- openIntent.setDataAndType(fileUri, contentResolver.getType(fileUri));
- }
-
- // Allow the app to read the file URI.
- openIntent.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
-
- // Try the intent.
- try {
- // Show the chooser.
- activity.startActivity(openIntent);
- } catch (ActivityNotFoundException exception) { // There are no apps available to open the URL.
- // Show a snackbar with the error.
- Snackbar.make(noSwipeViewPager, activity.getString(R.string.error) + " " + exception, Snackbar.LENGTH_INDEFINITE).show();
- }
- });
- }
-
- // Show the file saved snackbar.
- fileSavedSnackbar.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();
projects / PrivacyBrowserAndroid.git / blobdiff