2 * Copyright © 2015-2022 Soren Stoutner <soren@stoutner.com>.
4 * Download cookie code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
6 * This file is part of Privacy Browser Android <https://www.stoutner.com/privacy-browser-android>.
8 * Privacy Browser Android is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * Privacy Browser Android is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with Privacy Browser Android. If not, see <http://www.gnu.org/licenses/>.
22 package com.stoutner.privacybrowser.activities;
24 import android.animation.ObjectAnimator;
25 import android.annotation.SuppressLint;
26 import android.app.Activity;
27 import android.app.Dialog;
28 import android.app.DownloadManager;
29 import android.app.SearchManager;
30 import android.content.ActivityNotFoundException;
31 import android.content.BroadcastReceiver;
32 import android.content.ClipData;
33 import android.content.ClipboardManager;
34 import android.content.Context;
35 import android.content.Intent;
36 import android.content.IntentFilter;
37 import android.content.SharedPreferences;
38 import android.content.pm.PackageManager;
39 import android.content.res.Configuration;
40 import android.database.Cursor;
41 import android.graphics.Bitmap;
42 import android.graphics.BitmapFactory;
43 import android.graphics.Typeface;
44 import android.graphics.drawable.BitmapDrawable;
45 import android.graphics.drawable.Drawable;
46 import android.net.Uri;
47 import android.net.http.SslCertificate;
48 import android.net.http.SslError;
49 import android.os.AsyncTask;
50 import android.os.Build;
51 import android.os.Bundle;
52 import android.os.Environment;
53 import android.os.Handler;
54 import android.os.Message;
55 import android.preference.PreferenceManager;
56 import android.print.PrintDocumentAdapter;
57 import android.print.PrintManager;
58 import android.provider.DocumentsContract;
59 import android.provider.OpenableColumns;
60 import android.text.Editable;
61 import android.text.Spanned;
62 import android.text.TextWatcher;
63 import android.text.style.ForegroundColorSpan;
64 import android.util.Patterns;
65 import android.util.TypedValue;
66 import android.view.ContextMenu;
67 import android.view.GestureDetector;
68 import android.view.KeyEvent;
69 import android.view.Menu;
70 import android.view.MenuItem;
71 import android.view.MotionEvent;
72 import android.view.View;
73 import android.view.ViewGroup;
74 import android.view.WindowManager;
75 import android.view.inputmethod.InputMethodManager;
76 import android.webkit.CookieManager;
77 import android.webkit.HttpAuthHandler;
78 import android.webkit.SslErrorHandler;
79 import android.webkit.ValueCallback;
80 import android.webkit.WebBackForwardList;
81 import android.webkit.WebChromeClient;
82 import android.webkit.WebResourceRequest;
83 import android.webkit.WebResourceResponse;
84 import android.webkit.WebSettings;
85 import android.webkit.WebStorage;
86 import android.webkit.WebView;
87 import android.webkit.WebViewClient;
88 import android.webkit.WebViewDatabase;
89 import android.widget.ArrayAdapter;
90 import android.widget.CheckBox;
91 import android.widget.CursorAdapter;
92 import android.widget.EditText;
93 import android.widget.FrameLayout;
94 import android.widget.ImageView;
95 import android.widget.LinearLayout;
96 import android.widget.ListView;
97 import android.widget.ProgressBar;
98 import android.widget.RadioButton;
99 import android.widget.RelativeLayout;
100 import android.widget.TextView;
102 import androidx.activity.result.ActivityResultCallback;
103 import androidx.activity.result.ActivityResultLauncher;
104 import androidx.activity.result.contract.ActivityResultContracts;
105 import androidx.annotation.NonNull;
106 import androidx.appcompat.app.ActionBar;
107 import androidx.appcompat.app.ActionBarDrawerToggle;
108 import androidx.appcompat.app.AppCompatActivity;
109 import androidx.appcompat.app.AppCompatDelegate;
110 import androidx.appcompat.widget.Toolbar;
111 import androidx.coordinatorlayout.widget.CoordinatorLayout;
112 import androidx.core.content.res.ResourcesCompat;
113 import androidx.core.view.GravityCompat;
114 import androidx.drawerlayout.widget.DrawerLayout;
115 import androidx.fragment.app.DialogFragment;
116 import androidx.fragment.app.Fragment;
117 import androidx.swiperefreshlayout.widget.SwipeRefreshLayout;
118 import androidx.viewpager.widget.ViewPager;
119 import androidx.webkit.WebSettingsCompat;
120 import androidx.webkit.WebViewFeature;
123 import com.google.android.material.appbar.AppBarLayout;
124 import com.google.android.material.floatingactionbutton.FloatingActionButton;
125 import com.google.android.material.navigation.NavigationView;
126 import com.google.android.material.snackbar.Snackbar;
127 import com.google.android.material.tabs.TabLayout;
129 import com.stoutner.privacybrowser.R;
130 import com.stoutner.privacybrowser.adapters.WebViewPagerAdapter;
131 import com.stoutner.privacybrowser.asynctasks.GetHostIpAddresses;
132 import com.stoutner.privacybrowser.asynctasks.PopulateBlocklists;
133 import com.stoutner.privacybrowser.asynctasks.PrepareSaveDialog;
134 import com.stoutner.privacybrowser.asynctasks.SaveUrl;
135 import com.stoutner.privacybrowser.asynctasks.SaveWebpageImage;
136 import com.stoutner.privacybrowser.dataclasses.PendingDialog;
137 import com.stoutner.privacybrowser.dialogs.CreateBookmarkDialog;
138 import com.stoutner.privacybrowser.dialogs.CreateBookmarkFolderDialog;
139 import com.stoutner.privacybrowser.dialogs.CreateHomeScreenShortcutDialog;
140 import com.stoutner.privacybrowser.dialogs.EditBookmarkFolderDialog;
141 import com.stoutner.privacybrowser.dialogs.FontSizeDialog;
142 import com.stoutner.privacybrowser.dialogs.HttpAuthenticationDialog;
143 import com.stoutner.privacybrowser.dialogs.OpenDialog;
144 import com.stoutner.privacybrowser.dialogs.ProxyNotInstalledDialog;
145 import com.stoutner.privacybrowser.dialogs.PinnedMismatchDialog;
146 import com.stoutner.privacybrowser.dialogs.SaveDialog;
147 import com.stoutner.privacybrowser.dialogs.SslCertificateErrorDialog;
148 import com.stoutner.privacybrowser.dialogs.UrlHistoryDialog;
149 import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog;
150 import com.stoutner.privacybrowser.dialogs.WaitingForProxyDialog;
151 import com.stoutner.privacybrowser.fragments.WebViewTabFragment;
152 import com.stoutner.privacybrowser.helpers.BlocklistHelper;
153 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
154 import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper;
155 import com.stoutner.privacybrowser.helpers.ProxyHelper;
156 import com.stoutner.privacybrowser.views.NestedScrollWebView;
158 import java.io.ByteArrayInputStream;
159 import java.io.ByteArrayOutputStream;
161 import java.io.FileInputStream;
162 import java.io.FileOutputStream;
163 import java.io.IOException;
164 import java.io.InputStream;
165 import java.io.OutputStream;
166 import java.io.UnsupportedEncodingException;
168 import java.net.MalformedURLException;
170 import java.net.URLDecoder;
171 import java.net.URLEncoder;
173 import java.text.NumberFormat;
175 import java.util.ArrayList;
176 import java.util.Date;
177 import java.util.HashMap;
178 import java.util.HashSet;
179 import java.util.List;
180 import java.util.Map;
181 import java.util.Objects;
182 import java.util.Set;
183 import java.util.concurrent.ExecutorService;
184 import java.util.concurrent.Executors;
186 public class MainWebViewActivity extends AppCompatActivity implements CreateBookmarkDialog.CreateBookmarkListener, CreateBookmarkFolderDialog.CreateBookmarkFolderListener,
187 EditBookmarkFolderDialog.EditBookmarkFolderListener, FontSizeDialog.UpdateFontSizeListener, NavigationView.OnNavigationItemSelectedListener, OpenDialog.OpenListener,
188 PinnedMismatchDialog.PinnedMismatchListener, PopulateBlocklists.PopulateBlocklistsListener, SaveDialog.SaveListener, UrlHistoryDialog.NavigateHistoryListener,
189 WebViewTabFragment.NewTabListener {
191 // Define the public static variables.
192 public static ExecutorService executorService = Executors.newFixedThreadPool(4);
193 public static String orbotStatus = "unknown";
194 public static ArrayList<PendingDialog> pendingDialogsArrayList = new ArrayList<>();
195 public static String proxyMode = ProxyHelper.NONE;
197 // Declare the public static variables.
198 public static String currentBookmarksFolder;
199 public static boolean restartFromBookmarksActivity;
200 public static WebViewPagerAdapter webViewPagerAdapter;
202 // Declare the public static views.
203 public static AppBarLayout appBarLayout;
205 // The user agent constants are public static so they can be accessed from `SettingsFragment`, `DomainsActivity`, and `DomainSettingsFragment`.
206 public final static int UNRECOGNIZED_USER_AGENT = -1;
207 public final static int SETTINGS_WEBVIEW_DEFAULT_USER_AGENT = 1;
208 public final static int SETTINGS_CUSTOM_USER_AGENT = 11;
209 public final static int DOMAINS_SYSTEM_DEFAULT_USER_AGENT = 0;
210 public final static int DOMAINS_WEBVIEW_DEFAULT_USER_AGENT = 2;
211 public final static int DOMAINS_CUSTOM_USER_AGENT = 12;
213 // Define the start activity for result request codes. The public static entry is accessed from `OpenDialog()`.
214 private final int BROWSE_FILE_UPLOAD_REQUEST_CODE = 0;
215 public final static int BROWSE_OPEN_REQUEST_CODE = 1;
217 // Define the saved instance state constants.
218 private final String SAVED_STATE_ARRAY_LIST = "saved_state_array_list";
219 private final String SAVED_NESTED_SCROLL_WEBVIEW_STATE_ARRAY_LIST = "saved_nested_scroll_webview_state_array_list";
220 private final String SAVED_TAB_POSITION = "saved_tab_position";
221 private final String PROXY_MODE = "proxy_mode";
223 // Define the saved instance state variables.
224 private ArrayList<Bundle> savedStateArrayList;
225 private ArrayList<Bundle> savedNestedScrollWebViewStateArrayList;
226 private int savedTabPosition;
227 private String savedProxyMode;
229 // Define the class variables.
230 @SuppressWarnings("rawtypes")
231 AsyncTask populateBlocklists;
233 // The current WebView is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`,
234 // `findNextOnPage()`, `closeFindOnPage()`, `loadUrlFromTextBox()`, `onSslMismatchBack()`, `applyProxy()`, and `applyDomainSettings()`.
235 private NestedScrollWebView currentWebView;
237 // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrl()`.
238 private final Map<String, String> customHeaders = new HashMap<>();
240 // The search URL is set in `applyAppSettings()` and used in `onNewIntent()`, `loadUrlFromTextBox()`, `initializeApp()`, and `initializeWebView()`.
241 private String searchURL;
243 // The blocklists are populated in `finishedPopulatingBlocklists()` and accessed from `initializeWebView()`.
244 private ArrayList<List<String[]>> easyList;
245 private ArrayList<List<String[]>> easyPrivacy;
246 private ArrayList<List<String[]>> fanboysAnnoyanceList;
247 private ArrayList<List<String[]>> fanboysSocialList;
248 private ArrayList<List<String[]>> ultraList;
249 private ArrayList<List<String[]>> ultraPrivacy;
251 // The action bar drawer toggle is initialized in `onCreate()` and used in `onResume()`.
252 private ActionBarDrawerToggle actionBarDrawerToggle;
254 // The color spans are used in `onCreate()` and `highlightUrlText()`.
255 private ForegroundColorSpan redColorSpan;
256 private ForegroundColorSpan initialGrayColorSpan;
257 private ForegroundColorSpan finalGrayColorSpan;
259 // `bookmarksCursor` is used in `onDestroy()`, `onOptionsItemSelected()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
260 private Cursor bookmarksCursor;
262 // `bookmarksCursorAdapter` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()` `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
263 private CursorAdapter bookmarksCursorAdapter;
265 // `oldFolderNameString` is used in `onCreate()` and `onSaveEditBookmarkFolder()`.
266 private String oldFolderNameString;
268 // `fileChooserCallback` is used in `onCreate()` and `onActivityResult()`.
269 private ValueCallback<Uri[]> fileChooserCallback;
271 // The default progress view offsets are set in `onCreate()` and used in `initializeWebView()`.
272 private int appBarHeight;
273 private int defaultProgressViewStartOffset;
274 private int defaultProgressViewEndOffset;
276 // The URL sanitizers are set in `applyAppSettings()` and used in `sanitizeUrl()`.
277 private boolean sanitizeGoogleAnalytics;
278 private boolean sanitizeFacebookClickIds;
279 private boolean sanitizeTwitterAmpRedirects;
281 // Declare the class variables
282 private BookmarksDatabaseHelper bookmarksDatabaseHelper;
283 private boolean bottomAppBar;
284 private boolean displayingFullScreenVideo;
285 private boolean downloadWithExternalApp;
286 private boolean fullScreenBrowsingModeEnabled;
287 private boolean hideAppBar;
288 private boolean incognitoModeEnabled;
289 private boolean inFullScreenBrowsingMode;
290 private boolean loadingNewIntent;
291 private BroadcastReceiver orbotStatusBroadcastReceiver;
292 private ProxyHelper proxyHelper;
293 private boolean reapplyAppSettingsOnRestart;
294 private boolean reapplyDomainSettingsOnRestart;
295 private boolean scrollAppBar;
296 private boolean waitingForProxy;
297 private String webViewDefaultUserAgent;
299 // Define the class variables.
300 private ObjectAnimator objectAnimator = new ObjectAnimator();
301 private String saveUrlString = "";
303 // Declare the class views.
304 private FrameLayout rootFrameLayout;
305 private DrawerLayout drawerLayout;
306 private CoordinatorLayout coordinatorLayout;
307 private Toolbar toolbar;
308 private RelativeLayout urlRelativeLayout;
309 private EditText urlEditText;
310 private ActionBar actionBar;
311 private LinearLayout findOnPageLinearLayout;
312 private LinearLayout tabsLinearLayout;
313 private TabLayout tabLayout;
314 private SwipeRefreshLayout swipeRefreshLayout;
315 private ViewPager webViewPager;
316 private FrameLayout fullScreenVideoFrameLayout;
318 // Declare the class menus.
319 private Menu optionsMenu;
321 // Declare the class menu items.
322 private MenuItem navigationBackMenuItem;
323 private MenuItem navigationForwardMenuItem;
324 private MenuItem navigationHistoryMenuItem;
325 private MenuItem navigationRequestsMenuItem;
326 private MenuItem optionsPrivacyMenuItem;
327 private MenuItem optionsRefreshMenuItem;
328 private MenuItem optionsCookiesMenuItem;
329 private MenuItem optionsDomStorageMenuItem;
330 private MenuItem optionsSaveFormDataMenuItem;
331 private MenuItem optionsClearDataMenuItem;
332 private MenuItem optionsClearCookiesMenuItem;
333 private MenuItem optionsClearDomStorageMenuItem;
334 private MenuItem optionsClearFormDataMenuItem;
335 private MenuItem optionsBlocklistsMenuItem;
336 private MenuItem optionsEasyListMenuItem;
337 private MenuItem optionsEasyPrivacyMenuItem;
338 private MenuItem optionsFanboysAnnoyanceListMenuItem;
339 private MenuItem optionsFanboysSocialBlockingListMenuItem;
340 private MenuItem optionsUltraListMenuItem;
341 private MenuItem optionsUltraPrivacyMenuItem;
342 private MenuItem optionsBlockAllThirdPartyRequestsMenuItem;
343 private MenuItem optionsProxyMenuItem;
344 private MenuItem optionsProxyNoneMenuItem;
345 private MenuItem optionsProxyTorMenuItem;
346 private MenuItem optionsProxyI2pMenuItem;
347 private MenuItem optionsProxyCustomMenuItem;
348 private MenuItem optionsUserAgentMenuItem;
349 private MenuItem optionsUserAgentPrivacyBrowserMenuItem;
350 private MenuItem optionsUserAgentWebViewDefaultMenuItem;
351 private MenuItem optionsUserAgentFirefoxOnAndroidMenuItem;
352 private MenuItem optionsUserAgentChromeOnAndroidMenuItem;
353 private MenuItem optionsUserAgentSafariOnIosMenuItem;
354 private MenuItem optionsUserAgentFirefoxOnLinuxMenuItem;
355 private MenuItem optionsUserAgentChromiumOnLinuxMenuItem;
356 private MenuItem optionsUserAgentFirefoxOnWindowsMenuItem;
357 private MenuItem optionsUserAgentChromeOnWindowsMenuItem;
358 private MenuItem optionsUserAgentEdgeOnWindowsMenuItem;
359 private MenuItem optionsUserAgentInternetExplorerOnWindowsMenuItem;
360 private MenuItem optionsUserAgentSafariOnMacosMenuItem;
361 private MenuItem optionsUserAgentCustomMenuItem;
362 private MenuItem optionsSwipeToRefreshMenuItem;
363 private MenuItem optionsWideViewportMenuItem;
364 private MenuItem optionsDisplayImagesMenuItem;
365 private MenuItem optionsDarkWebViewMenuItem;
366 private MenuItem optionsFontSizeMenuItem;
367 private MenuItem optionsAddOrEditDomainMenuItem;
369 // This variable won't be needed once the class is migrated to Kotlin, as can be seen in LogcatActivity or AboutVersionFragment.
370 private Activity resultLauncherActivityHandle;
372 // Define the save URL activity result launcher. It must be defined before `onCreate()` is run or the app will crash.
373 private final ActivityResultLauncher<String> saveUrlActivityResultLauncher = registerForActivityResult(new ActivityResultContracts.CreateDocument(),
374 new ActivityResultCallback<Uri>() {
376 public void onActivityResult(Uri fileUri) {
377 // Only save the URL if the file URI is not null, which happens if the user exited the file picker by pressing back.
378 if (fileUri != null) {
379 new SaveUrl(getApplicationContext(), resultLauncherActivityHandle, fileUri, currentWebView.getSettings().getUserAgentString(), currentWebView.getAcceptCookies()).execute(saveUrlString);
382 // Reset the save URL string.
387 // Define the save webpage archive activity result launcher. It must be defined before `onCreate()` is run or the app will crash.
388 private final ActivityResultLauncher<String> saveWebpageArchiveActivityResultLauncher = registerForActivityResult(new ActivityResultContracts.CreateDocument(),
389 new ActivityResultCallback<Uri>() {
391 public void onActivityResult(Uri fileUri) {
392 // Only save the webpage archive if the file URI is not null, which happens if the user exited the file picker by pressing back.
393 if (fileUri != null) {
395 // Create a temporary MHT file.
396 File temporaryMhtFile = File.createTempFile("temporary_mht_file", ".mht", getCacheDir());
398 // Save the temporary MHT file.
399 currentWebView.saveWebArchive(temporaryMhtFile.toString(), false, callbackValue -> {
400 if (callbackValue != null) { // The temporary MHT file was saved successfully.
402 // Create a temporary MHT file input stream.
403 FileInputStream temporaryMhtFileInputStream = new FileInputStream(temporaryMhtFile);
405 // Get an output stream for the save webpage file path.
406 OutputStream mhtOutputStream = getContentResolver().openOutputStream(fileUri);
408 // Create a transfer byte array.
409 byte[] transferByteArray = new byte[1024];
411 // Create an integer to track the number of bytes read.
414 // Copy the temporary MHT file input stream to the MHT output stream.
415 while ((bytesRead = temporaryMhtFileInputStream.read(transferByteArray)) > 0) {
416 mhtOutputStream.write(transferByteArray, 0, bytesRead);
419 // Close the streams.
420 mhtOutputStream.close();
421 temporaryMhtFileInputStream.close();
423 // Initialize the file name string from the file URI last path segment.
424 String fileNameString = fileUri.getLastPathSegment();
426 // Query the exact file name if the API >= 26.
427 if (Build.VERSION.SDK_INT >= 26) {
428 // Get a cursor from the content resolver.
429 Cursor contentResolverCursor = resultLauncherActivityHandle.getContentResolver().query(fileUri, null, null, null);
431 // Move to the fist row.
432 contentResolverCursor.moveToFirst();
434 // Get the file name from the cursor.
435 fileNameString = contentResolverCursor.getString(contentResolverCursor.getColumnIndexOrThrow(OpenableColumns.DISPLAY_NAME));
438 contentResolverCursor.close();
441 // Display a snackbar.
442 Snackbar.make(currentWebView, getString(R.string.file_saved) + " " + fileNameString, Snackbar.LENGTH_SHORT).show();
443 } catch (Exception exception) {
444 // Display a snackbar with the exception.
445 Snackbar.make(currentWebView, getString(R.string.error_saving_file) + " " + exception, Snackbar.LENGTH_INDEFINITE).show();
447 // Delete the temporary MHT file.
448 //noinspection ResultOfMethodCallIgnored
449 temporaryMhtFile.delete();
451 } else { // There was an unspecified error while saving the temporary MHT file.
452 // Display an error snackbar.
453 Snackbar.make(currentWebView, getString(R.string.error_saving_file), Snackbar.LENGTH_INDEFINITE).show();
456 } catch (IOException ioException) {
457 // Display a snackbar with the IO exception.
458 Snackbar.make(currentWebView, getString(R.string.error_saving_file) + " " + ioException, Snackbar.LENGTH_INDEFINITE).show();
464 // Define the save webpage image activity result launcher. It must be defined before `onCreate()` is run or the app will crash.
465 private final ActivityResultLauncher<String> saveWebpageImageActivityResultLauncher = registerForActivityResult(new ActivityResultContracts.CreateDocument(),
466 new ActivityResultCallback<Uri>() {
468 public void onActivityResult(Uri fileUri) {
469 // Only save the webpage image if the file URI is not null, which happens if the user exited the file picker by pressing back.
470 if (fileUri != null) {
471 // Save the webpage image.
472 new SaveWebpageImage(resultLauncherActivityHandle, fileUri, currentWebView).execute();
477 // Remove the warning about needing to override `performClick()` when using an `OnTouchListener` with WebView.
478 @SuppressLint("ClickableViewAccessibility")
480 protected void onCreate(Bundle savedInstanceState) {
481 // Run the default commands.
482 super.onCreate(savedInstanceState);
484 // Populate the result launcher activity. This will no longer be needed once the activity has transitioned to Kotlin.
485 resultLauncherActivityHandle = this;
487 // Check to see if the activity has been restarted.
488 if (savedInstanceState != null) {
489 // Store the saved instance state variables.
490 savedStateArrayList = savedInstanceState.getParcelableArrayList(SAVED_STATE_ARRAY_LIST);
491 savedNestedScrollWebViewStateArrayList = savedInstanceState.getParcelableArrayList(SAVED_NESTED_SCROLL_WEBVIEW_STATE_ARRAY_LIST);
492 savedTabPosition = savedInstanceState.getInt(SAVED_TAB_POSITION);
493 savedProxyMode = savedInstanceState.getString(PROXY_MODE);
496 // Initialize the default preference values the first time the program is run. `false` keeps this command from resetting any current preferences back to default.
497 PreferenceManager.setDefaultValues(this, R.xml.preferences, false);
499 // Get a handle for the shared preferences.
500 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
502 // Get the preferences.
503 String appTheme = sharedPreferences.getString("app_theme", getString(R.string.app_theme_default_value));
504 boolean allowScreenshots = sharedPreferences.getBoolean(getString(R.string.allow_screenshots_key), false);
505 bottomAppBar = sharedPreferences.getBoolean(getString(R.string.bottom_app_bar_key), false);
507 // Get the theme entry values string array.
508 String[] appThemeEntryValuesStringArray = getResources().getStringArray(R.array.app_theme_entry_values);
510 // Set the app theme according to the preference. A switch statement cannot be used because the theme entry values string array is not a compile time constant.
511 if (appTheme.equals(appThemeEntryValuesStringArray[1])) { // The light theme is selected.
512 // Apply the light theme.
513 AppCompatDelegate.setDefaultNightMode(AppCompatDelegate.MODE_NIGHT_NO);
514 } else if (appTheme.equals(appThemeEntryValuesStringArray[2])) { // The dark theme is selected.
515 // Apply the dark theme.
516 AppCompatDelegate.setDefaultNightMode(AppCompatDelegate.MODE_NIGHT_YES);
517 } else { // The system default theme is selected.
518 if (Build.VERSION.SDK_INT >= 28) { // The system default theme is supported.
519 // Follow the system default theme.
520 AppCompatDelegate.setDefaultNightMode(AppCompatDelegate.MODE_NIGHT_FOLLOW_SYSTEM);
521 } else { // The system default theme is not supported.
522 // Follow the battery saver mode.
523 AppCompatDelegate.setDefaultNightMode(AppCompatDelegate.MODE_NIGHT_AUTO_BATTERY);
527 // Disable screenshots if not allowed.
528 if (!allowScreenshots) {
529 getWindow().addFlags(WindowManager.LayoutParams.FLAG_SECURE);
532 // Enable the drawing of the entire webpage. This makes it possible to save a website image. This must be done before anything else happens with the WebView.
533 WebView.enableSlowWholeDocumentDraw();
536 setTheme(R.style.PrivacyBrowser);
538 // Set the content view.
540 setContentView(R.layout.main_framelayout_bottom_appbar);
542 setContentView(R.layout.main_framelayout_top_appbar);
545 // Get handles for the views.
546 rootFrameLayout = findViewById(R.id.root_framelayout);
547 drawerLayout = findViewById(R.id.drawerlayout);
548 coordinatorLayout = findViewById(R.id.coordinatorlayout);
549 appBarLayout = findViewById(R.id.appbar_layout);
550 toolbar = findViewById(R.id.toolbar);
551 findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
552 tabsLinearLayout = findViewById(R.id.tabs_linearlayout);
553 tabLayout = findViewById(R.id.tablayout);
554 swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
555 webViewPager = findViewById(R.id.webviewpager);
556 NavigationView navigationView = findViewById(R.id.navigationview);
557 fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
559 // Get a handle for the navigation menu.
560 Menu navigationMenu = navigationView.getMenu();
562 // Get handles for the navigation menu items.
563 navigationBackMenuItem = navigationMenu.findItem(R.id.back);
564 navigationForwardMenuItem = navigationMenu.findItem(R.id.forward);
565 navigationHistoryMenuItem = navigationMenu.findItem(R.id.history);
566 navigationRequestsMenuItem = navigationMenu.findItem(R.id.requests);
568 // Listen for touches on the navigation menu.
569 navigationView.setNavigationItemSelectedListener(this);
571 // Get a handle for the app compat delegate.
572 AppCompatDelegate appCompatDelegate = getDelegate();
574 // Set the support action bar.
575 appCompatDelegate.setSupportActionBar(toolbar);
577 // Get a handle for the action bar.
578 actionBar = appCompatDelegate.getSupportActionBar();
580 // Remove the incorrect lint warning below that the action bar might be null.
581 assert actionBar != null;
583 // Add the custom layout, which shows the URL text bar.
584 actionBar.setCustomView(R.layout.url_app_bar);
585 actionBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
587 // Get handles for the views in the URL app bar.
588 urlRelativeLayout = findViewById(R.id.url_relativelayout);
589 urlEditText = findViewById(R.id.url_edittext);
591 // Create the hamburger icon at the start of the AppBar.
592 actionBarDrawerToggle = new ActionBarDrawerToggle(this, drawerLayout, toolbar, R.string.open_navigation_drawer, R.string.close_navigation_drawer);
594 // Initially disable the sliding drawers. They will be enabled once the blocklists are loaded.
595 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED);
597 // Initialize the web view pager adapter.
598 webViewPagerAdapter = new WebViewPagerAdapter(getSupportFragmentManager());
600 // Set the pager adapter on the web view pager.
601 webViewPager.setAdapter(webViewPagerAdapter);
603 // Store up to 100 tabs in memory.
604 webViewPager.setOffscreenPageLimit(100);
606 // Instantiate the proxy helper.
607 proxyHelper = new ProxyHelper();
609 // Initialize the app.
612 // Apply the app settings from the shared preferences.
615 // Populate the blocklists.
616 populateBlocklists = new PopulateBlocklists(this, this).execute();
620 protected void onNewIntent(Intent intent) {
621 // Run the default commands.
622 super.onNewIntent(intent);
624 // Replace the intent that started the app with this one.
627 // Check to see if the app is being restarted from a saved state.
628 if (savedStateArrayList == null || savedStateArrayList.size() == 0) { // The activity is not being restarted from a saved state.
629 // Get the information from the intent.
630 String intentAction = intent.getAction();
631 Uri intentUriData = intent.getData();
632 String intentStringExtra = intent.getStringExtra(Intent.EXTRA_TEXT);
634 // Determine if this is a web search.
635 boolean isWebSearch = ((intentAction != null) && intentAction.equals(Intent.ACTION_WEB_SEARCH));
637 // Only process the URI if it contains data or it is a web search. If the user pressed the desktop icon after the app was already running the URI will be null.
638 if (intentUriData != null || intentStringExtra != null || isWebSearch) {
639 // Exit the full screen video if it is displayed.
640 if (displayingFullScreenVideo) {
641 // Exit full screen video mode.
642 exitFullScreenVideo();
644 // Reload the current WebView. Otherwise, it can display entirely black.
645 currentWebView.reload();
648 // Get the shared preferences.
649 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
651 // Create a URL string.
654 // If the intent action is a web search, perform the search.
655 if (isWebSearch) { // The intent is a web search.
656 // Create an encoded URL string.
657 String encodedUrlString;
659 // Sanitize the search input and convert it to a search.
661 encodedUrlString = URLEncoder.encode(intent.getStringExtra(SearchManager.QUERY), "UTF-8");
662 } catch (UnsupportedEncodingException exception) {
663 encodedUrlString = "";
666 // Add the base search URL.
667 url = searchURL + encodedUrlString;
668 } else if (intentUriData != null) { // The intent contains a URL formatted as a URI.
669 // Set the intent data as the URL.
670 url = intentUriData.toString();
671 } else { // The intent contains a string, which might be a URL.
672 // Set the intent string as the URL.
673 url = intentStringExtra;
676 // Add a new tab if specified in the preferences.
677 if (sharedPreferences.getBoolean("open_intents_in_new_tab", true)) { // Load the URL in a new tab.
678 // Set the loading new intent flag.
679 loadingNewIntent = true;
682 addNewTab(url, true);
683 } else { // Load the URL in the current tab.
685 loadUrl(currentWebView, url);
688 // Close the navigation drawer if it is open.
689 if (drawerLayout.isDrawerVisible(GravityCompat.START)) {
690 drawerLayout.closeDrawer(GravityCompat.START);
693 // Close the bookmarks drawer if it is open.
694 if (drawerLayout.isDrawerVisible(GravityCompat.END)) {
695 drawerLayout.closeDrawer(GravityCompat.END);
702 public void onRestart() {
703 // Run the default commands.
706 // Apply the app settings if returning from the Settings activity.
707 if (reapplyAppSettingsOnRestart) {
708 // Reset the reapply app settings on restart tracker.
709 reapplyAppSettingsOnRestart = false;
711 // Apply the app settings.
715 // Apply the domain settings if returning from the settings or domains activity.
716 if (reapplyDomainSettingsOnRestart) {
717 // Reset the reapply domain settings on restart tracker.
718 reapplyDomainSettingsOnRestart = false;
720 // Reapply the domain settings for each tab.
721 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
722 // Get the WebView tab fragment.
723 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
725 // Get the fragment view.
726 View fragmentView = webViewTabFragment.getView();
728 // Only reload the WebViews if they exist.
729 if (fragmentView != null) {
730 // Get the nested scroll WebView from the tab fragment.
731 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
733 // Reset the current domain name so the domain settings will be reapplied.
734 nestedScrollWebView.setCurrentDomainName("");
736 // Reapply the domain settings if the URL is not null, which can happen if an empty tab is active when returning from settings.
737 if (nestedScrollWebView.getUrl() != null) {
738 applyDomainSettings(nestedScrollWebView, nestedScrollWebView.getUrl(), false, true, false);
744 // Update the bookmarks drawer if returning from the Bookmarks activity.
745 if (restartFromBookmarksActivity) {
746 // Close the bookmarks drawer.
747 drawerLayout.closeDrawer(GravityCompat.END);
749 // Reload the bookmarks drawer.
750 loadBookmarksFolder();
752 // Reset `restartFromBookmarksActivity`.
753 restartFromBookmarksActivity = false;
756 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step. This can be important if the screen was rotated.
757 updatePrivacyIcons(true);
760 // `onStart()` runs after `onCreate()` or `onRestart()`. This is used instead of `onResume()` so the commands aren't called every time the screen is partially hidden.
762 public void onStart() {
763 // Run the default commands.
766 // Resume any WebViews.
767 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
768 // Get the WebView tab fragment.
769 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
771 // Get the fragment view.
772 View fragmentView = webViewTabFragment.getView();
774 // Only resume the WebViews if they exist (they won't when the app is first created).
775 if (fragmentView != null) {
776 // Get the nested scroll WebView from the tab fragment.
777 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
779 // Resume the nested scroll WebView.
780 nestedScrollWebView.onResume();
784 // Resume the nested scroll WebView JavaScript timers. This is a global command that resumes JavaScript timers on all WebViews.
785 if (currentWebView != null) {
786 currentWebView.resumeTimers();
789 // Reapply the proxy settings if the system is using a proxy. This redisplays the appropriate alert dialog.
790 if (!proxyMode.equals(ProxyHelper.NONE)) {
794 // Reapply any system UI flags.
795 if (displayingFullScreenVideo || inFullScreenBrowsingMode) { // The system is displaying a website or a video in full screen mode.
796 /* Hide the system bars.
797 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
798 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
799 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
800 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
802 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
803 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
806 // Show any pending dialogs.
807 for (int i = 0; i < pendingDialogsArrayList.size(); i++) {
808 // Get the pending dialog from the array list.
809 PendingDialog pendingDialog = pendingDialogsArrayList.get(i);
811 // Show the pending dialog.
812 pendingDialog.dialogFragment.show(getSupportFragmentManager(), pendingDialog.tag);
815 // Clear the pending dialogs array list.
816 pendingDialogsArrayList.clear();
819 // `onStop()` runs after `onPause()`. It is used instead of `onPause()` so the commands are not called every time the screen is partially hidden.
821 public void onStop() {
822 // Run the default commands.
825 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
826 // Get the WebView tab fragment.
827 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
829 // Get the fragment view.
830 View fragmentView = webViewTabFragment.getView();
832 // Only pause the WebViews if they exist (they won't when the app is first created).
833 if (fragmentView != null) {
834 // Get the nested scroll WebView from the tab fragment.
835 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
837 // Pause the nested scroll WebView.
838 nestedScrollWebView.onPause();
842 // Pause the WebView JavaScript timers. This is a global command that pauses JavaScript on all WebViews.
843 if (currentWebView != null) {
844 currentWebView.pauseTimers();
849 public void onSaveInstanceState(@NonNull Bundle savedInstanceState) {
850 // Run the default commands.
851 super.onSaveInstanceState(savedInstanceState);
853 // Create the saved state array lists.
854 ArrayList<Bundle> savedStateArrayList = new ArrayList<>();
855 ArrayList<Bundle> savedNestedScrollWebViewStateArrayList = new ArrayList<>();
857 // Get the URLs from each tab.
858 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
859 // Get the WebView tab fragment.
860 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
862 // Get the fragment view.
863 View fragmentView = webViewTabFragment.getView();
865 if (fragmentView != null) {
866 // Get the nested scroll WebView from the tab fragment.
867 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
869 // Create saved state bundle.
870 Bundle savedStateBundle = new Bundle();
872 // Get the current states.
873 nestedScrollWebView.saveState(savedStateBundle);
874 Bundle savedNestedScrollWebViewStateBundle = nestedScrollWebView.saveNestedScrollWebViewState();
876 // Store the saved states in the array lists.
877 savedStateArrayList.add(savedStateBundle);
878 savedNestedScrollWebViewStateArrayList.add(savedNestedScrollWebViewStateBundle);
882 // Get the current tab position.
883 int currentTabPosition = tabLayout.getSelectedTabPosition();
885 // Store the saved states in the bundle.
886 savedInstanceState.putParcelableArrayList(SAVED_STATE_ARRAY_LIST, savedStateArrayList);
887 savedInstanceState.putParcelableArrayList(SAVED_NESTED_SCROLL_WEBVIEW_STATE_ARRAY_LIST, savedNestedScrollWebViewStateArrayList);
888 savedInstanceState.putInt(SAVED_TAB_POSITION, currentTabPosition);
889 savedInstanceState.putString(PROXY_MODE, proxyMode);
893 public void onDestroy() {
894 // Unregister the orbot status broadcast receiver if it exists.
895 if (orbotStatusBroadcastReceiver != null) {
896 this.unregisterReceiver(orbotStatusBroadcastReceiver);
899 // Close the bookmarks cursor if it exists.
900 if (bookmarksCursor != null) {
901 bookmarksCursor.close();
904 // Close the bookmarks database if it exists.
905 if (bookmarksDatabaseHelper != null) {
906 bookmarksDatabaseHelper.close();
909 // Stop populating the blocklists if the AsyncTask is running in the background.
910 if (populateBlocklists != null) {
911 populateBlocklists.cancel(true);
914 // Run the default commands.
919 public boolean onCreateOptionsMenu(Menu menu) {
920 // Inflate the menu. This adds items to the action bar if it is present.
921 getMenuInflater().inflate(R.menu.webview_options_menu, menu);
923 // Store a handle for the options menu so it can be used by `onOptionsItemSelected()` and `updatePrivacyIcons()`.
926 // Get handles for the menu items.
927 optionsPrivacyMenuItem = menu.findItem(R.id.javascript);
928 optionsRefreshMenuItem = menu.findItem(R.id.refresh);
929 MenuItem bookmarksMenuItem = menu.findItem(R.id.bookmarks);
930 optionsCookiesMenuItem = menu.findItem(R.id.cookies);
931 optionsDomStorageMenuItem = menu.findItem(R.id.dom_storage);
932 optionsSaveFormDataMenuItem = menu.findItem(R.id.save_form_data); // Form data can be removed once the minimum API >= 26.
933 optionsClearDataMenuItem = menu.findItem(R.id.clear_data);
934 optionsClearCookiesMenuItem = menu.findItem(R.id.clear_cookies);
935 optionsClearDomStorageMenuItem = menu.findItem(R.id.clear_dom_storage);
936 optionsClearFormDataMenuItem = menu.findItem(R.id.clear_form_data); // Form data can be removed once the minimum API >= 26.
937 optionsBlocklistsMenuItem = menu.findItem(R.id.blocklists);
938 optionsEasyListMenuItem = menu.findItem(R.id.easylist);
939 optionsEasyPrivacyMenuItem = menu.findItem(R.id.easyprivacy);
940 optionsFanboysAnnoyanceListMenuItem = menu.findItem(R.id.fanboys_annoyance_list);
941 optionsFanboysSocialBlockingListMenuItem = menu.findItem(R.id.fanboys_social_blocking_list);
942 optionsUltraListMenuItem = menu.findItem(R.id.ultralist);
943 optionsUltraPrivacyMenuItem = menu.findItem(R.id.ultraprivacy);
944 optionsBlockAllThirdPartyRequestsMenuItem = menu.findItem(R.id.block_all_third_party_requests);
945 optionsProxyMenuItem = menu.findItem(R.id.proxy);
946 optionsProxyNoneMenuItem = menu.findItem(R.id.proxy_none);
947 optionsProxyTorMenuItem = menu.findItem(R.id.proxy_tor);
948 optionsProxyI2pMenuItem = menu.findItem(R.id.proxy_i2p);
949 optionsProxyCustomMenuItem = menu.findItem(R.id.proxy_custom);
950 optionsUserAgentMenuItem = menu.findItem(R.id.user_agent);
951 optionsUserAgentPrivacyBrowserMenuItem = menu.findItem(R.id.user_agent_privacy_browser);
952 optionsUserAgentWebViewDefaultMenuItem = menu.findItem(R.id.user_agent_webview_default);
953 optionsUserAgentFirefoxOnAndroidMenuItem = menu.findItem(R.id.user_agent_firefox_on_android);
954 optionsUserAgentChromeOnAndroidMenuItem = menu.findItem(R.id.user_agent_chrome_on_android);
955 optionsUserAgentSafariOnIosMenuItem = menu.findItem(R.id.user_agent_safari_on_ios);
956 optionsUserAgentFirefoxOnLinuxMenuItem = menu.findItem(R.id.user_agent_firefox_on_linux);
957 optionsUserAgentChromiumOnLinuxMenuItem = menu.findItem(R.id.user_agent_chromium_on_linux);
958 optionsUserAgentFirefoxOnWindowsMenuItem = menu.findItem(R.id.user_agent_firefox_on_windows);
959 optionsUserAgentChromeOnWindowsMenuItem = menu.findItem(R.id.user_agent_chrome_on_windows);
960 optionsUserAgentEdgeOnWindowsMenuItem = menu.findItem(R.id.user_agent_edge_on_windows);
961 optionsUserAgentInternetExplorerOnWindowsMenuItem = menu.findItem(R.id.user_agent_internet_explorer_on_windows);
962 optionsUserAgentSafariOnMacosMenuItem = menu.findItem(R.id.user_agent_safari_on_macos);
963 optionsUserAgentCustomMenuItem = menu.findItem(R.id.user_agent_custom);
964 optionsSwipeToRefreshMenuItem = menu.findItem(R.id.swipe_to_refresh);
965 optionsWideViewportMenuItem = menu.findItem(R.id.wide_viewport);
966 optionsDisplayImagesMenuItem = menu.findItem(R.id.display_images);
967 optionsDarkWebViewMenuItem = menu.findItem(R.id.dark_webview);
968 optionsFontSizeMenuItem = menu.findItem(R.id.font_size);
969 optionsAddOrEditDomainMenuItem = menu.findItem(R.id.add_or_edit_domain);
971 // Set the initial status of the privacy icons. `false` does not call `invalidateOptionsMenu` as the last step.
972 updatePrivacyIcons(false);
974 // Only display the form data menu items if the API < 26.
975 optionsSaveFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
976 optionsClearFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
978 // Disable the clear form data menu item if the API >= 26 so that the status of the main Clear Data is calculated correctly.
979 optionsClearFormDataMenuItem.setEnabled(Build.VERSION.SDK_INT < 26);
981 // Get the shared preferences.
982 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
984 // Get the dark theme and app bar preferences.
985 boolean displayAdditionalAppBarIcons = sharedPreferences.getBoolean(getString(R.string.display_additional_app_bar_icons_key), false);
987 // Set the status of the additional app bar icons. Setting the refresh menu item to `SHOW_AS_ACTION_ALWAYS` makes it appear even on small devices like phones.
988 if (displayAdditionalAppBarIcons) {
989 optionsRefreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_ALWAYS);
990 bookmarksMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
991 optionsCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
992 } else { //Do not display the additional icons.
993 optionsRefreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
994 bookmarksMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
995 optionsCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
998 // Replace Refresh with Stop if a URL is already loading.
999 if (currentWebView != null && currentWebView.getProgress() != 100) {
1001 optionsRefreshMenuItem.setTitle(R.string.stop);
1003 // Set the icon if it is displayed in the app bar. Once the minimum API is >= 26, the blue and black icons can be combined with a tint list.
1004 if (displayAdditionalAppBarIcons) {
1005 optionsRefreshMenuItem.setIcon(R.drawable.close_blue);
1014 public boolean onPrepareOptionsMenu(Menu menu) {
1015 // Get a handle for the cookie manager.
1016 CookieManager cookieManager = CookieManager.getInstance();
1018 // Initialize the current user agent string and the font size.
1019 String currentUserAgent = getString(R.string.user_agent_privacy_browser);
1022 // Set items that require the current web view to be populated. It will be null when the program is first opened, as `onPrepareOptionsMenu()` is called before the first WebView is initialized.
1023 if (currentWebView != null) {
1024 // Set the add or edit domain text.
1025 if (currentWebView.getDomainSettingsApplied()) {
1026 optionsAddOrEditDomainMenuItem.setTitle(R.string.edit_domain_settings);
1028 optionsAddOrEditDomainMenuItem.setTitle(R.string.add_domain_settings);
1031 // Get the current user agent from the WebView.
1032 currentUserAgent = currentWebView.getSettings().getUserAgentString();
1034 // Get the current font size from the
1035 fontSize = currentWebView.getSettings().getTextZoom();
1037 // Set the status of the menu item checkboxes.
1038 optionsDomStorageMenuItem.setChecked(currentWebView.getSettings().getDomStorageEnabled());
1039 optionsSaveFormDataMenuItem.setChecked(currentWebView.getSettings().getSaveFormData()); // Form data can be removed once the minimum API >= 26.
1040 optionsEasyListMenuItem.setChecked(currentWebView.getEasyListEnabled());
1041 optionsEasyPrivacyMenuItem.setChecked(currentWebView.getEasyPrivacyEnabled());
1042 optionsFanboysAnnoyanceListMenuItem.setChecked(currentWebView.getFanboysAnnoyanceListEnabled());
1043 optionsFanboysSocialBlockingListMenuItem.setChecked(currentWebView.getFanboysSocialBlockingListEnabled());
1044 optionsUltraListMenuItem.setChecked(currentWebView.getUltraListEnabled());
1045 optionsUltraPrivacyMenuItem.setChecked(currentWebView.getUltraPrivacyEnabled());
1046 optionsBlockAllThirdPartyRequestsMenuItem.setChecked(currentWebView.getBlockAllThirdPartyRequests());
1047 optionsSwipeToRefreshMenuItem.setChecked(currentWebView.getSwipeToRefresh());
1048 optionsWideViewportMenuItem.setChecked(currentWebView.getSettings().getUseWideViewPort());
1049 optionsDisplayImagesMenuItem.setChecked(currentWebView.getSettings().getLoadsImagesAutomatically());
1051 // Initialize the display names for the blocklists with the number of blocked requests.
1052 optionsBlocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + currentWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
1053 optionsEasyListMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.EASYLIST) + " - " + getString(R.string.easylist));
1054 optionsEasyPrivacyMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.EASYPRIVACY) + " - " + getString(R.string.easyprivacy));
1055 optionsFanboysAnnoyanceListMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST) + " - " + getString(R.string.fanboys_annoyance_list));
1056 optionsFanboysSocialBlockingListMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST) + " - " + getString(R.string.fanboys_social_blocking_list));
1057 optionsUltraListMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.ULTRALIST) + " - " + getString(R.string.ultralist));
1058 optionsUltraPrivacyMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.ULTRAPRIVACY) + " - " + getString(R.string.ultraprivacy));
1059 optionsBlockAllThirdPartyRequestsMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.THIRD_PARTY_REQUESTS) + " - " + getString(R.string.block_all_third_party_requests));
1061 // Enable DOM Storage if JavaScript is enabled.
1062 optionsDomStorageMenuItem.setEnabled(currentWebView.getSettings().getJavaScriptEnabled());
1064 // Set the checkbox status for dark WebView if the WebView supports it.
1065 if (WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) {
1066 optionsDarkWebViewMenuItem.setChecked(WebSettingsCompat.getForceDark(currentWebView.getSettings()) == WebSettingsCompat.FORCE_DARK_ON);
1070 // Set the cookies menu item checked status.
1071 optionsCookiesMenuItem.setChecked(cookieManager.acceptCookie());
1073 // Enable Clear Cookies if there are any.
1074 optionsClearCookiesMenuItem.setEnabled(cookieManager.hasCookies());
1076 // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`, which links to `/data/data/com.stoutner.privacybrowser.standard`.
1077 String privateDataDirectoryString = getApplicationInfo().dataDir;
1079 // Get a count of the number of files in the Local Storage directory.
1080 File localStorageDirectory = new File (privateDataDirectoryString + "/app_webview/Local Storage/");
1081 int localStorageDirectoryNumberOfFiles = 0;
1082 if (localStorageDirectory.exists()) {
1083 // `Objects.requireNonNull` removes a lint warning that `localStorageDirectory.list` might produce a null pointed exception if it is dereferenced.
1084 localStorageDirectoryNumberOfFiles = Objects.requireNonNull(localStorageDirectory.list()).length;
1087 // Get a count of the number of files in the IndexedDB directory.
1088 File indexedDBDirectory = new File (privateDataDirectoryString + "/app_webview/IndexedDB");
1089 int indexedDBDirectoryNumberOfFiles = 0;
1090 if (indexedDBDirectory.exists()) {
1091 // `Objects.requireNonNull` removes a lint warning that `indexedDBDirectory.list` might produce a null pointed exception if it is dereferenced.
1092 indexedDBDirectoryNumberOfFiles = Objects.requireNonNull(indexedDBDirectory.list()).length;
1095 // Enable Clear DOM Storage if there is any.
1096 optionsClearDomStorageMenuItem.setEnabled(localStorageDirectoryNumberOfFiles > 0 || indexedDBDirectoryNumberOfFiles > 0);
1098 // Enable Clear Form Data is there is any. This can be removed once the minimum API >= 26.
1099 if (Build.VERSION.SDK_INT < 26) {
1100 // Get the WebView database.
1101 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
1103 // Enable the clear form data menu item if there is anything to clear.
1104 optionsClearFormDataMenuItem.setEnabled(webViewDatabase.hasFormData());
1107 // Enable Clear Data if any of the submenu items are enabled.
1108 optionsClearDataMenuItem.setEnabled(optionsClearCookiesMenuItem.isEnabled() || optionsClearDomStorageMenuItem.isEnabled() || optionsClearFormDataMenuItem.isEnabled());
1110 // Disable Fanboy's Social Blocking List menu item if Fanboy's Annoyance List is checked.
1111 optionsFanboysSocialBlockingListMenuItem.setEnabled(!optionsFanboysAnnoyanceListMenuItem.isChecked());
1113 // Set the proxy title and check the applied proxy.
1114 switch (proxyMode) {
1115 case ProxyHelper.NONE:
1116 // Set the proxy title.
1117 optionsProxyMenuItem.setTitle(getString(R.string.proxy) + " - " + getString(R.string.proxy_none));
1119 // Check the proxy None radio button.
1120 optionsProxyNoneMenuItem.setChecked(true);
1123 case ProxyHelper.TOR:
1124 // Set the proxy title.
1125 optionsProxyMenuItem.setTitle(getString(R.string.proxy) + " - " + getString(R.string.proxy_tor));
1127 // Check the proxy Tor radio button.
1128 optionsProxyTorMenuItem.setChecked(true);
1131 case ProxyHelper.I2P:
1132 // Set the proxy title.
1133 optionsProxyMenuItem.setTitle(getString(R.string.proxy) + " - " + getString(R.string.proxy_i2p));
1135 // Check the proxy I2P radio button.
1136 optionsProxyI2pMenuItem.setChecked(true);
1139 case ProxyHelper.CUSTOM:
1140 // Set the proxy title.
1141 optionsProxyMenuItem.setTitle(getString(R.string.proxy) + " - " + getString(R.string.proxy_custom));
1143 // Check the proxy Custom radio button.
1144 optionsProxyCustomMenuItem.setChecked(true);
1148 // Select the current user agent menu item. A switch statement cannot be used because the user agents are not compile time constants.
1149 if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[0])) { // Privacy Browser.
1150 // Update the user agent menu item title.
1151 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_privacy_browser));
1153 // Select the Privacy Browser radio box.
1154 optionsUserAgentPrivacyBrowserMenuItem.setChecked(true);
1155 } else if (currentUserAgent.equals(webViewDefaultUserAgent)) { // WebView Default.
1156 // Update the user agent menu item title.
1157 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_webview_default));
1159 // Select the WebView Default radio box.
1160 optionsUserAgentWebViewDefaultMenuItem.setChecked(true);
1161 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[2])) { // Firefox on Android.
1162 // Update the user agent menu item title.
1163 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_firefox_on_android));
1165 // Select the Firefox on Android radio box.
1166 optionsUserAgentFirefoxOnAndroidMenuItem.setChecked(true);
1167 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[3])) { // Chrome on Android.
1168 // Update the user agent menu item title.
1169 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_chrome_on_android));
1171 // Select the Chrome on Android radio box.
1172 optionsUserAgentChromeOnAndroidMenuItem.setChecked(true);
1173 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[4])) { // Safari on iOS.
1174 // Update the user agent menu item title.
1175 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_safari_on_ios));
1177 // Select the Safari on iOS radio box.
1178 optionsUserAgentSafariOnIosMenuItem.setChecked(true);
1179 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[5])) { // Firefox on Linux.
1180 // Update the user agent menu item title.
1181 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_firefox_on_linux));
1183 // Select the Firefox on Linux radio box.
1184 optionsUserAgentFirefoxOnLinuxMenuItem.setChecked(true);
1185 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[6])) { // Chromium on Linux.
1186 // Update the user agent menu item title.
1187 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_chromium_on_linux));
1189 // Select the Chromium on Linux radio box.
1190 optionsUserAgentChromiumOnLinuxMenuItem.setChecked(true);
1191 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[7])) { // Firefox on Windows.
1192 // Update the user agent menu item title.
1193 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_firefox_on_windows));
1195 // Select the Firefox on Windows radio box.
1196 optionsUserAgentFirefoxOnWindowsMenuItem.setChecked(true);
1197 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[8])) { // Chrome on Windows.
1198 // Update the user agent menu item title.
1199 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_chrome_on_windows));
1201 // Select the Chrome on Windows radio box.
1202 optionsUserAgentChromeOnWindowsMenuItem.setChecked(true);
1203 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[9])) { // Edge on Windows.
1204 // Update the user agent menu item title.
1205 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_edge_on_windows));
1207 // Select the Edge on Windows radio box.
1208 optionsUserAgentEdgeOnWindowsMenuItem.setChecked(true);
1209 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[10])) { // Internet Explorer on Windows.
1210 // Update the user agent menu item title.
1211 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_internet_explorer_on_windows));
1213 // Select the Internet on Windows radio box.
1214 optionsUserAgentInternetExplorerOnWindowsMenuItem.setChecked(true);
1215 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[11])) { // Safari on macOS.
1216 // Update the user agent menu item title.
1217 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_safari_on_macos));
1219 // Select the Safari on macOS radio box.
1220 optionsUserAgentSafariOnMacosMenuItem.setChecked(true);
1221 } else { // Custom user agent.
1222 // Update the user agent menu item title.
1223 optionsUserAgentMenuItem.setTitle(getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_custom));
1225 // Select the Custom radio box.
1226 optionsUserAgentCustomMenuItem.setChecked(true);
1229 // Set the font size title.
1230 optionsFontSizeMenuItem.setTitle(getString(R.string.font_size) + " - " + fontSize + "%");
1232 // Run all the other default commands.
1233 super.onPrepareOptionsMenu(menu);
1235 // Display the menu.
1240 public boolean onOptionsItemSelected(MenuItem menuItem) {
1241 // Get a handle for the shared preferences.
1242 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
1244 // Get a handle for the cookie manager.
1245 CookieManager cookieManager = CookieManager.getInstance();
1247 // Get the selected menu item ID.
1248 int menuItemId = menuItem.getItemId();
1250 // Run the commands that correlate to the selected menu item.
1251 if (menuItemId == R.id.javascript) { // JavaScript.
1252 // Toggle the JavaScript status.
1253 currentWebView.getSettings().setJavaScriptEnabled(!currentWebView.getSettings().getJavaScriptEnabled());
1255 // Update the privacy icon.
1256 updatePrivacyIcons(true);
1258 // Display a `Snackbar`.
1259 if (currentWebView.getSettings().getJavaScriptEnabled()) { // JavaScrip is enabled.
1260 Snackbar.make(webViewPager, R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show();
1261 } else if (cookieManager.acceptCookie()) { // JavaScript is disabled, but first-party cookies are enabled.
1262 Snackbar.make(webViewPager, R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show();
1263 } else { // Privacy mode.
1264 Snackbar.make(webViewPager, R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1267 // Reload the current WebView.
1268 currentWebView.reload();
1270 // Consume the event.
1272 } else if (menuItemId == R.id.refresh) { // Refresh.
1273 // Run the command that correlates to the current status of the menu item.
1274 if (menuItem.getTitle().equals(getString(R.string.refresh))) { // The refresh button was pushed.
1275 // Reload the current WebView.
1276 currentWebView.reload();
1277 } else { // The stop button was pushed.
1278 // Stop the loading of the WebView.
1279 currentWebView.stopLoading();
1282 // Consume the event.
1284 } else if (menuItemId == R.id.bookmarks) { // Bookmarks.
1285 // Open the bookmarks drawer.
1286 drawerLayout.openDrawer(GravityCompat.END);
1288 // Consume the event.
1290 } else if (menuItemId == R.id.cookies) { // Cookies.
1291 // Switch the first-party cookie status.
1292 cookieManager.setAcceptCookie(!cookieManager.acceptCookie());
1294 // Store the cookie status.
1295 currentWebView.setAcceptCookies(cookieManager.acceptCookie());
1297 // Update the menu checkbox.
1298 menuItem.setChecked(cookieManager.acceptCookie());
1300 // Update the privacy icon.
1301 updatePrivacyIcons(true);
1303 // Display a snackbar.
1304 if (cookieManager.acceptCookie()) { // Cookies are enabled.
1305 Snackbar.make(webViewPager, R.string.cookies_enabled, Snackbar.LENGTH_SHORT).show();
1306 } else if (currentWebView.getSettings().getJavaScriptEnabled()) { // JavaScript is still enabled.
1307 Snackbar.make(webViewPager, R.string.cookies_disabled, Snackbar.LENGTH_SHORT).show();
1308 } else { // Privacy mode.
1309 Snackbar.make(webViewPager, R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1312 // Reload the current WebView.
1313 currentWebView.reload();
1315 // Consume the event.
1317 } else if (menuItemId == R.id.dom_storage) { // DOM storage.
1318 // Toggle the status of domStorageEnabled.
1319 currentWebView.getSettings().setDomStorageEnabled(!currentWebView.getSettings().getDomStorageEnabled());
1321 // Update the menu checkbox.
1322 menuItem.setChecked(currentWebView.getSettings().getDomStorageEnabled());
1324 // Update the privacy icon.
1325 updatePrivacyIcons(true);
1327 // Display a snackbar.
1328 if (currentWebView.getSettings().getDomStorageEnabled()) {
1329 Snackbar.make(webViewPager, R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show();
1331 Snackbar.make(webViewPager, R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show();
1334 // Reload the current WebView.
1335 currentWebView.reload();
1337 // Consume the event.
1339 } else if (menuItemId == R.id.save_form_data) { // Form data. This can be removed once the minimum API >= 26.
1340 // Switch the status of saveFormDataEnabled.
1341 currentWebView.getSettings().setSaveFormData(!currentWebView.getSettings().getSaveFormData());
1343 // Update the menu checkbox.
1344 menuItem.setChecked(currentWebView.getSettings().getSaveFormData());
1346 // Display a snackbar.
1347 if (currentWebView.getSettings().getSaveFormData()) {
1348 Snackbar.make(webViewPager, R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show();
1350 Snackbar.make(webViewPager, R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show();
1353 // Update the privacy icon.
1354 updatePrivacyIcons(true);
1356 // Reload the current WebView.
1357 currentWebView.reload();
1359 // Consume the event.
1361 } else if (menuItemId == R.id.clear_cookies) { // Clear cookies.
1362 // Create a snackbar.
1363 Snackbar.make(webViewPager, R.string.cookies_deleted, Snackbar.LENGTH_LONG)
1364 .setAction(R.string.undo, v -> {
1365 // Do nothing because everything will be handled by `onDismissed()` below.
1367 .addCallback(new Snackbar.Callback() {
1369 public void onDismissed(Snackbar snackbar, int event) {
1370 if (event != Snackbar.Callback.DISMISS_EVENT_ACTION) { // The snackbar was dismissed without the undo button being pushed.
1371 // Delete the cookies.
1372 cookieManager.removeAllCookies(null);
1378 // Consume the event.
1380 } else if (menuItemId == R.id.clear_dom_storage) { // Clear DOM storage.
1381 // Create a snackbar.
1382 Snackbar.make(webViewPager, R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
1383 .setAction(R.string.undo, v -> {
1384 // Do nothing because everything will be handled by `onDismissed()` below.
1386 .addCallback(new Snackbar.Callback() {
1388 public void onDismissed(Snackbar snackbar, int event) {
1389 if (event != Snackbar.Callback.DISMISS_EVENT_ACTION) { // The snackbar was dismissed without the undo button being pushed.
1390 // Delete the DOM Storage.
1391 WebStorage webStorage = WebStorage.getInstance();
1392 webStorage.deleteAllData();
1394 // Initialize a handler to manually delete the DOM storage files and directories.
1395 Handler deleteDomStorageHandler = new Handler();
1397 // Setup a runnable to manually delete the DOM storage files and directories.
1398 Runnable deleteDomStorageRunnable = () -> {
1400 // Get a handle for the runtime.
1401 Runtime runtime = Runtime.getRuntime();
1403 // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
1404 // which links to `/data/data/com.stoutner.privacybrowser.standard`.
1405 String privateDataDirectoryString = getApplicationInfo().dataDir;
1407 // A string array must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
1408 Process deleteLocalStorageProcess = runtime.exec(new String[]{"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
1410 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
1411 Process deleteIndexProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
1412 Process deleteQuotaManagerProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
1413 Process deleteQuotaManagerJournalProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
1414 Process deleteDatabasesProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
1416 // Wait for the processes to finish.
1417 deleteLocalStorageProcess.waitFor();
1418 deleteIndexProcess.waitFor();
1419 deleteQuotaManagerProcess.waitFor();
1420 deleteQuotaManagerJournalProcess.waitFor();
1421 deleteDatabasesProcess.waitFor();
1422 } catch (Exception exception) {
1423 // Do nothing if an error is thrown.
1427 // Manually delete the DOM storage files after 200 milliseconds.
1428 deleteDomStorageHandler.postDelayed(deleteDomStorageRunnable, 200);
1434 // Consume the event.
1436 } else if (menuItemId == R.id.clear_form_data) { // Clear form data. This can be remove once the minimum API >= 26.
1437 // Create a snackbar.
1438 Snackbar.make(webViewPager, R.string.form_data_deleted, Snackbar.LENGTH_LONG)
1439 .setAction(R.string.undo, v -> {
1440 // Do nothing because everything will be handled by `onDismissed()` below.
1442 .addCallback(new Snackbar.Callback() {
1444 public void onDismissed(Snackbar snackbar, int event) {
1445 if (event != Snackbar.Callback.DISMISS_EVENT_ACTION) { // The snackbar was dismissed without the undo button being pushed.
1446 // Get a handle for the webView database.
1447 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(getApplicationContext());
1449 // Delete the form data.
1450 webViewDatabase.clearFormData();
1456 // Consume the event.
1458 } else if (menuItemId == R.id.easylist) { // EasyList.
1459 // Toggle the EasyList status.
1460 currentWebView.setEasyListEnabled(!currentWebView.getEasyListEnabled());
1462 // Update the menu checkbox.
1463 menuItem.setChecked(currentWebView.getEasyListEnabled());
1465 // Reload the current WebView.
1466 currentWebView.reload();
1468 // Consume the event.
1470 } else if (menuItemId == R.id.easyprivacy) { // EasyPrivacy.
1471 // Toggle the EasyPrivacy status.
1472 currentWebView.setEasyPrivacyEnabled(!currentWebView.getEasyPrivacyEnabled());
1474 // Update the menu checkbox.
1475 menuItem.setChecked(currentWebView.getEasyPrivacyEnabled());
1477 // Reload the current WebView.
1478 currentWebView.reload();
1480 // Consume the event.
1482 } else if (menuItemId == R.id.fanboys_annoyance_list) { // Fanboy's Annoyance List.
1483 // Toggle Fanboy's Annoyance List status.
1484 currentWebView.setFanboysAnnoyanceListEnabled(!currentWebView.getFanboysAnnoyanceListEnabled());
1486 // Update the menu checkbox.
1487 menuItem.setChecked(currentWebView.getFanboysAnnoyanceListEnabled());
1489 // Update the status of Fanboy's Social Blocking List.
1490 optionsFanboysSocialBlockingListMenuItem.setEnabled(!currentWebView.getFanboysAnnoyanceListEnabled());
1492 // Reload the current WebView.
1493 currentWebView.reload();
1495 // Consume the event.
1497 } else if (menuItemId == R.id.fanboys_social_blocking_list) { // Fanboy's Social Blocking List.
1498 // Toggle Fanboy's Social Blocking List status.
1499 currentWebView.setFanboysSocialBlockingListEnabled(!currentWebView.getFanboysSocialBlockingListEnabled());
1501 // Update the menu checkbox.
1502 menuItem.setChecked(currentWebView.getFanboysSocialBlockingListEnabled());
1504 // Reload the current WebView.
1505 currentWebView.reload();
1507 // Consume the event.
1509 } else if (menuItemId == R.id.ultralist) { // UltraList.
1510 // Toggle the UltraList status.
1511 currentWebView.setUltraListEnabled(!currentWebView.getUltraListEnabled());
1513 // Update the menu checkbox.
1514 menuItem.setChecked(currentWebView.getUltraListEnabled());
1516 // Reload the current WebView.
1517 currentWebView.reload();
1519 // Consume the event.
1521 } else if (menuItemId == R.id.ultraprivacy) { // UltraPrivacy.
1522 // Toggle the UltraPrivacy status.
1523 currentWebView.setUltraPrivacyEnabled(!currentWebView.getUltraPrivacyEnabled());
1525 // Update the menu checkbox.
1526 menuItem.setChecked(currentWebView.getUltraPrivacyEnabled());
1528 // Reload the current WebView.
1529 currentWebView.reload();
1531 // Consume the event.
1533 } else if (menuItemId == R.id.block_all_third_party_requests) { // Block all third-party requests.
1534 //Toggle the third-party requests blocker status.
1535 currentWebView.setBlockAllThirdPartyRequests(!currentWebView.getBlockAllThirdPartyRequests());
1537 // Update the menu checkbox.
1538 menuItem.setChecked(currentWebView.getBlockAllThirdPartyRequests());
1540 // Reload the current WebView.
1541 currentWebView.reload();
1543 // Consume the event.
1545 } else if (menuItemId == R.id.proxy_none) { // Proxy - None.
1546 // Update the proxy mode.
1547 proxyMode = ProxyHelper.NONE;
1549 // Apply the proxy mode.
1552 // Consume the event.
1554 } else if (menuItemId == R.id.proxy_tor) { // Proxy - Tor.
1555 // Update the proxy mode.
1556 proxyMode = ProxyHelper.TOR;
1558 // Apply the proxy mode.
1561 // Consume the event.
1563 } else if (menuItemId == R.id.proxy_i2p) { // Proxy - I2P.
1564 // Update the proxy mode.
1565 proxyMode = ProxyHelper.I2P;
1567 // Apply the proxy mode.
1570 // Consume the event.
1572 } else if (menuItemId == R.id.proxy_custom) { // Proxy - Custom.
1573 // Update the proxy mode.
1574 proxyMode = ProxyHelper.CUSTOM;
1576 // Apply the proxy mode.
1579 // Consume the event.
1581 } else if (menuItemId == R.id.user_agent_privacy_browser) { // User Agent - Privacy Browser.
1582 // Update the user agent.
1583 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[0]);
1585 // Reload the current WebView.
1586 currentWebView.reload();
1588 // Consume the event.
1590 } else if (menuItemId == R.id.user_agent_webview_default) { // User Agent - WebView Default.
1591 // Update the user agent.
1592 currentWebView.getSettings().setUserAgentString("");
1594 // Reload the current WebView.
1595 currentWebView.reload();
1597 // Consume the event.
1599 } else if (menuItemId == R.id.user_agent_firefox_on_android) { // User Agent - Firefox on Android.
1600 // Update the user agent.
1601 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[2]);
1603 // Reload the current WebView.
1604 currentWebView.reload();
1606 // Consume the event.
1608 } else if (menuItemId == R.id.user_agent_chrome_on_android) { // User Agent - Chrome on Android.
1609 // Update the user agent.
1610 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[3]);
1612 // Reload the current WebView.
1613 currentWebView.reload();
1615 // Consume the event.
1617 } else if (menuItemId == R.id.user_agent_safari_on_ios) { // User Agent - Safari on iOS.
1618 // Update the user agent.
1619 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[4]);
1621 // Reload the current WebView.
1622 currentWebView.reload();
1624 // Consume the event.
1626 } else if (menuItemId == R.id.user_agent_firefox_on_linux) { // User Agent - Firefox on Linux.
1627 // Update the user agent.
1628 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[5]);
1630 // Reload the current WebView.
1631 currentWebView.reload();
1633 // Consume the event.
1635 } else if (menuItemId == R.id.user_agent_chromium_on_linux) { // User Agent - Chromium on Linux.
1636 // Update the user agent.
1637 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[6]);
1639 // Reload the current WebView.
1640 currentWebView.reload();
1642 // Consume the event.
1644 } else if (menuItemId == R.id.user_agent_firefox_on_windows) { // User Agent - Firefox on Windows.
1645 // Update the user agent.
1646 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[7]);
1648 // Reload the current WebView.
1649 currentWebView.reload();
1651 // Consume the event.
1653 } else if (menuItemId == R.id.user_agent_chrome_on_windows) { // User Agent - Chrome on Windows.
1654 // Update the user agent.
1655 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[8]);
1657 // Reload the current WebView.
1658 currentWebView.reload();
1660 // Consume the event.
1662 } else if (menuItemId == R.id.user_agent_edge_on_windows) { // User Agent - Edge on Windows.
1663 // Update the user agent.
1664 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[9]);
1666 // Reload the current WebView.
1667 currentWebView.reload();
1669 // Consume the event.
1671 } else if (menuItemId == R.id.user_agent_internet_explorer_on_windows) { // User Agent - Internet Explorer on Windows.
1672 // Update the user agent.
1673 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[10]);
1675 // Reload the current WebView.
1676 currentWebView.reload();
1678 // Consume the event.
1680 } else if (menuItemId == R.id.user_agent_safari_on_macos) { // User Agent - Safari on macOS.
1681 // Update the user agent.
1682 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[11]);
1684 // Reload the current WebView.
1685 currentWebView.reload();
1687 // Consume the event.
1689 } else if (menuItemId == R.id.user_agent_custom) { // User Agent - Custom.
1690 // Update the user agent.
1691 currentWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", getString(R.string.custom_user_agent_default_value)));
1693 // Reload the current WebView.
1694 currentWebView.reload();
1696 // Consume the event.
1698 } else if (menuItemId == R.id.font_size) { // Font size.
1699 // Instantiate the font size dialog.
1700 DialogFragment fontSizeDialogFragment = FontSizeDialog.displayDialog(currentWebView.getSettings().getTextZoom());
1702 // Show the font size dialog.
1703 fontSizeDialogFragment.show(getSupportFragmentManager(), getString(R.string.font_size));
1705 // Consume the event.
1707 } else if (menuItemId == R.id.swipe_to_refresh) { // Swipe to refresh.
1708 // Toggle the stored status of swipe to refresh.
1709 currentWebView.setSwipeToRefresh(!currentWebView.getSwipeToRefresh());
1711 // Update the swipe refresh layout.
1712 if (currentWebView.getSwipeToRefresh()) { // Swipe to refresh is enabled.
1713 // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
1714 swipeRefreshLayout.setEnabled(currentWebView.getScrollY() == 0);
1715 } else { // Swipe to refresh is disabled.
1716 // Disable the swipe refresh layout.
1717 swipeRefreshLayout.setEnabled(false);
1720 // Consume the event.
1722 } else if (menuItemId == R.id.wide_viewport) { // Wide viewport.
1723 // Toggle the viewport.
1724 currentWebView.getSettings().setUseWideViewPort(!currentWebView.getSettings().getUseWideViewPort());
1726 // Consume the event.
1728 } else if (menuItemId == R.id.display_images) { // Display images.
1729 // Toggle the displaying of images.
1730 if (currentWebView.getSettings().getLoadsImagesAutomatically()) { // Images are currently loaded automatically.
1731 // Disable loading of images.
1732 currentWebView.getSettings().setLoadsImagesAutomatically(false);
1734 // Reload the website to remove existing images.
1735 currentWebView.reload();
1736 } else { // Images are not currently loaded automatically.
1737 // Enable loading of images. Missing images will be loaded without the need for a reload.
1738 currentWebView.getSettings().setLoadsImagesAutomatically(true);
1741 // Consume the event.
1743 } else if (menuItemId == R.id.dark_webview) { // Dark WebView.
1744 // Check to see if dark WebView is supported by this WebView.
1745 if (WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) {
1746 // Toggle the dark WebView setting.
1747 if (WebSettingsCompat.getForceDark(currentWebView.getSettings()) == WebSettingsCompat.FORCE_DARK_ON) { // Dark WebView is currently enabled.
1748 // Turn off dark WebView.
1749 WebSettingsCompat.setForceDark(currentWebView.getSettings(), WebSettingsCompat.FORCE_DARK_OFF);
1750 } else { // Dark WebView is currently disabled.
1751 // Turn on dark WebView.
1752 WebSettingsCompat.setForceDark(currentWebView.getSettings(), WebSettingsCompat.FORCE_DARK_ON);
1756 // Consume the event.
1758 } else if (menuItemId == R.id.find_on_page) { // Find on page.
1759 // Get a handle for the views.
1760 Toolbar toolbar = findViewById(R.id.toolbar);
1761 LinearLayout findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
1762 EditText findOnPageEditText = findViewById(R.id.find_on_page_edittext);
1764 // Set the minimum height of the find on page linear layout to match the toolbar.
1765 findOnPageLinearLayout.setMinimumHeight(toolbar.getHeight());
1767 // Hide the toolbar.
1768 toolbar.setVisibility(View.GONE);
1770 // Show the find on page linear layout.
1771 findOnPageLinearLayout.setVisibility(View.VISIBLE);
1773 // Display the keyboard. The app must wait 200 ms before running the command to work around a bug in Android.
1774 // http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
1775 findOnPageEditText.postDelayed(() -> {
1776 // Set the focus on the find on page edit text.
1777 findOnPageEditText.requestFocus();
1779 // Get a handle for the input method manager.
1780 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
1782 // Remove the lint warning below that the input method manager might be null.
1783 assert inputMethodManager != null;
1785 // Display the keyboard. `0` sets no input flags.
1786 inputMethodManager.showSoftInput(findOnPageEditText, 0);
1789 // Consume the event.
1791 } else if (menuItemId == R.id.print) { // Print.
1792 // Get a print manager instance.
1793 PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
1795 // Remove the lint error below that print manager might be null.
1796 assert printManager != null;
1798 // Create a print document adapter from the current WebView.
1799 PrintDocumentAdapter printDocumentAdapter = currentWebView.createPrintDocumentAdapter(getString(R.string.print));
1801 // Print the document.
1802 printManager.print(getString(R.string.privacy_browser_webpage), printDocumentAdapter, null);
1804 // Consume the event.
1806 } else if (menuItemId == R.id.save_url) { // Save URL.
1807 // Check the download preference.
1808 if (downloadWithExternalApp) { // Download with an external app.
1809 downloadUrlWithExternalApp(currentWebView.getCurrentUrl());
1810 } else { // Handle the download inside of Privacy Browser.
1811 // Prepare the save dialog. The dialog will be displayed once the file size and the content disposition have been acquired.
1812 new PrepareSaveDialog(this, this, getSupportFragmentManager(), currentWebView.getSettings().getUserAgentString(),
1813 currentWebView.getAcceptCookies()).execute(currentWebView.getCurrentUrl());
1816 // Consume the event.
1818 } else if (menuItemId == R.id.save_archive) {
1819 // Open the file picker with a default file name built from the current domain name.
1820 saveWebpageArchiveActivityResultLauncher.launch(currentWebView.getCurrentDomainName() + ".mht");
1822 // Consume the event.
1824 } else if (menuItemId == R.id.save_image) { // Save image.
1825 // Open the file picker with a default file name built from the current domain name.
1826 saveWebpageImageActivityResultLauncher.launch(currentWebView.getCurrentDomainName() + ".png");
1828 // Consume the event.
1830 } else if (menuItemId == R.id.add_to_homescreen) { // Add to homescreen.
1831 // Instantiate the create home screen shortcut dialog.
1832 DialogFragment createHomeScreenShortcutDialogFragment = CreateHomeScreenShortcutDialog.createDialog(currentWebView.getTitle(), currentWebView.getUrl(),
1833 currentWebView.getFavoriteOrDefaultIcon());
1835 // Show the create home screen shortcut dialog.
1836 createHomeScreenShortcutDialogFragment.show(getSupportFragmentManager(), getString(R.string.create_shortcut));
1838 // Consume the event.
1840 } else if (menuItemId == R.id.view_source) { // View source.
1841 // Create an intent to launch the view source activity.
1842 Intent viewSourceIntent = new Intent(this, ViewSourceActivity.class);
1844 // Add the variables to the intent.
1845 viewSourceIntent.putExtra(ViewSourceActivityKt.CURRENT_URL, currentWebView.getUrl());
1846 viewSourceIntent.putExtra(ViewSourceActivityKt.USER_AGENT, currentWebView.getSettings().getUserAgentString());
1849 startActivity(viewSourceIntent);
1851 // Consume the event.
1853 } else if (menuItemId == R.id.share_message) { // Share a message.
1854 // Prepare the share string.
1855 String shareString = currentWebView.getTitle() + " – " + currentWebView.getUrl();
1857 // Create the share intent.
1858 Intent shareMessageIntent = new Intent(Intent.ACTION_SEND);
1860 // Add the share string to the intent.
1861 shareMessageIntent.putExtra(Intent.EXTRA_TEXT, shareString);
1863 // Set the MIME type.
1864 shareMessageIntent.setType("text/plain");
1866 // Set the intent to open in a new task.
1867 shareMessageIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1870 startActivity(Intent.createChooser(shareMessageIntent, getString(R.string.share_message)));
1872 // Consume the event.
1874 } else if (menuItemId == R.id.share_url) { // Share URL.
1875 // Create the share intent.
1876 Intent shareUrlIntent = new Intent(Intent.ACTION_SEND);
1878 // Add the URL to the intent.
1879 shareUrlIntent.putExtra(Intent.EXTRA_TEXT, currentWebView.getUrl());
1881 // Add the title to the intent.
1882 shareUrlIntent.putExtra(Intent.EXTRA_SUBJECT, currentWebView.getTitle());
1884 // Set the MIME type.
1885 shareUrlIntent.setType("text/plain");
1887 // Set the intent to open in a new task.
1888 shareUrlIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1891 startActivity(Intent.createChooser(shareUrlIntent, getString(R.string.share_url)));
1893 // Consume the event.
1895 } else if (menuItemId == R.id.open_with_app) { // Open with app.
1896 // Open the URL with an outside app.
1897 openWithApp(currentWebView.getUrl());
1899 // Consume the event.
1901 } else if (menuItemId == R.id.open_with_browser) { // Open with browser.
1902 // Open the URL with an outside browser.
1903 openWithBrowser(currentWebView.getUrl());
1905 // Consume the event.
1907 } else if (menuItemId == R.id.add_or_edit_domain) { // Add or edit domain.
1908 // Check if domain settings currently exist.
1909 if (currentWebView.getDomainSettingsApplied()) { // Edit the current domain settings.
1910 // Reapply the domain settings on returning to `MainWebViewActivity`.
1911 reapplyDomainSettingsOnRestart = true;
1913 // Create an intent to launch the domains activity.
1914 Intent domainsIntent = new Intent(this, DomainsActivity.class);
1916 // Add the extra information to the intent.
1917 domainsIntent.putExtra("load_domain", currentWebView.getDomainSettingsDatabaseId());
1918 domainsIntent.putExtra("close_on_back", true);
1919 domainsIntent.putExtra("current_url", currentWebView.getUrl());
1920 domainsIntent.putExtra("current_ip_addresses", currentWebView.getCurrentIpAddresses());
1922 // Get the current certificate.
1923 SslCertificate sslCertificate = currentWebView.getCertificate();
1925 // Check to see if the SSL certificate is populated.
1926 if (sslCertificate != null) {
1927 // Extract the certificate to strings.
1928 String issuedToCName = sslCertificate.getIssuedTo().getCName();
1929 String issuedToOName = sslCertificate.getIssuedTo().getOName();
1930 String issuedToUName = sslCertificate.getIssuedTo().getUName();
1931 String issuedByCName = sslCertificate.getIssuedBy().getCName();
1932 String issuedByOName = sslCertificate.getIssuedBy().getOName();
1933 String issuedByUName = sslCertificate.getIssuedBy().getUName();
1934 long startDateLong = sslCertificate.getValidNotBeforeDate().getTime();
1935 long endDateLong = sslCertificate.getValidNotAfterDate().getTime();
1937 // Add the certificate to the intent.
1938 domainsIntent.putExtra("ssl_issued_to_cname", issuedToCName);
1939 domainsIntent.putExtra("ssl_issued_to_oname", issuedToOName);
1940 domainsIntent.putExtra("ssl_issued_to_uname", issuedToUName);
1941 domainsIntent.putExtra("ssl_issued_by_cname", issuedByCName);
1942 domainsIntent.putExtra("ssl_issued_by_oname", issuedByOName);
1943 domainsIntent.putExtra("ssl_issued_by_uname", issuedByUName);
1944 domainsIntent.putExtra("ssl_start_date", startDateLong);
1945 domainsIntent.putExtra("ssl_end_date", endDateLong);
1949 startActivity(domainsIntent);
1950 } else { // Add a new domain.
1951 // Apply the new domain settings on returning to `MainWebViewActivity`.
1952 reapplyDomainSettingsOnRestart = true;
1954 // Get the current domain
1955 Uri currentUri = Uri.parse(currentWebView.getUrl());
1956 String currentDomain = currentUri.getHost();
1958 // Initialize the database handler.
1959 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this);
1961 // Create the domain and store the database ID.
1962 int newDomainDatabaseId = domainsDatabaseHelper.addDomain(currentDomain);
1964 // Create an intent to launch the domains activity.
1965 Intent domainsIntent = new Intent(this, DomainsActivity.class);
1967 // Add the extra information to the intent.
1968 domainsIntent.putExtra("load_domain", newDomainDatabaseId);
1969 domainsIntent.putExtra("close_on_back", true);
1970 domainsIntent.putExtra("current_url", currentWebView.getUrl());
1971 domainsIntent.putExtra("current_ip_addresses", currentWebView.getCurrentIpAddresses());
1973 // Get the current certificate.
1974 SslCertificate sslCertificate = currentWebView.getCertificate();
1976 // Check to see if the SSL certificate is populated.
1977 if (sslCertificate != null) {
1978 // Extract the certificate to strings.
1979 String issuedToCName = sslCertificate.getIssuedTo().getCName();
1980 String issuedToOName = sslCertificate.getIssuedTo().getOName();
1981 String issuedToUName = sslCertificate.getIssuedTo().getUName();
1982 String issuedByCName = sslCertificate.getIssuedBy().getCName();
1983 String issuedByOName = sslCertificate.getIssuedBy().getOName();
1984 String issuedByUName = sslCertificate.getIssuedBy().getUName();
1985 long startDateLong = sslCertificate.getValidNotBeforeDate().getTime();
1986 long endDateLong = sslCertificate.getValidNotAfterDate().getTime();
1988 // Add the certificate to the intent.
1989 domainsIntent.putExtra("ssl_issued_to_cname", issuedToCName);
1990 domainsIntent.putExtra("ssl_issued_to_oname", issuedToOName);
1991 domainsIntent.putExtra("ssl_issued_to_uname", issuedToUName);
1992 domainsIntent.putExtra("ssl_issued_by_cname", issuedByCName);
1993 domainsIntent.putExtra("ssl_issued_by_oname", issuedByOName);
1994 domainsIntent.putExtra("ssl_issued_by_uname", issuedByUName);
1995 domainsIntent.putExtra("ssl_start_date", startDateLong);
1996 domainsIntent.putExtra("ssl_end_date", endDateLong);
2000 startActivity(domainsIntent);
2003 // Consume the event.
2005 } else { // There is no match with the options menu. Pass the event up to the parent method.
2006 // Don't consume the event.
2007 return super.onOptionsItemSelected(menuItem);
2011 // removeAllCookies is deprecated, but it is required for API < 21.
2013 public boolean onNavigationItemSelected(@NonNull MenuItem menuItem) {
2014 // Get a handle for the shared preferences.
2015 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2017 // Get the menu item ID.
2018 int menuItemId = menuItem.getItemId();
2020 // Run the commands that correspond to the selected menu item.
2021 if (menuItemId == R.id.clear_and_exit) { // Clear and exit.
2022 // Clear and exit Privacy Browser.
2024 } else if (menuItemId == R.id.home) { // Home.
2025 // Load the homepage.
2026 loadUrl(currentWebView, sharedPreferences.getString("homepage", getString(R.string.homepage_default_value)));
2027 } else if (menuItemId == R.id.back) { // Back.
2028 // Check if the WebView can go back.
2029 if (currentWebView.canGoBack()) {
2030 // Get the current web back forward list.
2031 WebBackForwardList webBackForwardList = currentWebView.copyBackForwardList();
2033 // Get the previous entry URL.
2034 String previousUrl = webBackForwardList.getItemAtIndex(webBackForwardList.getCurrentIndex() - 1).getUrl();
2036 // Apply the domain settings.
2037 applyDomainSettings(currentWebView, previousUrl, false, false, false);
2039 // Load the previous website in the history.
2040 currentWebView.goBack();
2042 } else if (menuItemId == R.id.forward) { // Forward.
2043 // Check if the WebView can go forward.
2044 if (currentWebView.canGoForward()) {
2045 // Get the current web back forward list.
2046 WebBackForwardList webBackForwardList = currentWebView.copyBackForwardList();
2048 // Get the next entry URL.
2049 String nextUrl = webBackForwardList.getItemAtIndex(webBackForwardList.getCurrentIndex() + 1).getUrl();
2051 // Apply the domain settings.
2052 applyDomainSettings(currentWebView, nextUrl, false, false, false);
2054 // Load the next website in the history.
2055 currentWebView.goForward();
2057 } else if (menuItemId == R.id.history) { // History.
2058 // Instantiate the URL history dialog.
2059 DialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(currentWebView.getWebViewFragmentId());
2061 // Show the URL history dialog.
2062 urlHistoryDialogFragment.show(getSupportFragmentManager(), getString(R.string.history));
2063 } else if (menuItemId == R.id.open) { // Open.
2064 // Instantiate the open file dialog.
2065 DialogFragment openDialogFragment = new OpenDialog();
2067 // Show the open file dialog.
2068 openDialogFragment.show(getSupportFragmentManager(), getString(R.string.open));
2069 } else if (menuItemId == R.id.requests) { // Requests.
2070 // Populate the resource requests.
2071 RequestsActivity.resourceRequests = currentWebView.getResourceRequests();
2073 // Create an intent to launch the Requests activity.
2074 Intent requestsIntent = new Intent(this, RequestsActivity.class);
2076 // Add the block third-party requests status to the intent.
2077 requestsIntent.putExtra("block_all_third_party_requests", currentWebView.getBlockAllThirdPartyRequests());
2080 startActivity(requestsIntent);
2081 } else if (menuItemId == R.id.downloads) { // Downloads.
2082 // Try the default system download manager.
2084 // Launch the default system Download Manager.
2085 Intent defaultDownloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
2087 // Launch as a new task so that the download manager and Privacy Browser show as separate windows in the recent tasks list.
2088 defaultDownloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2091 startActivity(defaultDownloadManagerIntent);
2092 } catch (Exception defaultDownloadManagerException) {
2093 // Try a generic file manager.
2095 // Create a generic file manager intent.
2096 Intent genericFileManagerIntent = new Intent(Intent.ACTION_VIEW);
2098 // Open the download directory.
2099 genericFileManagerIntent.setDataAndType(Uri.parse(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS).toString()), DocumentsContract.Document.MIME_TYPE_DIR);
2101 // Launch as a new task so that the file manager and Privacy Browser show as separate windows in the recent tasks list.
2102 genericFileManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2105 startActivity(genericFileManagerIntent);
2106 } catch (Exception genericFileManagerException) {
2107 // Try an alternate file manager.
2109 // Create an alternate file manager intent.
2110 Intent alternateFileManagerIntent = new Intent(Intent.ACTION_VIEW);
2112 // Open the download directory.
2113 alternateFileManagerIntent.setDataAndType(Uri.parse(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS).toString()), "resource/folder");
2115 // Launch as a new task so that the file manager and Privacy Browser show as separate windows in the recent tasks list.
2116 alternateFileManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2118 // Open the alternate file manager.
2119 startActivity(alternateFileManagerIntent);
2120 } catch (Exception alternateFileManagerException) {
2121 // Display a snackbar.
2122 Snackbar.make(currentWebView, R.string.no_file_manager_detected, Snackbar.LENGTH_INDEFINITE).show();
2126 } else if (menuItemId == R.id.domains) { // Domains.
2127 // Set the flag to reapply the domain settings on restart when returning from Domain Settings.
2128 reapplyDomainSettingsOnRestart = true;
2130 // Launch the domains activity.
2131 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2133 // Add the extra information to the intent.
2134 domainsIntent.putExtra("current_url", currentWebView.getUrl());
2135 domainsIntent.putExtra("current_ip_addresses", currentWebView.getCurrentIpAddresses());
2137 // Get the current certificate.
2138 SslCertificate sslCertificate = currentWebView.getCertificate();
2140 // Check to see if the SSL certificate is populated.
2141 if (sslCertificate != null) {
2142 // Extract the certificate to strings.
2143 String issuedToCName = sslCertificate.getIssuedTo().getCName();
2144 String issuedToOName = sslCertificate.getIssuedTo().getOName();
2145 String issuedToUName = sslCertificate.getIssuedTo().getUName();
2146 String issuedByCName = sslCertificate.getIssuedBy().getCName();
2147 String issuedByOName = sslCertificate.getIssuedBy().getOName();
2148 String issuedByUName = sslCertificate.getIssuedBy().getUName();
2149 long startDateLong = sslCertificate.getValidNotBeforeDate().getTime();
2150 long endDateLong = sslCertificate.getValidNotAfterDate().getTime();
2152 // Add the certificate to the intent.
2153 domainsIntent.putExtra("ssl_issued_to_cname", issuedToCName);
2154 domainsIntent.putExtra("ssl_issued_to_oname", issuedToOName);
2155 domainsIntent.putExtra("ssl_issued_to_uname", issuedToUName);
2156 domainsIntent.putExtra("ssl_issued_by_cname", issuedByCName);
2157 domainsIntent.putExtra("ssl_issued_by_oname", issuedByOName);
2158 domainsIntent.putExtra("ssl_issued_by_uname", issuedByUName);
2159 domainsIntent.putExtra("ssl_start_date", startDateLong);
2160 domainsIntent.putExtra("ssl_end_date", endDateLong);
2164 startActivity(domainsIntent);
2165 } else if (menuItemId == R.id.settings) { // Settings.
2166 // Set the flag to reapply app settings on restart when returning from Settings.
2167 reapplyAppSettingsOnRestart = true;
2169 // Set the flag to reapply the domain settings on restart when returning from Settings.
2170 reapplyDomainSettingsOnRestart = true;
2172 // Launch the settings activity.
2173 Intent settingsIntent = new Intent(this, SettingsActivity.class);
2174 startActivity(settingsIntent);
2175 } else if (menuItemId == R.id.import_export) { // Import/Export.
2176 // Create an intent to launch the import/export activity.
2177 Intent importExportIntent = new Intent(this, ImportExportActivity.class);
2180 startActivity(importExportIntent);
2181 } else if (menuItemId == R.id.logcat) { // Logcat.
2182 // Create an intent to launch the logcat activity.
2183 Intent logcatIntent = new Intent(this, LogcatActivity.class);
2186 startActivity(logcatIntent);
2187 } else if (menuItemId == R.id.guide) { // Guide.
2188 // Create an intent to launch the guide activity.
2189 Intent guideIntent = new Intent(this, GuideActivity.class);
2192 startActivity(guideIntent);
2193 } else if (menuItemId == R.id.about) { // About
2194 // Create an intent to launch the about activity.
2195 Intent aboutIntent = new Intent(this, AboutActivity.class);
2197 // Create a string array for the blocklist versions.
2198 String[] blocklistVersions = new String[]{easyList.get(0).get(0)[0], easyPrivacy.get(0).get(0)[0], fanboysAnnoyanceList.get(0).get(0)[0], fanboysSocialList.get(0).get(0)[0],
2199 ultraList.get(0).get(0)[0], ultraPrivacy.get(0).get(0)[0]};
2201 // Add the blocklist versions to the intent.
2202 aboutIntent.putExtra(AboutActivity.BLOCKLIST_VERSIONS, blocklistVersions);
2205 startActivity(aboutIntent);
2208 // Close the navigation drawer.
2209 drawerLayout.closeDrawer(GravityCompat.START);
2214 public void onPostCreate(Bundle savedInstanceState) {
2215 // Run the default commands.
2216 super.onPostCreate(savedInstanceState);
2218 // Sync the state of the DrawerToggle after the default `onRestoreInstanceState()` has finished. This creates the navigation drawer icon.
2219 actionBarDrawerToggle.syncState();
2223 public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
2224 // Get the hit test result.
2225 final WebView.HitTestResult hitTestResult = currentWebView.getHitTestResult();
2227 // Define the URL strings.
2228 final String imageUrl;
2229 final String linkUrl;
2231 // Get handles for the system managers.
2232 final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
2234 // Remove the lint errors below that the clipboard manager might be null.
2235 assert clipboardManager != null;
2237 // Process the link according to the type.
2238 switch (hitTestResult.getType()) {
2239 // `SRC_ANCHOR_TYPE` is a link.
2240 case WebView.HitTestResult.SRC_ANCHOR_TYPE:
2241 // Get the target URL.
2242 linkUrl = hitTestResult.getExtra();
2244 // Set the target URL as the title of the `ContextMenu`.
2245 menu.setHeaderTitle(linkUrl);
2247 // Add an Open in New Tab entry.
2248 menu.add(R.string.open_in_new_tab).setOnMenuItemClickListener((MenuItem item) -> {
2249 // Load the link URL in a new tab and move to it.
2250 addNewTab(linkUrl, true);
2252 // Consume the event.
2256 // Add an Open in Background entry.
2257 menu.add(R.string.open_in_background).setOnMenuItemClickListener((MenuItem item) -> {
2258 // Load the link URL in a new tab but do not move to it.
2259 addNewTab(linkUrl, false);
2261 // Consume the event.
2265 // Add an Open with App entry.
2266 menu.add(R.string.open_with_app).setOnMenuItemClickListener((MenuItem item) -> {
2267 openWithApp(linkUrl);
2269 // Consume the event.
2273 // Add an Open with Browser entry.
2274 menu.add(R.string.open_with_browser).setOnMenuItemClickListener((MenuItem item) -> {
2275 openWithBrowser(linkUrl);
2277 // Consume the event.
2281 // Add a Copy URL entry.
2282 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
2283 // Save the link URL in a `ClipData`.
2284 ClipData srcAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
2286 // Set the `ClipData` as the clipboard's primary clip.
2287 clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
2289 // Consume the event.
2293 // Add a Save URL entry.
2294 menu.add(R.string.save_url).setOnMenuItemClickListener((MenuItem item) -> {
2295 // Check the download preference.
2296 if (downloadWithExternalApp) { // Download with an external app.
2297 downloadUrlWithExternalApp(linkUrl);
2298 } else { // Handle the download inside of Privacy Browser.
2299 // Prepare the save dialog. The dialog will be displayed once the file size and the content disposition have been acquired.
2300 new PrepareSaveDialog(this, this, getSupportFragmentManager(), currentWebView.getSettings().getUserAgentString(),
2301 currentWebView.getAcceptCookies()).execute(linkUrl);
2304 // Consume the event.
2308 // Add an empty Cancel entry, which by default closes the context menu.
2309 menu.add(R.string.cancel);
2312 // `IMAGE_TYPE` is an image.
2313 case WebView.HitTestResult.IMAGE_TYPE:
2314 // Get the image URL.
2315 imageUrl = hitTestResult.getExtra();
2317 // Remove the incorrect lint warning below that the image URL might be null.
2318 assert imageUrl != null;
2320 // Set the context menu title.
2321 if (imageUrl.startsWith("data:")) { // The image data is contained in within the URL, making it exceedingly long.
2322 // Truncate the image URL before making it the title.
2323 menu.setHeaderTitle(imageUrl.substring(0, 100));
2324 } else { // The image URL does not contain the full image data.
2325 // Set the image URL as the title of the context menu.
2326 menu.setHeaderTitle(imageUrl);
2329 // Add an Open in New Tab entry.
2330 menu.add(R.string.open_image_in_new_tab).setOnMenuItemClickListener((MenuItem item) -> {
2331 // Load the image in a new tab.
2332 addNewTab(imageUrl, true);
2334 // Consume the event.
2338 // Add an Open with App entry.
2339 menu.add(R.string.open_with_app).setOnMenuItemClickListener((MenuItem item) -> {
2340 // Open the image URL with an external app.
2341 openWithApp(imageUrl);
2343 // Consume the event.
2347 // Add an Open with Browser entry.
2348 menu.add(R.string.open_with_browser).setOnMenuItemClickListener((MenuItem item) -> {
2349 // Open the image URL with an external browser.
2350 openWithBrowser(imageUrl);
2352 // Consume the event.
2356 // Add a View Image entry.
2357 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2358 // Load the image in the current tab.
2359 loadUrl(currentWebView, imageUrl);
2361 // Consume the event.
2365 // Add a Save Image entry.
2366 menu.add(R.string.save_image).setOnMenuItemClickListener((MenuItem item) -> {
2367 // Check the download preference.
2368 if (downloadWithExternalApp) { // Download with an external app.
2369 downloadUrlWithExternalApp(imageUrl);
2370 } else { // Handle the download inside of Privacy Browser.
2371 // Prepare the save dialog. The dialog will be displayed once the file size and the content disposition have been acquired.
2372 new PrepareSaveDialog(this, this, getSupportFragmentManager(), currentWebView.getSettings().getUserAgentString(),
2373 currentWebView.getAcceptCookies()).execute(imageUrl);
2376 // Consume the event.
2380 // Add a Copy URL entry.
2381 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
2382 // Save the image URL in a clip data.
2383 ClipData imageTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2385 // Set the clip data as the clipboard's primary clip.
2386 clipboardManager.setPrimaryClip(imageTypeClipData);
2388 // Consume the event.
2392 // Add an empty Cancel entry, which by default closes the context menu.
2393 menu.add(R.string.cancel);
2396 // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
2397 case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
2398 // Get the image URL.
2399 imageUrl = hitTestResult.getExtra();
2401 // Instantiate a handler.
2402 Handler handler = new Handler();
2404 // Get a message from the handler.
2405 Message message = handler.obtainMessage();
2407 // Request the image details from the last touched node be returned in the message.
2408 currentWebView.requestFocusNodeHref(message);
2410 // Get the link URL from the message data.
2411 linkUrl = message.getData().getString("url");
2413 // Set the link URL as the title of the context menu.
2414 menu.setHeaderTitle(linkUrl);
2416 // Add an Open in New Tab entry.
2417 menu.add(R.string.open_in_new_tab).setOnMenuItemClickListener((MenuItem item) -> {
2418 // Load the link URL in a new tab and move to it.
2419 addNewTab(linkUrl, true);
2421 // Consume the event.
2425 // Add an Open in Background entry.
2426 menu.add(R.string.open_in_background).setOnMenuItemClickListener((MenuItem item) -> {
2427 // Lod the link URL in a new tab but do not move to it.
2428 addNewTab(linkUrl, false);
2430 // Consume the event.
2434 // Add an Open Image in New Tab entry.
2435 menu.add(R.string.open_image_in_new_tab).setOnMenuItemClickListener((MenuItem item) -> {
2436 // Load the image in a new tab and move to it.
2437 addNewTab(imageUrl, true);
2439 // Consume the event.
2443 // Add an Open with App entry.
2444 menu.add(R.string.open_with_app).setOnMenuItemClickListener((MenuItem item) -> {
2445 // Open the link URL with an external app.
2446 openWithApp(linkUrl);
2448 // Consume the event.
2452 // Add an Open with Browser entry.
2453 menu.add(R.string.open_with_browser).setOnMenuItemClickListener((MenuItem item) -> {
2454 // Open the link URL with an external browser.
2455 openWithBrowser(linkUrl);
2457 // Consume the event.
2461 // Add a View Image entry.
2462 menu.add(R.string.view_image).setOnMenuItemClickListener((MenuItem item) -> {
2463 // View the image in the current tab.
2464 loadUrl(currentWebView, imageUrl);
2466 // Consume the event.
2470 // Add a Save Image entry.
2471 menu.add(R.string.save_image).setOnMenuItemClickListener((MenuItem item) -> {
2472 // Check the download preference.
2473 if (downloadWithExternalApp) { // Download with an external app.
2474 downloadUrlWithExternalApp(imageUrl);
2475 } else { // Handle the download inside of Privacy Browser.
2476 // Prepare the save dialog. The dialog will be displayed once the file size and the content disposition have been acquired.
2477 new PrepareSaveDialog(this, this, getSupportFragmentManager(), currentWebView.getSettings().getUserAgentString(),
2478 currentWebView.getAcceptCookies()).execute(imageUrl);
2481 // Consume the event.
2485 // Add a Copy URL entry.
2486 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
2487 // Save the link URL in a clip data.
2488 ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
2490 // Set the clip data as the clipboard's primary clip.
2491 clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
2493 // Consume the event.
2497 // Add a Save URL entry.
2498 menu.add(R.string.save_url).setOnMenuItemClickListener((MenuItem item) -> {
2499 // Check the download preference.
2500 if (downloadWithExternalApp) { // Download with an external app.
2501 downloadUrlWithExternalApp(linkUrl);
2502 } else { // Handle the download inside of Privacy Browser.
2503 // Prepare the save dialog. The dialog will be displayed once the file size and the content disposition have been acquired.
2504 new PrepareSaveDialog(this, this, getSupportFragmentManager(), currentWebView.getSettings().getUserAgentString(),
2505 currentWebView.getAcceptCookies()).execute(linkUrl);
2508 // Consume the event.
2512 // Add an empty Cancel entry, which by default closes the context menu.
2513 menu.add(R.string.cancel);
2516 case WebView.HitTestResult.EMAIL_TYPE:
2517 // Get the target URL.
2518 linkUrl = hitTestResult.getExtra();
2520 // Set the target URL as the title of the `ContextMenu`.
2521 menu.setHeaderTitle(linkUrl);
2523 // Add a Write Email entry.
2524 menu.add(R.string.write_email).setOnMenuItemClickListener(item -> {
2525 // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
2526 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
2528 // Parse the url and set it as the data for the `Intent`.
2529 emailIntent.setData(Uri.parse("mailto:" + linkUrl));
2531 // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
2532 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2536 startActivity(emailIntent);
2537 } catch (ActivityNotFoundException exception) {
2538 // Display a snackbar.
2539 Snackbar.make(currentWebView, getString(R.string.error) + " " + exception, Snackbar.LENGTH_INDEFINITE).show();
2542 // Consume the event.
2546 // Add a Copy Email Address entry.
2547 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(item -> {
2548 // Save the email address in a `ClipData`.
2549 ClipData srcEmailTypeClipData = ClipData.newPlainText(getString(R.string.email_address), linkUrl);
2551 // Set the `ClipData` as the clipboard's primary clip.
2552 clipboardManager.setPrimaryClip(srcEmailTypeClipData);
2554 // Consume the event.
2558 // Add an empty Cancel entry, which by default closes the context menu.
2559 menu.add(R.string.cancel);
2565 public void onCreateBookmark(DialogFragment dialogFragment, Bitmap favoriteIconBitmap) {
2566 // Get a handle for the bookmarks list view.
2567 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
2570 Dialog dialog = dialogFragment.getDialog();
2572 // Remove the incorrect lint warning below that the dialog might be null.
2573 assert dialog != null;
2575 // Get the views from the dialog fragment.
2576 EditText createBookmarkNameEditText = dialog.findViewById(R.id.create_bookmark_name_edittext);
2577 EditText createBookmarkUrlEditText = dialog.findViewById(R.id.create_bookmark_url_edittext);
2579 // Extract the strings from the edit texts.
2580 String bookmarkNameString = createBookmarkNameEditText.getText().toString();
2581 String bookmarkUrlString = createBookmarkUrlEditText.getText().toString();
2583 // Create a favorite icon byte array output stream.
2584 ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2586 // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2587 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
2589 // Convert the favorite icon byte array stream to a byte array.
2590 byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
2592 // Display the new bookmark below the current items in the (0 indexed) list.
2593 int newBookmarkDisplayOrder = bookmarksListView.getCount();
2595 // Create the bookmark.
2596 bookmarksDatabaseHelper.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray);
2598 // Update the bookmarks cursor with the current contents of this folder.
2599 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2601 // Update the list view.
2602 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2604 // Scroll to the new bookmark.
2605 bookmarksListView.setSelection(newBookmarkDisplayOrder);
2609 public void onCreateBookmarkFolder(DialogFragment dialogFragment, @NonNull Bitmap favoriteIconBitmap) {
2610 // Get a handle for the bookmarks list view.
2611 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
2614 Dialog dialog = dialogFragment.getDialog();
2616 // Remove the incorrect lint warning below that the dialog might be null.
2617 assert dialog != null;
2619 // Get handles for the views in the dialog fragment.
2620 EditText folderNameEditText = dialog.findViewById(R.id.folder_name_edittext);
2621 RadioButton defaultIconRadioButton = dialog.findViewById(R.id.default_icon_radiobutton);
2622 ImageView defaultIconImageView = dialog.findViewById(R.id.default_icon_imageview);
2624 // Get new folder name string.
2625 String folderNameString = folderNameEditText.getText().toString();
2627 // Create a folder icon bitmap.
2628 Bitmap folderIconBitmap;
2630 // Set the folder icon bitmap according to the dialog.
2631 if (defaultIconRadioButton.isChecked()) { // Use the default folder icon.
2632 // Get the default folder icon drawable.
2633 Drawable folderIconDrawable = defaultIconImageView.getDrawable();
2635 // Convert the folder icon drawable to a bitmap drawable.
2636 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2638 // Convert the folder icon bitmap drawable to a bitmap.
2639 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2640 } else { // Use the WebView favorite icon.
2641 // Copy the favorite icon bitmap to the folder icon bitmap.
2642 folderIconBitmap = favoriteIconBitmap;
2645 // Create a folder icon byte array output stream.
2646 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2648 // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2649 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
2651 // Convert the folder icon byte array stream to a byte array.
2652 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
2654 // Move all the bookmarks down one in the display order.
2655 for (int i = 0; i < bookmarksListView.getCount(); i++) {
2656 int databaseId = (int) bookmarksListView.getItemIdAtPosition(i);
2657 bookmarksDatabaseHelper.updateDisplayOrder(databaseId, i + 1);
2660 // Create the folder, which will be placed at the top of the `ListView`.
2661 bookmarksDatabaseHelper.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray);
2663 // Update the bookmarks cursor with the current contents of this folder.
2664 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2666 // Update the `ListView`.
2667 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2669 // Scroll to the new folder.
2670 bookmarksListView.setSelection(0);
2674 public void onSaveBookmarkFolder(DialogFragment dialogFragment, int selectedFolderDatabaseId, @NonNull Bitmap favoriteIconBitmap) {
2675 // Remove the incorrect lint warning below that the dialog fragment might be null.
2676 assert dialogFragment != null;
2679 Dialog dialog = dialogFragment.getDialog();
2681 // Remove the incorrect lint warning below that the dialog might be null.
2682 assert dialog != null;
2684 // Get handles for the views from the dialog.
2685 RadioButton currentFolderIconRadioButton = dialog.findViewById(R.id.current_icon_radiobutton);
2686 RadioButton defaultFolderIconRadioButton = dialog.findViewById(R.id.default_icon_radiobutton);
2687 ImageView defaultFolderIconImageView = dialog.findViewById(R.id.default_icon_imageview);
2688 EditText editFolderNameEditText = dialog.findViewById(R.id.folder_name_edittext);
2690 // Get the new folder name.
2691 String newFolderNameString = editFolderNameEditText.getText().toString();
2693 // Check if the favorite icon has changed.
2694 if (currentFolderIconRadioButton.isChecked()) { // Only the name has changed.
2695 // Update the name in the database.
2696 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString);
2697 } else if (!currentFolderIconRadioButton.isChecked() && newFolderNameString.equals(oldFolderNameString)) { // Only the icon has changed.
2698 // Create the new folder icon Bitmap.
2699 Bitmap folderIconBitmap;
2701 // Populate the new folder icon bitmap.
2702 if (defaultFolderIconRadioButton.isChecked()) {
2703 // Get the default folder icon drawable.
2704 Drawable folderIconDrawable = defaultFolderIconImageView.getDrawable();
2706 // Convert the folder icon drawable to a bitmap drawable.
2707 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2709 // Convert the folder icon bitmap drawable to a bitmap.
2710 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2711 } else { // Use the `WebView` favorite icon.
2712 // Copy the favorite icon bitmap to the folder icon bitmap.
2713 folderIconBitmap = favoriteIconBitmap;
2716 // Create a folder icon byte array output stream.
2717 ByteArrayOutputStream newFolderIconByteArrayOutputStream = new ByteArrayOutputStream();
2719 // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2720 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFolderIconByteArrayOutputStream);
2722 // Convert the folder icon byte array stream to a byte array.
2723 byte[] newFolderIconByteArray = newFolderIconByteArrayOutputStream.toByteArray();
2725 // Update the folder icon in the database.
2726 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, newFolderIconByteArray);
2727 } else { // The folder icon and the name have changed.
2728 // Get the new folder icon bitmap.
2729 Bitmap folderIconBitmap;
2730 if (defaultFolderIconRadioButton.isChecked()) {
2731 // Get the default folder icon drawable.
2732 Drawable folderIconDrawable = defaultFolderIconImageView.getDrawable();
2734 // Convert the folder icon drawable to a bitmap drawable.
2735 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2737 // Convert the folder icon bitmap drawable to a bitmap.
2738 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2739 } else { // Use the `WebView` favorite icon.
2740 // Copy the favorite icon bitmap to the folder icon bitmap.
2741 folderIconBitmap = favoriteIconBitmap;
2744 // Create a folder icon byte array output stream.
2745 ByteArrayOutputStream newFolderIconByteArrayOutputStream = new ByteArrayOutputStream();
2747 // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2748 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFolderIconByteArrayOutputStream);
2750 // Convert the folder icon byte array stream to a byte array.
2751 byte[] newFolderIconByteArray = newFolderIconByteArrayOutputStream.toByteArray();
2753 // Update the folder name and icon in the database.
2754 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString, newFolderIconByteArray);
2757 // Update the bookmarks cursor with the current contents of this folder.
2758 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2760 // Update the `ListView`.
2761 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2764 // Override `onBackPressed()` to handle the navigation drawer and and the WebViews.
2766 public void onBackPressed() {
2767 // Check the different options for processing `back`.
2768 if (drawerLayout.isDrawerVisible(GravityCompat.START)) { // The navigation drawer is open.
2769 // Close the navigation drawer.
2770 drawerLayout.closeDrawer(GravityCompat.START);
2771 } else if (drawerLayout.isDrawerVisible(GravityCompat.END)){ // The bookmarks drawer is open.
2772 // close the bookmarks drawer.
2773 drawerLayout.closeDrawer(GravityCompat.END);
2774 } else if (displayingFullScreenVideo) { // A full screen video is shown.
2775 // Exit the full screen video.
2776 exitFullScreenVideo();
2777 } else if (currentWebView.canGoBack()) { // There is at least one item in the current WebView history.
2778 // Get the current web back forward list.
2779 WebBackForwardList webBackForwardList = currentWebView.copyBackForwardList();
2781 // Get the previous entry URL.
2782 String previousUrl = webBackForwardList.getItemAtIndex(webBackForwardList.getCurrentIndex() - 1).getUrl();
2784 // Apply the domain settings.
2785 applyDomainSettings(currentWebView, previousUrl, false, false, false);
2788 currentWebView.goBack();
2789 } else if (tabLayout.getTabCount() > 1) { // There are at least two tabs.
2790 // Close the current tab.
2792 } else { // There isn't anything to do in Privacy Browser.
2793 // Close Privacy Browser. `finishAndRemoveTask()` also removes Privacy Browser from the recent app list.
2794 finishAndRemoveTask();
2796 // Manually kill Privacy Browser. Otherwise, it is glitchy when restarted.
2801 // Process the results of a file browse.
2803 public void onActivityResult(int requestCode, int resultCode, Intent returnedIntent) {
2804 // Run the default commands.
2805 super.onActivityResult(requestCode, resultCode, returnedIntent);
2807 // Run the commands that correlate to the specified request code.
2808 switch (requestCode) {
2809 case BROWSE_FILE_UPLOAD_REQUEST_CODE:
2810 // Pass the file to the WebView.
2811 fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(resultCode, returnedIntent));
2814 case BROWSE_OPEN_REQUEST_CODE:
2815 // Don't do anything if the user pressed back from the file picker.
2816 if (resultCode == Activity.RESULT_OK) {
2817 // Get a handle for the open dialog fragment.
2818 DialogFragment openDialogFragment = (DialogFragment) getSupportFragmentManager().findFragmentByTag(getString(R.string.open));
2820 // Only update the file name if the dialog still exists.
2821 if (openDialogFragment != null) {
2822 // Get a handle for the open dialog.
2823 Dialog openDialog = openDialogFragment.getDialog();
2825 // Remove the incorrect lint warning below that the dialog might be null.
2826 assert openDialog != null;
2828 // Get a handle for the file name edit text.
2829 EditText fileNameEditText = openDialog.findViewById(R.id.file_name_edittext);
2831 // Get the file name URI from the intent.
2832 Uri fileNameUri = returnedIntent.getData();
2834 // Get the file name string from the URI.
2835 String fileNameString = fileNameUri.toString();
2837 // Set the file name text.
2838 fileNameEditText.setText(fileNameString);
2840 // Move the cursor to the end of the file name edit text.
2841 fileNameEditText.setSelection(fileNameString.length());
2848 private void loadUrlFromTextBox() {
2849 // Get the text from urlTextBox and convert it to a string. trim() removes white spaces from the beginning and end of the string.
2850 String unformattedUrlString = urlEditText.getText().toString().trim();
2852 // Initialize the formatted URL string.
2855 // Check to see if the unformatted URL string is a valid URL. Otherwise, convert it into a search.
2856 if (unformattedUrlString.startsWith("content://")) { // This is a Content URL.
2857 // Load the entire content URL.
2858 url = unformattedUrlString;
2859 } else if (Patterns.WEB_URL.matcher(unformattedUrlString).matches() || unformattedUrlString.startsWith("http://") || unformattedUrlString.startsWith("https://") ||
2860 unformattedUrlString.startsWith("file://")) { // This is a standard URL.
2861 // Add `https://` at the beginning if there is no protocol. Otherwise the app will segfault.
2862 if (!unformattedUrlString.startsWith("http") && !unformattedUrlString.startsWith("file://")) {
2863 unformattedUrlString = "https://" + unformattedUrlString;
2866 // Initialize the unformatted URL.
2867 URL unformattedUrl = null;
2869 // Convert the unformatted URL string to a URL, then to a URI, and then back to a string, which sanitizes the input and adds in any missing components.
2871 unformattedUrl = new URL(unformattedUrlString);
2872 } catch (MalformedURLException e) {
2873 e.printStackTrace();
2876 // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if `.get` was called on a `null` value.
2877 String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
2878 String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
2879 String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
2880 String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
2881 String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
2884 Uri.Builder uri = new Uri.Builder();
2885 uri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
2887 // Decode the URI as a UTF-8 string in.
2889 url = URLDecoder.decode(uri.build().toString(), "UTF-8");
2890 } catch (UnsupportedEncodingException exception) {
2891 // Do nothing. The formatted URL string will remain blank.
2893 } else if (!unformattedUrlString.isEmpty()){ // This is not a URL, but rather a search string.
2894 // Create an encoded URL String.
2895 String encodedUrlString;
2897 // Sanitize the search input.
2899 encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
2900 } catch (UnsupportedEncodingException exception) {
2901 encodedUrlString = "";
2904 // Add the base search URL.
2905 url = searchURL + encodedUrlString;
2908 // Clear the focus from the URL edit text. Otherwise, proximate typing in the box will retain the colorized formatting instead of being reset during refocus.
2909 urlEditText.clearFocus();
2912 loadUrl(currentWebView, url);
2915 private void loadUrl(NestedScrollWebView nestedScrollWebView, String url) {
2916 // Sanitize the URL.
2917 url = sanitizeUrl(url);
2919 // Apply the domain settings and load the URL.
2920 applyDomainSettings(nestedScrollWebView, url, true, false, true);
2923 public void findPreviousOnPage(View view) {
2924 // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards.
2925 currentWebView.findNext(false);
2928 public void findNextOnPage(View view) {
2929 // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
2930 currentWebView.findNext(true);
2933 public void closeFindOnPage(View view) {
2934 // Get a handle for the views.
2935 Toolbar toolbar = findViewById(R.id.toolbar);
2936 LinearLayout findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
2937 EditText findOnPageEditText = findViewById(R.id.find_on_page_edittext);
2939 // Delete the contents of `find_on_page_edittext`.
2940 findOnPageEditText.setText(null);
2942 // Clear the highlighted phrases if the WebView is not null.
2943 if (currentWebView != null) {
2944 currentWebView.clearMatches();
2947 // Hide the find on page linear layout.
2948 findOnPageLinearLayout.setVisibility(View.GONE);
2950 // Show the toolbar.
2951 toolbar.setVisibility(View.VISIBLE);
2953 // Get a handle for the input method manager.
2954 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
2956 // Remove the lint warning below that the input method manager might be null.
2957 assert inputMethodManager != null;
2959 // Hide the keyboard.
2960 inputMethodManager.hideSoftInputFromWindow(toolbar.getWindowToken(), 0);
2964 public void onApplyNewFontSize(DialogFragment dialogFragment) {
2965 // Remove the incorrect lint warning below that the dialog fragment might be null.
2966 assert dialogFragment != null;
2969 Dialog dialog = dialogFragment.getDialog();
2971 // Remove the incorrect lint warning below tha the dialog might be null.
2972 assert dialog != null;
2974 // Get a handle for the font size edit text.
2975 EditText fontSizeEditText = dialog.findViewById(R.id.font_size_edittext);
2977 // Initialize the new font size variable with the current font size.
2978 int newFontSize = currentWebView.getSettings().getTextZoom();
2980 // Get the font size from the edit text.
2982 newFontSize = Integer.parseInt(fontSizeEditText.getText().toString());
2983 } catch (Exception exception) {
2984 // If the edit text does not contain a valid font size do nothing.
2987 // Apply the new font size.
2988 currentWebView.getSettings().setTextZoom(newFontSize);
2992 public void onOpen(DialogFragment dialogFragment) {
2994 Dialog dialog = dialogFragment.getDialog();
2996 // Remove the incorrect lint warning below that the dialog might be null.
2997 assert dialog != null;
2999 // Get handles for the views.
3000 EditText fileNameEditText = dialog.findViewById(R.id.file_name_edittext);
3001 CheckBox mhtCheckBox = dialog.findViewById(R.id.mht_checkbox);
3003 // Get the file path string.
3004 String openFilePath = fileNameEditText.getText().toString();
3006 // Apply the domain settings. This resets the favorite icon and removes any domain settings.
3007 applyDomainSettings(currentWebView, openFilePath, true, false, false);
3009 // Open the file according to the type.
3010 if (mhtCheckBox.isChecked()) { // Force opening of an MHT file.
3012 // Get the MHT file input stream.
3013 InputStream mhtFileInputStream = getContentResolver().openInputStream(Uri.parse(openFilePath));
3015 // Create a temporary MHT file.
3016 File temporaryMhtFile = File.createTempFile("temporary_mht_file", ".mht", getCacheDir());
3018 // Get a file output stream for the temporary MHT file.
3019 FileOutputStream temporaryMhtFileOutputStream = new FileOutputStream(temporaryMhtFile);
3021 // Create a transfer byte array.
3022 byte[] transferByteArray = new byte[1024];
3024 // Create an integer to track the number of bytes read.
3027 // Copy the temporary MHT file input stream to the MHT output stream.
3028 while ((bytesRead = mhtFileInputStream.read(transferByteArray)) > 0) {
3029 temporaryMhtFileOutputStream.write(transferByteArray, 0, bytesRead);
3032 // Flush the temporary MHT file output stream.
3033 temporaryMhtFileOutputStream.flush();
3035 // Close the streams.
3036 temporaryMhtFileOutputStream.close();
3037 mhtFileInputStream.close();
3039 // Load the temporary MHT file.
3040 currentWebView.loadUrl(temporaryMhtFile.toString());
3041 } catch (Exception exception) {
3042 // Display a snackbar.
3043 Snackbar.make(currentWebView, getString(R.string.error) + " " + exception, Snackbar.LENGTH_INDEFINITE).show();
3045 } else { // Let the WebView handle opening of the file.
3047 currentWebView.loadUrl(openFilePath);
3051 private void downloadUrlWithExternalApp(String url) {
3052 // Create a download intent. Not specifying the action type will display the maximum number of options.
3053 Intent downloadIntent = new Intent();
3055 // Set the URI and the mime type.
3056 downloadIntent.setDataAndType(Uri.parse(url), "text/html");
3058 // Flag the intent to open in a new task.
3059 downloadIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
3061 // Show the chooser.
3062 startActivity(Intent.createChooser(downloadIntent, getString(R.string.download_with_external_app)));
3065 public void onSaveUrl(@NonNull String originalUrlString, @NonNull String fileNameString, @NonNull DialogFragment dialogFragment) {
3066 // Store the URL. This will be used in the save URL activity result launcher.
3067 if (originalUrlString.startsWith("data:")) {
3068 // Save the original URL.
3069 saveUrlString = originalUrlString;
3072 Dialog dialog = dialogFragment.getDialog();
3074 // Remove the incorrect lint warning below that the dialog might be null.
3075 assert dialog != null;
3077 // Get a handle for the dialog URL edit text.
3078 EditText dialogUrlEditText = dialog.findViewById(R.id.url_edittext);
3080 // Get the URL from the edit text, which may have been modified.
3081 saveUrlString = dialogUrlEditText.getText().toString();
3084 // Open the file picker.
3085 saveUrlActivityResultLauncher.launch(fileNameString);
3088 // Remove the warning that `OnTouchListener()` needs to override `performClick()`, as the only purpose of setting the `OnTouchListener()` is to make it do nothing.
3089 @SuppressLint("ClickableViewAccessibility")
3090 private void initializeApp() {
3091 // Get a handle for the input method.
3092 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
3094 // Remove the lint warning below that the input method manager might be null.
3095 assert inputMethodManager != null;
3097 // Initialize the gray foreground color spans for highlighting the URLs.
3098 initialGrayColorSpan = new ForegroundColorSpan(getColor(R.color.gray_500));
3099 finalGrayColorSpan = new ForegroundColorSpan(getColor(R.color.gray_500));
3101 // Get the current theme status.
3102 int currentThemeStatus = getResources().getConfiguration().uiMode & Configuration.UI_MODE_NIGHT_MASK;
3104 // Set the red color span according to the theme.
3105 if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) {
3106 redColorSpan = new ForegroundColorSpan(getColor(R.color.red_a700));
3108 redColorSpan = new ForegroundColorSpan(getColor(R.color.red_900));
3111 // Remove the formatting from the URL edit text when the user is editing the text.
3112 urlEditText.setOnFocusChangeListener((View v, boolean hasFocus) -> {
3113 if (hasFocus) { // The user is editing the URL text box.
3114 // Remove the highlighting.
3115 urlEditText.getText().removeSpan(redColorSpan);
3116 urlEditText.getText().removeSpan(initialGrayColorSpan);
3117 urlEditText.getText().removeSpan(finalGrayColorSpan);
3118 } else { // The user has stopped editing the URL text box.
3119 // Move to the beginning of the string.
3120 urlEditText.setSelection(0);
3122 // Reapply the highlighting.
3127 // Set the go button on the keyboard to load the URL in `urlTextBox`.
3128 urlEditText.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
3129 // If the event is a key-down event on the `enter` button, load the URL.
3130 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
3131 // Load the URL into the mainWebView and consume the event.
3132 loadUrlFromTextBox();
3134 // If the enter key was pressed, consume the event.
3137 // If any other key was pressed, do not consume the event.
3142 // Create an Orbot status broadcast receiver.
3143 orbotStatusBroadcastReceiver = new BroadcastReceiver() {
3145 public void onReceive(Context context, Intent intent) {
3146 // Store the content of the status message in `orbotStatus`.
3147 orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS");
3149 // If Privacy Browser is waiting on the proxy, load the website now that Orbot is connected.
3150 if ((orbotStatus != null) && orbotStatus.equals(ProxyHelper.ORBOT_STATUS_ON) && waitingForProxy) {
3151 // Reset the waiting for proxy status.
3152 waitingForProxy = false;
3154 // Get a list of the current fragments.
3155 List<Fragment> fragmentList = getSupportFragmentManager().getFragments();
3157 // Check each fragment to see if it is a waiting for proxy dialog. Sometimes more than one is displayed.
3158 for (int i = 0; i < fragmentList.size(); i++) {
3159 // Get the fragment tag.
3160 String fragmentTag = fragmentList.get(i).getTag();
3162 // Check to see if it is the waiting for proxy dialog.
3163 if ((fragmentTag!= null) && fragmentTag.equals(getString(R.string.waiting_for_proxy_dialog))) {
3164 // Dismiss the waiting for proxy dialog.
3165 ((DialogFragment) fragmentList.get(i)).dismiss();
3169 // Reload existing URLs and load any URLs that are waiting for the proxy.
3170 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
3171 // Get the WebView tab fragment.
3172 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
3174 // Get the fragment view.
3175 View fragmentView = webViewTabFragment.getView();
3177 // Only process the WebViews if they exist.
3178 if (fragmentView != null) {
3179 // Get the nested scroll WebView from the tab fragment.
3180 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
3182 // Get the waiting for proxy URL string.
3183 String waitingForProxyUrlString = nestedScrollWebView.getWaitingForProxyUrlString();
3185 // Load the pending URL if it exists.
3186 if (!waitingForProxyUrlString.isEmpty()) { // A URL is waiting to be loaded.
3188 loadUrl(nestedScrollWebView, waitingForProxyUrlString);
3190 // Reset the waiting for proxy URL string.
3191 nestedScrollWebView.setWaitingForProxyUrlString("");
3192 } else { // No URL is waiting to be loaded.
3193 // Reload the existing URL.
3194 nestedScrollWebView.reload();
3202 // Register the Orbot status broadcast receiver on `this` context.
3203 this.registerReceiver(orbotStatusBroadcastReceiver, new IntentFilter("org.torproject.android.intent.action.STATUS"));
3205 // Get handles for views that need to be modified.
3206 LinearLayout bookmarksHeaderLinearLayout = findViewById(R.id.bookmarks_header_linearlayout);
3207 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
3208 FloatingActionButton launchBookmarksActivityFab = findViewById(R.id.launch_bookmarks_activity_fab);
3209 FloatingActionButton createBookmarkFolderFab = findViewById(R.id.create_bookmark_folder_fab);
3210 FloatingActionButton createBookmarkFab = findViewById(R.id.create_bookmark_fab);
3211 EditText findOnPageEditText = findViewById(R.id.find_on_page_edittext);
3213 // Update the web view pager every time a tab is modified.
3214 webViewPager.addOnPageChangeListener(new ViewPager.OnPageChangeListener() {
3216 public void onPageScrolled(int position, float positionOffset, int positionOffsetPixels) {
3221 public void onPageSelected(int position) {
3222 // Close the find on page bar if it is open.
3223 closeFindOnPage(null);
3225 // Set the current WebView.
3226 setCurrentWebView(position);
3228 // Select the corresponding tab if it does not match the currently selected page. This will happen if the page was scrolled by creating a new tab.
3229 if (tabLayout.getSelectedTabPosition() != position) {
3230 // Wait until the new tab has been created.
3231 tabLayout.post(() -> {
3232 // Get a handle for the tab.
3233 TabLayout.Tab tab = tabLayout.getTabAt(position);
3235 // Assert that the tab is not null.
3245 public void onPageScrollStateChanged(int state) {
3250 // Display the View SSL Certificate dialog when the currently selected tab is reselected.
3251 tabLayout.addOnTabSelectedListener(new TabLayout.OnTabSelectedListener() {
3253 public void onTabSelected(TabLayout.Tab tab) {
3254 // Select the same page in the view pager.
3255 webViewPager.setCurrentItem(tab.getPosition());
3259 public void onTabUnselected(TabLayout.Tab tab) {
3264 public void onTabReselected(TabLayout.Tab tab) {
3265 // Instantiate the View SSL Certificate dialog.
3266 DialogFragment viewSslCertificateDialogFragment = ViewSslCertificateDialog.displayDialog(currentWebView.getWebViewFragmentId(), currentWebView.getFavoriteOrDefaultIcon());
3268 // Display the View SSL Certificate dialog.
3269 viewSslCertificateDialogFragment.show(getSupportFragmentManager(), getString(R.string.view_ssl_certificate));
3273 // Set a touch listener on the bookmarks header linear layout so that touches don't pass through to the button underneath.
3274 bookmarksHeaderLinearLayout.setOnTouchListener((view, motionEvent) -> {
3275 // Consume the touch.
3279 // Set the launch bookmarks activity FAB to launch the bookmarks activity.
3280 launchBookmarksActivityFab.setOnClickListener(v -> {
3281 // Get a copy of the favorite icon bitmap.
3282 Bitmap favoriteIconBitmap = currentWebView.getFavoriteOrDefaultIcon();
3284 // Create a favorite icon byte array output stream.
3285 ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
3287 // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
3288 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
3290 // Convert the favorite icon byte array stream to a byte array.
3291 byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
3293 // Create an intent to launch the bookmarks activity.
3294 Intent bookmarksIntent = new Intent(getApplicationContext(), BookmarksActivity.class);
3296 // Add the extra information to the intent.
3297 bookmarksIntent.putExtra("current_url", currentWebView.getUrl());
3298 bookmarksIntent.putExtra("current_title", currentWebView.getTitle());
3299 bookmarksIntent.putExtra("current_folder", currentBookmarksFolder);
3300 bookmarksIntent.putExtra("favorite_icon_byte_array", favoriteIconByteArray);
3303 startActivity(bookmarksIntent);
3306 // Set the create new bookmark folder FAB to display an alert dialog.
3307 createBookmarkFolderFab.setOnClickListener(v -> {
3308 // Create a create bookmark folder dialog.
3309 DialogFragment createBookmarkFolderDialog = CreateBookmarkFolderDialog.createBookmarkFolder(currentWebView.getFavoriteOrDefaultIcon());
3311 // Show the create bookmark folder dialog.
3312 createBookmarkFolderDialog.show(getSupportFragmentManager(), getString(R.string.create_folder));
3315 // Set the create new bookmark FAB to display an alert dialog.
3316 createBookmarkFab.setOnClickListener(view -> {
3317 // Instantiate the create bookmark dialog.
3318 DialogFragment createBookmarkDialog = CreateBookmarkDialog.createBookmark(currentWebView.getUrl(), currentWebView.getTitle(), currentWebView.getFavoriteOrDefaultIcon());
3320 // Display the create bookmark dialog.
3321 createBookmarkDialog.show(getSupportFragmentManager(), getString(R.string.create_bookmark));
3324 // Search for the string on the page whenever a character changes in the `findOnPageEditText`.
3325 findOnPageEditText.addTextChangedListener(new TextWatcher() {
3327 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
3332 public void onTextChanged(CharSequence s, int start, int before, int count) {
3337 public void afterTextChanged(Editable s) {
3338 // Search for the text in the WebView if it is not null. Sometimes on resume after a period of non-use the WebView will be null.
3339 if (currentWebView != null) {
3340 currentWebView.findAllAsync(findOnPageEditText.getText().toString());
3345 // Set the `check mark` button for the `findOnPageEditText` keyboard to close the soft keyboard.
3346 findOnPageEditText.setOnKeyListener((v, keyCode, event) -> {
3347 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) { // The `enter` key was pressed.
3348 // Hide the soft keyboard.
3349 inputMethodManager.hideSoftInputFromWindow(currentWebView.getWindowToken(), 0);
3351 // Consume the event.
3353 } else { // A different key was pressed.
3354 // Do not consume the event.
3359 // Implement swipe to refresh.
3360 swipeRefreshLayout.setOnRefreshListener(() -> {
3361 // Reload the website.
3362 currentWebView.reload();
3365 // Store the default progress view offsets for use later in `initializeWebView()`.
3366 defaultProgressViewStartOffset = swipeRefreshLayout.getProgressViewStartOffset();
3367 defaultProgressViewEndOffset = swipeRefreshLayout.getProgressViewEndOffset();
3369 // Set the refresh color scheme according to the theme.
3370 swipeRefreshLayout.setColorSchemeResources(R.color.blue_text);
3372 // Initialize a color background typed value.
3373 TypedValue colorBackgroundTypedValue = new TypedValue();
3375 // Get the color background from the theme.
3376 getTheme().resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true);
3378 // Get the color background int from the typed value.
3379 int colorBackgroundInt = colorBackgroundTypedValue.data;
3381 // Set the swipe refresh background color.
3382 swipeRefreshLayout.setProgressBackgroundColorSchemeColor(colorBackgroundInt);
3384 // The drawer titles identify the drawer layouts in accessibility mode.
3385 drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer));
3386 drawerLayout.setDrawerTitle(GravityCompat.END, getString(R.string.bookmarks));
3388 // Initialize the bookmarks database helper.
3389 bookmarksDatabaseHelper = new BookmarksDatabaseHelper(this);
3391 // Initialize `currentBookmarksFolder`. `""` is the home folder in the database.
3392 currentBookmarksFolder = "";
3394 // Load the home folder, which is `""` in the database.
3395 loadBookmarksFolder();
3397 bookmarksListView.setOnItemClickListener((parent, view, position, id) -> {
3398 // Convert the id from long to int to match the format of the bookmarks database.
3399 int databaseId = (int) id;
3401 // Get the bookmark cursor for this ID.
3402 Cursor bookmarkCursor = bookmarksDatabaseHelper.getBookmark(databaseId);
3404 // Move the bookmark cursor to the first row.
3405 bookmarkCursor.moveToFirst();
3407 // Act upon the bookmark according to the type.
3408 if (bookmarkCursor.getInt(bookmarkCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.IS_FOLDER)) == 1) { // The selected bookmark is a folder.
3409 // Store the new folder name in `currentBookmarksFolder`.
3410 currentBookmarksFolder = bookmarkCursor.getString(bookmarkCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_NAME));
3412 // Load the new folder.
3413 loadBookmarksFolder();
3414 } else { // The selected bookmark is not a folder.
3415 // Load the bookmark URL.
3416 loadUrl(currentWebView, bookmarkCursor.getString(bookmarkCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_URL)));
3418 // Close the bookmarks drawer.
3419 drawerLayout.closeDrawer(GravityCompat.END);
3422 // Close the `Cursor`.
3423 bookmarkCursor.close();
3426 bookmarksListView.setOnItemLongClickListener((parent, view, position, id) -> {
3427 // Convert the database ID from `long` to `int`.
3428 int databaseId = (int) id;
3430 // Find out if the selected bookmark is a folder.
3431 boolean isFolder = bookmarksDatabaseHelper.isFolder(databaseId);
3433 // Check to see if the bookmark is a folder.
3434 if (isFolder) { // The bookmark is a folder.
3435 // Save the current folder name, which is used in `onSaveEditBookmarkFolder()`.
3436 oldFolderNameString = bookmarksCursor.getString(bookmarksCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_NAME));
3438 // Instantiate the edit folder bookmark dialog.
3439 DialogFragment editBookmarkFolderDialog = EditBookmarkFolderDialog.folderDatabaseId(databaseId, currentWebView.getFavoriteOrDefaultIcon());
3441 // Show the edit folder bookmark dialog.
3442 editBookmarkFolderDialog.show(getSupportFragmentManager(), getString(R.string.edit_folder));
3443 } else { // The bookmark is not a folder.
3444 // Get the bookmark cursor for this ID.
3445 Cursor bookmarkCursor = bookmarksDatabaseHelper.getBookmark(databaseId);
3447 // Move the bookmark cursor to the first row.
3448 bookmarkCursor.moveToFirst();
3450 // Load the bookmark in a new tab but do not switch to the tab or close the drawer.
3451 addNewTab(bookmarkCursor.getString(bookmarkCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_URL)), false);
3453 // Display a snackbar.
3454 Snackbar.make(currentWebView, R.string.bookmark_opened_in_background, Snackbar.LENGTH_SHORT).show();
3457 // Consume the event.
3461 // The drawer listener is used to update the navigation menu.
3462 drawerLayout.addDrawerListener(new DrawerLayout.DrawerListener() {
3464 public void onDrawerSlide(@NonNull View drawerView, float slideOffset) {
3468 public void onDrawerOpened(@NonNull View drawerView) {
3472 public void onDrawerClosed(@NonNull View drawerView) {
3473 // Reset the drawer icon when the drawer is closed. Otherwise, it is an arrow if the drawer is open when the app is restarted.
3474 actionBarDrawerToggle.syncState();
3478 public void onDrawerStateChanged(int newState) {
3479 if ((newState == DrawerLayout.STATE_SETTLING) || (newState == DrawerLayout.STATE_DRAGGING)) { // A drawer is opening or closing.
3480 // Update the navigation menu items if the WebView is not null.
3481 if (currentWebView != null) {
3482 navigationBackMenuItem.setEnabled(currentWebView.canGoBack());
3483 navigationForwardMenuItem.setEnabled(currentWebView.canGoForward());
3484 navigationHistoryMenuItem.setEnabled((currentWebView.canGoBack() || currentWebView.canGoForward()));
3485 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + currentWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
3487 // Hide the keyboard (if displayed).
3488 inputMethodManager.hideSoftInputFromWindow(currentWebView.getWindowToken(), 0);
3491 // Clear the focus from from the URL text box. This removes any text selection markers and context menus, which otherwise draw above the open drawers.
3492 urlEditText.clearFocus();
3494 // Clear the focus from from the WebView if it is not null, which can happen if a user opens a drawer while the browser is being resumed.
3495 if (currentWebView != null) {
3496 // Clearing the focus from the WebView removes any text selection markers and context menus, which otherwise draw above the open drawers.
3497 currentWebView.clearFocus();
3503 // Replace the header that `WebView` creates for `X-Requested-With` with a null value. The default value is the application ID (com.stoutner.privacybrowser.standard).
3504 customHeaders.put("X-Requested-With", "");
3506 // Inflate a bare WebView to get the default user agent. It is not used to render content on the screen.
3507 @SuppressLint("InflateParams") View webViewLayout = getLayoutInflater().inflate(R.layout.bare_webview, null, false);
3509 // Get a handle for the WebView.
3510 WebView bareWebView = webViewLayout.findViewById(R.id.bare_webview);
3512 // Store the default user agent.
3513 webViewDefaultUserAgent = bareWebView.getSettings().getUserAgentString();
3515 // Destroy the bare WebView.
3516 bareWebView.destroy();
3519 private void applyAppSettings() {
3520 // Get a handle for the shared preferences.
3521 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3523 // Store the values from the shared preferences in variables.
3524 incognitoModeEnabled = sharedPreferences.getBoolean("incognito_mode", false);
3525 sanitizeGoogleAnalytics = sharedPreferences.getBoolean("google_analytics", true);
3526 sanitizeFacebookClickIds = sharedPreferences.getBoolean("facebook_click_ids", true);
3527 sanitizeTwitterAmpRedirects = sharedPreferences.getBoolean("twitter_amp_redirects", true);
3528 proxyMode = sharedPreferences.getString("proxy", getString(R.string.proxy_default_value));
3529 fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean("full_screen_browsing_mode", false);
3530 downloadWithExternalApp = sharedPreferences.getBoolean(getString(R.string.download_with_external_app_key), false);
3531 hideAppBar = sharedPreferences.getBoolean("hide_app_bar", true);
3532 scrollAppBar = sharedPreferences.getBoolean(getString(R.string.scroll_app_bar_key), true);
3534 // Apply the saved proxy mode if the app has been restarted.
3535 if (savedProxyMode != null) {
3536 // Apply the saved proxy mode.
3537 proxyMode = savedProxyMode;
3539 // Reset the saved proxy mode.
3540 savedProxyMode = null;
3543 // Get the search string.
3544 String searchString = sharedPreferences.getString("search", getString(R.string.search_default_value));
3546 // Set the search string.
3547 if (searchString.equals("Custom URL")) { // A custom search string is used.
3548 searchURL = sharedPreferences.getString("search_custom_url", getString(R.string.search_custom_url_default_value));
3549 } else { // A custom search string is not used.
3550 searchURL = searchString;
3556 // Adjust the layout and scrolling parameters if the app bar is at the top of the screen.
3557 if (!bottomAppBar) {
3558 // Get the current layout parameters. Using coordinator layout parameters allows the `setBehavior()` command and using app bar layout parameters allows the `setScrollFlags()` command.
3559 CoordinatorLayout.LayoutParams swipeRefreshLayoutParams = (CoordinatorLayout.LayoutParams) swipeRefreshLayout.getLayoutParams();
3560 AppBarLayout.LayoutParams toolbarLayoutParams = (AppBarLayout.LayoutParams) toolbar.getLayoutParams();
3561 AppBarLayout.LayoutParams findOnPageLayoutParams = (AppBarLayout.LayoutParams) findOnPageLinearLayout.getLayoutParams();
3562 AppBarLayout.LayoutParams tabsLayoutParams = (AppBarLayout.LayoutParams) tabsLinearLayout.getLayoutParams();
3564 // Add the scrolling behavior to the layout parameters.
3566 // Enable scrolling of the app bar.
3567 swipeRefreshLayoutParams.setBehavior(new AppBarLayout.ScrollingViewBehavior());
3568 toolbarLayoutParams.setScrollFlags(AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP);
3569 findOnPageLayoutParams.setScrollFlags(AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP);
3570 tabsLayoutParams.setScrollFlags(AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP);
3572 // Disable scrolling of the app bar.
3573 swipeRefreshLayoutParams.setBehavior(null);
3574 toolbarLayoutParams.setScrollFlags(0);
3575 findOnPageLayoutParams.setScrollFlags(0);
3576 tabsLayoutParams.setScrollFlags(0);
3578 // Expand the app bar if it is currently collapsed.
3579 appBarLayout.setExpanded(true);
3582 // Set the app bar scrolling for each WebView.
3583 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
3584 // Get the WebView tab fragment.
3585 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
3587 // Get the fragment view.
3588 View fragmentView = webViewTabFragment.getView();
3590 // Only modify the WebViews if they exist.
3591 if (fragmentView != null) {
3592 // Get the nested scroll WebView from the tab fragment.
3593 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
3595 // Set the app bar scrolling.
3596 nestedScrollWebView.setNestedScrollingEnabled(scrollAppBar);
3601 // Update the full screen browsing mode settings.
3602 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
3603 // Update the visibility of the app bar, which might have changed in the settings.
3605 // Hide the tab linear layout.
3606 tabsLinearLayout.setVisibility(View.GONE);
3608 // Hide the action bar.
3611 // Show the tab linear layout.
3612 tabsLinearLayout.setVisibility(View.VISIBLE);
3614 // Show the action bar.
3618 /* Hide the system bars.
3619 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
3620 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
3621 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
3622 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
3624 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
3625 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
3626 } else { // Privacy Browser is not in full screen browsing mode.
3627 // Reset the full screen tracker, which could be true if Privacy Browser was in full screen mode before entering settings and full screen browsing was disabled.
3628 inFullScreenBrowsingMode = false;
3630 // Show the tab linear layout.
3631 tabsLinearLayout.setVisibility(View.VISIBLE);
3633 // Show the action bar.
3636 // Remove the `SYSTEM_UI` flags from the root frame layout.
3637 rootFrameLayout.setSystemUiVisibility(0);
3642 public void navigateHistory(@NonNull String url, int steps) {
3643 // Apply the domain settings.
3644 applyDomainSettings(currentWebView, url, false, false, false);
3646 // Load the history entry.
3647 currentWebView.goBackOrForward(steps);
3651 public void pinnedErrorGoBack() {
3652 // Get the current web back forward list.
3653 WebBackForwardList webBackForwardList = currentWebView.copyBackForwardList();
3655 // Get the previous entry URL.
3656 String previousUrl = webBackForwardList.getItemAtIndex(webBackForwardList.getCurrentIndex() - 1).getUrl();
3658 // Apply the domain settings.
3659 applyDomainSettings(currentWebView, previousUrl, false, false, false);
3662 currentWebView.goBack();
3665 // `reloadWebsite` is used if returning from the Domains activity. Otherwise JavaScript might not function correctly if it is newly enabled.
3666 @SuppressLint("SetJavaScriptEnabled")
3667 private void applyDomainSettings(NestedScrollWebView nestedScrollWebView, String url, boolean resetTab, boolean reloadWebsite, boolean loadUrl) {
3668 // Store the current URL.
3669 nestedScrollWebView.setCurrentUrl(url);
3671 // Parse the URL into a URI.
3672 Uri uri = Uri.parse(url);
3674 // Extract the domain from `uri`.
3675 String newHostName = uri.getHost();
3677 // Strings don't like to be null.
3678 if (newHostName == null) {
3682 // Apply the domain settings if a new domain is being loaded or if the new domain is blank. This allows the user to set temporary settings for JavaScript, cookies, DOM storage, etc.
3683 if (!nestedScrollWebView.getCurrentDomainName().equals(newHostName) || newHostName.equals("")) {
3684 // Set the new host name as the current domain name.
3685 nestedScrollWebView.setCurrentDomainName(newHostName);
3687 // Reset the ignoring of pinned domain information.
3688 nestedScrollWebView.setIgnorePinnedDomainInformation(false);
3690 // Clear any pinned SSL certificate or IP addresses.
3691 nestedScrollWebView.clearPinnedSslCertificate();
3692 nestedScrollWebView.setPinnedIpAddresses("");
3694 // Reset the favorite icon if specified.
3696 // Initialize the favorite icon.
3697 nestedScrollWebView.initializeFavoriteIcon();
3699 // Get the current page position.
3700 int currentPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
3702 // Get the corresponding tab.
3703 TabLayout.Tab tab = tabLayout.getTabAt(currentPagePosition);
3705 // Update the tab if it isn't null, which sometimes happens when restarting from the background.
3707 // Get the tab custom view.
3708 View tabCustomView = tab.getCustomView();
3710 // Remove the warning below that the tab custom view might be null.
3711 assert tabCustomView != null;
3713 // Get the tab views.
3714 ImageView tabFavoriteIconImageView = tabCustomView.findViewById(R.id.favorite_icon_imageview);
3715 TextView tabTitleTextView = tabCustomView.findViewById(R.id.title_textview);
3717 // Set the default favorite icon as the favorite icon for this tab.
3718 tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(nestedScrollWebView.getFavoriteOrDefaultIcon(), 64, 64, true));
3720 // Set the loading title text.
3721 tabTitleTextView.setText(R.string.loading);
3725 // Initialize the database handler.
3726 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this);
3728 // Get a full cursor from `domainsDatabaseHelper`.
3729 Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain();
3731 // Initialize `domainSettingsSet`.
3732 Set<String> domainSettingsSet = new HashSet<>();
3734 // Get the domain name column index.
3735 int domainNameColumnIndex = domainNameCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.DOMAIN_NAME);
3737 // Populate the domain settings set.
3738 for (int i = 0; i < domainNameCursor.getCount(); i++) {
3739 // Move the domains cursor to the current row.
3740 domainNameCursor.moveToPosition(i);
3742 // Store the domain name in the domain settings set.
3743 domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex));
3746 // Close the domain name cursor.
3747 domainNameCursor.close();
3749 // Initialize the domain name in database variable.
3750 String domainNameInDatabase = null;
3752 // Check the hostname against the domain settings set.
3753 if (domainSettingsSet.contains(newHostName)) { // The hostname is contained in the domain settings set.
3754 // Record the domain name in the database.
3755 domainNameInDatabase = newHostName;
3757 // Set the domain settings applied tracker to true.
3758 nestedScrollWebView.setDomainSettingsApplied(true);
3759 } else { // The hostname is not contained in the domain settings set.
3760 // Set the domain settings applied tracker to false.
3761 nestedScrollWebView.setDomainSettingsApplied(false);
3764 // Check all the subdomains of the host name against wildcard domains in the domain cursor.
3765 while (!nestedScrollWebView.getDomainSettingsApplied() && newHostName.contains(".")) { // Stop checking if domain settings are already applied or there are no more `.` in the hostname.
3766 if (domainSettingsSet.contains("*." + newHostName)) { // Check the host name prepended by `*.`.
3767 // Set the domain settings applied tracker to true.
3768 nestedScrollWebView.setDomainSettingsApplied(true);
3770 // Store the applied domain names as it appears in the database.
3771 domainNameInDatabase = "*." + newHostName;
3774 // Strip out the lowest subdomain of of the host name.
3775 newHostName = newHostName.substring(newHostName.indexOf(".") + 1);
3779 // Get a handle for the shared preferences.
3780 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3782 // Store the general preference information.
3783 String defaultFontSizeString = sharedPreferences.getString("font_size", getString(R.string.font_size_default_value));
3784 String defaultUserAgentName = sharedPreferences.getString("user_agent", getString(R.string.user_agent_default_value));
3785 boolean defaultSwipeToRefresh = sharedPreferences.getBoolean("swipe_to_refresh", true);
3786 String webViewTheme = sharedPreferences.getString("webview_theme", getString(R.string.webview_theme_default_value));
3787 boolean wideViewport = sharedPreferences.getBoolean("wide_viewport", true);
3788 boolean displayWebpageImages = sharedPreferences.getBoolean("display_webpage_images", true);
3790 // Get the WebView theme entry values string array.
3791 String[] webViewThemeEntryValuesStringArray = getResources().getStringArray(R.array.webview_theme_entry_values);
3793 // Get a handle for the cookie manager.
3794 CookieManager cookieManager = CookieManager.getInstance();
3796 // Initialize the user agent array adapter and string array.
3797 ArrayAdapter<CharSequence> userAgentNamesArray = ArrayAdapter.createFromResource(this, R.array.user_agent_names, R.layout.spinner_item);
3798 String[] userAgentDataArray = getResources().getStringArray(R.array.user_agent_data);
3800 if (nestedScrollWebView.getDomainSettingsApplied()) { // The url has custom domain settings.
3801 // Remove the incorrect lint warning below that the domain name in database might be null.
3802 assert domainNameInDatabase != null;
3804 // Get a cursor for the current host.
3805 Cursor currentDomainSettingsCursor = domainsDatabaseHelper.getCursorForDomainName(domainNameInDatabase);
3807 // Move to the first position.
3808 currentDomainSettingsCursor.moveToFirst();
3810 // Get the settings from the cursor.
3811 nestedScrollWebView.setDomainSettingsDatabaseId(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ID)));
3812 nestedScrollWebView.getSettings().setJavaScriptEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1);
3813 nestedScrollWebView.setAcceptCookies(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.COOKIES)) == 1);
3814 nestedScrollWebView.getSettings().setDomStorageEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1);
3815 // Form data can be removed once the minimum API >= 26.
3816 boolean saveFormData = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1);
3817 nestedScrollWebView.setEasyListEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_EASYLIST)) == 1);
3818 nestedScrollWebView.setEasyPrivacyEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_EASYPRIVACY)) == 1);
3819 nestedScrollWebView.setFanboysAnnoyanceListEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_FANBOYS_ANNOYANCE_LIST)) == 1);
3820 nestedScrollWebView.setFanboysSocialBlockingListEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(
3821 DomainsDatabaseHelper.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST)) == 1);
3822 nestedScrollWebView.setUltraListEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ULTRALIST)) == 1);
3823 nestedScrollWebView.setUltraPrivacyEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_ULTRAPRIVACY)) == 1);
3824 nestedScrollWebView.setBlockAllThirdPartyRequests(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.BLOCK_ALL_THIRD_PARTY_REQUESTS)) == 1);
3825 String userAgentName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.USER_AGENT));
3826 int fontSize = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.FONT_SIZE));
3827 int swipeToRefreshInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SWIPE_TO_REFRESH));
3828 int webViewThemeInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.WEBVIEW_THEME));
3829 int wideViewportInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.WIDE_VIEWPORT));
3830 int displayWebpageImagesInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.DISPLAY_IMAGES));
3831 boolean pinnedSslCertificate = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.PINNED_SSL_CERTIFICATE)) == 1);
3832 String pinnedSslIssuedToCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_TO_COMMON_NAME));
3833 String pinnedSslIssuedToOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATION));
3834 String pinnedSslIssuedToUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT));
3835 String pinnedSslIssuedByCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_BY_COMMON_NAME));
3836 String pinnedSslIssuedByOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATION));
3837 String pinnedSslIssuedByUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT));
3838 Date pinnedSslStartDate = new Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_START_DATE)));
3839 Date pinnedSslEndDate = new Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_END_DATE)));
3840 boolean pinnedIpAddresses = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.PINNED_IP_ADDRESSES)) == 1);
3841 String pinnedHostIpAddresses = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.IP_ADDRESSES));
3843 // Close the current host domain settings cursor.
3844 currentDomainSettingsCursor.close();
3846 // If there is a pinned SSL certificate, store it in the WebView.
3847 if (pinnedSslCertificate) {
3848 nestedScrollWebView.setPinnedSslCertificate(pinnedSslIssuedToCName, pinnedSslIssuedToOName, pinnedSslIssuedToUName, pinnedSslIssuedByCName, pinnedSslIssuedByOName, pinnedSslIssuedByUName,
3849 pinnedSslStartDate, pinnedSslEndDate);
3852 // If there is a pinned IP address, store it in the WebView.
3853 if (pinnedIpAddresses) {
3854 nestedScrollWebView.setPinnedIpAddresses(pinnedHostIpAddresses);
3857 // Apply the cookie domain settings.
3858 cookieManager.setAcceptCookie(nestedScrollWebView.getAcceptCookies());
3860 // Apply the form data setting if the API < 26.
3861 if (Build.VERSION.SDK_INT < 26) {
3862 nestedScrollWebView.getSettings().setSaveFormData(saveFormData);
3865 // Apply the font size.
3866 try { // Try the specified font size to see if it is valid.
3867 if (fontSize == 0) { // Apply the default font size.
3868 // Try to set the font size from the value in the app settings.
3869 nestedScrollWebView.getSettings().setTextZoom(Integer.parseInt(defaultFontSizeString));
3870 } else { // Apply the font size from domain settings.
3871 nestedScrollWebView.getSettings().setTextZoom(fontSize);
3873 } catch (Exception exception) { // The specified font size is invalid
3874 // Set the font size to be 100%
3875 nestedScrollWebView.getSettings().setTextZoom(100);
3878 // Set the user agent.
3879 if (userAgentName.equals(getString(R.string.system_default_user_agent))) { // Use the system default user agent.
3880 // Get the array position of the default user agent name.
3881 int defaultUserAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3883 // Set the user agent according to the system default.
3884 switch (defaultUserAgentArrayPosition) {
3885 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
3886 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3887 nestedScrollWebView.getSettings().setUserAgentString(defaultUserAgentName);
3890 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3891 // Set the user agent to `""`, which uses the default value.
3892 nestedScrollWebView.getSettings().setUserAgentString("");
3895 case SETTINGS_CUSTOM_USER_AGENT:
3896 // Set the default custom user agent.
3897 nestedScrollWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", getString(R.string.custom_user_agent_default_value)));
3901 // Get the user agent string from the user agent data array
3902 nestedScrollWebView.getSettings().setUserAgentString(userAgentDataArray[defaultUserAgentArrayPosition]);
3904 } else { // Set the user agent according to the stored name.
3905 // Get the array position of the user agent name.
3906 int userAgentArrayPosition = userAgentNamesArray.getPosition(userAgentName);
3908 switch (userAgentArrayPosition) {
3909 case UNRECOGNIZED_USER_AGENT: // The user agent name contains a custom user agent.
3910 nestedScrollWebView.getSettings().setUserAgentString(userAgentName);
3913 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3914 // Set the user agent to `""`, which uses the default value.
3915 nestedScrollWebView.getSettings().setUserAgentString("");
3919 // Get the user agent string from the user agent data array.
3920 nestedScrollWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3924 // Set swipe to refresh.
3925 switch (swipeToRefreshInt) {
3926 case DomainsDatabaseHelper.SYSTEM_DEFAULT:
3927 // Store the swipe to refresh status in the nested scroll WebView.
3928 nestedScrollWebView.setSwipeToRefresh(defaultSwipeToRefresh);
3930 // Update the swipe refresh layout.
3931 if (defaultSwipeToRefresh) { // Swipe to refresh is enabled.
3932 // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
3933 swipeRefreshLayout.setEnabled(currentWebView.getScrollY() == 0);
3934 } else { // Swipe to refresh is disabled.
3935 // Disable the swipe refresh layout.
3936 swipeRefreshLayout.setEnabled(false);
3940 case DomainsDatabaseHelper.ENABLED:
3941 // Store the swipe to refresh status in the nested scroll WebView.
3942 nestedScrollWebView.setSwipeToRefresh(true);
3944 // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
3945 swipeRefreshLayout.setEnabled(currentWebView.getScrollY() == 0);
3948 case DomainsDatabaseHelper.DISABLED:
3949 // Store the swipe to refresh status in the nested scroll WebView.
3950 nestedScrollWebView.setSwipeToRefresh(false);
3952 // Disable swipe to refresh.
3953 swipeRefreshLayout.setEnabled(false);
3956 // Check to see if WebView themes are supported.
3957 if (WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) {
3958 // Set the WebView theme.
3959 switch (webViewThemeInt) {
3960 case DomainsDatabaseHelper.SYSTEM_DEFAULT:
3961 // Set the WebView theme. A switch statement cannot be used because the WebView theme entry values string array is not a compile time constant.
3962 if (webViewTheme.equals(webViewThemeEntryValuesStringArray[1])) { // The light theme is selected.
3963 // Turn off the WebView dark mode.
3964 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_OFF);
3965 } else if (webViewTheme.equals(webViewThemeEntryValuesStringArray[2])) { // The dark theme is selected.
3966 // Turn on the WebView dark mode.
3967 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_ON);
3968 } else { // The system default theme is selected.
3969 // Get the current system theme status.
3970 int currentThemeStatus = getResources().getConfiguration().uiMode & Configuration.UI_MODE_NIGHT_MASK;
3972 // Set the WebView theme according to the current system theme status.
3973 if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) { // The system is in day mode.
3974 // Turn off the WebView dark mode.
3975 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_OFF);
3976 } else { // The system is in night mode.
3977 // Turn on the WebView dark mode.
3978 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_ON);
3983 case DomainsDatabaseHelper.LIGHT_THEME:
3984 // Turn off the WebView dark mode.
3985 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_OFF);
3988 case DomainsDatabaseHelper.DARK_THEME:
3989 // Turn on the WebView dark mode.
3990 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_ON);
3995 // Set the viewport.
3996 switch (wideViewportInt) {
3997 case DomainsDatabaseHelper.SYSTEM_DEFAULT:
3998 nestedScrollWebView.getSettings().setUseWideViewPort(wideViewport);
4001 case DomainsDatabaseHelper.ENABLED:
4002 nestedScrollWebView.getSettings().setUseWideViewPort(true);
4005 case DomainsDatabaseHelper.DISABLED:
4006 nestedScrollWebView.getSettings().setUseWideViewPort(false);
4010 // Set the loading of webpage images.
4011 switch (displayWebpageImagesInt) {
4012 case DomainsDatabaseHelper.SYSTEM_DEFAULT:
4013 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImages);
4016 case DomainsDatabaseHelper.ENABLED:
4017 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(true);
4020 case DomainsDatabaseHelper.DISABLED:
4021 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(false);
4025 // Set a background on the URL relative layout to indicate that custom domain settings are being used.
4026 urlRelativeLayout.setBackground(ResourcesCompat.getDrawable(getResources(), R.drawable.domain_settings_url_background, null));
4027 } else { // The new URL does not have custom domain settings. Load the defaults.
4028 // Store the values from the shared preferences.
4029 nestedScrollWebView.getSettings().setJavaScriptEnabled(sharedPreferences.getBoolean("javascript", false));
4030 nestedScrollWebView.setAcceptCookies(sharedPreferences.getBoolean(getString(R.string.cookies_key), false));
4031 nestedScrollWebView.getSettings().setDomStorageEnabled(sharedPreferences.getBoolean("dom_storage", false));
4032 boolean saveFormData = sharedPreferences.getBoolean("save_form_data", false); // Form data can be removed once the minimum API >= 26.
4033 nestedScrollWebView.setEasyListEnabled(sharedPreferences.getBoolean("easylist", true));
4034 nestedScrollWebView.setEasyPrivacyEnabled(sharedPreferences.getBoolean("easyprivacy", true));
4035 nestedScrollWebView.setFanboysAnnoyanceListEnabled(sharedPreferences.getBoolean("fanboys_annoyance_list", true));
4036 nestedScrollWebView.setFanboysSocialBlockingListEnabled(sharedPreferences.getBoolean("fanboys_social_blocking_list", true));
4037 nestedScrollWebView.setUltraListEnabled(sharedPreferences.getBoolean("ultralist", true));
4038 nestedScrollWebView.setUltraPrivacyEnabled(sharedPreferences.getBoolean("ultraprivacy", true));
4039 nestedScrollWebView.setBlockAllThirdPartyRequests(sharedPreferences.getBoolean("block_all_third_party_requests", false));
4041 // Apply the default cookie setting.
4042 cookieManager.setAcceptCookie(nestedScrollWebView.getAcceptCookies());
4044 // Apply the default font size setting.
4046 // Try to set the font size from the value in the app settings.
4047 nestedScrollWebView.getSettings().setTextZoom(Integer.parseInt(defaultFontSizeString));
4048 } catch (Exception exception) {
4049 // If the app settings value is invalid, set the font size to 100%.
4050 nestedScrollWebView.getSettings().setTextZoom(100);
4053 // Apply the form data setting if the API < 26.
4054 if (Build.VERSION.SDK_INT < 26) {
4055 nestedScrollWebView.getSettings().setSaveFormData(saveFormData);
4058 // Store the swipe to refresh status in the nested scroll WebView.
4059 nestedScrollWebView.setSwipeToRefresh(defaultSwipeToRefresh);
4061 // Update the swipe refresh layout.
4062 if (defaultSwipeToRefresh) { // Swipe to refresh is enabled.
4063 // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
4064 swipeRefreshLayout.setEnabled(currentWebView.getScrollY() == 0);
4065 } else { // Swipe to refresh is disabled.
4066 // Disable the swipe refresh layout.
4067 swipeRefreshLayout.setEnabled(false);
4070 // Reset the pinned variables.
4071 nestedScrollWebView.setDomainSettingsDatabaseId(-1);
4073 // Get the array position of the user agent name.
4074 int userAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
4076 // Set the user agent.
4077 switch (userAgentArrayPosition) {
4078 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
4079 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
4080 nestedScrollWebView.getSettings().setUserAgentString(defaultUserAgentName);
4083 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
4084 // Set the user agent to `""`, which uses the default value.
4085 nestedScrollWebView.getSettings().setUserAgentString("");
4088 case SETTINGS_CUSTOM_USER_AGENT:
4089 // Set the default custom user agent.
4090 nestedScrollWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", getString(R.string.custom_user_agent_default_value)));
4094 // Get the user agent string from the user agent data array
4095 nestedScrollWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
4098 // Apply the WebView theme if supported by the installed WebView.
4099 if (WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) {
4100 // Set the WebView theme. A switch statement cannot be used because the WebView theme entry values string array is not a compile time constant.
4101 if (webViewTheme.equals(webViewThemeEntryValuesStringArray[1])) { // The light theme is selected.
4102 // Turn off the WebView dark mode.
4103 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_OFF);
4104 } else if (webViewTheme.equals(webViewThemeEntryValuesStringArray[2])) { // The dark theme is selected.
4105 // Turn on the WebView dark mode.
4106 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_ON);
4107 } else { // The system default theme is selected.
4108 // Get the current system theme status.
4109 int currentThemeStatus = getResources().getConfiguration().uiMode & Configuration.UI_MODE_NIGHT_MASK;
4111 // Set the WebView theme according to the current system theme status.
4112 if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) { // The system is in day mode.
4113 // Turn off the WebView dark mode.
4114 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_OFF);
4115 } else { // The system is in night mode.
4116 // Turn on the WebView dark mode.
4117 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_ON);
4122 // Set the viewport.
4123 nestedScrollWebView.getSettings().setUseWideViewPort(wideViewport);
4125 // Set the loading of webpage images.
4126 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImages);
4128 // Set a transparent background on the URL relative layout.
4129 urlRelativeLayout.setBackground(ResourcesCompat.getDrawable(getResources(), R.color.transparent, null));
4132 // Close the domains database helper.
4133 domainsDatabaseHelper.close();
4135 // Update the privacy icons.
4136 updatePrivacyIcons(true);
4139 // Reload the website if returning from the Domains activity.
4140 if (reloadWebsite) {
4141 nestedScrollWebView.reload();
4144 // Load the URL if directed. This makes sure that the domain settings are properly loaded before the URL. By using `loadUrl()`, instead of `loadUrlFromBase()`, the Referer header will never be sent.
4146 nestedScrollWebView.loadUrl(url, customHeaders);
4150 private void applyProxy(boolean reloadWebViews) {
4151 // Set the proxy according to the mode.
4152 proxyHelper.setProxy(getApplicationContext(), appBarLayout, proxyMode);
4154 // Reset the waiting for proxy tracker.
4155 waitingForProxy = false;
4157 // Get the current theme status.
4158 int currentThemeStatus = getResources().getConfiguration().uiMode & Configuration.UI_MODE_NIGHT_MASK;
4160 // Update the user interface and reload the WebViews if requested.
4161 switch (proxyMode) {
4162 case ProxyHelper.NONE:
4163 // Initialize a color background typed value.
4164 TypedValue colorBackgroundTypedValue = new TypedValue();
4166 // Get the color background from the theme.
4167 getTheme().resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true);
4169 // Get the color background int from the typed value.
4170 int colorBackgroundInt = colorBackgroundTypedValue.data;
4172 // Set the default app bar layout background.
4173 appBarLayout.setBackgroundColor(colorBackgroundInt);
4176 case ProxyHelper.TOR:
4177 // Set the app bar background to indicate proxying through Orbot is enabled.
4178 if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) {
4179 appBarLayout.setBackgroundResource(R.color.blue_50);
4181 appBarLayout.setBackgroundResource(R.color.dark_blue_30);
4184 // Check to see if Orbot is installed.
4186 // Get the package manager.
4187 PackageManager packageManager = getPackageManager();
4189 // Check to see if Orbot is in the list. This will throw an error and drop to the catch section if it isn't installed.
4190 packageManager.getPackageInfo("org.torproject.android", 0);
4192 // Check to see if the proxy is ready.
4193 if (!orbotStatus.equals(ProxyHelper.ORBOT_STATUS_ON)) { // Orbot is not ready.
4194 // Set the waiting for proxy status.
4195 waitingForProxy = true;
4197 // Show the waiting for proxy dialog if it isn't already displayed.
4198 if (getSupportFragmentManager().findFragmentByTag(getString(R.string.waiting_for_proxy_dialog)) == null) {
4199 // Get a handle for the waiting for proxy alert dialog.
4200 DialogFragment waitingForProxyDialogFragment = new WaitingForProxyDialog();
4202 // Try to show the dialog. Sometimes the window is not yet active if returning from Settings.
4204 // Show the waiting for proxy alert dialog.
4205 waitingForProxyDialogFragment.show(getSupportFragmentManager(), getString(R.string.waiting_for_proxy_dialog));
4206 } catch (Exception waitingForTorException) {
4207 // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
4208 pendingDialogsArrayList.add(new PendingDialog(waitingForProxyDialogFragment, getString(R.string.waiting_for_proxy_dialog)));
4212 } catch (PackageManager.NameNotFoundException exception) { // Orbot is not installed.
4213 // Show the Orbot not installed dialog if it is not already displayed.
4214 if (getSupportFragmentManager().findFragmentByTag(getString(R.string.proxy_not_installed_dialog)) == null) {
4215 // Get a handle for the Orbot not installed alert dialog.
4216 DialogFragment orbotNotInstalledDialogFragment = ProxyNotInstalledDialog.displayDialog(proxyMode);
4218 // Try to show the dialog. Sometimes the window is not yet active if returning from Settings.
4220 // Display the Orbot not installed alert dialog.
4221 orbotNotInstalledDialogFragment.show(getSupportFragmentManager(), getString(R.string.proxy_not_installed_dialog));
4222 } catch (Exception orbotNotInstalledException) {
4223 // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
4224 pendingDialogsArrayList.add(new PendingDialog(orbotNotInstalledDialogFragment, getString(R.string.proxy_not_installed_dialog)));
4230 case ProxyHelper.I2P:
4231 // Set the app bar background to indicate proxying through Orbot is enabled.
4232 if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) {
4233 appBarLayout.setBackgroundResource(R.color.blue_50);
4235 appBarLayout.setBackgroundResource(R.color.dark_blue_30);
4238 // Check to see if I2P is installed.
4240 // Get the package manager.
4241 PackageManager packageManager = getPackageManager();
4243 // Check to see if I2P is in the list. This will throw an error and drop to the catch section if it isn't installed.
4244 packageManager.getPackageInfo("net.i2p.android.router", 0);
4245 } catch (PackageManager.NameNotFoundException exception) { // I2P is not installed.
4246 // Sow the I2P not installed dialog if it is not already displayed.
4247 if (getSupportFragmentManager().findFragmentByTag(getString(R.string.proxy_not_installed_dialog)) == null) {
4248 // Get a handle for the waiting for proxy alert dialog.
4249 DialogFragment i2pNotInstalledDialogFragment = ProxyNotInstalledDialog.displayDialog(proxyMode);
4251 // Try to show the dialog. Sometimes the window is not yet active if returning from Settings.
4253 // Display the I2P not installed alert dialog.
4254 i2pNotInstalledDialogFragment.show(getSupportFragmentManager(), getString(R.string.proxy_not_installed_dialog));
4255 } catch (Exception i2pNotInstalledException) {
4256 // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
4257 pendingDialogsArrayList.add(new PendingDialog(i2pNotInstalledDialogFragment, getString(R.string.proxy_not_installed_dialog)));
4263 case ProxyHelper.CUSTOM:
4264 // Set the app bar background to indicate proxying through Orbot is enabled.
4265 if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) {
4266 appBarLayout.setBackgroundResource(R.color.blue_50);
4268 appBarLayout.setBackgroundResource(R.color.dark_blue_30);
4273 // Reload the WebViews if requested and not waiting for the proxy.
4274 if (reloadWebViews && !waitingForProxy) {
4275 // Reload the WebViews.
4276 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
4277 // Get the WebView tab fragment.
4278 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
4280 // Get the fragment view.
4281 View fragmentView = webViewTabFragment.getView();
4283 // Only reload the WebViews if they exist.
4284 if (fragmentView != null) {
4285 // Get the nested scroll WebView from the tab fragment.
4286 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
4288 // Reload the WebView.
4289 nestedScrollWebView.reload();
4295 private void updatePrivacyIcons(boolean runInvalidateOptionsMenu) {
4296 // Only update the privacy icons if the options menu and the current WebView have already been populated.
4297 if ((optionsMenu != null) && (currentWebView != null)) {
4298 // Update the privacy icon.
4299 if (currentWebView.getSettings().getJavaScriptEnabled()) { // JavaScript is enabled.
4300 optionsPrivacyMenuItem.setIcon(R.drawable.javascript_enabled);
4301 } else if (currentWebView.getAcceptCookies()) { // JavaScript is disabled but cookies are enabled.
4302 optionsPrivacyMenuItem.setIcon(R.drawable.warning);
4303 } else { // All the dangerous features are disabled.
4304 optionsPrivacyMenuItem.setIcon(R.drawable.privacy_mode);
4307 // Update the cookies icon.
4308 if (currentWebView.getAcceptCookies()) {
4309 optionsCookiesMenuItem.setIcon(R.drawable.cookies_enabled);
4311 optionsCookiesMenuItem.setIcon(R.drawable.cookies_disabled);
4314 // Update the refresh icon.
4315 if (optionsRefreshMenuItem.getTitle() == getString(R.string.refresh)) { // The refresh icon is displayed.
4316 // Set the icon. Once the minimum API is >= 26, the blue and black icons can be combined with a tint list.
4317 optionsRefreshMenuItem.setIcon(R.drawable.refresh_enabled);
4318 } else { // The stop icon is displayed.
4319 // Set the icon. Once the minimum API is >= 26, the blue and black icons can be combined with a tint list.
4320 optionsRefreshMenuItem.setIcon(R.drawable.close_blue);
4323 // `invalidateOptionsMenu()` calls `onPrepareOptionsMenu()` and redraws the icons in the app bar.
4324 if (runInvalidateOptionsMenu) {
4325 invalidateOptionsMenu();
4330 private void highlightUrlText() {
4331 // Only highlight the URL text if the box is not currently selected.
4332 if (!urlEditText.hasFocus()) {
4333 // Get the URL string.
4334 String urlString = urlEditText.getText().toString();
4336 // Highlight the URL according to the protocol.
4337 if (urlString.startsWith("file://") || urlString.startsWith("content://")) { // This is a file or content URL.
4338 // De-emphasize everything before the file name.
4339 urlEditText.getText().setSpan(initialGrayColorSpan, 0, urlString.lastIndexOf("/") + 1,Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4340 } else { // This is a web URL.
4341 // Get the index of the `/` immediately after the domain name.
4342 int endOfDomainName = urlString.indexOf("/", (urlString.indexOf("//") + 2));
4344 // Create a base URL string.
4347 // Get the base URL.
4348 if (endOfDomainName > 0) { // There is at least one character after the base URL.
4349 // Get the base URL.
4350 baseUrl = urlString.substring(0, endOfDomainName);
4351 } else { // There are no characters after the base URL.
4352 // Set the base URL to be the entire URL string.
4353 baseUrl = urlString;
4356 // Get the index of the last `.` in the domain.
4357 int lastDotIndex = baseUrl.lastIndexOf(".");
4359 // Get the index of the penultimate `.` in the domain.
4360 int penultimateDotIndex = baseUrl.lastIndexOf(".", lastDotIndex - 1);
4362 // Markup the beginning of the URL.
4363 if (urlString.startsWith("http://")) { // Highlight the protocol of connections that are not encrypted.
4364 urlEditText.getText().setSpan(redColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4366 // De-emphasize subdomains.
4367 if (penultimateDotIndex > 0) { // There is more than one subdomain in the domain name.
4368 urlEditText.getText().setSpan(initialGrayColorSpan, 7, penultimateDotIndex + 1, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4370 } else if (urlString.startsWith("https://")) { // De-emphasize the protocol of connections that are encrypted.
4371 if (penultimateDotIndex > 0) { // There is more than one subdomain in the domain name.
4372 // De-emphasize the protocol and the additional subdomains.
4373 urlEditText.getText().setSpan(initialGrayColorSpan, 0, penultimateDotIndex + 1, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4374 } else { // There is only one subdomain in the domain name.
4375 // De-emphasize only the protocol.
4376 urlEditText.getText().setSpan(initialGrayColorSpan, 0, 8, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4380 // De-emphasize the text after the domain name.
4381 if (endOfDomainName > 0) {
4382 urlEditText.getText().setSpan(finalGrayColorSpan, endOfDomainName, urlString.length(), Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4388 private void loadBookmarksFolder() {
4389 // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
4390 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
4392 // Populate the bookmarks cursor adapter.
4393 bookmarksCursorAdapter = new CursorAdapter(this, bookmarksCursor, false) {
4395 public View newView(Context context, Cursor cursor, ViewGroup parent) {
4396 // Inflate the individual item layout.
4397 return getLayoutInflater().inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false);
4401 public void bindView(View view, Context context, Cursor cursor) {
4402 // Get handles for the views.
4403 ImageView bookmarkFavoriteIcon = view.findViewById(R.id.bookmark_favorite_icon);
4404 TextView bookmarkNameTextView = view.findViewById(R.id.bookmark_name);
4406 // Get the favorite icon byte array from the cursor.
4407 byte[] favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.FAVORITE_ICON));
4409 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
4410 Bitmap favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.length);
4412 // Display the bitmap in `bookmarkFavoriteIcon`.
4413 bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap);
4415 // Get the bookmark name from the cursor and display it in `bookmarkNameTextView`.
4416 String bookmarkNameString = cursor.getString(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_NAME));
4417 bookmarkNameTextView.setText(bookmarkNameString);
4419 // Make the font bold for folders.
4420 if (cursor.getInt(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {
4421 bookmarkNameTextView.setTypeface(Typeface.DEFAULT_BOLD);
4422 } else { // Reset the font to default for normal bookmarks.
4423 bookmarkNameTextView.setTypeface(Typeface.DEFAULT);
4428 // Get a handle for the bookmarks list view.
4429 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
4431 // Populate the list view with the adapter.
4432 bookmarksListView.setAdapter(bookmarksCursorAdapter);
4434 // Get a handle for the bookmarks title text view.
4435 TextView bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview);
4437 // Set the bookmarks drawer title.
4438 if (currentBookmarksFolder.isEmpty()) {
4439 bookmarksTitleTextView.setText(R.string.bookmarks);
4441 bookmarksTitleTextView.setText(currentBookmarksFolder);
4445 private void openWithApp(String url) {
4446 // Create an open with app intent with `ACTION_VIEW`.
4447 Intent openWithAppIntent = new Intent(Intent.ACTION_VIEW);
4449 // Set the URI but not the MIME type. This should open all available apps.
4450 openWithAppIntent.setData(Uri.parse(url));
4452 // Flag the intent to open in a new task.
4453 openWithAppIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4457 // Show the chooser.
4458 startActivity(openWithAppIntent);
4459 } catch (ActivityNotFoundException exception) { // There are no apps available to open the URL.
4460 // Show a snackbar with the error.
4461 Snackbar.make(currentWebView, getString(R.string.error) + " " + exception, Snackbar.LENGTH_INDEFINITE).show();
4465 private void openWithBrowser(String url) {
4466 // Create an open with browser intent with `ACTION_VIEW`.
4467 Intent openWithBrowserIntent = new Intent(Intent.ACTION_VIEW);
4469 // Set the URI and the MIME type. `"text/html"` should load browser options.
4470 openWithBrowserIntent.setDataAndType(Uri.parse(url), "text/html");
4472 // Flag the intent to open in a new task.
4473 openWithBrowserIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4477 // Show the chooser.
4478 startActivity(openWithBrowserIntent);
4479 } catch (ActivityNotFoundException exception) { // There are no browsers available to open the URL.
4480 // Show a snackbar with the error.
4481 Snackbar.make(currentWebView, getString(R.string.error) + " " + exception, Snackbar.LENGTH_INDEFINITE).show();
4485 private String sanitizeUrl(String url) {
4486 // Sanitize Google Analytics.
4487 if (sanitizeGoogleAnalytics) {
4489 if (url.contains("?utm_")) {
4490 url = url.substring(0, url.indexOf("?utm_"));
4494 if (url.contains("&utm_")) {
4495 url = url.substring(0, url.indexOf("&utm_"));
4499 // Sanitize Facebook Click IDs.
4500 if (sanitizeFacebookClickIds) {
4501 // Remove `?fbclid=`.
4502 if (url.contains("?fbclid=")) {
4503 url = url.substring(0, url.indexOf("?fbclid="));
4506 // Remove `&fbclid=`.
4507 if (url.contains("&fbclid=")) {
4508 url = url.substring(0, url.indexOf("&fbclid="));
4511 // Remove `?fbadid=`.
4512 if (url.contains("?fbadid=")) {
4513 url = url.substring(0, url.indexOf("?fbadid="));
4516 // Remove `&fbadid=`.
4517 if (url.contains("&fbadid=")) {
4518 url = url.substring(0, url.indexOf("&fbadid="));
4522 // Sanitize Twitter AMP redirects.
4523 if (sanitizeTwitterAmpRedirects) {
4525 if (url.contains("?amp=1")) {
4526 url = url.substring(0, url.indexOf("?amp=1"));
4530 // Return the sanitized URL.
4534 public void finishedPopulatingBlocklists(ArrayList<ArrayList<List<String[]>>> combinedBlocklists) {
4535 // Store the blocklists.
4536 easyList = combinedBlocklists.get(0);
4537 easyPrivacy = combinedBlocklists.get(1);
4538 fanboysAnnoyanceList = combinedBlocklists.get(2);
4539 fanboysSocialList = combinedBlocklists.get(3);
4540 ultraList = combinedBlocklists.get(4);
4541 ultraPrivacy = combinedBlocklists.get(5);
4543 // Check to see if the activity has been restarted with a saved state.
4544 if ((savedStateArrayList == null) || (savedStateArrayList.size() == 0)) { // The activity has not been restarted or it was restarted on start to force the night theme.
4545 // Add the first tab.
4546 addNewTab("", true);
4547 } else { // The activity has been restarted.
4548 // Restore each tab. Once the minimum API >= 24, a `forEach()` command can be used.
4549 for (int i = 0; i < savedStateArrayList.size(); i++) {
4551 tabLayout.addTab(tabLayout.newTab());
4554 TabLayout.Tab newTab = tabLayout.getTabAt(i);
4556 // Remove the lint warning below that the current tab might be null.
4557 assert newTab != null;
4559 // Set a custom view on the new tab.
4560 newTab.setCustomView(R.layout.tab_custom_view);
4562 // Add the new page.
4563 webViewPagerAdapter.restorePage(savedStateArrayList.get(i), savedNestedScrollWebViewStateArrayList.get(i));
4566 // Reset the saved state variables.
4567 savedStateArrayList = null;
4568 savedNestedScrollWebViewStateArrayList = null;
4570 // Restore the selected tab position.
4571 if (savedTabPosition == 0) { // The first tab is selected.
4572 // Set the first page as the current WebView.
4573 setCurrentWebView(0);
4574 } else { // the first tab is not selected.
4575 // Move to the selected tab.
4576 webViewPager.setCurrentItem(savedTabPosition);
4579 // Get the intent that started the app.
4580 Intent intent = getIntent();
4582 // Reset the intent. This prevents a duplicate tab from being created on restart.
4583 setIntent(new Intent());
4585 // Get the information from the intent.
4586 String intentAction = intent.getAction();
4587 Uri intentUriData = intent.getData();
4588 String intentStringExtra = intent.getStringExtra(Intent.EXTRA_TEXT);
4590 // Determine if this is a web search.
4591 boolean isWebSearch = ((intentAction != null) && intentAction.equals(Intent.ACTION_WEB_SEARCH));
4593 // Only process the URI if it contains data or it is a web search. If the user pressed the desktop icon after the app was already running the URI will be null.
4594 if (intentUriData != null || intentStringExtra != null || isWebSearch) {
4595 // Get the shared preferences.
4596 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
4598 // Create a URL string.
4601 // If the intent action is a web search, perform the search.
4602 if (isWebSearch) { // The intent is a web search.
4603 // Create an encoded URL string.
4604 String encodedUrlString;
4606 // Sanitize the search input and convert it to a search.
4608 encodedUrlString = URLEncoder.encode(intent.getStringExtra(SearchManager.QUERY), "UTF-8");
4609 } catch (UnsupportedEncodingException exception) {
4610 encodedUrlString = "";
4613 // Add the base search URL.
4614 url = searchURL + encodedUrlString;
4615 } else if (intentUriData != null) { // The intent contains a URL formatted as a URI.
4616 // Set the intent data as the URL.
4617 url = intentUriData.toString();
4618 } else { // The intent contains a string, which might be a URL.
4619 // Set the intent string as the URL.
4620 url = intentStringExtra;
4623 // Add a new tab if specified in the preferences.
4624 if (sharedPreferences.getBoolean("open_intents_in_new_tab", true)) { // Load the URL in a new tab.
4625 // Set the loading new intent flag.
4626 loadingNewIntent = true;
4629 addNewTab(url, true);
4630 } else { // Load the URL in the current tab.
4632 loadUrl(currentWebView, url);
4638 public void addTab(View view) {
4639 // Add a new tab with a blank URL.
4640 addNewTab("", true);
4643 private void addNewTab(String url, boolean moveToTab) {
4644 // Clear the focus from the URL edit text, so that it will be populated with the information from the new tab.
4645 urlEditText.clearFocus();
4647 // Get the new page number. The page numbers are 0 indexed, so the new page number will match the current count.
4648 int newTabNumber = tabLayout.getTabCount();
4651 tabLayout.addTab(tabLayout.newTab());
4654 TabLayout.Tab newTab = tabLayout.getTabAt(newTabNumber);
4656 // Remove the lint warning below that the current tab might be null.
4657 assert newTab != null;
4659 // Set a custom view on the new tab.
4660 newTab.setCustomView(R.layout.tab_custom_view);
4662 // Add the new WebView page.
4663 webViewPagerAdapter.addPage(newTabNumber, webViewPager, url, moveToTab);
4665 // Show the app bar if it is at the bottom of the screen and the new tab is taking focus.
4666 if (bottomAppBar && moveToTab && (appBarLayout.getTranslationY() != 0)) {
4667 // Animate the bottom app bar onto the screen.
4668 objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", 0);
4671 objectAnimator.start();
4675 public void closeTab(View view) {
4676 // Run the command according to the number of tabs.
4677 if (tabLayout.getTabCount() > 1) { // There is more than one tab open.
4678 // Close the current tab.
4680 } else { // There is only one tab open.
4685 private void closeCurrentTab() {
4686 // Get the current tab number.
4687 int currentTabNumber = tabLayout.getSelectedTabPosition();
4689 // Delete the current tab.
4690 tabLayout.removeTabAt(currentTabNumber);
4692 // Delete the current page. If the selected page number did not change during the delete (because the newly selected tab has has same number as the previously deleted tab), it will return true,
4693 // meaning that the current WebView must be reset. Otherwise it will happen automatically as the selected tab number changes.
4694 if (webViewPagerAdapter.deletePage(currentTabNumber, webViewPager)) {
4695 setCurrentWebView(currentTabNumber);
4699 private void exitFullScreenVideo() {
4700 // Re-enable the screen timeout.
4701 fullScreenVideoFrameLayout.setKeepScreenOn(false);
4703 // Unset the full screen video flag.
4704 displayingFullScreenVideo = false;
4706 // Remove all the views from the full screen video frame layout.
4707 fullScreenVideoFrameLayout.removeAllViews();
4709 // Hide the full screen video frame layout.
4710 fullScreenVideoFrameLayout.setVisibility(View.GONE);
4712 // Enable the sliding drawers.
4713 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED);
4715 // Show the coordinator layout.
4716 coordinatorLayout.setVisibility(View.VISIBLE);
4718 // Apply the appropriate full screen mode flags.
4719 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
4720 // Hide the app bar if specified.
4722 // Hide the tab linear layout.
4723 tabsLinearLayout.setVisibility(View.GONE);
4725 // Hide the action bar.
4729 /* Hide the system bars.
4730 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
4731 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
4732 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
4733 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
4735 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
4736 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
4737 } else { // Switch to normal viewing mode.
4738 // Remove the `SYSTEM_UI` flags from the root frame layout.
4739 rootFrameLayout.setSystemUiVisibility(0);
4743 private void clearAndExit() {
4744 // Get a handle for the shared preferences.
4745 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
4747 // Close the bookmarks cursor and database.
4748 bookmarksCursor.close();
4749 bookmarksDatabaseHelper.close();
4751 // Get the status of the clear everything preference.
4752 boolean clearEverything = sharedPreferences.getBoolean("clear_everything", true);
4754 // Get a handle for the runtime.
4755 Runtime runtime = Runtime.getRuntime();
4757 // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
4758 // which links to `/data/data/com.stoutner.privacybrowser.standard`.
4759 String privateDataDirectoryString = getApplicationInfo().dataDir;
4762 if (clearEverything || sharedPreferences.getBoolean("clear_cookies", true)) {
4763 // Request the cookies be deleted.
4764 CookieManager.getInstance().removeAllCookies(null);
4766 // Manually delete the cookies database, as `CookieManager` sometimes will not flush its changes to disk before `System.exit(0)` is run.
4768 // Two commands must be used because `Runtime.exec()` does not like `*`.
4769 Process deleteCookiesProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies");
4770 Process deleteCookiesJournalProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies-journal");
4772 // Wait until the processes have finished.
4773 deleteCookiesProcess.waitFor();
4774 deleteCookiesJournalProcess.waitFor();
4775 } catch (Exception exception) {
4776 // Do nothing if an error is thrown.
4780 // Clear DOM storage.
4781 if (clearEverything || sharedPreferences.getBoolean("clear_dom_storage", true)) {
4782 // Ask `WebStorage` to clear the DOM storage.
4783 WebStorage webStorage = WebStorage.getInstance();
4784 webStorage.deleteAllData();
4786 // Manually delete the DOM storage files and directories, as `WebStorage` sometimes will not flush its changes to disk before `System.exit(0)` is run.
4788 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
4789 Process deleteLocalStorageProcess = runtime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
4791 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
4792 Process deleteIndexProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
4793 Process deleteQuotaManagerProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
4794 Process deleteQuotaManagerJournalProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
4795 Process deleteDatabaseProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
4797 // Wait until the processes have finished.
4798 deleteLocalStorageProcess.waitFor();
4799 deleteIndexProcess.waitFor();
4800 deleteQuotaManagerProcess.waitFor();
4801 deleteQuotaManagerJournalProcess.waitFor();
4802 deleteDatabaseProcess.waitFor();
4803 } catch (Exception exception) {
4804 // Do nothing if an error is thrown.
4808 // Clear form data if the API < 26.
4809 if ((Build.VERSION.SDK_INT < 26) && (clearEverything || sharedPreferences.getBoolean("clear_form_data", true))) {
4810 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
4811 webViewDatabase.clearFormData();
4813 // Manually delete the form data database, as `WebViewDatabase` sometimes will not flush its changes to disk before `System.exit(0)` is run.
4815 // A string array must be used because the database contains a space and `Runtime.exec` will not otherwise escape the string correctly.
4816 Process deleteWebDataProcess = runtime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data"});
4817 Process deleteWebDataJournalProcess = runtime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data-journal"});
4819 // Wait until the processes have finished.
4820 deleteWebDataProcess.waitFor();
4821 deleteWebDataJournalProcess.waitFor();
4822 } catch (Exception exception) {
4823 // Do nothing if an error is thrown.
4827 // Clear the logcat.
4828 if (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_logcat_key), true)) {
4830 // Clear the logcat. `-c` clears the logcat. `-b all` clears all the buffers (instead of just crash, main, and system).
4831 Process process = Runtime.getRuntime().exec("logcat -b all -c");
4833 // Wait for the process to finish.
4835 } catch (IOException|InterruptedException exception) {
4841 if (clearEverything || sharedPreferences.getBoolean("clear_cache", true)) {
4842 // Clear the cache from each WebView.
4843 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
4844 // Get the WebView tab fragment.
4845 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
4847 // Get the WebView fragment view.
4848 View webViewFragmentView = webViewTabFragment.getView();
4850 // Only clear the cache if the WebView exists.
4851 if (webViewFragmentView != null) {
4852 // Get the nested scroll WebView from the tab fragment.
4853 NestedScrollWebView nestedScrollWebView = webViewFragmentView.findViewById(R.id.nestedscroll_webview);
4855 // Clear the cache for this WebView.
4856 nestedScrollWebView.clearCache(true);
4860 // Manually delete the cache directories.
4862 // Delete the main cache directory.
4863 Process deleteCacheProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/cache");
4865 // Delete the secondary `Service Worker` cache directory.
4866 // A string array must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
4867 Process deleteServiceWorkerProcess = runtime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
4869 // Wait until the processes have finished.
4870 deleteCacheProcess.waitFor();
4871 deleteServiceWorkerProcess.waitFor();
4872 } catch (Exception exception) {
4873 // Do nothing if an error is thrown.
4877 // Wipe out each WebView.
4878 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
4879 // Get the WebView tab fragment.
4880 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
4882 // Get the WebView frame layout.
4883 FrameLayout webViewFrameLayout = (FrameLayout) webViewTabFragment.getView();
4885 // Only wipe out the WebView if it exists.
4886 if (webViewFrameLayout != null) {
4887 // Get the nested scroll WebView from the tab fragment.
4888 NestedScrollWebView nestedScrollWebView = webViewFrameLayout.findViewById(R.id.nestedscroll_webview);
4890 // Clear SSL certificate preferences for this WebView.
4891 nestedScrollWebView.clearSslPreferences();
4893 // Clear the back/forward history for this WebView.
4894 nestedScrollWebView.clearHistory();
4896 // Remove all the views from the frame layout.
4897 webViewFrameLayout.removeAllViews();
4899 // Destroy the internal state of the WebView.
4900 nestedScrollWebView.destroy();
4904 // Clear the custom headers.
4905 customHeaders.clear();
4907 // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
4908 // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
4909 if (clearEverything) {
4911 // Delete the folder.
4912 Process deleteAppWebviewProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
4914 // Wait until the process has finished.
4915 deleteAppWebviewProcess.waitFor();
4916 } catch (Exception exception) {
4917 // Do nothing if an error is thrown.
4921 // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
4922 finishAndRemoveTask();
4924 // Remove the terminated program from RAM. The status code is `0`.
4928 public void bookmarksBack(View view) {
4929 if (currentBookmarksFolder.isEmpty()) { // The home folder is displayed.
4930 // close the bookmarks drawer.
4931 drawerLayout.closeDrawer(GravityCompat.END);
4932 } else { // A subfolder is displayed.
4933 // Place the former parent folder in `currentFolder`.
4934 currentBookmarksFolder = bookmarksDatabaseHelper.getParentFolderName(currentBookmarksFolder);
4936 // Load the new folder.
4937 loadBookmarksFolder();
4941 private void setCurrentWebView(int pageNumber) {
4942 // Stop the swipe to refresh indicator if it is running
4943 swipeRefreshLayout.setRefreshing(false);
4945 // Get the WebView tab fragment.
4946 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(pageNumber);
4948 // Get the fragment view.
4949 View webViewFragmentView = webViewTabFragment.getView();
4951 // Set the current WebView if the fragment view is not null.
4952 if (webViewFragmentView != null) { // The fragment has been populated.
4953 // Store the current WebView.
4954 currentWebView = webViewFragmentView.findViewById(R.id.nestedscroll_webview);
4956 // Update the status of swipe to refresh.
4957 if (currentWebView.getSwipeToRefresh()) { // Swipe to refresh is enabled.
4958 // Enable the swipe refresh layout if the WebView is scrolled all the way to the top. It is updated every time the scroll changes.
4959 swipeRefreshLayout.setEnabled(currentWebView.getScrollY() == 0);
4960 } else { // Swipe to refresh is disabled.
4961 // Disable the swipe refresh layout.
4962 swipeRefreshLayout.setEnabled(false);
4965 // Get a handle for the cookie manager.
4966 CookieManager cookieManager = CookieManager.getInstance();
4968 // Set the cookie status.
4969 cookieManager.setAcceptCookie(currentWebView.getAcceptCookies());
4971 // Update the privacy icons. `true` redraws the icons in the app bar.
4972 updatePrivacyIcons(true);
4974 // Get a handle for the input method manager.
4975 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
4977 // Remove the lint warning below that the input method manager might be null.
4978 assert inputMethodManager != null;
4980 // Get the current URL.
4981 String url = currentWebView.getUrl();
4983 // Update the URL edit text if not loading a new intent. Otherwise, this will be handled by `onPageStarted()` (if called) and `onPageFinished()`.
4984 if (!loadingNewIntent) { // A new intent is not being loaded.
4985 if ((url == null) || url.equals("about:blank")) { // The WebView is blank.
4986 // Display the hint in the URL edit text.
4987 urlEditText.setText("");
4989 // Request focus for the URL text box.
4990 urlEditText.requestFocus();
4992 // Display the keyboard.
4993 inputMethodManager.showSoftInput(urlEditText, 0);
4994 } else { // The WebView has a loaded URL.
4995 // Clear the focus from the URL text box.
4996 urlEditText.clearFocus();
4998 // Hide the soft keyboard.
4999 inputMethodManager.hideSoftInputFromWindow(currentWebView.getWindowToken(), 0);
5001 // Display the current URL in the URL text box.
5002 urlEditText.setText(url);
5004 // Highlight the URL text.
5007 } else { // A new intent is being loaded.
5008 // Reset the loading new intent tracker.
5009 loadingNewIntent = false;
5012 // Set the background to indicate the domain settings status.
5013 if (currentWebView.getDomainSettingsApplied()) {
5014 // Set a background on the URL relative layout to indicate that custom domain settings are being used.
5015 urlRelativeLayout.setBackground(ResourcesCompat.getDrawable(getResources(), R.drawable.domain_settings_url_background, null));
5017 // Remove any background on the URL relative layout.
5018 urlRelativeLayout.setBackground(ResourcesCompat.getDrawable(getResources(), R.color.transparent, null));
5020 } else { // The fragment has not been populated. Try again in 100 milliseconds.
5021 // Create a handler to set the current WebView.
5022 Handler setCurrentWebViewHandler = new Handler();
5024 // Create a runnable to set the current WebView.
5025 Runnable setCurrentWebWebRunnable = () -> {
5026 // Set the current WebView.
5027 setCurrentWebView(pageNumber);
5030 // Try setting the current WebView again after 100 milliseconds.
5031 setCurrentWebViewHandler.postDelayed(setCurrentWebWebRunnable, 100);
5035 @SuppressLint("ClickableViewAccessibility")
5037 public void initializeWebView(NestedScrollWebView nestedScrollWebView, int pageNumber, ProgressBar progressBar, String url, Boolean restoringState) {
5038 // Get a handle for the shared preferences.
5039 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
5041 // Get the WebView theme.
5042 String webViewTheme = sharedPreferences.getString("webview_theme", getString(R.string.webview_theme_default_value));
5044 // Get the WebView theme entry values string array.
5045 String[] webViewThemeEntryValuesStringArray = getResources().getStringArray(R.array.webview_theme_entry_values);
5047 // Apply the WebView theme if supported by the installed WebView.
5048 if (WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) {
5049 // Set the WebView theme. A switch statement cannot be used because the WebView theme entry values string array is not a compile time constant.
5050 if (webViewTheme.equals(webViewThemeEntryValuesStringArray[1])) { // The light theme is selected.
5051 // Turn off the WebView dark mode.
5052 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_OFF);
5054 // Make the WebView visible. The WebView was created invisible in `webview_framelayout` to prevent a white background splash in night mode.
5055 // If the system is currently in night mode, showing the WebView will be handled in `onProgressChanged()`.
5056 nestedScrollWebView.setVisibility(View.VISIBLE);
5057 } else if (webViewTheme.equals(webViewThemeEntryValuesStringArray[2])) { // The dark theme is selected.
5058 // Turn on the WebView dark mode.
5059 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_ON);
5060 } else { // The system default theme is selected.
5061 // Get the current system theme status.
5062 int currentThemeStatus = getResources().getConfiguration().uiMode & Configuration.UI_MODE_NIGHT_MASK;
5064 // Set the WebView theme according to the current system theme status.
5065 if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) { // The system is in day mode.
5066 // Turn off the WebView dark mode.
5067 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_OFF);
5069 // Make the WebView visible. The WebView was created invisible in `webview_framelayout` to prevent a white background splash in night mode.
5070 // If the system is currently in night mode, showing the WebView will be handled in `onProgressChanged()`.
5071 nestedScrollWebView.setVisibility(View.VISIBLE);
5072 } else { // The system is in night mode.
5073 // Turn on the WebView dark mode.
5074 WebSettingsCompat.setForceDark(nestedScrollWebView.getSettings(), WebSettingsCompat.FORCE_DARK_ON);
5079 // Get a handle for the activity
5080 Activity activity = this;
5082 // Get a handle for the input method manager.
5083 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
5085 // Instantiate the blocklist helper.
5086 BlocklistHelper blocklistHelper = new BlocklistHelper();
5088 // Remove the lint warning below that the input method manager might be null.
5089 assert inputMethodManager != null;
5091 // Set the app bar scrolling.
5092 nestedScrollWebView.setNestedScrollingEnabled(scrollAppBar);
5094 // Allow pinch to zoom.
5095 nestedScrollWebView.getSettings().setBuiltInZoomControls(true);
5097 // Hide zoom controls.
5098 nestedScrollWebView.getSettings().setDisplayZoomControls(false);
5100 // Don't allow mixed content (HTTP and HTTPS) on the same website.
5101 nestedScrollWebView.getSettings().setMixedContentMode(WebSettings.MIXED_CONTENT_NEVER_ALLOW);
5103 // Set the WebView to load in overview mode (zoomed out to the maximum width).
5104 nestedScrollWebView.getSettings().setLoadWithOverviewMode(true);
5106 // Explicitly disable geolocation.
5107 nestedScrollWebView.getSettings().setGeolocationEnabled(false);
5109 // Allow loading of file:// URLs. This is necessary for opening MHT web archives, which are copies into a temporary cache location.
5110 nestedScrollWebView.getSettings().setAllowFileAccess(true);
5112 // Create a double-tap gesture detector to toggle full-screen mode.
5113 GestureDetector doubleTapGestureDetector = new GestureDetector(getApplicationContext(), new GestureDetector.SimpleOnGestureListener() {
5114 // Override `onDoubleTap()`. All other events are handled using the default settings.
5116 public boolean onDoubleTap(MotionEvent event) {
5117 if (fullScreenBrowsingModeEnabled) { // Only process the double-tap if full screen browsing mode is enabled.
5118 // Toggle the full screen browsing mode tracker.
5119 inFullScreenBrowsingMode = !inFullScreenBrowsingMode;
5121 // Toggle the full screen browsing mode.
5122 if (inFullScreenBrowsingMode) { // Switch to full screen mode.
5123 // Hide the app bar if specified.
5125 // Close the find on page bar if it is visible.
5126 closeFindOnPage(null);
5128 // Hide the tab linear layout.
5129 tabsLinearLayout.setVisibility(View.GONE);
5131 // Hide the action bar.
5134 // Set layout and scrolling parameters if the app bar is at the top of the screen.
5135 if (!bottomAppBar) {
5136 // Check to see if the app bar is normally scrolled.
5137 if (scrollAppBar) { // The app bar is scrolled when it is displayed.
5138 // Get the swipe refresh layout parameters.
5139 CoordinatorLayout.LayoutParams swipeRefreshLayoutParams = (CoordinatorLayout.LayoutParams) swipeRefreshLayout.getLayoutParams();
5141 // Remove the off-screen scrolling layout.
5142 swipeRefreshLayoutParams.setBehavior(null);
5143 } else { // The app bar is not scrolled when it is displayed.
5144 // Remove the padding from the top of the swipe refresh layout.
5145 swipeRefreshLayout.setPadding(0, 0, 0, 0);
5147 // The swipe refresh circle must be moved above the now removed status bar location.
5148 swipeRefreshLayout.setProgressViewOffset(false, -200, defaultProgressViewEndOffset);
5153 /* Hide the system bars.
5154 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
5155 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
5156 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
5157 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
5159 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
5160 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
5161 } else { // Switch to normal viewing mode.
5162 // Show the app bar if it was hidden.
5164 // Show the tab linear layout.
5165 tabsLinearLayout.setVisibility(View.VISIBLE);
5167 // Show the action bar.
5170 // Set layout and scrolling parameters if the app bar is at the top of the screen.
5171 if (!bottomAppBar) {
5172 // Check to see if the app bar is normally scrolled.
5173 if (scrollAppBar) { // The app bar is scrolled when it is displayed.
5174 // Get the swipe refresh layout parameters.
5175 CoordinatorLayout.LayoutParams swipeRefreshLayoutParams = (CoordinatorLayout.LayoutParams) swipeRefreshLayout.getLayoutParams();
5177 // Add the off-screen scrolling layout.
5178 swipeRefreshLayoutParams.setBehavior(new AppBarLayout.ScrollingViewBehavior());
5179 } else { // The app bar is not scrolled when it is displayed.
5180 // The swipe refresh layout must be manually moved below the app bar layout.
5181 swipeRefreshLayout.setPadding(0, appBarHeight, 0, 0);
5183 // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
5184 swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10 + appBarHeight, defaultProgressViewEndOffset + appBarHeight);
5189 // Remove the `SYSTEM_UI` flags from the root frame layout.
5190 rootFrameLayout.setSystemUiVisibility(0);
5193 // Consume the double-tap.
5195 } else { // Do not consume the double-tap because full screen browsing mode is disabled.
5201 // Pass all touch events on the WebView through the double-tap gesture detector.
5202 nestedScrollWebView.setOnTouchListener((View view, MotionEvent event) -> {
5203 // Call `performClick()` on the view, which is required for accessibility.
5204 view.performClick();
5206 // Send the event to the gesture detector.
5207 return doubleTapGestureDetector.onTouchEvent(event);
5210 // Register the WebView for a context menu. This is used to see link targets and download images.
5211 registerForContextMenu(nestedScrollWebView);
5213 // Allow the downloading of files.
5214 nestedScrollWebView.setDownloadListener((String downloadUrl, String userAgent, String contentDisposition, String mimetype, long contentLength) -> {
5215 // Check the download preference.
5216 if (downloadWithExternalApp) { // Download with an external app.
5217 downloadUrlWithExternalApp(downloadUrl);
5218 } else { // Handle the download inside of Privacy Browser.
5219 // Define a formatted file size string.
5220 String formattedFileSizeString;
5222 // Process the content length if it contains data.
5223 if (contentLength > 0) { // The content length is greater than 0.
5224 // Format the content length as a string.
5225 formattedFileSizeString = NumberFormat.getInstance().format(contentLength) + " " + getString(R.string.bytes);
5226 } else { // The content length is not greater than 0.
5227 // Set the formatted file size string to be `unknown size`.
5228 formattedFileSizeString = getString(R.string.unknown_size);
5231 // Get the file name from the content disposition.
5232 String fileNameString = PrepareSaveDialog.getFileNameFromHeaders(this, contentDisposition, mimetype, downloadUrl);
5234 // Instantiate the save dialog.
5235 DialogFragment saveDialogFragment = SaveDialog.saveUrl(downloadUrl, formattedFileSizeString, fileNameString, userAgent,
5236 nestedScrollWebView.getAcceptCookies());
5238 // Try to show the dialog. The download listener continues to function even when the WebView is paused. Attempting to display a dialog in that state leads to a crash.
5240 // Show the save dialog. It must be named `save_dialog` so that the file picker can update the file name.
5241 saveDialogFragment.show(getSupportFragmentManager(), getString(R.string.save_dialog));
5242 } catch (Exception exception) { // The dialog could not be shown.
5243 // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
5244 pendingDialogsArrayList.add(new PendingDialog(saveDialogFragment, getString(R.string.save_dialog)));
5249 // Update the find on page count.
5250 nestedScrollWebView.setFindListener(new WebView.FindListener() {
5251 // Get a handle for `findOnPageCountTextView`.
5252 final TextView findOnPageCountTextView = findViewById(R.id.find_on_page_count_textview);
5255 public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, boolean isDoneCounting) {
5256 if ((isDoneCounting) && (numberOfMatches == 0)) { // There are no matches.
5257 // Set `findOnPageCountTextView` to `0/0`.
5258 findOnPageCountTextView.setText(R.string.zero_of_zero);
5259 } else if (isDoneCounting) { // There are matches.
5260 // `activeMatchOrdinal` is zero-based.
5261 int activeMatch = activeMatchOrdinal + 1;
5263 // Build the match string.
5264 String matchString = activeMatch + "/" + numberOfMatches;
5266 // Set `findOnPageCountTextView`.
5267 findOnPageCountTextView.setText(matchString);
5272 // Update the status of swipe to refresh based on the scroll position of the nested scroll WebView. Also reinforce full screen browsing mode.
5273 nestedScrollWebView.setOnScrollChangeListener((view, scrollX, scrollY, oldScrollX, oldScrollY) -> {
5274 // Set the swipe to refresh status.
5275 if (nestedScrollWebView.getSwipeToRefresh()) {
5276 // Only enable swipe to refresh if the WebView is scrolled to the top.
5277 swipeRefreshLayout.setEnabled(nestedScrollWebView.getScrollY() == 0);
5279 // Disable swipe to refresh.
5280 swipeRefreshLayout.setEnabled(false);
5283 // Scroll the bottom app bar if enabled.
5284 if (bottomAppBar && scrollAppBar && !objectAnimator.isRunning()) {
5285 if (scrollY < oldScrollY) { // The WebView was scrolled down.
5286 // Animate the bottom app bar onto the screen.
5287 objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", 0);
5290 objectAnimator.start();
5291 } else if (scrollY > oldScrollY) { // The WebView was scrolled up.
5292 // Animate the bottom app bar off the screen.
5293 objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", appBarLayout.getHeight());
5296 objectAnimator.start();
5300 // Reinforce the system UI visibility flags if in full screen browsing mode.
5301 // This hides the status and navigation bars, which are displayed if other elements are shown, like dialog boxes, the options menu, or the keyboard.
5302 if (inFullScreenBrowsingMode) {
5303 /* Hide the system bars.
5304 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
5305 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
5306 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
5307 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
5309 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
5310 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
5314 // Set the web chrome client.
5315 nestedScrollWebView.setWebChromeClient(new WebChromeClient() {
5316 // Update the progress bar when a page is loading.
5318 public void onProgressChanged(WebView view, int progress) {
5319 // Update the progress bar.
5320 progressBar.setProgress(progress);
5322 // Set the visibility of the progress bar.
5323 if (progress < 100) {
5324 // Show the progress bar.
5325 progressBar.setVisibility(View.VISIBLE);
5327 // Hide the progress bar.
5328 progressBar.setVisibility(View.GONE);
5330 //Stop the swipe to refresh indicator if it is running
5331 swipeRefreshLayout.setRefreshing(false);
5333 // Make the current WebView visible. If this is a new tab, the current WebView would have been created invisible in `webview_framelayout` to prevent a white background splash in night mode.
5334 nestedScrollWebView.setVisibility(View.VISIBLE);
5338 // Set the favorite icon when it changes.
5340 public void onReceivedIcon(WebView view, Bitmap icon) {
5341 // Only update the favorite icon if the website has finished loading.
5342 if (progressBar.getVisibility() == View.GONE) {
5343 // Store the new favorite icon.
5344 nestedScrollWebView.setFavoriteOrDefaultIcon(icon);
5346 // Get the current page position.
5347 int currentPosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
5349 // Get the current tab.
5350 TabLayout.Tab tab = tabLayout.getTabAt(currentPosition);
5352 // Check to see if the tab has been populated.
5354 // Get the custom view from the tab.
5355 View tabView = tab.getCustomView();
5357 // Check to see if the custom tab view has been populated.
5358 if (tabView != null) {
5359 // Get the favorite icon image view from the tab.
5360 ImageView tabFavoriteIconImageView = tabView.findViewById(R.id.favorite_icon_imageview);
5362 // Display the favorite icon in the tab.
5363 tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
5369 // Save a copy of the title when it changes.
5371 public void onReceivedTitle(WebView view, String title) {
5372 // Get the current page position.
5373 int currentPosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
5375 // Get the current tab.
5376 TabLayout.Tab tab = tabLayout.getTabAt(currentPosition);
5378 // Only populate the title text view if the tab has been fully created.
5380 // Get the custom view from the tab.
5381 View tabView = tab.getCustomView();
5383 // Only populate the title text view if the tab view has been fully populated.
5384 if (tabView != null) {
5385 // Get the title text view from the tab.
5386 TextView tabTitleTextView = tabView.findViewById(R.id.title_textview);
5388 // Set the title according to the URL.
5389 if (title.equals("about:blank")) {
5390 // Set the title to indicate a new tab.
5391 tabTitleTextView.setText(R.string.new_tab);
5393 // Set the title as the tab text.
5394 tabTitleTextView.setText(title);
5400 // Enter full screen video.
5402 public void onShowCustomView(View video, CustomViewCallback callback) {
5403 // Set the full screen video flag.
5404 displayingFullScreenVideo = true;
5406 // Hide the keyboard.
5407 inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.getWindowToken(), 0);
5409 // Hide the coordinator layout.
5410 coordinatorLayout.setVisibility(View.GONE);
5412 /* Hide the system bars.
5413 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
5414 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
5415 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
5416 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
5418 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
5419 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
5421 // Disable the sliding drawers.
5422 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED);
5424 // Add the video view to the full screen video frame layout.
5425 fullScreenVideoFrameLayout.addView(video);
5427 // Show the full screen video frame layout.
5428 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
5430 // Disable the screen timeout while the video is playing. YouTube does this automatically, but not all other videos do.
5431 fullScreenVideoFrameLayout.setKeepScreenOn(true);
5434 // Exit full screen video.
5436 public void onHideCustomView() {
5437 // Exit the full screen video.
5438 exitFullScreenVideo();
5443 public boolean onShowFileChooser(WebView webView, ValueCallback<Uri[]> filePathCallback, FileChooserParams fileChooserParams) {
5444 // Store the file path callback.
5445 fileChooserCallback = filePathCallback;
5447 // Create an intent to open a chooser based on the file chooser parameters.
5448 Intent fileChooserIntent = fileChooserParams.createIntent();
5450 // Get a handle for the package manager.
5451 PackageManager packageManager = getPackageManager();
5453 // Check to see if the file chooser intent resolves to an installed package.
5454 if (fileChooserIntent.resolveActivity(packageManager) != null) { // The file chooser intent is fine.
5455 // Start the file chooser intent.
5456 startActivityForResult(fileChooserIntent, BROWSE_FILE_UPLOAD_REQUEST_CODE);
5457 } else { // The file chooser intent will cause a crash.
5458 // Create a generic intent to open a chooser.
5459 Intent genericFileChooserIntent = new Intent(Intent.ACTION_GET_CONTENT);
5461 // Request an openable file.
5462 genericFileChooserIntent.addCategory(Intent.CATEGORY_OPENABLE);
5464 // Set the file type to everything.
5465 genericFileChooserIntent.setType("*/*");
5467 // Start the generic file chooser intent.
5468 startActivityForResult(genericFileChooserIntent, BROWSE_FILE_UPLOAD_REQUEST_CODE);
5474 nestedScrollWebView.setWebViewClient(new WebViewClient() {
5475 // `shouldOverrideUrlLoading` makes this WebView the default handler for URLs inside the app, so that links are not kicked out to other apps.
5476 // The deprecated `shouldOverrideUrlLoading` must be used until API >= 24.
5478 public boolean shouldOverrideUrlLoading(WebView view, String url) {
5479 // Sanitize the url.
5480 url = sanitizeUrl(url);
5482 // Handle the URL according to the type.
5483 if (url.startsWith("http")) { // Load the URL in Privacy Browser.
5484 // Load the URL. By using `loadUrl()`, instead of `loadUrlFromBase()`, the Referer header will never be sent.
5485 loadUrl(nestedScrollWebView, url);
5487 // Returning true indicates that Privacy Browser is manually handling the loading of the URL.
5488 // Custom headers cannot be added if false is returned and the WebView handles the loading of the URL.
5490 } else if (url.startsWith("mailto:")) { // Load the email address in an external email program.
5491 // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
5492 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
5494 // Parse the url and set it as the data for the intent.
5495 emailIntent.setData(Uri.parse(url));
5497 // Open the email program in a new task instead of as part of Privacy Browser.
5498 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
5502 startActivity(emailIntent);
5503 } catch (ActivityNotFoundException exception) {
5504 // Display a snackbar.
5505 Snackbar.make(currentWebView, getString(R.string.error) + " " + exception, Snackbar.LENGTH_INDEFINITE).show();
5509 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
5511 } else if (url.startsWith("tel:")) { // Load the phone number in the dialer.
5512 // Open the dialer and load the phone number, but wait for the user to place the call.
5513 Intent dialIntent = new Intent(Intent.ACTION_DIAL);
5515 // Add the phone number to the intent.
5516 dialIntent.setData(Uri.parse(url));
5518 // Open the dialer in a new task instead of as part of Privacy Browser.
5519 dialIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
5523 startActivity(dialIntent);
5524 } catch (ActivityNotFoundException exception) {
5525 // Display a snackbar.
5526 Snackbar.make(currentWebView, getString(R.string.error) + " " + exception, Snackbar.LENGTH_INDEFINITE).show();
5529 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
5531 } else { // Load a system chooser to select an app that can handle the URL.
5532 // Open an app that can handle the URL.
5533 Intent genericIntent = new Intent(Intent.ACTION_VIEW);
5535 // Add the URL to the intent.
5536 genericIntent.setData(Uri.parse(url));
5538 // List all apps that can handle the URL instead of just opening the first one.
5539 genericIntent.addCategory(Intent.CATEGORY_BROWSABLE);
5541 // Open the app in a new task instead of as part of Privacy Browser.
5542 genericIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
5544 // Start the app or display a snackbar if no app is available to handle the URL.
5546 startActivity(genericIntent);
5547 } catch (ActivityNotFoundException exception) {
5548 Snackbar.make(nestedScrollWebView, getString(R.string.unrecognized_url) + " " + url, Snackbar.LENGTH_SHORT).show();
5551 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
5556 // Check requests against the block lists. The deprecated `shouldInterceptRequest()` must be used until minimum API >= 21.
5558 public WebResourceResponse shouldInterceptRequest(WebView view, WebResourceRequest webResourceRequest) {
5560 String url = webResourceRequest.getUrl().toString();
5562 // Check to see if the resource request is for the main URL.
5563 if (url.equals(nestedScrollWebView.getCurrentUrl())) {
5564 // `return null` loads the resource request, which should never be blocked if it is the main URL.
5568 // Wait until the blocklists have been populated. When Privacy Browser is being resumed after having the process killed in the background it will try to load the URLs immediately.
5569 while (ultraPrivacy == null) {
5570 // The wait must be synchronized, which only lets one thread run on it at a time, or `java.lang.IllegalMonitorStateException` is thrown.
5571 synchronized (this) {
5573 // Check to see if the blocklists have been populated after 100 ms.
5575 } catch (InterruptedException exception) {
5581 // Create an empty web resource response to be used if the resource request is blocked.
5582 WebResourceResponse emptyWebResourceResponse = new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
5584 // Reset the whitelist results tracker.
5585 String[] whitelistResultStringArray = null;
5587 // Initialize the third party request tracker.
5588 boolean isThirdPartyRequest = false;
5590 // Get the current URL. `.getUrl()` throws an error because operations on the WebView cannot be made from this thread.
5591 String currentBaseDomain = nestedScrollWebView.getCurrentDomainName();
5593 // Store a copy of the current domain for use in later requests.
5594 String currentDomain = currentBaseDomain;
5596 // Get the request host name.
5597 String requestBaseDomain = webResourceRequest.getUrl().getHost();
5599 // Only check for third-party requests if the current base domain is not empty and the request domain is not null.
5600 if (!currentBaseDomain.isEmpty() && (requestBaseDomain != null)) {
5601 // Determine the current base domain.
5602 while (currentBaseDomain.indexOf(".", currentBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
5603 // Remove the first subdomain.
5604 currentBaseDomain = currentBaseDomain.substring(currentBaseDomain.indexOf(".") + 1);
5607 // Determine the request base domain.
5608 while (requestBaseDomain.indexOf(".", requestBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
5609 // Remove the first subdomain.
5610 requestBaseDomain = requestBaseDomain.substring(requestBaseDomain.indexOf(".") + 1);
5613 // Update the third party request tracker.
5614 isThirdPartyRequest = !currentBaseDomain.equals(requestBaseDomain);
5617 // Get the current WebView page position.
5618 int webViewPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
5620 // Determine if the WebView is currently displayed.
5621 boolean webViewDisplayed = (webViewPagePosition == tabLayout.getSelectedTabPosition());
5623 // Block third-party requests if enabled.
5624 if (isThirdPartyRequest && nestedScrollWebView.getBlockAllThirdPartyRequests()) {
5625 // Add the result to the resource requests.
5626 nestedScrollWebView.addResourceRequest(new String[]{BlocklistHelper.REQUEST_THIRD_PARTY, url});
5628 // Increment the blocked requests counters.
5629 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5630 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.THIRD_PARTY_REQUESTS);
5632 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5633 if (webViewDisplayed) {
5634 // Updating the UI must be run from the UI thread.
5635 activity.runOnUiThread(() -> {
5636 // Update the menu item titles.
5637 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5639 // Update the options menu if it has been populated.
5640 if (optionsMenu != null) {
5641 optionsBlocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5642 optionsBlockAllThirdPartyRequestsMenuItem.setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.THIRD_PARTY_REQUESTS) + " - " +
5643 getString(R.string.block_all_third_party_requests));
5648 // Return an empty web resource response.
5649 return emptyWebResourceResponse;
5652 // Check UltraList if it is enabled.
5653 if (nestedScrollWebView.getUltraListEnabled()) {
5654 // Check the URL against UltraList.
5655 String[] ultraListResults = blocklistHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, ultraList);
5657 // Process the UltraList results.
5658 if (ultraListResults[0].equals(BlocklistHelper.REQUEST_BLOCKED)) { // The resource request matched UltraList's blacklist.
5659 // Add the result to the resource requests.
5660 nestedScrollWebView.addResourceRequest(new String[] {ultraListResults[0], ultraListResults[1], ultraListResults[2], ultraListResults[3], ultraListResults[4], ultraListResults[5]});
5662 // Increment the blocked requests counters.
5663 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5664 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.ULTRALIST);
5666 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5667 if (webViewDisplayed) {
5668 // Updating the UI must be run from the UI thread.
5669 activity.runOnUiThread(() -> {
5670 // Update the menu item titles.
5671 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5673 // Update the options menu if it has been populated.
5674 if (optionsMenu != null) {
5675 optionsBlocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5676 optionsUltraListMenuItem.setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.ULTRALIST) + " - " + getString(R.string.ultralist));
5681 // The resource request was blocked. Return an empty web resource response.
5682 return emptyWebResourceResponse;
5683 } else if (ultraListResults[0].equals(BlocklistHelper.REQUEST_ALLOWED)) { // The resource request matched UltraList's whitelist.
5684 // Add a whitelist entry to the resource requests array.
5685 nestedScrollWebView.addResourceRequest(new String[] {ultraListResults[0], ultraListResults[1], ultraListResults[2], ultraListResults[3], ultraListResults[4], ultraListResults[5]});
5687 // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
5692 // Check UltraPrivacy if it is enabled.
5693 if (nestedScrollWebView.getUltraPrivacyEnabled()) {
5694 // Check the URL against UltraPrivacy.
5695 String[] ultraPrivacyResults = blocklistHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, ultraPrivacy);
5697 // Process the UltraPrivacy results.
5698 if (ultraPrivacyResults[0].equals(BlocklistHelper.REQUEST_BLOCKED)) { // The resource request matched UltraPrivacy's blacklist.
5699 // Add the result to the resource requests.
5700 nestedScrollWebView.addResourceRequest(new String[] {ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
5701 ultraPrivacyResults[5]});
5703 // Increment the blocked requests counters.
5704 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5705 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.ULTRAPRIVACY);
5707 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5708 if (webViewDisplayed) {
5709 // Updating the UI must be run from the UI thread.
5710 activity.runOnUiThread(() -> {
5711 // Update the menu item titles.
5712 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5714 // Update the options menu if it has been populated.
5715 if (optionsMenu != null) {
5716 optionsBlocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5717 optionsUltraPrivacyMenuItem.setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.ULTRAPRIVACY) + " - " + getString(R.string.ultraprivacy));
5722 // The resource request was blocked. Return an empty web resource response.
5723 return emptyWebResourceResponse;
5724 } else if (ultraPrivacyResults[0].equals(BlocklistHelper.REQUEST_ALLOWED)) { // The resource request matched UltraPrivacy's whitelist.
5725 // Add a whitelist entry to the resource requests array.
5726 nestedScrollWebView.addResourceRequest(new String[] {ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
5727 ultraPrivacyResults[5]});
5729 // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
5734 // Check EasyList if it is enabled.
5735 if (nestedScrollWebView.getEasyListEnabled()) {
5736 // Check the URL against EasyList.
5737 String[] easyListResults = blocklistHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, easyList);
5739 // Process the EasyList results.
5740 if (easyListResults[0].equals(BlocklistHelper.REQUEST_BLOCKED)) { // The resource request matched EasyList's blacklist.
5741 // Add the result to the resource requests.
5742 nestedScrollWebView.addResourceRequest(new String[] {easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5]});
5744 // Increment the blocked requests counters.
5745 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5746 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.EASYLIST);
5748 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5749 if (webViewDisplayed) {
5750 // Updating the UI must be run from the UI thread.
5751 activity.runOnUiThread(() -> {
5752 // Update the menu item titles.
5753 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5755 // Update the options menu if it has been populated.
5756 if (optionsMenu != null) {
5757 optionsBlocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5758 optionsEasyListMenuItem.setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.EASYLIST) + " - " + getString(R.string.easylist));
5763 // The resource request was blocked. Return an empty web resource response.
5764 return emptyWebResourceResponse;
5765 } else if (easyListResults[0].equals(BlocklistHelper.REQUEST_ALLOWED)) { // The resource request matched EasyList's whitelist.
5766 // Update the whitelist result string array tracker.
5767 whitelistResultStringArray = new String[] {easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5]};
5771 // Check EasyPrivacy if it is enabled.
5772 if (nestedScrollWebView.getEasyPrivacyEnabled()) {
5773 // Check the URL against EasyPrivacy.
5774 String[] easyPrivacyResults = blocklistHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, easyPrivacy);
5776 // Process the EasyPrivacy results.
5777 if (easyPrivacyResults[0].equals(BlocklistHelper.REQUEST_BLOCKED)) { // The resource request matched EasyPrivacy's blacklist.
5778 // Add the result to the resource requests.
5779 nestedScrollWebView.addResourceRequest(new String[] {easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4],
5780 easyPrivacyResults[5]});
5782 // Increment the blocked requests counters.
5783 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5784 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.EASYPRIVACY);
5786 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5787 if (webViewDisplayed) {
5788 // Updating the UI must be run from the UI thread.
5789 activity.runOnUiThread(() -> {
5790 // Update the menu item titles.
5791 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5793 // Update the options menu if it has been populated.
5794 if (optionsMenu != null) {
5795 optionsBlocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5796 optionsEasyPrivacyMenuItem.setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.EASYPRIVACY) + " - " + getString(R.string.easyprivacy));
5801 // The resource request was blocked. Return an empty web resource response.
5802 return emptyWebResourceResponse;
5803 } else if (easyPrivacyResults[0].equals(BlocklistHelper.REQUEST_ALLOWED)) { // The resource request matched EasyPrivacy's whitelist.
5804 // Update the whitelist result string array tracker.
5805 whitelistResultStringArray = new String[] {easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4], easyPrivacyResults[5]};
5809 // Check Fanboy’s Annoyance List if it is enabled.
5810 if (nestedScrollWebView.getFanboysAnnoyanceListEnabled()) {
5811 // Check the URL against Fanboy's Annoyance List.
5812 String[] fanboysAnnoyanceListResults = blocklistHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, fanboysAnnoyanceList);
5814 // Process the Fanboy's Annoyance List results.
5815 if (fanboysAnnoyanceListResults[0].equals(BlocklistHelper.REQUEST_BLOCKED)) { // The resource request matched Fanboy's Annoyance List's blacklist.
5816 // Add the result to the resource requests.
5817 nestedScrollWebView.addResourceRequest(new String[] {fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
5818 fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5]});
5820 // Increment the blocked requests counters.
5821 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5822 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST);
5824 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5825 if (webViewDisplayed) {
5826 // Updating the UI must be run from the UI thread.
5827 activity.runOnUiThread(() -> {
5828 // Update the menu item titles.
5829 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5831 // Update the options menu if it has been populated.
5832 if (optionsMenu != null) {
5833 optionsBlocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5834 optionsFanboysAnnoyanceListMenuItem.setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST) + " - " +
5835 getString(R.string.fanboys_annoyance_list));
5840 // The resource request was blocked. Return an empty web resource response.
5841 return emptyWebResourceResponse;
5842 } else if (fanboysAnnoyanceListResults[0].equals(BlocklistHelper.REQUEST_ALLOWED)){ // The resource request matched Fanboy's Annoyance List's whitelist.
5843 // Update the whitelist result string array tracker.
5844 whitelistResultStringArray = new String[] {fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
5845 fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5]};
5847 } else if (nestedScrollWebView.getFanboysSocialBlockingListEnabled()) { // Only check Fanboy’s Social Blocking List if Fanboy’s Annoyance List is disabled.
5848 // Check the URL against Fanboy's Annoyance List.
5849 String[] fanboysSocialListResults = blocklistHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, fanboysSocialList);
5851 // Process the Fanboy's Social Blocking List results.
5852 if (fanboysSocialListResults[0].equals(BlocklistHelper.REQUEST_BLOCKED)) { // The resource request matched Fanboy's Social Blocking List's blacklist.
5853 // Add the result to the resource requests.
5854 nestedScrollWebView.addResourceRequest(new String[] {fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3],
5855 fanboysSocialListResults[4], fanboysSocialListResults[5]});
5857 // Increment the blocked requests counters.
5858 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5859 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST);
5861 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5862 if (webViewDisplayed) {
5863 // Updating the UI must be run from the UI thread.
5864 activity.runOnUiThread(() -> {
5865 // Update the menu item titles.
5866 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5868 // Update the options menu if it has been populated.
5869 if (optionsMenu != null) {
5870 optionsBlocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5871 optionsFanboysSocialBlockingListMenuItem.setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST) + " - " +
5872 getString(R.string.fanboys_social_blocking_list));
5877 // The resource request was blocked. Return an empty web resource response.
5878 return emptyWebResourceResponse;
5879 } else if (fanboysSocialListResults[0].equals(BlocklistHelper.REQUEST_ALLOWED)) { // The resource request matched Fanboy's Social Blocking List's whitelist.
5880 // Update the whitelist result string array tracker.
5881 whitelistResultStringArray = new String[] {fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3],
5882 fanboysSocialListResults[4], fanboysSocialListResults[5]};
5886 // Add the request to the log because it hasn't been processed by any of the previous checks.
5887 if (whitelistResultStringArray != null) { // The request was processed by a whitelist.
5888 nestedScrollWebView.addResourceRequest(whitelistResultStringArray);
5889 } else { // The request didn't match any blocklist entry. Log it as a default request.
5890 nestedScrollWebView.addResourceRequest(new String[]{BlocklistHelper.REQUEST_DEFAULT, url});
5893 // The resource request has not been blocked. `return null` loads the requested resource.
5897 // Handle HTTP authentication requests.
5899 public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) {
5900 // Store the handler.
5901 nestedScrollWebView.setHttpAuthHandler(handler);
5903 // Instantiate an HTTP authentication dialog.
5904 DialogFragment httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm, nestedScrollWebView.getWebViewFragmentId());
5906 // Show the HTTP authentication dialog.
5907 httpAuthenticationDialogFragment.show(getSupportFragmentManager(), getString(R.string.http_authentication));
5911 public void onPageStarted(WebView view, String url, Bitmap favicon) {
5912 // Set the padding and layout settings if the app bar is at the top of the screen.
5913 if (!bottomAppBar) {
5914 // Set the top padding of the swipe refresh layout according to the app bar scrolling preference. This can't be done in `appAppSettings()` because the app bar is not yet populated there.
5915 if (scrollAppBar || (inFullScreenBrowsingMode && hideAppBar)) {
5916 // No padding is needed because it will automatically be placed below the app bar layout due to the scrolling layout behavior.
5917 swipeRefreshLayout.setPadding(0, 0, 0, 0);
5919 // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
5920 swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10, defaultProgressViewEndOffset);
5922 // Get the app bar layout height. This can't be done in `applyAppSettings()` because the app bar is not yet populated there.
5923 appBarHeight = appBarLayout.getHeight();
5925 // The swipe refresh layout must be manually moved below the app bar layout.
5926 swipeRefreshLayout.setPadding(0, appBarHeight, 0, 0);
5928 // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
5929 swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10 + appBarHeight, defaultProgressViewEndOffset + appBarHeight);
5933 // Reset the list of resource requests.
5934 nestedScrollWebView.clearResourceRequests();
5936 // Reset the requests counters.
5937 nestedScrollWebView.resetRequestsCounters();
5939 // Get the current page position.
5940 int currentPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
5942 // Update the URL text bar if the page is currently selected and the URL edit text is not currently being edited.
5943 if ((tabLayout.getSelectedTabPosition() == currentPagePosition) && !urlEditText.hasFocus()) {
5944 // Display the formatted URL text.
5945 urlEditText.setText(url);
5947 // Apply text highlighting to the URL text box.
5950 // Hide the keyboard.
5951 inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.getWindowToken(), 0);
5954 // Reset the list of host IP addresses.
5955 nestedScrollWebView.setCurrentIpAddresses("");
5957 // Get a URI for the current URL.
5958 Uri currentUri = Uri.parse(url);
5960 // Get the IP addresses for the host.
5961 new GetHostIpAddresses(activity, getSupportFragmentManager(), nestedScrollWebView).execute(currentUri.getHost());
5963 // Replace Refresh with Stop if the options menu has been created. (The first WebView typically begins loading before the menu items are instantiated.)
5964 if (optionsMenu != null) {
5966 optionsRefreshMenuItem.setTitle(R.string.stop);
5968 // Get the app bar and theme preferences.
5969 boolean displayAdditionalAppBarIcons = sharedPreferences.getBoolean(getString(R.string.display_additional_app_bar_icons_key), false);
5971 // Set the icon if it is displayed in the AppBar. Once the minimum API is >= 26, the blue and black icons can be combined with a tint list.
5972 if (displayAdditionalAppBarIcons) {
5973 optionsRefreshMenuItem.setIcon(R.drawable.close_blue);
5979 public void onPageFinished(WebView view, String url) {
5980 // Flush any cookies to persistent storage. The cookie manager has become very lazy about flushing cookies in recent versions.
5981 if (nestedScrollWebView.getAcceptCookies()) {
5982 CookieManager.getInstance().flush();
5985 // Update the Refresh menu item if the options menu has been created.
5986 if (optionsMenu != null) {
5987 // Reset the Refresh title.
5988 optionsRefreshMenuItem.setTitle(R.string.refresh);
5990 // Get the app bar and theme preferences.
5991 boolean displayAdditionalAppBarIcons = sharedPreferences.getBoolean(getString(R.string.display_additional_app_bar_icons_key), false);
5993 // If the icon is displayed in the app bar, reset it according to the theme.
5994 if (displayAdditionalAppBarIcons) {
5996 optionsRefreshMenuItem.setIcon(R.drawable.refresh_enabled);
6000 // Clear the cache, history, and logcat if Incognito Mode is enabled.
6001 if (incognitoModeEnabled) {
6002 // Clear the cache. `true` includes disk files.
6003 nestedScrollWebView.clearCache(true);
6005 // Clear the back/forward history.
6006 nestedScrollWebView.clearHistory();
6008 // Manually delete cache folders.
6010 // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
6011 // which links to `/data/data/com.stoutner.privacybrowser.standard`.
6012 String privateDataDirectoryString = getApplicationInfo().dataDir;
6014 // Delete the main cache directory.
6015 Runtime.getRuntime().exec("rm -rf " + privateDataDirectoryString + "/cache");
6017 // Delete the secondary `Service Worker` cache directory.
6018 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
6019 Runtime.getRuntime().exec(new String[]{"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
6020 } catch (IOException exception) {
6021 // Do nothing if an error is thrown.
6024 // Clear the logcat.
6026 // Clear the logcat. `-c` clears the logcat. `-b all` clears all the buffers (instead of just crash, main, and system).
6027 Runtime.getRuntime().exec("logcat -b all -c");
6028 } catch (IOException exception) {
6033 // Get the current page position.
6034 int currentPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
6036 // Get the current URL from the nested scroll WebView. This is more accurate than using the URL passed into the method, which is sometimes not the final one.
6037 String currentUrl = nestedScrollWebView.getUrl();
6039 // Get the current tab.
6040 TabLayout.Tab tab = tabLayout.getTabAt(currentPagePosition);
6042 // Update the URL text bar if the page is currently selected and the user is not currently typing in the URL edit text.
6043 // Crash records show that, in some crazy way, it is possible for the current URL to be blank at this point.
6044 // Probably some sort of race condition when Privacy Browser is being resumed.
6045 if ((tabLayout.getSelectedTabPosition() == currentPagePosition) && !urlEditText.hasFocus() && (currentUrl != null)) {
6046 // Check to see if the URL is `about:blank`.
6047 if (currentUrl.equals("about:blank")) { // The WebView is blank.
6048 // Display the hint in the URL edit text.
6049 urlEditText.setText("");
6051 // Request focus for the URL text box.
6052 urlEditText.requestFocus();
6054 // Display the keyboard.
6055 inputMethodManager.showSoftInput(urlEditText, 0);
6057 // Apply the domain settings. This clears any settings from the previous domain.
6058 applyDomainSettings(nestedScrollWebView, "", true, false, false);
6060 // Only populate the title text view if the tab has been fully created.
6062 // Get the custom view from the tab.
6063 View tabView = tab.getCustomView();
6065 // Remove the incorrect warning below that the current tab view might be null.
6066 assert tabView != null;
6068 // Get the title text view from the tab.
6069 TextView tabTitleTextView = tabView.findViewById(R.id.title_textview);
6071 // Set the title as the tab text.
6072 tabTitleTextView.setText(R.string.new_tab);
6074 } else { // The WebView has loaded a webpage.
6075 // Update the URL edit text if it is not currently being edited.
6076 if (!urlEditText.hasFocus()) {
6077 // Sanitize the current URL. This removes unwanted URL elements that were added by redirects, so that they won't be included if the URL is shared.
6078 String sanitizedUrl = sanitizeUrl(currentUrl);
6080 // Display the final URL. Getting the URL from the WebView instead of using the one provided by `onPageFinished()` makes websites like YouTube function correctly.
6081 urlEditText.setText(sanitizedUrl);
6083 // Apply text highlighting to the URL.
6087 // Only populate the title text view if the tab has been fully created.
6089 // Get the custom view from the tab.
6090 View tabView = tab.getCustomView();
6092 // Remove the incorrect warning below that the current tab view might be null.
6093 assert tabView != null;
6095 // Get the title text view from the tab.
6096 TextView tabTitleTextView = tabView.findViewById(R.id.title_textview);
6098 // Set the title as the tab text. Sometimes `onReceivedTitle()` is not called, especially when navigating history.
6099 tabTitleTextView.setText(nestedScrollWebView.getTitle());
6105 // Handle SSL Certificate errors. Suppress the lint warning that ignoring the error might be dangerous.
6106 @SuppressLint("WebViewClientOnReceivedSslError")
6108 public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
6109 // Get the current website SSL certificate.
6110 SslCertificate currentWebsiteSslCertificate = error.getCertificate();
6112 // Extract the individual pieces of information from the current website SSL certificate.
6113 String currentWebsiteIssuedToCName = currentWebsiteSslCertificate.getIssuedTo().getCName();
6114 String currentWebsiteIssuedToOName = currentWebsiteSslCertificate.getIssuedTo().getOName();
6115 String currentWebsiteIssuedToUName = currentWebsiteSslCertificate.getIssuedTo().getUName();
6116 String currentWebsiteIssuedByCName = currentWebsiteSslCertificate.getIssuedBy().getCName();
6117 String currentWebsiteIssuedByOName = currentWebsiteSslCertificate.getIssuedBy().getOName();
6118 String currentWebsiteIssuedByUName = currentWebsiteSslCertificate.getIssuedBy().getUName();
6119 Date currentWebsiteSslStartDate = currentWebsiteSslCertificate.getValidNotBeforeDate();
6120 Date currentWebsiteSslEndDate = currentWebsiteSslCertificate.getValidNotAfterDate();
6122 // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
6123 if (nestedScrollWebView.hasPinnedSslCertificate()) {
6124 // Get the pinned SSL certificate.
6125 Pair<String[], Date[]> pinnedSslCertificatePair = nestedScrollWebView.getPinnedSslCertificate();
6127 // Extract the arrays from the array list.
6128 String[] pinnedSslCertificateStringArray = pinnedSslCertificatePair.getFirst();
6129 Date[] pinnedSslCertificateDateArray = pinnedSslCertificatePair.getSecond();
6131 // Check if the current SSL certificate matches the pinned certificate.
6132 if (currentWebsiteIssuedToCName.equals(pinnedSslCertificateStringArray[0]) && currentWebsiteIssuedToOName.equals(pinnedSslCertificateStringArray[1]) &&
6133 currentWebsiteIssuedToUName.equals(pinnedSslCertificateStringArray[2]) && currentWebsiteIssuedByCName.equals(pinnedSslCertificateStringArray[3]) &&
6134 currentWebsiteIssuedByOName.equals(pinnedSslCertificateStringArray[4]) && currentWebsiteIssuedByUName.equals(pinnedSslCertificateStringArray[5]) &&
6135 currentWebsiteSslStartDate.equals(pinnedSslCertificateDateArray[0]) && currentWebsiteSslEndDate.equals(pinnedSslCertificateDateArray[1])) {
6137 // An SSL certificate is pinned and matches the current domain certificate. Proceed to the website without displaying an error.
6140 } else { // Either there isn't a pinned SSL certificate or it doesn't match the current website certificate.
6141 // Store the SSL error handler.
6142 nestedScrollWebView.setSslErrorHandler(handler);
6144 // Instantiate an SSL certificate error alert dialog.
6145 DialogFragment sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error, nestedScrollWebView.getWebViewFragmentId());
6147 // Try to show the dialog. The SSL error handler continues to function even when the WebView is paused. Attempting to display a dialog in that state leads to a crash.
6149 // Show the SSL certificate error dialog.
6150 sslCertificateErrorDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_error));
6151 } catch (Exception exception) {
6152 // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
6153 pendingDialogsArrayList.add(new PendingDialog(sslCertificateErrorDialogFragment, getString(R.string.ssl_certificate_error)));
6159 // Check to see if the state is being restored.
6160 if (restoringState) { // The state is being restored.
6161 // Resume the nested scroll WebView JavaScript timers.
6162 nestedScrollWebView.resumeTimers();
6163 } else if (pageNumber == 0) { // The first page is being loaded.
6164 // Set this nested scroll WebView as the current WebView.
6165 currentWebView = nestedScrollWebView;
6167 // Initialize the URL to load string.
6168 String urlToLoadString;
6170 // Get the intent that started the app.
6171 Intent launchingIntent = getIntent();
6173 // Reset the intent. This prevents a duplicate tab from being created on restart.
6174 setIntent(new Intent());
6176 // Get the information from the intent.
6177 String launchingIntentAction = launchingIntent.getAction();
6178 Uri launchingIntentUriData = launchingIntent.getData();
6179 String launchingIntentStringExtra = launchingIntent.getStringExtra(Intent.EXTRA_TEXT);
6181 // Parse the launching intent URL.
6182 if ((launchingIntentAction != null) && launchingIntentAction.equals(Intent.ACTION_WEB_SEARCH)) { // The intent contains a search string.
6183 // Create an encoded URL string.
6184 String encodedUrlString;
6186 // Sanitize the search input and convert it to a search.
6188 encodedUrlString = URLEncoder.encode(launchingIntent.getStringExtra(SearchManager.QUERY), "UTF-8");
6189 } catch (UnsupportedEncodingException exception) {
6190 encodedUrlString = "";
6193 // Store the web search as the URL to load.
6194 urlToLoadString = searchURL + encodedUrlString;
6195 } else if (launchingIntentUriData != null) { // The launching intent contains a URL formatted as a URI.
6196 // Store the URI as a URL.
6197 urlToLoadString = launchingIntentUriData.toString();
6198 } else if (launchingIntentStringExtra != null) { // The launching intent contains text that might be a URL.
6200 urlToLoadString = launchingIntentStringExtra;
6201 } else if (!url.equals("")) { // The activity has been restarted.
6202 // Load the saved URL.
6203 urlToLoadString = url;
6204 } else { // The is no URL in the intent.
6205 // Store the homepage to be loaded.
6206 urlToLoadString = sharedPreferences.getString("homepage", getString(R.string.homepage_default_value));
6209 // Load the website if not waiting for the proxy.
6210 if (waitingForProxy) { // Store the URL to be loaded in the Nested Scroll WebView.
6211 nestedScrollWebView.setWaitingForProxyUrlString(urlToLoadString);
6212 } else { // Load the URL.
6213 loadUrl(nestedScrollWebView, urlToLoadString);
6216 // Reset the intent. This prevents a duplicate tab from being created on a subsequent restart if loading an link from a new intent on restart.
6217 // For example, this prevents a duplicate tab if a link is loaded from the Guide after changing the theme in the guide and then changing the theme again in the main activity.
6218 setIntent(new Intent());
6219 } else { // This is not the first tab.
6221 loadUrl(nestedScrollWebView, url);
6223 // Set the focus and display the keyboard if the URL is blank.
6224 if (url.equals("")) {
6225 // Request focus for the URL text box.
6226 urlEditText.requestFocus();
6228 // Create a display keyboard handler.
6229 Handler displayKeyboardHandler = new Handler();
6231 // Create a display keyboard runnable.
6232 Runnable displayKeyboardRunnable = () -> {
6233 // Display the keyboard.
6234 inputMethodManager.showSoftInput(urlEditText, 0);
6237 // Display the keyboard after 100 milliseconds, which leaves enough time for the tab to transition.
6238 displayKeyboardHandler.postDelayed(displayKeyboardRunnable, 100);