2 * Copyright © 2015-2019 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 <https://www.stoutner.com/privacy-browser>.
8 * Privacy Browser 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 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. If not, see <http://www.gnu.org/licenses/>.
22 package com.stoutner.privacybrowser.activities;
24 import android.Manifest;
25 import android.annotation.SuppressLint;
26 import android.app.Activity;
27 import android.app.DownloadManager;
28 import android.app.SearchManager;
29 import android.content.ActivityNotFoundException;
30 import android.content.BroadcastReceiver;
31 import android.content.ClipData;
32 import android.content.ClipboardManager;
33 import android.content.Context;
34 import android.content.Intent;
35 import android.content.IntentFilter;
36 import android.content.SharedPreferences;
37 import android.content.pm.PackageManager;
38 import android.content.res.Configuration;
39 import android.database.Cursor;
40 import android.graphics.Bitmap;
41 import android.graphics.BitmapFactory;
42 import android.graphics.Typeface;
43 import android.graphics.drawable.BitmapDrawable;
44 import android.graphics.drawable.Drawable;
45 import android.net.Uri;
46 import android.net.http.SslCertificate;
47 import android.net.http.SslError;
48 import android.os.Build;
49 import android.os.Bundle;
50 import android.os.Environment;
51 import android.os.Handler;
52 import android.preference.PreferenceManager;
53 import android.print.PrintDocumentAdapter;
54 import android.print.PrintManager;
55 import android.text.Editable;
56 import android.text.Spanned;
57 import android.text.TextWatcher;
58 import android.text.style.ForegroundColorSpan;
59 import android.util.Patterns;
60 import android.view.ContextMenu;
61 import android.view.GestureDetector;
62 import android.view.KeyEvent;
63 import android.view.Menu;
64 import android.view.MenuItem;
65 import android.view.MotionEvent;
66 import android.view.View;
67 import android.view.ViewGroup;
68 import android.view.WindowManager;
69 import android.view.inputmethod.InputMethodManager;
70 import android.webkit.CookieManager;
71 import android.webkit.HttpAuthHandler;
72 import android.webkit.SslErrorHandler;
73 import android.webkit.ValueCallback;
74 import android.webkit.WebChromeClient;
75 import android.webkit.WebResourceResponse;
76 import android.webkit.WebSettings;
77 import android.webkit.WebStorage;
78 import android.webkit.WebView;
79 import android.webkit.WebViewClient;
80 import android.webkit.WebViewDatabase;
81 import android.widget.ArrayAdapter;
82 import android.widget.CursorAdapter;
83 import android.widget.EditText;
84 import android.widget.FrameLayout;
85 import android.widget.ImageView;
86 import android.widget.LinearLayout;
87 import android.widget.ListView;
88 import android.widget.ProgressBar;
89 import android.widget.RadioButton;
90 import android.widget.RelativeLayout;
91 import android.widget.TextView;
93 import androidx.annotation.NonNull;
94 import androidx.appcompat.app.ActionBar;
95 import androidx.appcompat.app.ActionBarDrawerToggle;
96 import androidx.appcompat.app.AppCompatActivity;
97 import androidx.appcompat.widget.Toolbar;
98 import androidx.coordinatorlayout.widget.CoordinatorLayout;
99 import androidx.core.app.ActivityCompat;
100 import androidx.core.content.ContextCompat;
101 import androidx.core.view.GravityCompat;
102 import androidx.drawerlayout.widget.DrawerLayout;
103 import androidx.fragment.app.DialogFragment;
104 import androidx.fragment.app.FragmentManager;
105 import androidx.swiperefreshlayout.widget.SwipeRefreshLayout;
106 import androidx.viewpager.widget.ViewPager;
108 import com.google.android.material.appbar.AppBarLayout;
109 import com.google.android.material.floatingactionbutton.FloatingActionButton;
110 import com.google.android.material.navigation.NavigationView;
111 import com.google.android.material.snackbar.Snackbar;
112 import com.google.android.material.tabs.TabLayout;
114 import com.stoutner.privacybrowser.BuildConfig;
115 import com.stoutner.privacybrowser.R;
116 import com.stoutner.privacybrowser.adapters.WebViewPagerAdapter;
117 import com.stoutner.privacybrowser.asynctasks.GetHostIpAddresses;
118 import com.stoutner.privacybrowser.dialogs.AdConsentDialog;
119 import com.stoutner.privacybrowser.dialogs.CreateBookmarkDialog;
120 import com.stoutner.privacybrowser.dialogs.CreateBookmarkFolderDialog;
121 import com.stoutner.privacybrowser.dialogs.CreateHomeScreenShortcutDialog;
122 import com.stoutner.privacybrowser.dialogs.DownloadFileDialog;
123 import com.stoutner.privacybrowser.dialogs.DownloadImageDialog;
124 import com.stoutner.privacybrowser.dialogs.DownloadLocationPermissionDialog;
125 import com.stoutner.privacybrowser.dialogs.EditBookmarkDialog;
126 import com.stoutner.privacybrowser.dialogs.EditBookmarkFolderDialog;
127 import com.stoutner.privacybrowser.dialogs.HttpAuthenticationDialog;
128 import com.stoutner.privacybrowser.dialogs.SslCertificateErrorDialog;
129 import com.stoutner.privacybrowser.dialogs.UrlHistoryDialog;
130 import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog;
131 import com.stoutner.privacybrowser.fragments.WebViewTabFragment;
132 import com.stoutner.privacybrowser.helpers.AdHelper;
133 import com.stoutner.privacybrowser.helpers.BlockListHelper;
134 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
135 import com.stoutner.privacybrowser.helpers.CheckPinnedMismatchHelper;
136 import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper;
137 import com.stoutner.privacybrowser.helpers.OrbotProxyHelper;
138 import com.stoutner.privacybrowser.views.NestedScrollWebView;
140 import java.io.ByteArrayInputStream;
141 import java.io.ByteArrayOutputStream;
143 import java.io.IOException;
144 import java.io.UnsupportedEncodingException;
145 import java.net.MalformedURLException;
147 import java.net.URLDecoder;
148 import java.net.URLEncoder;
149 import java.util.ArrayList;
150 import java.util.Date;
151 import java.util.HashMap;
152 import java.util.HashSet;
153 import java.util.List;
154 import java.util.Map;
155 import java.util.Set;
157 // AppCompatActivity from android.support.v7.app.AppCompatActivity must be used to have access to the SupportActionBar until the minimum API is >= 21.
158 public class MainWebViewActivity extends AppCompatActivity implements CreateBookmarkDialog.CreateBookmarkListener, CreateBookmarkFolderDialog.CreateBookmarkFolderListener,
159 DownloadFileDialog.DownloadFileListener, DownloadImageDialog.DownloadImageListener, DownloadLocationPermissionDialog.DownloadLocationPermissionDialogListener, EditBookmarkDialog.EditBookmarkListener,
160 EditBookmarkFolderDialog.EditBookmarkFolderListener, NavigationView.OnNavigationItemSelectedListener, WebViewTabFragment.NewTabListener {
162 // `orbotStatus` is public static so it can be accessed from `OrbotProxyHelper`. It is also used in `onCreate()`, `onResume()`, and `applyProxyThroughOrbot()`.
163 public static String orbotStatus;
165 // The WebView pager adapter is accessed from `HttpAuthenticationDialog`, `PinnedMismatchDialog`, and `SslCertificateErrorDialog`. It is also used in `onCreate()`, `onResume()`, and `addTab()`.
166 public static WebViewPagerAdapter webViewPagerAdapter;
168 // The load URL on restart variables are public static so they can be accessed from `BookmarksActivity`. They are used in `onRestart()`.
169 public static boolean loadUrlOnRestart;
170 public static String urlToLoadOnRestart;
172 // `restartFromBookmarksActivity` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onRestart()`.
173 public static boolean restartFromBookmarksActivity;
175 // `currentBookmarksFolder` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onCreate()`, `onBackPressed()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`,
176 // `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
177 public static String currentBookmarksFolder;
179 // The user agent constants are public static so they can be accessed from `SettingsFragment`, `DomainsActivity`, and `DomainSettingsFragment`.
180 public final static int UNRECOGNIZED_USER_AGENT = -1;
181 public final static int SETTINGS_WEBVIEW_DEFAULT_USER_AGENT = 1;
182 public final static int SETTINGS_CUSTOM_USER_AGENT = 12;
183 public final static int DOMAINS_SYSTEM_DEFAULT_USER_AGENT = 0;
184 public final static int DOMAINS_WEBVIEW_DEFAULT_USER_AGENT = 2;
185 public final static int DOMAINS_CUSTOM_USER_AGENT = 13;
189 // The current WebView is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`,
190 // `findNextOnPage()`, `closeFindOnPage()`, `loadUrlFromTextBox()`, `onSslMismatchBack()`, `applyProxyThroughOrbot()`, and `applyDomainSettings()`.
191 private NestedScrollWebView currentWebView;
193 // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrl()`.
194 private final Map<String, String> customHeaders = new HashMap<>();
196 // The search URL is set in `applyProxyThroughOrbot()` and used in `onCreate()`, `onNewIntent()`, `loadURLFromTextBox()`, and `initializeWebView()`.
197 private String searchURL;
199 // The options menu is set in `onCreateOptionsMenu()` and used in `onOptionsItemSelected()`, `updatePrivacyIcons()`, and `initializeWebView()`.
200 private Menu optionsMenu;
202 // The blocklists are populated in `onCreate()` and accessed from `initializeWebView()`.
203 private ArrayList<List<String[]>> easyList;
204 private ArrayList<List<String[]>> easyPrivacy;
205 private ArrayList<List<String[]>> fanboysAnnoyanceList;
206 private ArrayList<List<String[]>> fanboysSocialList;
207 private ArrayList<List<String[]>> ultraPrivacy;
209 // `webViewDefaultUserAgent` is used in `onCreate()` and `onPrepareOptionsMenu()`.
210 private String webViewDefaultUserAgent;
212 // `proxyThroughOrbot` is used in `onRestart()`, `onOptionsItemSelected()`, `applyAppSettings()`, and `applyProxyThroughOrbot()`.
213 private boolean proxyThroughOrbot;
215 // The incognito mode is set in `applyAppSettings()` and used in `initializeWebView()`.
216 private boolean incognitoModeEnabled;
218 // The full screen browsing mode tracker is set it `applyAppSettings()` and used in `initializeWebView()`.
219 private boolean fullScreenBrowsingModeEnabled;
221 // `inFullScreenBrowsingMode` is used in `onCreate()`, `onConfigurationChanged()`, and `applyAppSettings()`.
222 private boolean inFullScreenBrowsingMode;
224 // The app bar trackers are set in `applyAppSettings()` and used in `initializeWebView()`.
225 private boolean hideAppBar;
226 private boolean scrollAppBar;
228 // The loading new intent tracker is set in `onNewIntent()` and used in `setCurrentWebView()`.
229 private boolean loadingNewIntent;
231 // `reapplyDomainSettingsOnRestart` is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, and `onAddDomain()`, .
232 private boolean reapplyDomainSettingsOnRestart;
234 // `reapplyAppSettingsOnRestart` is used in `onNavigationItemSelected()` and `onRestart()`.
235 private boolean reapplyAppSettingsOnRestart;
237 // `displayingFullScreenVideo` is used in `onCreate()` and `onResume()`.
238 private boolean displayingFullScreenVideo;
240 // `orbotStatusBroadcastReceiver` is used in `onCreate()` and `onDestroy()`.
241 private BroadcastReceiver orbotStatusBroadcastReceiver;
243 // `waitingForOrbot` is used in `onCreate()`, `onResume()`, and `applyProxyThroughOrbot()`.
244 private boolean waitingForOrbot;
246 // The action bar drawer toggle is initialized in `onCreate()` and used in `onResume()`.
247 private ActionBarDrawerToggle actionBarDrawerToggle;
249 // The color spans are used in `onCreate()` and `highlightUrlText()`.
250 private ForegroundColorSpan redColorSpan;
251 private ForegroundColorSpan initialGrayColorSpan;
252 private ForegroundColorSpan finalGrayColorSpan;
254 // The drawer header padding variables are used in `onCreate()` and `onConfigurationChanged()`.
255 private int drawerHeaderPaddingLeftAndRight;
256 private int drawerHeaderPaddingTop;
257 private int drawerHeaderPaddingBottom;
259 // `bookmarksDatabaseHelper` is used in `onCreate()`, `onDestroy`, `onOptionsItemSelected()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`,
260 // and `loadBookmarksFolder()`.
261 private BookmarksDatabaseHelper bookmarksDatabaseHelper;
263 // `bookmarksCursor` is used in `onDestroy()`, `onOptionsItemSelected()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
264 private Cursor bookmarksCursor;
266 // `bookmarksCursorAdapter` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()` `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
267 private CursorAdapter bookmarksCursorAdapter;
269 // `oldFolderNameString` is used in `onCreate()` and `onSaveEditBookmarkFolder()`.
270 private String oldFolderNameString;
272 // `fileChooserCallback` is used in `onCreate()` and `onActivityResult()`.
273 private ValueCallback<Uri[]> fileChooserCallback;
275 // The default progress view offsets are set in `onCreate()` and used in `initializeWebView()`.
276 private int defaultProgressViewStartOffset;
277 private int defaultProgressViewEndOffset;
279 // The swipe refresh layout top padding is used when exiting full screen browsing mode. It is used in an inner class in `initializeWebView()`.
280 private int swipeRefreshLayoutPaddingTop;
282 // The download strings are used in `onCreate()`, `onRequestPermissionResult()` and `initializeWebView()`.
283 private String downloadUrl;
284 private String downloadContentDisposition;
285 private long downloadContentLength;
287 // `downloadImageUrl` is used in `onCreateContextMenu()` and `onRequestPermissionResult()`.
288 private String downloadImageUrl;
290 // The request codes are used in `onCreate()`, `onCreateContextMenu()`, `onCloseDownloadLocationPermissionDialog()`, `onRequestPermissionResult()`, and `initializeWebView()`.
291 private final int DOWNLOAD_FILE_REQUEST_CODE = 1;
292 private final int DOWNLOAD_IMAGE_REQUEST_CODE = 2;
295 // Remove the warning about needing to override `performClick()` when using an `OnTouchListener` with `WebView`.
296 @SuppressLint("ClickableViewAccessibility")
297 protected void onCreate(Bundle savedInstanceState) {
298 // Get a handle for the shared preferences.
299 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
301 // Get the theme and screenshot preferences.
302 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
303 boolean allowScreenshots = sharedPreferences.getBoolean("allow_screenshots", false);
305 // Disable screenshots if not allowed.
306 if (!allowScreenshots) {
307 getWindow().addFlags(WindowManager.LayoutParams.FLAG_SECURE);
310 // Set the activity theme.
312 setTheme(R.style.PrivacyBrowserDark);
314 setTheme(R.style.PrivacyBrowserLight);
317 // Run the default commands.
318 super.onCreate(savedInstanceState);
320 // Set the content view.
321 setContentView(R.layout.main_framelayout);
323 // Get a handle for the input method.
324 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
326 // Remove the lint warning below that the input method manager might be null.
327 assert inputMethodManager != null;
329 // Get a handle for the toolbar.
330 Toolbar toolbar = findViewById(R.id.toolbar);
332 // Set the action bar. `SupportActionBar` must be used until the minimum API is >= 21.
333 setSupportActionBar(toolbar);
335 // Get a handle for the action bar.
336 ActionBar actionBar = getSupportActionBar();
338 // This is needed to get rid of the Android Studio warning that the action bar might be null.
339 assert actionBar != null;
341 // Add the custom layout, which shows the URL text bar.
342 actionBar.setCustomView(R.layout.url_app_bar);
343 actionBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
345 // Initialize the foreground color spans for highlighting the URLs. We have to use the deprecated `getColor()` until API >= 23.
346 redColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.red_a700));
347 initialGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
348 finalGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
350 // Get handles for the URL views.
351 EditText urlEditText = findViewById(R.id.url_edittext);
353 // Remove the formatting from `urlTextBar` when the user is editing the text.
354 urlEditText.setOnFocusChangeListener((View v, boolean hasFocus) -> {
355 if (hasFocus) { // The user is editing the URL text box.
356 // Remove the highlighting.
357 urlEditText.getText().removeSpan(redColorSpan);
358 urlEditText.getText().removeSpan(initialGrayColorSpan);
359 urlEditText.getText().removeSpan(finalGrayColorSpan);
360 } else { // The user has stopped editing the URL text box.
361 // Move to the beginning of the string.
362 urlEditText.setSelection(0);
364 // Reapply the highlighting.
369 // Set the go button on the keyboard to load the URL in `urlTextBox`.
370 urlEditText.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
371 // If the event is a key-down event on the `enter` button, load the URL.
372 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
373 // Load the URL into the mainWebView and consume the event.
374 loadUrlFromTextBox();
376 // If the enter key was pressed, consume the event.
379 // If any other key was pressed, do not consume the event.
384 // Initialize the Orbot status and the waiting for Orbot trackers.
385 orbotStatus = "unknown";
386 waitingForOrbot = false;
388 // Create an Orbot status `BroadcastReceiver`.
389 orbotStatusBroadcastReceiver = new BroadcastReceiver() {
391 public void onReceive(Context context, Intent intent) {
392 // Store the content of the status message in `orbotStatus`.
393 orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS");
395 // If Privacy Browser is waiting on Orbot, load the website now that Orbot is connected.
396 if (orbotStatus.equals("ON") && waitingForOrbot) {
397 // Reset the waiting for Orbot status.
398 waitingForOrbot = false;
400 // Get the intent that started the app.
401 Intent launchingIntent = getIntent();
403 // Get the information from the intent.
404 String launchingIntentAction = launchingIntent.getAction();
405 Uri launchingIntentUriData = launchingIntent.getData();
407 // If the intent action is a web search, perform the search.
408 if ((launchingIntentAction != null) && launchingIntentAction.equals(Intent.ACTION_WEB_SEARCH)) {
409 // Create an encoded URL string.
410 String encodedUrlString;
412 // Sanitize the search input and convert it to a search.
414 encodedUrlString = URLEncoder.encode(launchingIntent.getStringExtra(SearchManager.QUERY), "UTF-8");
415 } catch (UnsupportedEncodingException exception) {
416 encodedUrlString = "";
419 // Load the completed search URL.
420 loadUrl(searchURL + encodedUrlString);
421 } else if (launchingIntentUriData != null){ // Check to see if the intent contains a new URL.
422 // Load the URL from the intent.
423 loadUrl(launchingIntentUriData.toString());
424 } else { // The is no URL in the intent.
425 // Select the homepage based on the proxy through Orbot status.
426 if (proxyThroughOrbot) {
427 // Load the Tor homepage.
428 loadUrl(sharedPreferences.getString("tor_homepage", getString(R.string.tor_homepage_default_value)));
430 // Load the normal homepage.
431 loadUrl(sharedPreferences.getString("homepage", getString(R.string.homepage_default_value)));
438 // Register `orbotStatusBroadcastReceiver` on `this` context.
439 this.registerReceiver(orbotStatusBroadcastReceiver, new IntentFilter("org.torproject.android.intent.action.STATUS"));
441 // Instantiate the blocklist helper.
442 BlockListHelper blockListHelper = new BlockListHelper();
444 // Parse the block lists.
445 easyList = blockListHelper.parseBlockList(getAssets(), "blocklists/easylist.txt");
446 easyPrivacy = blockListHelper.parseBlockList(getAssets(), "blocklists/easyprivacy.txt");
447 fanboysAnnoyanceList = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-annoyance.txt");
448 fanboysSocialList = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-social.txt");
449 ultraPrivacy = blockListHelper.parseBlockList(getAssets(), "blocklists/ultraprivacy.txt");
451 // Get handles for views that need to be modified.
452 DrawerLayout drawerLayout = findViewById(R.id.drawerlayout);
453 NavigationView navigationView = findViewById(R.id.navigationview);
454 TabLayout tabLayout = findViewById(R.id.tablayout);
455 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
456 ViewPager webViewPager = findViewById(R.id.webviewpager);
457 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
458 FloatingActionButton launchBookmarksActivityFab = findViewById(R.id.launch_bookmarks_activity_fab);
459 FloatingActionButton createBookmarkFolderFab = findViewById(R.id.create_bookmark_folder_fab);
460 FloatingActionButton createBookmarkFab = findViewById(R.id.create_bookmark_fab);
461 EditText findOnPageEditText = findViewById(R.id.find_on_page_edittext);
463 // Listen for touches on the navigation menu.
464 navigationView.setNavigationItemSelectedListener(this);
466 // Get handles for the navigation menu and the back and forward menu items. The menu is zero-based.
467 Menu navigationMenu = navigationView.getMenu();
468 MenuItem navigationCloseTabMenuItem = navigationMenu.getItem(0);
469 MenuItem navigationBackMenuItem = navigationMenu.getItem(3);
470 MenuItem navigationForwardMenuItem = navigationMenu.getItem(4);
471 MenuItem navigationHistoryMenuItem = navigationMenu.getItem(5);
472 MenuItem navigationRequestsMenuItem = navigationMenu.getItem(6);
474 // Initialize the web view pager adapter.
475 webViewPagerAdapter = new WebViewPagerAdapter(getSupportFragmentManager());
477 // Set the pager adapter on the web view pager.
478 webViewPager.setAdapter(webViewPagerAdapter);
480 // Store up to 100 tabs in memory.
481 webViewPager.setOffscreenPageLimit(100);
483 // Update the web view pager every time a tab is modified.
484 webViewPager.addOnPageChangeListener(new ViewPager.OnPageChangeListener() {
486 public void onPageScrolled(int position, float positionOffset, int positionOffsetPixels) {
491 public void onPageSelected(int position) {
492 // Close the find on page bar if it is open.
493 closeFindOnPage(null);
495 // Set the current WebView.
496 setCurrentWebView(position);
498 // Select the corresponding tab if it does not match the currently selected page. This will happen if the page was scrolled via swiping in the view pager or by creating a new tab.
499 if (tabLayout.getSelectedTabPosition() != position) {
500 // Create a handler to select the tab.
501 Handler selectTabHandler = new Handler();
503 // Create a runnable select the new tab.
504 Runnable selectTabRunnable = () -> {
505 // Get a handle for the tab.
506 TabLayout.Tab tab = tabLayout.getTabAt(position);
508 // Assert that the tab is not null.
515 // Select the tab layout after 100 milliseconds, which leaves enough time for a new tab to be created.
516 selectTabHandler.postDelayed(selectTabRunnable, 100);
521 public void onPageScrollStateChanged(int state) {
526 // Display the View SSL Certificate dialog when the currently selected tab is reselected.
527 tabLayout.addOnTabSelectedListener(new TabLayout.OnTabSelectedListener() {
529 public void onTabSelected(TabLayout.Tab tab) {
530 // Select the same page in the view pager.
531 webViewPager.setCurrentItem(tab.getPosition());
535 public void onTabUnselected(TabLayout.Tab tab) {
540 public void onTabReselected(TabLayout.Tab tab) {
541 // Instantiate the View SSL Certificate dialog.
542 DialogFragment viewSslCertificateDialogFragment = ViewSslCertificateDialog.displayDialog(currentWebView.getWebViewFragmentId());
544 // Display the View SSL Certificate dialog.
545 viewSslCertificateDialogFragment.show(getSupportFragmentManager(), getString(R.string.view_ssl_certificate));
549 // Add the first tab.
552 // Set the bookmarks drawer resources according to the theme. This can't be done in the layout due to compatibility issues with the `DrawerLayout` support widget.
553 // The deprecated `getResources().getDrawable()` must be used until the minimum API >= 21 and and `getResources().getColor()` must be used until the minimum API >= 23.
555 launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_dark));
556 createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_dark));
557 createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_dark));
558 bookmarksListView.setBackgroundColor(getResources().getColor(R.color.gray_850));
560 launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_light));
561 createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_light));
562 createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_light));
563 bookmarksListView.setBackgroundColor(getResources().getColor(R.color.white));
566 // Set the launch bookmarks activity FAB to launch the bookmarks activity.
567 launchBookmarksActivityFab.setOnClickListener(v -> {
568 // Get a copy of the favorite icon bitmap.
569 Bitmap favoriteIconBitmap = currentWebView.getFavoriteOrDefaultIcon();
571 // Create a favorite icon byte array output stream.
572 ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
574 // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
575 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
577 // Convert the favorite icon byte array stream to a byte array.
578 byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
580 // Create an intent to launch the bookmarks activity.
581 Intent bookmarksIntent = new Intent(getApplicationContext(), BookmarksActivity.class);
583 // Add the extra information to the intent.
584 bookmarksIntent.putExtra("current_url", currentWebView.getUrl());
585 bookmarksIntent.putExtra("current_title", currentWebView.getTitle());
586 bookmarksIntent.putExtra("current_folder", currentBookmarksFolder);
587 bookmarksIntent.putExtra("favorite_icon_byte_array", favoriteIconByteArray);
590 startActivity(bookmarksIntent);
593 // Set the create new bookmark folder FAB to display an alert dialog.
594 createBookmarkFolderFab.setOnClickListener(v -> {
595 // Create a create bookmark folder dialog.
596 DialogFragment createBookmarkFolderDialog = CreateBookmarkFolderDialog.createBookmarkFolder(currentWebView.getFavoriteOrDefaultIcon());
598 // Show the create bookmark folder dialog.
599 createBookmarkFolderDialog.show(getSupportFragmentManager(), getString(R.string.create_folder));
602 // Set the create new bookmark FAB to display an alert dialog.
603 createBookmarkFab.setOnClickListener(view -> {
604 // Instantiate the create bookmark dialog.
605 DialogFragment createBookmarkDialog = CreateBookmarkDialog.createBookmark(currentWebView.getUrl(), currentWebView.getTitle(), currentWebView.getFavoriteOrDefaultIcon());
607 // Display the create bookmark dialog.
608 createBookmarkDialog.show(getSupportFragmentManager(), getString(R.string.create_bookmark));
611 // Search for the string on the page whenever a character changes in the `findOnPageEditText`.
612 findOnPageEditText.addTextChangedListener(new TextWatcher() {
614 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
619 public void onTextChanged(CharSequence s, int start, int before, int count) {
624 public void afterTextChanged(Editable s) {
625 // 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.
626 if (currentWebView != null) {
627 currentWebView.findAllAsync(findOnPageEditText.getText().toString());
632 // Set the `check mark` button for the `findOnPageEditText` keyboard to close the soft keyboard.
633 findOnPageEditText.setOnKeyListener((v, keyCode, event) -> {
634 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) { // The `enter` key was pressed.
635 // Hide the soft keyboard.
636 inputMethodManager.hideSoftInputFromWindow(currentWebView.getWindowToken(), 0);
638 // Consume the event.
640 } else { // A different key was pressed.
641 // Do not consume the event.
646 // Implement swipe to refresh.
647 swipeRefreshLayout.setOnRefreshListener(() -> currentWebView.reload());
649 // Store the default progress view offsets for use later in `initializeWebView()`.
650 defaultProgressViewStartOffset = swipeRefreshLayout.getProgressViewStartOffset();
651 defaultProgressViewEndOffset = swipeRefreshLayout.getProgressViewEndOffset();
653 // Set the swipe to refresh color according to the theme.
655 swipeRefreshLayout.setColorSchemeResources(R.color.blue_800);
656 swipeRefreshLayout.setProgressBackgroundColorSchemeResource(R.color.gray_850);
658 swipeRefreshLayout.setColorSchemeResources(R.color.blue_500);
661 // `DrawerTitle` identifies the `DrawerLayouts` in accessibility mode.
662 drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer));
663 drawerLayout.setDrawerTitle(GravityCompat.END, getString(R.string.bookmarks));
665 // Initialize the bookmarks database helper. The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
666 bookmarksDatabaseHelper = new BookmarksDatabaseHelper(this, null, null, 0);
668 // Initialize `currentBookmarksFolder`. `""` is the home folder in the database.
669 currentBookmarksFolder = "";
671 // Load the home folder, which is `""` in the database.
672 loadBookmarksFolder();
674 bookmarksListView.setOnItemClickListener((parent, view, position, id) -> {
675 // Convert the id from long to int to match the format of the bookmarks database.
676 int databaseID = (int) id;
678 // Get the bookmark cursor for this ID and move it to the first row.
679 Cursor bookmarkCursor = bookmarksDatabaseHelper.getBookmark(databaseID);
680 bookmarkCursor.moveToFirst();
682 // Act upon the bookmark according to the type.
683 if (bookmarkCursor.getInt(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) { // The selected bookmark is a folder.
684 // Store the new folder name in `currentBookmarksFolder`.
685 currentBookmarksFolder = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
687 // Load the new folder.
688 loadBookmarksFolder();
689 } else { // The selected bookmark is not a folder.
690 // Load the bookmark URL.
691 loadUrl(bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_URL)));
693 // Close the bookmarks drawer.
694 drawerLayout.closeDrawer(GravityCompat.END);
697 // Close the `Cursor`.
698 bookmarkCursor.close();
701 bookmarksListView.setOnItemLongClickListener((parent, view, position, id) -> {
702 // Convert the database ID from `long` to `int`.
703 int databaseId = (int) id;
705 // Find out if the selected bookmark is a folder.
706 boolean isFolder = bookmarksDatabaseHelper.isFolder(databaseId);
709 // Save the current folder name, which is used in `onSaveEditBookmarkFolder()`.
710 oldFolderNameString = bookmarksCursor.getString(bookmarksCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
712 // Show the edit bookmark folder `AlertDialog` and name the instance `@string/edit_folder`.
713 DialogFragment editBookmarkFolderDialog = EditBookmarkFolderDialog.folderDatabaseId(databaseId, currentWebView.getFavoriteOrDefaultIcon());
714 editBookmarkFolderDialog.show(getSupportFragmentManager(), getString(R.string.edit_folder));
716 // Show the edit bookmark `AlertDialog` and name the instance `@string/edit_bookmark`.
717 DialogFragment editBookmarkDialog = EditBookmarkDialog.bookmarkDatabaseId(databaseId, currentWebView.getFavoriteOrDefaultIcon());
718 editBookmarkDialog.show(getSupportFragmentManager(), getString(R.string.edit_bookmark));
721 // Consume the event.
725 // Get the status bar pixel size.
726 int statusBarResourceId = getResources().getIdentifier("status_bar_height", "dimen", "android");
727 int statusBarPixelSize = getResources().getDimensionPixelSize(statusBarResourceId);
729 // Get the resource density.
730 float screenDensity = getResources().getDisplayMetrics().density;
732 // Calculate the drawer header padding. This is used to move the text in the drawer headers below any cutouts.
733 drawerHeaderPaddingLeftAndRight = (int) (15 * screenDensity);
734 drawerHeaderPaddingTop = statusBarPixelSize + (int) (4 * screenDensity);
735 drawerHeaderPaddingBottom = (int) (8 * screenDensity);
737 // The drawer listener is used to update the navigation menu.`
738 drawerLayout.addDrawerListener(new DrawerLayout.DrawerListener() {
740 public void onDrawerSlide(@NonNull View drawerView, float slideOffset) {
744 public void onDrawerOpened(@NonNull View drawerView) {
748 public void onDrawerClosed(@NonNull View drawerView) {
752 public void onDrawerStateChanged(int newState) {
753 if ((newState == DrawerLayout.STATE_SETTLING) || (newState == DrawerLayout.STATE_DRAGGING)) { // A drawer is opening or closing.
754 // Get handles for the drawer headers.
755 TextView navigationHeaderTextView = findViewById(R.id.navigationText);
756 TextView bookmarksHeaderTextView = findViewById(R.id.bookmarks_title_textview);
758 // Apply the navigation header paddings if the view is not null (sometimes it is null if another activity has already started). This moves the text in the header below any cutouts.
759 if (navigationHeaderTextView != null) {
760 navigationHeaderTextView.setPadding(drawerHeaderPaddingLeftAndRight, drawerHeaderPaddingTop, drawerHeaderPaddingLeftAndRight, drawerHeaderPaddingBottom);
763 // Apply the bookmarks header paddings if the view is not null (sometimes it is null if another activity has already started). This moves the text in the header below any cutouts.
764 if (bookmarksHeaderTextView != null) {
765 bookmarksHeaderTextView.setPadding(drawerHeaderPaddingLeftAndRight, drawerHeaderPaddingTop, drawerHeaderPaddingLeftAndRight, drawerHeaderPaddingBottom);
768 // Update the navigation menu items.
769 navigationCloseTabMenuItem.setEnabled(tabLayout.getTabCount() > 1);
770 navigationBackMenuItem.setEnabled(currentWebView.canGoBack());
771 navigationForwardMenuItem.setEnabled(currentWebView.canGoForward());
772 navigationHistoryMenuItem.setEnabled((currentWebView.canGoBack() || currentWebView.canGoForward()));
773 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + currentWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
775 // Hide the keyboard (if displayed).
776 inputMethodManager.hideSoftInputFromWindow(currentWebView.getWindowToken(), 0);
778 // Clear the focus from from the URL text box and the WebView. This removes any text selection markers and context menus, which otherwise draw above the open drawers.
779 urlEditText.clearFocus();
780 currentWebView.clearFocus();
785 // Create the hamburger icon at the start of the AppBar.
786 actionBarDrawerToggle = new ActionBarDrawerToggle(this, drawerLayout, toolbar, R.string.open_navigation_drawer, R.string.close_navigation_drawer);
788 // 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).
789 customHeaders.put("X-Requested-With", "");
791 // Initialize the default preference values the first time the program is run. `false` keeps this command from resetting any current preferences back to default.
792 PreferenceManager.setDefaultValues(this, R.xml.preferences, false);
794 // Inflate a bare WebView to get the default user agent. It is not used to render content on the screen.
795 @SuppressLint("InflateParams") View webViewLayout = getLayoutInflater().inflate(R.layout.bare_webview, null, false);
797 // Get a handle for the WebView.
798 WebView bareWebView = webViewLayout.findViewById(R.id.bare_webview);
800 // Store the default user agent.
801 webViewDefaultUserAgent = bareWebView.getSettings().getUserAgentString();
803 // Destroy the bare WebView.
804 bareWebView.destroy();
808 protected void onNewIntent(Intent intent) {
809 // Get the information from the intent.
810 String intentAction = intent.getAction();
811 Uri intentUriData = intent.getData();
813 // Determine if this is a web search.
814 boolean isWebSearch = ((intentAction != null) && intentAction.equals(Intent.ACTION_WEB_SEARCH));
816 // 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.
817 if (intentUriData != null || isWebSearch) {
818 // Get the shared preferences.
819 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
821 // Add a new tab if specified in the preferences.
822 if (sharedPreferences.getBoolean("open_intents_in_new_tab", true)) {
823 // Set the loading new intent flag.
824 loadingNewIntent = true;
830 // Create a URL string.
833 // If the intent action is a web search, perform the search.
835 // Create an encoded URL string.
836 String encodedUrlString;
838 // Sanitize the search input and convert it to a search.
840 encodedUrlString = URLEncoder.encode(intent.getStringExtra(SearchManager.QUERY), "UTF-8");
841 } catch (UnsupportedEncodingException exception) {
842 encodedUrlString = "";
845 // Add the base search URL.
846 url = searchURL + encodedUrlString;
847 } else { // The intent should contain a URL.
848 // Set the intent data as the URL.
849 url = intentUriData.toString();
855 // Get a handle for the drawer layout.
856 DrawerLayout drawerLayout = findViewById(R.id.drawerlayout);
858 // Close the navigation drawer if it is open.
859 if (drawerLayout.isDrawerVisible(GravityCompat.START)) {
860 drawerLayout.closeDrawer(GravityCompat.START);
863 // Close the bookmarks drawer if it is open.
864 if (drawerLayout.isDrawerVisible(GravityCompat.END)) {
865 drawerLayout.closeDrawer(GravityCompat.END);
868 // Clear the keyboard if displayed and remove the focus on the urlTextBar if it has it.
869 currentWebView.requestFocus();
874 public void onRestart() {
875 // Run the default commands.
878 // Make sure Orbot is running if Privacy Browser is proxying through Orbot.
879 if (proxyThroughOrbot) {
880 // Request Orbot to start. If Orbot is already running no hard will be caused by this request.
881 Intent orbotIntent = new Intent("org.torproject.android.intent.action.START");
883 // Send the intent to the Orbot package.
884 orbotIntent.setPackage("org.torproject.android");
887 sendBroadcast(orbotIntent);
890 // Apply the app settings if returning from the Settings activity.
891 if (reapplyAppSettingsOnRestart) {
892 // Reset the reapply app settings on restart tracker.
893 reapplyAppSettingsOnRestart = false;
895 // Apply the app settings.
899 // Apply the domain settings if returning from the settings or domains activity.
900 if (reapplyDomainSettingsOnRestart) {
901 // Reset the reapply domain settings on restart tracker.
902 reapplyDomainSettingsOnRestart = false;
904 // Reapply the domain settings for each tab.
905 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
906 // Get the WebView tab fragment.
907 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
909 // Get the fragment view.
910 View fragmentView = webViewTabFragment.getView();
912 // Only reload the WebViews if they exist.
913 if (fragmentView != null) {
914 // Get the nested scroll WebView from the tab fragment.
915 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
917 // Reset the current domain name so the domain settings will be reapplied.
918 nestedScrollWebView.resetCurrentDomainName();
920 // Reapply the domain settings if the URL is not null, which can happen if an empty tab is active when returning from settings.
921 if (nestedScrollWebView.getUrl() != null) {
922 applyDomainSettings(nestedScrollWebView, nestedScrollWebView.getUrl(), false, true);
928 // Load the URL on restart (used when loading a bookmark).
929 if (loadUrlOnRestart) {
930 // Load the specified URL.
931 loadUrl(urlToLoadOnRestart);
933 // Reset the load on restart tracker.
934 loadUrlOnRestart = false;
937 // Update the bookmarks drawer if returning from the Bookmarks activity.
938 if (restartFromBookmarksActivity) {
939 // Get a handle for the drawer layout.
940 DrawerLayout drawerLayout = findViewById(R.id.drawerlayout);
942 // Close the bookmarks drawer.
943 drawerLayout.closeDrawer(GravityCompat.END);
945 // Reload the bookmarks drawer.
946 loadBookmarksFolder();
948 // Reset `restartFromBookmarksActivity`.
949 restartFromBookmarksActivity = false;
952 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step. This can be important if the screen was rotated.
953 updatePrivacyIcons(true);
956 // `onResume()` runs after `onStart()`, which runs after `onCreate()` and `onRestart()`.
958 public void onResume() {
959 // Run the default commands.
962 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
963 // Get the WebView tab fragment.
964 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
966 // Get the fragment view.
967 View fragmentView = webViewTabFragment.getView();
969 // Only resume the WebViews if they exist (they won't when the app is first created).
970 if (fragmentView != null) {
971 // Get the nested scroll WebView from the tab fragment.
972 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
974 // Resume the nested scroll WebView JavaScript timers.
975 nestedScrollWebView.resumeTimers();
977 // Resume the nested scroll WebView.
978 nestedScrollWebView.onResume();
982 // Display a message to the user if waiting for Orbot.
983 if (waitingForOrbot && !orbotStatus.equals("ON")) {
984 // Disable the wide view port so that the waiting for Orbot text is displayed correctly.
985 currentWebView.getSettings().setUseWideViewPort(false);
987 // Load a waiting page. `null` specifies no encoding, which defaults to ASCII.
988 currentWebView.loadData("<html><body><br/><center><h1>" + getString(R.string.waiting_for_orbot) + "</h1></center></body></html>", "text/html", null);
991 if (displayingFullScreenVideo || inFullScreenBrowsingMode) {
992 // Get a handle for the root frame layouts.
993 FrameLayout rootFrameLayout = findViewById(R.id.root_framelayout);
995 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
996 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
998 /* Hide the system bars.
999 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
1000 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
1001 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
1002 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
1004 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
1005 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
1006 } else if (BuildConfig.FLAVOR.contentEquals("free")) { // Resume the adView for the free flavor.
1008 AdHelper.resumeAd(findViewById(R.id.adview));
1013 public void onPause() {
1014 // Run the default commands.
1017 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
1018 // Get the WebView tab fragment.
1019 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
1021 // Get the fragment view.
1022 View fragmentView = webViewTabFragment.getView();
1024 // Only pause the WebViews if they exist (they won't when the app is first created).
1025 if (fragmentView != null) {
1026 // Get the nested scroll WebView from the tab fragment.
1027 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
1029 // Pause the nested scroll WebView.
1030 nestedScrollWebView.onPause();
1032 // Pause the nested scroll WebView JavaScript timers.
1033 nestedScrollWebView.pauseTimers();
1037 // Pause the ad or it will continue to consume resources in the background on the free flavor.
1038 if (BuildConfig.FLAVOR.contentEquals("free")) {
1040 AdHelper.pauseAd(findViewById(R.id.adview));
1045 public void onDestroy() {
1046 // Unregister the Orbot status broadcast receiver.
1047 this.unregisterReceiver(orbotStatusBroadcastReceiver);
1049 // Close the bookmarks cursor and database.
1050 bookmarksCursor.close();
1051 bookmarksDatabaseHelper.close();
1053 // Run the default commands.
1058 public boolean onCreateOptionsMenu(Menu menu) {
1059 // Inflate the menu. This adds items to the action bar if it is present.
1060 getMenuInflater().inflate(R.menu.webview_options_menu, menu);
1062 // Store a handle for the options menu so it can be used by `onOptionsItemSelected()` and `updatePrivacyIcons()`.
1065 // Set the initial status of the privacy icons. `false` does not call `invalidateOptionsMenu` as the last step.
1066 updatePrivacyIcons(false);
1068 // Get handles for the menu items.
1069 MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1070 MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1071 MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1072 MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data); // Form data can be removed once the minimum API >= 26.
1073 MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data); // Form data can be removed once the minimum API >= 26.
1074 MenuItem refreshMenuItem = menu.findItem(R.id.refresh);
1075 MenuItem adConsentMenuItem = menu.findItem(R.id.ad_consent);
1077 // Only display third-party cookies if API >= 21
1078 toggleThirdPartyCookiesMenuItem.setVisible(Build.VERSION.SDK_INT >= 21);
1080 // Only display the form data menu items if the API < 26.
1081 toggleSaveFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
1082 clearFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
1084 // Disable the clear form data menu item if the API >= 26 so that the status of the main Clear Data is calculated correctly.
1085 clearFormDataMenuItem.setEnabled(Build.VERSION.SDK_INT < 26);
1087 // Only show Ad Consent if this is the free flavor.
1088 adConsentMenuItem.setVisible(BuildConfig.FLAVOR.contentEquals("free"));
1090 // Get the shared preferences.
1091 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
1093 // Get the dark theme and app bar preferences..
1094 boolean displayAdditionalAppBarIcons = sharedPreferences.getBoolean("display_additional_app_bar_icons", false);
1095 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
1097 // 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.
1098 if (displayAdditionalAppBarIcons) {
1099 toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1100 toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1101 refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_ALWAYS);
1102 } else { //Do not display the additional icons.
1103 toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1104 toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1105 refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1108 // Replace Refresh with Stop if a URL is already loading.
1109 if (currentWebView != null && currentWebView.getProgress() != 100) {
1111 refreshMenuItem.setTitle(R.string.stop);
1113 // If the icon is displayed in the AppBar, set it according to the theme.
1114 if (displayAdditionalAppBarIcons) {
1116 refreshMenuItem.setIcon(R.drawable.close_dark);
1118 refreshMenuItem.setIcon(R.drawable.close_light);
1127 public boolean onPrepareOptionsMenu(Menu menu) {
1128 // Get handles for the menu items.
1129 MenuItem addOrEditDomain = menu.findItem(R.id.add_or_edit_domain);
1130 MenuItem firstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1131 MenuItem thirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1132 MenuItem domStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1133 MenuItem saveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data); // Form data can be removed once the minimum API >= 26.
1134 MenuItem clearDataMenuItem = menu.findItem(R.id.clear_data);
1135 MenuItem clearCookiesMenuItem = menu.findItem(R.id.clear_cookies);
1136 MenuItem clearDOMStorageMenuItem = menu.findItem(R.id.clear_dom_storage);
1137 MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data); // Form data can be removed once the minimum API >= 26.
1138 MenuItem blocklistsMenuItem = menu.findItem(R.id.blocklists);
1139 MenuItem easyListMenuItem = menu.findItem(R.id.easylist);
1140 MenuItem easyPrivacyMenuItem = menu.findItem(R.id.easyprivacy);
1141 MenuItem fanboysAnnoyanceListMenuItem = menu.findItem(R.id.fanboys_annoyance_list);
1142 MenuItem fanboysSocialBlockingListMenuItem = menu.findItem(R.id.fanboys_social_blocking_list);
1143 MenuItem ultraPrivacyMenuItem = menu.findItem(R.id.ultraprivacy);
1144 MenuItem blockAllThirdPartyRequestsMenuItem = menu.findItem(R.id.block_all_third_party_requests);
1145 MenuItem fontSizeMenuItem = menu.findItem(R.id.font_size);
1146 MenuItem swipeToRefreshMenuItem = menu.findItem(R.id.swipe_to_refresh);
1147 MenuItem displayImagesMenuItem = menu.findItem(R.id.display_images);
1148 MenuItem nightModeMenuItem = menu.findItem(R.id.night_mode);
1149 MenuItem proxyThroughOrbotMenuItem = menu.findItem(R.id.proxy_through_orbot);
1151 // Get a handle for the cookie manager.
1152 CookieManager cookieManager = CookieManager.getInstance();
1154 // Initialize the current user agent string and the font size.
1155 String currentUserAgent = getString(R.string.user_agent_privacy_browser);
1158 // 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.
1159 if (currentWebView != null) {
1160 // Set the add or edit domain text.
1161 if (currentWebView.getDomainSettingsApplied()) {
1162 addOrEditDomain.setTitle(R.string.edit_domain_settings);
1164 addOrEditDomain.setTitle(R.string.add_domain_settings);
1167 // Get the current user agent from the WebView.
1168 currentUserAgent = currentWebView.getSettings().getUserAgentString();
1170 // Get the current font size from the
1171 fontSize = currentWebView.getSettings().getTextZoom();
1173 // Set the status of the menu item checkboxes.
1174 domStorageMenuItem.setChecked(currentWebView.getSettings().getDomStorageEnabled());
1175 saveFormDataMenuItem.setChecked(currentWebView.getSettings().getSaveFormData()); // Form data can be removed once the minimum API >= 26.
1176 easyListMenuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.EASY_LIST));
1177 easyPrivacyMenuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.EASY_PRIVACY));
1178 fanboysAnnoyanceListMenuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST));
1179 fanboysSocialBlockingListMenuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST));
1180 ultraPrivacyMenuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.ULTRA_PRIVACY));
1181 blockAllThirdPartyRequestsMenuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.THIRD_PARTY_REQUESTS));
1182 swipeToRefreshMenuItem.setChecked(currentWebView.getSwipeToRefresh());
1183 displayImagesMenuItem.setChecked(currentWebView.getSettings().getLoadsImagesAutomatically());
1184 nightModeMenuItem.setChecked(currentWebView.getNightMode());
1186 // Initialize the display names for the blocklists with the number of blocked requests.
1187 blocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + currentWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
1188 easyListMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.EASY_LIST) + " - " + getString(R.string.easylist));
1189 easyPrivacyMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.EASY_PRIVACY) + " - " + getString(R.string.easyprivacy));
1190 fanboysAnnoyanceListMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST) + " - " + getString(R.string.fanboys_annoyance_list));
1191 fanboysSocialBlockingListMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST) + " - " + getString(R.string.fanboys_social_blocking_list));
1192 ultraPrivacyMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.ULTRA_PRIVACY) + " - " + getString(R.string.ultraprivacy));
1193 blockAllThirdPartyRequestsMenuItem.setTitle(currentWebView.getRequestsCount(NestedScrollWebView.THIRD_PARTY_REQUESTS) + " - " + getString(R.string.block_all_third_party_requests));
1195 // Only modify third-party cookies if the API >= 21.
1196 if (Build.VERSION.SDK_INT >= 21) {
1197 // Set the status of the third-party cookies checkbox.
1198 thirdPartyCookiesMenuItem.setChecked(cookieManager.acceptThirdPartyCookies(currentWebView));
1200 // Enable third-party cookies if first-party cookies are enabled.
1201 thirdPartyCookiesMenuItem.setEnabled(cookieManager.acceptCookie());
1204 // Enable DOM Storage if JavaScript is enabled.
1205 domStorageMenuItem.setEnabled(currentWebView.getSettings().getJavaScriptEnabled());
1208 // Set the status of the menu item checkboxes.
1209 firstPartyCookiesMenuItem.setChecked(cookieManager.acceptCookie());
1210 proxyThroughOrbotMenuItem.setChecked(proxyThroughOrbot);
1212 // Enable Clear Cookies if there are any.
1213 clearCookiesMenuItem.setEnabled(cookieManager.hasCookies());
1215 // 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`.
1216 String privateDataDirectoryString = getApplicationInfo().dataDir;
1218 // Get a count of the number of files in the Local Storage directory.
1219 File localStorageDirectory = new File (privateDataDirectoryString + "/app_webview/Local Storage/");
1220 int localStorageDirectoryNumberOfFiles = 0;
1221 if (localStorageDirectory.exists()) {
1222 localStorageDirectoryNumberOfFiles = localStorageDirectory.list().length;
1225 // Get a count of the number of files in the IndexedDB directory.
1226 File indexedDBDirectory = new File (privateDataDirectoryString + "/app_webview/IndexedDB");
1227 int indexedDBDirectoryNumberOfFiles = 0;
1228 if (indexedDBDirectory.exists()) {
1229 indexedDBDirectoryNumberOfFiles = indexedDBDirectory.list().length;
1232 // Enable Clear DOM Storage if there is any.
1233 clearDOMStorageMenuItem.setEnabled(localStorageDirectoryNumberOfFiles > 0 || indexedDBDirectoryNumberOfFiles > 0);
1235 // Enable Clear Form Data is there is any. This can be removed once the minimum API >= 26.
1236 if (Build.VERSION.SDK_INT < 26) {
1237 // Get the WebView database.
1238 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
1240 // Enable the clear form data menu item if there is anything to clear.
1241 clearFormDataMenuItem.setEnabled(webViewDatabase.hasFormData());
1244 // Enable Clear Data if any of the submenu items are enabled.
1245 clearDataMenuItem.setEnabled(clearCookiesMenuItem.isEnabled() || clearDOMStorageMenuItem.isEnabled() || clearFormDataMenuItem.isEnabled());
1247 // Disable Fanboy's Social Blocking List menu item if Fanboy's Annoyance List is checked.
1248 fanboysSocialBlockingListMenuItem.setEnabled(!fanboysAnnoyanceListMenuItem.isChecked());
1250 // Select the current user agent menu item. A switch statement cannot be used because the user agents are not compile time constants.
1251 if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[0])) { // Privacy Browser.
1252 menu.findItem(R.id.user_agent_privacy_browser).setChecked(true);
1253 } else if (currentUserAgent.equals(webViewDefaultUserAgent)) { // WebView Default.
1254 menu.findItem(R.id.user_agent_webview_default).setChecked(true);
1255 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[2])) { // Firefox on Android.
1256 menu.findItem(R.id.user_agent_firefox_on_android).setChecked(true);
1257 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[3])) { // Chrome on Android.
1258 menu.findItem(R.id.user_agent_chrome_on_android).setChecked(true);
1259 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[4])) { // Safari on iOS.
1260 menu.findItem(R.id.user_agent_safari_on_ios).setChecked(true);
1261 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[5])) { // Firefox on Linux.
1262 menu.findItem(R.id.user_agent_firefox_on_linux).setChecked(true);
1263 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[6])) { // Chromium on Linux.
1264 menu.findItem(R.id.user_agent_chromium_on_linux).setChecked(true);
1265 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[7])) { // Firefox on Windows.
1266 menu.findItem(R.id.user_agent_firefox_on_windows).setChecked(true);
1267 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[8])) { // Chrome on Windows.
1268 menu.findItem(R.id.user_agent_chrome_on_windows).setChecked(true);
1269 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[9])) { // Edge on Windows.
1270 menu.findItem(R.id.user_agent_edge_on_windows).setChecked(true);
1271 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[10])) { // Internet Explorer on Windows.
1272 menu.findItem(R.id.user_agent_internet_explorer_on_windows).setChecked(true);
1273 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[11])) { // Safari on macOS.
1274 menu.findItem(R.id.user_agent_safari_on_macos).setChecked(true);
1275 } else { // Custom user agent.
1276 menu.findItem(R.id.user_agent_custom).setChecked(true);
1279 // Instantiate the font size title and the selected font size menu item.
1280 String fontSizeTitle;
1281 MenuItem selectedFontSizeMenuItem;
1283 // Prepare the font size title and current size menu item.
1286 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.twenty_five_percent);
1287 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_twenty_five_percent);
1291 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.fifty_percent);
1292 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_fifty_percent);
1296 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.seventy_five_percent);
1297 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_seventy_five_percent);
1301 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1302 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1306 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_twenty_five_percent);
1307 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_twenty_five_percent);
1311 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_fifty_percent);
1312 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_fifty_percent);
1316 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_seventy_five_percent);
1317 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_seventy_five_percent);
1321 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.two_hundred_percent);
1322 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_two_hundred_percent);
1326 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1327 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1331 // Set the font size title and select the current size menu item.
1332 fontSizeMenuItem.setTitle(fontSizeTitle);
1333 selectedFontSizeMenuItem.setChecked(true);
1335 // Run all the other default commands.
1336 super.onPrepareOptionsMenu(menu);
1338 // Display the menu.
1343 // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
1344 @SuppressLint("SetJavaScriptEnabled")
1345 public boolean onOptionsItemSelected(MenuItem menuItem) {
1346 // Reenter full screen browsing mode if it was interrupted by the options menu. <https://redmine.stoutner.com/issues/389>
1347 if (inFullScreenBrowsingMode) {
1348 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
1349 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1351 FrameLayout rootFrameLayout = findViewById(R.id.root_framelayout);
1353 /* Hide the system bars.
1354 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
1355 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
1356 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
1357 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
1359 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
1360 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
1363 // Get the selected menu item ID.
1364 int menuItemId = menuItem.getItemId();
1366 // Get a handle for the shared preferences.
1367 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
1369 // Get a handle for the cookie manager.
1370 CookieManager cookieManager = CookieManager.getInstance();
1372 // Run the commands that correlate to the selected menu item.
1373 switch (menuItemId) {
1374 case R.id.toggle_javascript:
1375 // Toggle the JavaScript status.
1376 currentWebView.getSettings().setJavaScriptEnabled(!currentWebView.getSettings().getJavaScriptEnabled());
1378 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
1379 updatePrivacyIcons(true);
1381 // Display a `Snackbar`.
1382 if (currentWebView.getSettings().getJavaScriptEnabled()) { // JavaScrip is enabled.
1383 Snackbar.make(findViewById(R.id.webviewpager), R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show();
1384 } else if (cookieManager.acceptCookie()) { // JavaScript is disabled, but first-party cookies are enabled.
1385 Snackbar.make(findViewById(R.id.webviewpager), R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show();
1386 } else { // Privacy mode.
1387 Snackbar.make(findViewById(R.id.webviewpager), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1390 // Reload the current WebView.
1391 currentWebView.reload();
1394 case R.id.add_or_edit_domain:
1395 if (currentWebView.getDomainSettingsApplied()) { // Edit the current domain settings.
1396 // Reapply the domain settings on returning to `MainWebViewActivity`.
1397 reapplyDomainSettingsOnRestart = true;
1399 // Create an intent to launch the domains activity.
1400 Intent domainsIntent = new Intent(this, DomainsActivity.class);
1402 // Add the extra information to the intent.
1403 domainsIntent.putExtra("load_domain", currentWebView.getDomainSettingsDatabaseId());
1404 domainsIntent.putExtra("close_on_back", true);
1405 domainsIntent.putExtra("current_url", currentWebView.getUrl());
1407 // Get the current certificate.
1408 SslCertificate sslCertificate = currentWebView.getCertificate();
1410 // Check to see if the SSL certificate is populated.
1411 if (sslCertificate != null) {
1412 // Extract the certificate to strings.
1413 String issuedToCName = sslCertificate.getIssuedTo().getCName();
1414 String issuedToOName = sslCertificate.getIssuedTo().getOName();
1415 String issuedToUName = sslCertificate.getIssuedTo().getUName();
1416 String issuedByCName = sslCertificate.getIssuedBy().getCName();
1417 String issuedByOName = sslCertificate.getIssuedBy().getOName();
1418 String issuedByUName = sslCertificate.getIssuedBy().getUName();
1419 long startDateLong = sslCertificate.getValidNotBeforeDate().getTime();
1420 long endDateLong = sslCertificate.getValidNotAfterDate().getTime();
1422 // Add the certificate to the intent.
1423 domainsIntent.putExtra("ssl_issued_to_cname", issuedToCName);
1424 domainsIntent.putExtra("ssl_issued_to_oname", issuedToOName);
1425 domainsIntent.putExtra("ssl_issued_to_uname", issuedToUName);
1426 domainsIntent.putExtra("ssl_issued_by_cname", issuedByCName);
1427 domainsIntent.putExtra("ssl_issued_by_oname", issuedByOName);
1428 domainsIntent.putExtra("ssl_issued_by_uname", issuedByUName);
1429 domainsIntent.putExtra("ssl_start_date", startDateLong);
1430 domainsIntent.putExtra("ssl_end_date", endDateLong);
1433 // Check to see if the current IP addresses have been received.
1434 if (currentWebView.hasCurrentIpAddresses()) {
1435 // Add the current IP addresses to the intent.
1436 domainsIntent.putExtra("current_ip_addresses", currentWebView.getCurrentIpAddresses());
1440 startActivity(domainsIntent);
1441 } else { // Add a new domain.
1442 // Apply the new domain settings on returning to `MainWebViewActivity`.
1443 reapplyDomainSettingsOnRestart = true;
1445 // Get the current domain
1446 Uri currentUri = Uri.parse(currentWebView.getUrl());
1447 String currentDomain = currentUri.getHost();
1449 // Initialize the database handler. The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
1450 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
1452 // Create the domain and store the database ID.
1453 int newDomainDatabaseId = domainsDatabaseHelper.addDomain(currentDomain);
1455 // Create an intent to launch the domains activity.
1456 Intent domainsIntent = new Intent(this, DomainsActivity.class);
1458 // Add the extra information to the intent.
1459 domainsIntent.putExtra("load_domain", newDomainDatabaseId);
1460 domainsIntent.putExtra("close_on_back", true);
1461 domainsIntent.putExtra("current_url", currentWebView.getUrl());
1463 // Get the current certificate.
1464 SslCertificate sslCertificate = currentWebView.getCertificate();
1466 // Check to see if the SSL certificate is populated.
1467 if (sslCertificate != null) {
1468 // Extract the certificate to strings.
1469 String issuedToCName = sslCertificate.getIssuedTo().getCName();
1470 String issuedToOName = sslCertificate.getIssuedTo().getOName();
1471 String issuedToUName = sslCertificate.getIssuedTo().getUName();
1472 String issuedByCName = sslCertificate.getIssuedBy().getCName();
1473 String issuedByOName = sslCertificate.getIssuedBy().getOName();
1474 String issuedByUName = sslCertificate.getIssuedBy().getUName();
1475 long startDateLong = sslCertificate.getValidNotBeforeDate().getTime();
1476 long endDateLong = sslCertificate.getValidNotAfterDate().getTime();
1478 // Add the certificate to the intent.
1479 domainsIntent.putExtra("ssl_issued_to_cname", issuedToCName);
1480 domainsIntent.putExtra("ssl_issued_to_oname", issuedToOName);
1481 domainsIntent.putExtra("ssl_issued_to_uname", issuedToUName);
1482 domainsIntent.putExtra("ssl_issued_by_cname", issuedByCName);
1483 domainsIntent.putExtra("ssl_issued_by_oname", issuedByOName);
1484 domainsIntent.putExtra("ssl_issued_by_uname", issuedByUName);
1485 domainsIntent.putExtra("ssl_start_date", startDateLong);
1486 domainsIntent.putExtra("ssl_end_date", endDateLong);
1489 // Check to see if the current IP addresses have been received.
1490 if (currentWebView.hasCurrentIpAddresses()) {
1491 // Add the current IP addresses to the intent.
1492 domainsIntent.putExtra("current_ip_addresses", currentWebView.getCurrentIpAddresses());
1496 startActivity(domainsIntent);
1500 case R.id.toggle_first_party_cookies:
1501 // Switch the first-party cookie status.
1502 cookieManager.setAcceptCookie(!cookieManager.acceptCookie());
1504 // Store the first-party cookie status.
1505 currentWebView.setAcceptFirstPartyCookies(cookieManager.acceptCookie());
1507 // Update the menu checkbox.
1508 menuItem.setChecked(cookieManager.acceptCookie());
1510 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
1511 updatePrivacyIcons(true);
1513 // Display a snackbar.
1514 if (cookieManager.acceptCookie()) { // First-party cookies are enabled.
1515 Snackbar.make(findViewById(R.id.webviewpager), R.string.first_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1516 } else if (currentWebView.getSettings().getJavaScriptEnabled()) { // JavaScript is still enabled.
1517 Snackbar.make(findViewById(R.id.webviewpager), R.string.first_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1518 } else { // Privacy mode.
1519 Snackbar.make(findViewById(R.id.webviewpager), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1522 // Reload the current WebView.
1523 currentWebView.reload();
1526 case R.id.toggle_third_party_cookies:
1527 if (Build.VERSION.SDK_INT >= 21) {
1528 // Switch the status of thirdPartyCookiesEnabled.
1529 cookieManager.setAcceptThirdPartyCookies(currentWebView, !cookieManager.acceptThirdPartyCookies(currentWebView));
1531 // Update the menu checkbox.
1532 menuItem.setChecked(cookieManager.acceptThirdPartyCookies(currentWebView));
1534 // Display a snackbar.
1535 if (cookieManager.acceptThirdPartyCookies(currentWebView)) {
1536 Snackbar.make(findViewById(R.id.webviewpager), R.string.third_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1538 Snackbar.make(findViewById(R.id.webviewpager), R.string.third_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1541 // Reload the current WebView.
1542 currentWebView.reload();
1543 } // Else do nothing because SDK < 21.
1546 case R.id.toggle_dom_storage:
1547 // Toggle the status of domStorageEnabled.
1548 currentWebView.getSettings().setDomStorageEnabled(!currentWebView.getSettings().getDomStorageEnabled());
1550 // Update the menu checkbox.
1551 menuItem.setChecked(currentWebView.getSettings().getDomStorageEnabled());
1553 // Update the privacy icon. `true` refreshes the app bar icons.
1554 updatePrivacyIcons(true);
1556 // Display a snackbar.
1557 if (currentWebView.getSettings().getDomStorageEnabled()) {
1558 Snackbar.make(findViewById(R.id.webviewpager), R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show();
1560 Snackbar.make(findViewById(R.id.webviewpager), R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show();
1563 // Reload the current WebView.
1564 currentWebView.reload();
1567 // Form data can be removed once the minimum API >= 26.
1568 case R.id.toggle_save_form_data:
1569 // Switch the status of saveFormDataEnabled.
1570 currentWebView.getSettings().setSaveFormData(!currentWebView.getSettings().getSaveFormData());
1572 // Update the menu checkbox.
1573 menuItem.setChecked(currentWebView.getSettings().getSaveFormData());
1575 // Display a snackbar.
1576 if (currentWebView.getSettings().getSaveFormData()) {
1577 Snackbar.make(findViewById(R.id.webviewpager), R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show();
1579 Snackbar.make(findViewById(R.id.webviewpager), R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show();
1582 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
1583 updatePrivacyIcons(true);
1585 // Reload the current WebView.
1586 currentWebView.reload();
1589 case R.id.clear_cookies:
1590 Snackbar.make(findViewById(R.id.webviewpager), R.string.cookies_deleted, Snackbar.LENGTH_LONG)
1591 .setAction(R.string.undo, v -> {
1592 // Do nothing because everything will be handled by `onDismissed()` below.
1594 .addCallback(new Snackbar.Callback() {
1595 @SuppressLint("SwitchIntDef") // Ignore the lint warning about not handling the other possible events as they are covered by `default:`.
1597 public void onDismissed(Snackbar snackbar, int event) {
1598 if (event != Snackbar.Callback.DISMISS_EVENT_ACTION) { // The snackbar was dismissed without the undo button being pushed.
1599 // Delete the cookies, which command varies by SDK.
1600 if (Build.VERSION.SDK_INT < 21) {
1601 cookieManager.removeAllCookie();
1603 cookieManager.removeAllCookies(null);
1611 case R.id.clear_dom_storage:
1612 Snackbar.make(findViewById(R.id.webviewpager), R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
1613 .setAction(R.string.undo, v -> {
1614 // Do nothing because everything will be handled by `onDismissed()` below.
1616 .addCallback(new Snackbar.Callback() {
1617 @SuppressLint("SwitchIntDef") // Ignore the lint warning about not handling the other possible events as they are covered by `default:`.
1619 public void onDismissed(Snackbar snackbar, int event) {
1620 if (event != Snackbar.Callback.DISMISS_EVENT_ACTION) { // The snackbar was dismissed without the undo button being pushed.
1621 // Delete the DOM Storage.
1622 WebStorage webStorage = WebStorage.getInstance();
1623 webStorage.deleteAllData();
1625 // Initialize a handler to manually delete the DOM storage files and directories.
1626 Handler deleteDomStorageHandler = new Handler();
1628 // Setup a runnable to manually delete the DOM storage files and directories.
1629 Runnable deleteDomStorageRunnable = () -> {
1631 // Get a handle for the runtime.
1632 Runtime runtime = Runtime.getRuntime();
1634 // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
1635 // which links to `/data/data/com.stoutner.privacybrowser.standard`.
1636 String privateDataDirectoryString = getApplicationInfo().dataDir;
1638 // A string array must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
1639 Process deleteLocalStorageProcess = runtime.exec(new String[]{"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
1641 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
1642 Process deleteIndexProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
1643 Process deleteQuotaManagerProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
1644 Process deleteQuotaManagerJournalProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
1645 Process deleteDatabasesProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
1647 // Wait for the processes to finish.
1648 deleteLocalStorageProcess.waitFor();
1649 deleteIndexProcess.waitFor();
1650 deleteQuotaManagerProcess.waitFor();
1651 deleteQuotaManagerJournalProcess.waitFor();
1652 deleteDatabasesProcess.waitFor();
1653 } catch (Exception exception) {
1654 // Do nothing if an error is thrown.
1658 // Manually delete the DOM storage files after 200 milliseconds.
1659 deleteDomStorageHandler.postDelayed(deleteDomStorageRunnable, 200);
1666 // Form data can be remove once the minimum API >= 26.
1667 case R.id.clear_form_data:
1668 Snackbar.make(findViewById(R.id.webviewpager), R.string.form_data_deleted, Snackbar.LENGTH_LONG)
1669 .setAction(R.string.undo, v -> {
1670 // Do nothing because everything will be handled by `onDismissed()` below.
1672 .addCallback(new Snackbar.Callback() {
1673 @SuppressLint("SwitchIntDef") // Ignore the lint warning about not handling the other possible events as they are covered by `default:`.
1675 public void onDismissed(Snackbar snackbar, int event) {
1676 if (event != Snackbar.Callback.DISMISS_EVENT_ACTION) { // The snackbar was dismissed without the undo button being pushed.
1677 // Delete the form data.
1678 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(getApplicationContext());
1679 mainWebViewDatabase.clearFormData();
1687 // Toggle the EasyList status.
1688 currentWebView.enableBlocklist(NestedScrollWebView.EASY_LIST, !currentWebView.isBlocklistEnabled(NestedScrollWebView.EASY_LIST));
1690 // Update the menu checkbox.
1691 menuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.EASY_LIST));
1693 // Reload the current WebView.
1694 currentWebView.reload();
1697 case R.id.easyprivacy:
1698 // Toggle the EasyPrivacy status.
1699 currentWebView.enableBlocklist(NestedScrollWebView.EASY_PRIVACY, !currentWebView.isBlocklistEnabled(NestedScrollWebView.EASY_PRIVACY));
1701 // Update the menu checkbox.
1702 menuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.EASY_PRIVACY));
1704 // Reload the current WebView.
1705 currentWebView.reload();
1708 case R.id.fanboys_annoyance_list:
1709 // Toggle Fanboy's Annoyance List status.
1710 currentWebView.enableBlocklist(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST, !currentWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST));
1712 // Update the menu checkbox.
1713 menuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST));
1715 // Update the staus of Fanboy's Social Blocking List.
1716 MenuItem fanboysSocialBlockingListMenuItem = optionsMenu.findItem(R.id.fanboys_social_blocking_list);
1717 fanboysSocialBlockingListMenuItem.setEnabled(!currentWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST));
1719 // Reload the current WebView.
1720 currentWebView.reload();
1723 case R.id.fanboys_social_blocking_list:
1724 // Toggle Fanboy's Social Blocking List status.
1725 currentWebView.enableBlocklist(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST, !currentWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST));
1727 // Update the menu checkbox.
1728 menuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST));
1730 // Reload the current WebView.
1731 currentWebView.reload();
1734 case R.id.ultraprivacy:
1735 // Toggle the UltraPrivacy status.
1736 currentWebView.enableBlocklist(NestedScrollWebView.ULTRA_PRIVACY, !currentWebView.isBlocklistEnabled(NestedScrollWebView.ULTRA_PRIVACY));
1738 // Update the menu checkbox.
1739 menuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.ULTRA_PRIVACY));
1741 // Reload the current WebView.
1742 currentWebView.reload();
1745 case R.id.block_all_third_party_requests:
1746 //Toggle the third-party requests blocker status.
1747 currentWebView.enableBlocklist(NestedScrollWebView.THIRD_PARTY_REQUESTS, !currentWebView.isBlocklistEnabled(NestedScrollWebView.THIRD_PARTY_REQUESTS));
1749 // Update the menu checkbox.
1750 menuItem.setChecked(currentWebView.isBlocklistEnabled(NestedScrollWebView.THIRD_PARTY_REQUESTS));
1752 // Reload the current WebView.
1753 currentWebView.reload();
1756 case R.id.user_agent_privacy_browser:
1757 // Update the user agent.
1758 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[0]);
1760 // Reload the current WebView.
1761 currentWebView.reload();
1764 case R.id.user_agent_webview_default:
1765 // Update the user agent.
1766 currentWebView.getSettings().setUserAgentString("");
1768 // Reload the current WebView.
1769 currentWebView.reload();
1772 case R.id.user_agent_firefox_on_android:
1773 // Update the user agent.
1774 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[2]);
1776 // Reload the current WebView.
1777 currentWebView.reload();
1780 case R.id.user_agent_chrome_on_android:
1781 // Update the user agent.
1782 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[3]);
1784 // Reload the current WebView.
1785 currentWebView.reload();
1788 case R.id.user_agent_safari_on_ios:
1789 // Update the user agent.
1790 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[4]);
1792 // Reload the current WebView.
1793 currentWebView.reload();
1796 case R.id.user_agent_firefox_on_linux:
1797 // Update the user agent.
1798 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[5]);
1800 // Reload the current WebView.
1801 currentWebView.reload();
1804 case R.id.user_agent_chromium_on_linux:
1805 // Update the user agent.
1806 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[6]);
1808 // Reload the current WebView.
1809 currentWebView.reload();
1812 case R.id.user_agent_firefox_on_windows:
1813 // Update the user agent.
1814 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[7]);
1816 // Reload the current WebView.
1817 currentWebView.reload();
1820 case R.id.user_agent_chrome_on_windows:
1821 // Update the user agent.
1822 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[8]);
1824 // Reload the current WebView.
1825 currentWebView.reload();
1828 case R.id.user_agent_edge_on_windows:
1829 // Update the user agent.
1830 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[9]);
1832 // Reload the current WebView.
1833 currentWebView.reload();
1836 case R.id.user_agent_internet_explorer_on_windows:
1837 // Update the user agent.
1838 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[10]);
1840 // Reload the current WebView.
1841 currentWebView.reload();
1844 case R.id.user_agent_safari_on_macos:
1845 // Update the user agent.
1846 currentWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[11]);
1848 // Reload the current WebView.
1849 currentWebView.reload();
1852 case R.id.user_agent_custom:
1853 // Update the user agent.
1854 currentWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", getString(R.string.custom_user_agent_default_value)));
1856 // Reload the current WebView.
1857 currentWebView.reload();
1860 case R.id.font_size_twenty_five_percent:
1861 currentWebView.getSettings().setTextZoom(25);
1864 case R.id.font_size_fifty_percent:
1865 currentWebView.getSettings().setTextZoom(50);
1868 case R.id.font_size_seventy_five_percent:
1869 currentWebView.getSettings().setTextZoom(75);
1872 case R.id.font_size_one_hundred_percent:
1873 currentWebView.getSettings().setTextZoom(100);
1876 case R.id.font_size_one_hundred_twenty_five_percent:
1877 currentWebView.getSettings().setTextZoom(125);
1880 case R.id.font_size_one_hundred_fifty_percent:
1881 currentWebView.getSettings().setTextZoom(150);
1884 case R.id.font_size_one_hundred_seventy_five_percent:
1885 currentWebView.getSettings().setTextZoom(175);
1888 case R.id.font_size_two_hundred_percent:
1889 currentWebView.getSettings().setTextZoom(200);
1892 case R.id.swipe_to_refresh:
1893 // Toggle the stored status of swipe to refresh.
1894 currentWebView.setSwipeToRefresh(!currentWebView.getSwipeToRefresh());
1896 // Get a handle for the swipe refresh layout.
1897 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
1899 // Update the swipe refresh layout.
1900 if (currentWebView.getSwipeToRefresh()) { // Swipe to refresh is enabled.
1901 if (Build.VERSION.SDK_INT >= 23) { // For API >= 23, the status of the scroll refresh listener is continuously updated by the on scroll change listener.
1902 // Only enable the swipe refresh layout if the WebView is scrolled to the top.
1903 swipeRefreshLayout.setEnabled(currentWebView.getY() == 0);
1904 } else { // For API < 23, the swipe refresh layout is always enabled.
1905 // Enable the swipe refresh layout.
1906 swipeRefreshLayout.setEnabled(true);
1908 } else { // Swipe to refresh is disabled.
1909 // Disable the swipe refresh layout.
1910 swipeRefreshLayout.setEnabled(false);
1914 case R.id.display_images:
1915 if (currentWebView.getSettings().getLoadsImagesAutomatically()) { // Images are currently loaded automatically.
1916 // Disable loading of images.
1917 currentWebView.getSettings().setLoadsImagesAutomatically(false);
1919 // Reload the website to remove existing images.
1920 currentWebView.reload();
1921 } else { // Images are not currently loaded automatically.
1922 // Enable loading of images. Missing images will be loaded without the need for a reload.
1923 currentWebView.getSettings().setLoadsImagesAutomatically(true);
1927 case R.id.night_mode:
1928 // Toggle night mode.
1929 currentWebView.setNightMode(!currentWebView.getNightMode());
1931 // Enable or disable JavaScript according to night mode, the global preference, and any domain settings.
1932 if (currentWebView.getNightMode()) { // Night mode is enabled, which requires JavaScript.
1933 // Enable JavaScript.
1934 currentWebView.getSettings().setJavaScriptEnabled(true);
1935 } else if (currentWebView.getDomainSettingsApplied()) { // Night mode is disabled and domain settings are applied. Set JavaScript according to the domain settings.
1936 // Apply the JavaScript preference that was stored the last time domain settings were loaded.
1937 currentWebView.getSettings().setJavaScriptEnabled(currentWebView.getDomainSettingsJavaScriptEnabled());
1938 } else { // Night mode is disabled and domain settings are not applied. Set JavaScript according to the global preference.
1939 // Apply the JavaScript preference.
1940 currentWebView.getSettings().setJavaScriptEnabled(sharedPreferences.getBoolean("javascript", false));
1943 // Update the privacy icons.
1944 updatePrivacyIcons(false);
1946 // Reload the website.
1947 currentWebView.reload();
1950 case R.id.find_on_page:
1951 // Get a handle for the views.
1952 Toolbar toolbar = findViewById(R.id.toolbar);
1953 LinearLayout findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
1954 EditText findOnPageEditText = findViewById(R.id.find_on_page_edittext);
1956 // Set the minimum height of the find on page linear layout to match the toolbar.
1957 findOnPageLinearLayout.setMinimumHeight(toolbar.getHeight());
1959 // Hide the toolbar.
1960 toolbar.setVisibility(View.GONE);
1962 // Show the find on page linear layout.
1963 findOnPageLinearLayout.setVisibility(View.VISIBLE);
1965 // Display the keyboard. The app must wait 200 ms before running the command to work around a bug in Android.
1966 // http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
1967 findOnPageEditText.postDelayed(() -> {
1968 // Set the focus on `findOnPageEditText`.
1969 findOnPageEditText.requestFocus();
1971 // Get a handle for the input method manager.
1972 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
1974 // Remove the lint warning below that the input method manager might be null.
1975 assert inputMethodManager != null;
1977 // Display the keyboard. `0` sets no input flags.
1978 inputMethodManager.showSoftInput(findOnPageEditText, 0);
1982 case R.id.view_source:
1983 // Create an intent to launch the view source activity.
1984 Intent viewSourceIntent = new Intent(this, ViewSourceActivity.class);
1986 // Add the variables to the intent.
1987 viewSourceIntent.putExtra("user_agent", currentWebView.getSettings().getUserAgentString());
1988 viewSourceIntent.putExtra("current_url", currentWebView.getUrl());
1991 startActivity(viewSourceIntent);
1994 case R.id.share_url:
1995 // Setup the share string.
1996 String shareString = currentWebView.getTitle() + " – " + currentWebView.getUrl();
1998 // Create the share intent.
1999 Intent shareIntent = new Intent(Intent.ACTION_SEND);
2000 shareIntent.putExtra(Intent.EXTRA_TEXT, shareString);
2001 shareIntent.setType("text/plain");
2004 startActivity(Intent.createChooser(shareIntent, getString(R.string.share_url)));
2008 // Get a print manager instance.
2009 PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
2011 // Remove the lint error below that print manager might be null.
2012 assert printManager != null;
2014 // Create a print document adapter from the current WebView.
2015 PrintDocumentAdapter printDocumentAdapter = currentWebView.createPrintDocumentAdapter();
2017 // Print the document.
2018 printManager.print(getString(R.string.privacy_browser_web_page), printDocumentAdapter, null);
2021 case R.id.open_with_app:
2022 openWithApp(currentWebView.getUrl());
2025 case R.id.open_with_browser:
2026 openWithBrowser(currentWebView.getUrl());
2029 case R.id.add_to_homescreen:
2030 // Instantiate the create home screen shortcut dialog.
2031 DialogFragment createHomeScreenShortcutDialogFragment = CreateHomeScreenShortcutDialog.createDialog(currentWebView.getTitle(), currentWebView.getUrl(),
2032 currentWebView.getFavoriteOrDefaultIcon());
2034 // Show the create home screen shortcut dialog.
2035 createHomeScreenShortcutDialogFragment.show(getSupportFragmentManager(), getString(R.string.create_shortcut));
2038 case R.id.proxy_through_orbot:
2039 // Toggle the proxy through Orbot variable.
2040 proxyThroughOrbot = !proxyThroughOrbot;
2042 // Apply the proxy through Orbot settings.
2043 applyProxyThroughOrbot(true);
2047 if (menuItem.getTitle().equals(getString(R.string.refresh))) { // The refresh button was pushed.
2048 // Reload the current WebView.
2049 currentWebView.reload();
2050 } else { // The stop button was pushed.
2051 // Stop the loading of the WebView.
2052 currentWebView.stopLoading();
2056 case R.id.ad_consent:
2057 // Display the ad consent dialog.
2058 DialogFragment adConsentDialogFragment = new AdConsentDialog();
2059 adConsentDialogFragment.show(getSupportFragmentManager(), getString(R.string.ad_consent));
2063 // Don't consume the event.
2064 return super.onOptionsItemSelected(menuItem);
2068 // removeAllCookies is deprecated, but it is required for API < 21.
2070 public boolean onNavigationItemSelected(@NonNull MenuItem menuItem) {
2071 // Get the menu item ID.
2072 int menuItemId = menuItem.getItemId();
2074 // Get a handle for the shared preferences.
2075 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2077 // Run the commands that correspond to the selected menu item.
2078 switch (menuItemId) {
2079 case R.id.close_tab:
2080 // Close the current tab.
2084 case R.id.clear_and_exit:
2085 // Close the bookmarks cursor and database.
2086 bookmarksCursor.close();
2087 bookmarksDatabaseHelper.close();
2089 // Get the status of the clear everything preference.
2090 boolean clearEverything = sharedPreferences.getBoolean("clear_everything", true);
2092 // Get a handle for the runtime.
2093 Runtime runtime = Runtime.getRuntime();
2095 // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
2096 // which links to `/data/data/com.stoutner.privacybrowser.standard`.
2097 String privateDataDirectoryString = getApplicationInfo().dataDir;
2100 if (clearEverything || sharedPreferences.getBoolean("clear_cookies", true)) {
2101 // The command to remove cookies changed slightly in API 21.
2102 if (Build.VERSION.SDK_INT >= 21) {
2103 CookieManager.getInstance().removeAllCookies(null);
2105 CookieManager.getInstance().removeAllCookie();
2108 // Manually delete the cookies database, as `CookieManager` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2110 // Two commands must be used because `Runtime.exec()` does not like `*`.
2111 Process deleteCookiesProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies");
2112 Process deleteCookiesJournalProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies-journal");
2114 // Wait until the processes have finished.
2115 deleteCookiesProcess.waitFor();
2116 deleteCookiesJournalProcess.waitFor();
2117 } catch (Exception exception) {
2118 // Do nothing if an error is thrown.
2122 // Clear DOM storage.
2123 if (clearEverything || sharedPreferences.getBoolean("clear_dom_storage", true)) {
2124 // Ask `WebStorage` to clear the DOM storage.
2125 WebStorage webStorage = WebStorage.getInstance();
2126 webStorage.deleteAllData();
2128 // Manually delete the DOM storage files and directories, as `WebStorage` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2130 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2131 Process deleteLocalStorageProcess = runtime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2133 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2134 Process deleteIndexProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2135 Process deleteQuotaManagerProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2136 Process deleteQuotaManagerJournalProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2137 Process deleteDatabaseProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2139 // Wait until the processes have finished.
2140 deleteLocalStorageProcess.waitFor();
2141 deleteIndexProcess.waitFor();
2142 deleteQuotaManagerProcess.waitFor();
2143 deleteQuotaManagerJournalProcess.waitFor();
2144 deleteDatabaseProcess.waitFor();
2145 } catch (Exception exception) {
2146 // Do nothing if an error is thrown.
2150 // Clear form data if the API < 26.
2151 if ((Build.VERSION.SDK_INT < 26) && (clearEverything || sharedPreferences.getBoolean("clear_form_data", true))) {
2152 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
2153 webViewDatabase.clearFormData();
2155 // Manually delete the form data database, as `WebViewDatabase` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2157 // A string array must be used because the database contains a space and `Runtime.exec` will not otherwise escape the string correctly.
2158 Process deleteWebDataProcess = runtime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data"});
2159 Process deleteWebDataJournalProcess = runtime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data-journal"});
2161 // Wait until the processes have finished.
2162 deleteWebDataProcess.waitFor();
2163 deleteWebDataJournalProcess.waitFor();
2164 } catch (Exception exception) {
2165 // Do nothing if an error is thrown.
2170 if (clearEverything || sharedPreferences.getBoolean("clear_cache", true)) {
2171 // Clear the cache from each WebView.
2172 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
2173 // Get the WebView tab fragment.
2174 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
2176 // Get the fragment view.
2177 View fragmentView = webViewTabFragment.getView();
2179 // Only clear the cache if the WebView exists.
2180 if (fragmentView != null) {
2181 // Get the nested scroll WebView from the tab fragment.
2182 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
2184 // Clear the cache for this WebView.
2185 nestedScrollWebView.clearCache(true);
2189 // Manually delete the cache directories.
2191 // Delete the main cache directory.
2192 Process deleteCacheProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/cache");
2194 // Delete the secondary `Service Worker` cache directory.
2195 // A string array must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2196 Process deleteServiceWorkerProcess = runtime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
2198 // Wait until the processes have finished.
2199 deleteCacheProcess.waitFor();
2200 deleteServiceWorkerProcess.waitFor();
2201 } catch (Exception exception) {
2202 // Do nothing if an error is thrown.
2206 // Wipe out each WebView.
2207 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
2208 // Get the WebView tab fragment.
2209 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
2211 // Get the fragment view.
2212 View fragmentView = webViewTabFragment.getView();
2214 // Only wipe out the WebView if it exists.
2215 if (fragmentView != null) {
2216 // Get the nested scroll WebView from the tab fragment.
2217 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
2219 // Clear SSL certificate preferences for this WebView.
2220 nestedScrollWebView.clearSslPreferences();
2222 // Clear the back/forward history for this WebView.
2223 nestedScrollWebView.clearHistory();
2225 // Destroy the internal state of `mainWebView`.
2226 nestedScrollWebView.destroy();
2230 // Clear the custom headers.
2231 customHeaders.clear();
2233 // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
2234 // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
2235 if (clearEverything) {
2237 // Delete the folder.
2238 Process deleteAppWebviewProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
2240 // Wait until the process has finished.
2241 deleteAppWebviewProcess.waitFor();
2242 } catch (Exception exception) {
2243 // Do nothing if an error is thrown.
2247 // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
2248 if (Build.VERSION.SDK_INT >= 21) {
2249 finishAndRemoveTask();
2254 // Remove the terminated program from RAM. The status code is `0`.
2259 // Select the homepage based on the proxy through Orbot status.
2260 if (proxyThroughOrbot) {
2261 // Load the Tor homepage.
2262 loadUrl(sharedPreferences.getString("tor_homepage", getString(R.string.tor_homepage_default_value)));
2264 // Load the normal homepage.
2265 loadUrl(sharedPreferences.getString("homepage", getString(R.string.homepage_default_value)));
2270 if (currentWebView.canGoBack()) {
2271 // Reset the current domain name so that navigation works if third-party requests are blocked.
2272 currentWebView.resetCurrentDomainName();
2274 // Set navigating history so that the domain settings are applied when the new URL is loaded.
2275 currentWebView.setNavigatingHistory(true);
2277 // Load the previous website in the history.
2278 currentWebView.goBack();
2283 if (currentWebView.canGoForward()) {
2284 // Reset the current domain name so that navigation works if third-party requests are blocked.
2285 currentWebView.resetCurrentDomainName();
2287 // Set navigating history so that the domain settings are applied when the new URL is loaded.
2288 currentWebView.setNavigatingHistory(true);
2290 // Load the next website in the history.
2291 currentWebView.goForward();
2296 // Instantiate the URL history dialog.
2297 DialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(currentWebView.getWebViewFragmentId());
2299 // Show the URL history dialog.
2300 urlHistoryDialogFragment.show(getSupportFragmentManager(), getString(R.string.history));
2304 // Populate the resource requests.
2305 RequestsActivity.resourceRequests = currentWebView.getResourceRequests();
2307 // Create an intent to launch the Requests activity.
2308 Intent requestsIntent = new Intent(this, RequestsActivity.class);
2310 // Add the block third-party requests status to the intent.
2311 requestsIntent.putExtra("block_all_third_party_requests", currentWebView.isBlocklistEnabled(NestedScrollWebView.THIRD_PARTY_REQUESTS));
2314 startActivity(requestsIntent);
2317 case R.id.downloads:
2318 // Launch the system Download Manager.
2319 Intent downloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
2321 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
2322 downloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2324 startActivity(downloadManagerIntent);
2328 // Set the flag to reapply the domain settings on restart when returning from Domain Settings.
2329 reapplyDomainSettingsOnRestart = true;
2331 // Launch the domains activity.
2332 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2334 // Add the extra information to the intent.
2335 domainsIntent.putExtra("current_url", currentWebView.getUrl());
2337 // Get the current certificate.
2338 SslCertificate sslCertificate = currentWebView.getCertificate();
2340 // Check to see if the SSL certificate is populated.
2341 if (sslCertificate != null) {
2342 // Extract the certificate to strings.
2343 String issuedToCName = sslCertificate.getIssuedTo().getCName();
2344 String issuedToOName = sslCertificate.getIssuedTo().getOName();
2345 String issuedToUName = sslCertificate.getIssuedTo().getUName();
2346 String issuedByCName = sslCertificate.getIssuedBy().getCName();
2347 String issuedByOName = sslCertificate.getIssuedBy().getOName();
2348 String issuedByUName = sslCertificate.getIssuedBy().getUName();
2349 long startDateLong = sslCertificate.getValidNotBeforeDate().getTime();
2350 long endDateLong = sslCertificate.getValidNotAfterDate().getTime();
2352 // Add the certificate to the intent.
2353 domainsIntent.putExtra("ssl_issued_to_cname", issuedToCName);
2354 domainsIntent.putExtra("ssl_issued_to_oname", issuedToOName);
2355 domainsIntent.putExtra("ssl_issued_to_uname", issuedToUName);
2356 domainsIntent.putExtra("ssl_issued_by_cname", issuedByCName);
2357 domainsIntent.putExtra("ssl_issued_by_oname", issuedByOName);
2358 domainsIntent.putExtra("ssl_issued_by_uname", issuedByUName);
2359 domainsIntent.putExtra("ssl_start_date", startDateLong);
2360 domainsIntent.putExtra("ssl_end_date", endDateLong);
2363 // Check to see if the current IP addresses have been received.
2364 if (currentWebView.hasCurrentIpAddresses()) {
2365 // Add the current IP addresses to the intent.
2366 domainsIntent.putExtra("current_ip_addresses", currentWebView.getCurrentIpAddresses());
2370 startActivity(domainsIntent);
2374 // Set the flag to reapply app settings on restart when returning from Settings.
2375 reapplyAppSettingsOnRestart = true;
2377 // Set the flag to reapply the domain settings on restart when returning from Settings.
2378 reapplyDomainSettingsOnRestart = true;
2380 // Launch the settings activity.
2381 Intent settingsIntent = new Intent(this, SettingsActivity.class);
2382 startActivity(settingsIntent);
2385 case R.id.import_export:
2386 // Launch the import/export activity.
2387 Intent importExportIntent = new Intent (this, ImportExportActivity.class);
2388 startActivity(importExportIntent);
2392 // Launch the logcat activity.
2393 Intent logcatIntent = new Intent(this, LogcatActivity.class);
2394 startActivity(logcatIntent);
2398 // Launch `GuideActivity`.
2399 Intent guideIntent = new Intent(this, GuideActivity.class);
2400 startActivity(guideIntent);
2404 // Create an intent to launch the about activity.
2405 Intent aboutIntent = new Intent(this, AboutActivity.class);
2407 // Create a string array for the blocklist versions.
2408 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],
2409 ultraPrivacy.get(0).get(0)[0]};
2411 // Add the blocklist versions to the intent.
2412 aboutIntent.putExtra("blocklist_versions", blocklistVersions);
2415 startActivity(aboutIntent);
2419 // Get a handle for the drawer layout.
2420 DrawerLayout drawerLayout = findViewById(R.id.drawerlayout);
2422 // Close the navigation drawer.
2423 drawerLayout.closeDrawer(GravityCompat.START);
2428 public void onPostCreate(Bundle savedInstanceState) {
2429 // Run the default commands.
2430 super.onPostCreate(savedInstanceState);
2432 // Sync the state of the DrawerToggle after the default `onRestoreInstanceState()` has finished. This creates the navigation drawer icon.
2433 actionBarDrawerToggle.syncState();
2437 public void onConfigurationChanged(Configuration newConfig) {
2438 // Run the default commands.
2439 super.onConfigurationChanged(newConfig);
2441 // Get the status bar pixel size.
2442 int statusBarResourceId = getResources().getIdentifier("status_bar_height", "dimen", "android");
2443 int statusBarPixelSize = getResources().getDimensionPixelSize(statusBarResourceId);
2445 // Get the resource density.
2446 float screenDensity = getResources().getDisplayMetrics().density;
2448 // Recalculate the drawer header padding.
2449 drawerHeaderPaddingLeftAndRight = (int) (15 * screenDensity);
2450 drawerHeaderPaddingTop = statusBarPixelSize + (int) (4 * screenDensity);
2451 drawerHeaderPaddingBottom = (int) (8 * screenDensity);
2453 // Reload the ad for the free flavor if not in full screen mode.
2454 if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
2455 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
2456 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
2459 // `invalidateOptionsMenu` should recalculate the number of action buttons from the menu to display on the app bar, but it doesn't because of the this bug:
2460 // https://code.google.com/p/android/issues/detail?id=20493#c8
2461 // ActivityCompat.invalidateOptionsMenu(this);
2465 public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
2466 // Store the hit test result.
2467 final WebView.HitTestResult hitTestResult = currentWebView.getHitTestResult();
2469 // Create the URL strings.
2470 final String imageUrl;
2471 final String linkUrl;
2473 // Get handles for the system managers.
2474 final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
2475 FragmentManager fragmentManager = getSupportFragmentManager();
2476 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2478 // Remove the lint errors below that the clipboard manager might be null.
2479 assert clipboardManager != null;
2481 // Process the link according to the type.
2482 switch (hitTestResult.getType()) {
2483 // `SRC_ANCHOR_TYPE` is a link.
2484 case WebView.HitTestResult.SRC_ANCHOR_TYPE:
2485 // Get the target URL.
2486 linkUrl = hitTestResult.getExtra();
2488 // Set the target URL as the title of the `ContextMenu`.
2489 menu.setHeaderTitle(linkUrl);
2491 // Add a Load URL entry.
2492 menu.add(R.string.open_in_new_tab).setOnMenuItemClickListener((MenuItem item) -> {
2501 // Add an Open with App entry.
2502 menu.add(R.string.open_with_app).setOnMenuItemClickListener((MenuItem item) -> {
2503 openWithApp(linkUrl);
2507 // Add an Open with Browser entry.
2508 menu.add(R.string.open_with_browser).setOnMenuItemClickListener((MenuItem item) -> {
2509 openWithBrowser(linkUrl);
2513 // Add a Copy URL entry.
2514 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
2515 // Save the link URL in a `ClipData`.
2516 ClipData srcAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
2518 // Set the `ClipData` as the clipboard's primary clip.
2519 clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
2523 // Add a Download URL entry.
2524 menu.add(R.string.download_url).setOnMenuItemClickListener((MenuItem item) -> {
2525 // Check if the download should be processed by an external app.
2526 if (sharedPreferences.getBoolean("download_with_external_app", false)) { // Download with an external app.
2527 openUrlWithExternalApp(linkUrl);
2528 } else { // Download with Android's download manager.
2529 // Check to see if the storage permission has already been granted.
2530 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) { // The storage permission needs to be requested.
2531 // Store the variables for future use by `onRequestPermissionsResult()`.
2532 downloadUrl = linkUrl;
2533 downloadContentDisposition = "none";
2534 downloadContentLength = -1;
2536 // Show a dialog if the user has previously denied the permission.
2537 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2538 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
2539 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
2541 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
2542 downloadLocationPermissionDialogFragment.show(fragmentManager, getString(R.string.download_location));
2543 } else { // Show the permission request directly.
2544 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
2545 ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
2547 } else { // The storage permission has already been granted.
2548 // Get a handle for the download file alert dialog.
2549 DialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(linkUrl, "none", -1);
2551 // Show the download file alert dialog.
2552 downloadFileDialogFragment.show(fragmentManager, getString(R.string.download));
2558 // Add a Cancel entry, which by default closes the context menu.
2559 menu.add(R.string.cancel);
2562 case WebView.HitTestResult.EMAIL_TYPE:
2563 // Get the target URL.
2564 linkUrl = hitTestResult.getExtra();
2566 // Set the target URL as the title of the `ContextMenu`.
2567 menu.setHeaderTitle(linkUrl);
2569 // Add a Write Email entry.
2570 menu.add(R.string.write_email).setOnMenuItemClickListener(item -> {
2571 // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
2572 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
2574 // Parse the url and set it as the data for the `Intent`.
2575 emailIntent.setData(Uri.parse("mailto:" + linkUrl));
2577 // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
2578 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2581 startActivity(emailIntent);
2585 // Add a Copy Email Address entry.
2586 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(item -> {
2587 // Save the email address in a `ClipData`.
2588 ClipData srcEmailTypeClipData = ClipData.newPlainText(getString(R.string.email_address), linkUrl);
2590 // Set the `ClipData` as the clipboard's primary clip.
2591 clipboardManager.setPrimaryClip(srcEmailTypeClipData);
2595 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2596 menu.add(R.string.cancel);
2599 // `IMAGE_TYPE` is an image.
2600 case WebView.HitTestResult.IMAGE_TYPE:
2601 // Get the image URL.
2602 imageUrl = hitTestResult.getExtra();
2604 // Set the image URL as the title of the `ContextMenu`.
2605 menu.setHeaderTitle(imageUrl);
2607 // Add a View Image entry.
2608 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2613 // Add a Download Image entry.
2614 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2615 // Check if the download should be processed by an external app.
2616 if (sharedPreferences.getBoolean("download_with_external_app", false)) { // Download with an external app.
2617 openUrlWithExternalApp(imageUrl);
2618 } else { // Download with Android's download manager.
2619 // Check to see if the storage permission has already been granted.
2620 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) { // The storage permission needs to be requested.
2621 // Store the image URL for use by `onRequestPermissionResult()`.
2622 downloadImageUrl = imageUrl;
2624 // Show a dialog if the user has previously denied the permission.
2625 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2626 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2627 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2629 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
2630 downloadLocationPermissionDialogFragment.show(fragmentManager, getString(R.string.download_location));
2631 } else { // Show the permission request directly.
2632 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
2633 ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2635 } else { // The storage permission has already been granted.
2636 // Get a handle for the download image alert dialog.
2637 DialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2639 // Show the download image alert dialog.
2640 downloadImageDialogFragment.show(fragmentManager, getString(R.string.download));
2646 // Add a Copy URL entry.
2647 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2648 // Save the image URL in a `ClipData`.
2649 ClipData srcImageTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2651 // Set the `ClipData` as the clipboard's primary clip.
2652 clipboardManager.setPrimaryClip(srcImageTypeClipData);
2656 // Add an Open with App entry.
2657 menu.add(R.string.open_with_app).setOnMenuItemClickListener((MenuItem item) -> {
2658 openWithApp(imageUrl);
2662 // Add an Open with Browser entry.
2663 menu.add(R.string.open_with_browser).setOnMenuItemClickListener((MenuItem item) -> {
2664 openWithBrowser(imageUrl);
2668 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2669 menu.add(R.string.cancel);
2673 // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
2674 case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
2675 // Get the image URL.
2676 imageUrl = hitTestResult.getExtra();
2678 // Set the image URL as the title of the `ContextMenu`.
2679 menu.setHeaderTitle(imageUrl);
2681 // Add a `View Image` entry.
2682 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2687 // Add a `Download Image` entry.
2688 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2689 // Check if the download should be processed by an external app.
2690 if (sharedPreferences.getBoolean("download_with_external_app", false)) { // Download with an external app.
2691 openUrlWithExternalApp(imageUrl);
2692 } else { // Download with Android's download manager.
2693 // Check to see if the storage permission has already been granted.
2694 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) { // The storage permission needs to be requested.
2695 // Store the image URL for use by `onRequestPermissionResult()`.
2696 downloadImageUrl = imageUrl;
2698 // Show a dialog if the user has previously denied the permission.
2699 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2700 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2701 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2703 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
2704 downloadLocationPermissionDialogFragment.show(fragmentManager, getString(R.string.download_location));
2705 } else { // Show the permission request directly.
2706 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
2707 ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2709 } else { // The storage permission has already been granted.
2710 // Get a handle for the download image alert dialog.
2711 DialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2713 // Show the download image alert dialog.
2714 downloadImageDialogFragment.show(fragmentManager, getString(R.string.download));
2720 // Add a `Copy URL` entry.
2721 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2722 // Save the image URL in a `ClipData`.
2723 ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2725 // Set the `ClipData` as the clipboard's primary clip.
2726 clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
2730 // Add an Open with App entry.
2731 menu.add(R.string.open_with_app).setOnMenuItemClickListener((MenuItem item) -> {
2732 openWithApp(imageUrl);
2736 // Add an Open with Browser entry.
2737 menu.add(R.string.open_with_browser).setOnMenuItemClickListener((MenuItem item) -> {
2738 openWithBrowser(imageUrl);
2742 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2743 menu.add(R.string.cancel);
2749 public void onCreateBookmark(DialogFragment dialogFragment, Bitmap favoriteIconBitmap) {
2750 // Get a handle for the bookmarks list view.
2751 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
2753 // Get the views from the dialog fragment.
2754 EditText createBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_name_edittext);
2755 EditText createBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_url_edittext);
2757 // Extract the strings from the edit texts.
2758 String bookmarkNameString = createBookmarkNameEditText.getText().toString();
2759 String bookmarkUrlString = createBookmarkUrlEditText.getText().toString();
2761 // Create a favorite icon byte array output stream.
2762 ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2764 // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2765 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
2767 // Convert the favorite icon byte array stream to a byte array.
2768 byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
2770 // Display the new bookmark below the current items in the (0 indexed) list.
2771 int newBookmarkDisplayOrder = bookmarksListView.getCount();
2773 // Create the bookmark.
2774 bookmarksDatabaseHelper.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray);
2776 // Update the bookmarks cursor with the current contents of this folder.
2777 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2779 // Update the list view.
2780 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2782 // Scroll to the new bookmark.
2783 bookmarksListView.setSelection(newBookmarkDisplayOrder);
2787 public void onCreateBookmarkFolder(DialogFragment dialogFragment, Bitmap favoriteIconBitmap) {
2788 // Get a handle for the bookmarks list view.
2789 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
2791 // Get handles for the views in the dialog fragment.
2792 EditText createFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.create_folder_name_edittext);
2793 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon_radiobutton);
2794 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon);
2796 // Get new folder name string.
2797 String folderNameString = createFolderNameEditText.getText().toString();
2799 // Create a folder icon bitmap.
2800 Bitmap folderIconBitmap;
2802 // Set the folder icon bitmap according to the dialog.
2803 if (defaultFolderIconRadioButton.isChecked()) { // Use the default folder icon.
2804 // Get the default folder icon drawable.
2805 Drawable folderIconDrawable = folderIconImageView.getDrawable();
2807 // Convert the folder icon drawable to a bitmap drawable.
2808 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2810 // Convert the folder icon bitmap drawable to a bitmap.
2811 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2812 } else { // Use the WebView favorite icon.
2813 // Copy the favorite icon bitmap to the folder icon bitmap.
2814 folderIconBitmap = favoriteIconBitmap;
2817 // Create a folder icon byte array output stream.
2818 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2820 // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2821 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
2823 // Convert the folder icon byte array stream to a byte array.
2824 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
2826 // Move all the bookmarks down one in the display order.
2827 for (int i = 0; i < bookmarksListView.getCount(); i++) {
2828 int databaseId = (int) bookmarksListView.getItemIdAtPosition(i);
2829 bookmarksDatabaseHelper.updateDisplayOrder(databaseId, i + 1);
2832 // Create the folder, which will be placed at the top of the `ListView`.
2833 bookmarksDatabaseHelper.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray);
2835 // Update the bookmarks cursor with the current contents of this folder.
2836 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2838 // Update the `ListView`.
2839 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2841 // Scroll to the new folder.
2842 bookmarksListView.setSelection(0);
2846 public void onSaveBookmark(DialogFragment dialogFragment, int selectedBookmarkDatabaseId, Bitmap favoriteIconBitmap) {
2847 // Get handles for the views from `dialogFragment`.
2848 EditText editBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_name_edittext);
2849 EditText editBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_url_edittext);
2850 RadioButton currentBookmarkIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_current_icon_radiobutton);
2852 // Store the bookmark strings.
2853 String bookmarkNameString = editBookmarkNameEditText.getText().toString();
2854 String bookmarkUrlString = editBookmarkUrlEditText.getText().toString();
2856 // Update the bookmark.
2857 if (currentBookmarkIconRadioButton.isChecked()) { // Update the bookmark without changing the favorite icon.
2858 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString);
2859 } else { // Update the bookmark using the `WebView` favorite icon.
2860 // Create a favorite icon byte array output stream.
2861 ByteArrayOutputStream newFavoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2863 // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2864 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFavoriteIconByteArrayOutputStream);
2866 // Convert the favorite icon byte array stream to a byte array.
2867 byte[] newFavoriteIconByteArray = newFavoriteIconByteArrayOutputStream.toByteArray();
2869 // Update the bookmark and the favorite icon.
2870 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString, newFavoriteIconByteArray);
2873 // Update the bookmarks cursor with the current contents of this folder.
2874 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2876 // Update the list view.
2877 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2881 public void onSaveBookmarkFolder(DialogFragment dialogFragment, int selectedFolderDatabaseId, Bitmap favoriteIconBitmap) {
2882 // Get handles for the views from `dialogFragment`.
2883 EditText editFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_folder_name_edittext);
2884 RadioButton currentFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_current_icon_radiobutton);
2885 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_radiobutton);
2886 ImageView defaultFolderIconImageView = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_imageview);
2888 // Get the new folder name.
2889 String newFolderNameString = editFolderNameEditText.getText().toString();
2891 // Check if the favorite icon has changed.
2892 if (currentFolderIconRadioButton.isChecked()) { // Only the name has changed.
2893 // Update the name in the database.
2894 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString);
2895 } else if (!currentFolderIconRadioButton.isChecked() && newFolderNameString.equals(oldFolderNameString)) { // Only the icon has changed.
2896 // Create the new folder icon Bitmap.
2897 Bitmap folderIconBitmap;
2899 // Populate the new folder icon bitmap.
2900 if (defaultFolderIconRadioButton.isChecked()) {
2901 // Get the default folder icon drawable.
2902 Drawable folderIconDrawable = defaultFolderIconImageView.getDrawable();
2904 // Convert the folder icon drawable to a bitmap drawable.
2905 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2907 // Convert the folder icon bitmap drawable to a bitmap.
2908 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2909 } else { // Use the `WebView` favorite icon.
2910 // Copy the favorite icon bitmap to the folder icon bitmap.
2911 folderIconBitmap = favoriteIconBitmap;
2914 // Create a folder icon byte array output stream.
2915 ByteArrayOutputStream newFolderIconByteArrayOutputStream = new ByteArrayOutputStream();
2917 // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2918 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFolderIconByteArrayOutputStream);
2920 // Convert the folder icon byte array stream to a byte array.
2921 byte[] newFolderIconByteArray = newFolderIconByteArrayOutputStream.toByteArray();
2923 // Update the folder icon in the database.
2924 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, newFolderIconByteArray);
2925 } else { // The folder icon and the name have changed.
2926 // Get the new folder icon `Bitmap`.
2927 Bitmap folderIconBitmap;
2928 if (defaultFolderIconRadioButton.isChecked()) {
2929 // Get the default folder icon drawable.
2930 Drawable folderIconDrawable = defaultFolderIconImageView.getDrawable();
2932 // Convert the folder icon drawable to a bitmap drawable.
2933 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2935 // Convert the folder icon bitmap drawable to a bitmap.
2936 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2937 } else { // Use the `WebView` favorite icon.
2938 // Copy the favorite icon bitmap to the folder icon bitmap.
2939 folderIconBitmap = favoriteIconBitmap;
2942 // Create a folder icon byte array output stream.
2943 ByteArrayOutputStream newFolderIconByteArrayOutputStream = new ByteArrayOutputStream();
2945 // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2946 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFolderIconByteArrayOutputStream);
2948 // Convert the folder icon byte array stream to a byte array.
2949 byte[] newFolderIconByteArray = newFolderIconByteArrayOutputStream.toByteArray();
2951 // Update the folder name and icon in the database.
2952 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString, newFolderIconByteArray);
2955 // Update the bookmarks cursor with the current contents of this folder.
2956 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2958 // Update the `ListView`.
2959 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2963 public void onCloseDownloadLocationPermissionDialog(int downloadType) {
2964 switch (downloadType) {
2965 case DownloadLocationPermissionDialog.DOWNLOAD_FILE:
2966 // Request the WRITE_EXTERNAL_STORAGE permission with a file request code.
2967 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
2970 case DownloadLocationPermissionDialog.DOWNLOAD_IMAGE:
2971 // Request the WRITE_EXTERNAL_STORAGE permission with an image request code.
2972 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2978 public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
2979 // Get a handle for the fragment manager.
2980 FragmentManager fragmentManager = getSupportFragmentManager();
2982 switch (requestCode) {
2983 case DOWNLOAD_FILE_REQUEST_CODE:
2984 // Show the download file alert dialog. When the dialog closes, the correct command will be used based on the permission status.
2985 DialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(downloadUrl, downloadContentDisposition, downloadContentLength);
2987 // On API 23, displaying the fragment must be delayed or the app will crash.
2988 if (Build.VERSION.SDK_INT == 23) {
2989 new Handler().postDelayed(() -> downloadFileDialogFragment.show(fragmentManager, getString(R.string.download)), 500);
2991 downloadFileDialogFragment.show(fragmentManager, getString(R.string.download));
2994 // Reset the download variables.
2996 downloadContentDisposition = "";
2997 downloadContentLength = 0;
3000 case DOWNLOAD_IMAGE_REQUEST_CODE:
3001 // Show the download image alert dialog. When the dialog closes, the correct command will be used based on the permission status.
3002 DialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(downloadImageUrl);
3004 // On API 23, displaying the fragment must be delayed or the app will crash.
3005 if (Build.VERSION.SDK_INT == 23) {
3006 new Handler().postDelayed(() -> downloadImageDialogFragment.show(fragmentManager, getString(R.string.download)), 500);
3008 downloadImageDialogFragment.show(fragmentManager, getString(R.string.download));
3011 // Reset the image URL variable.
3012 downloadImageUrl = "";
3018 public void onDownloadImage(DialogFragment dialogFragment, String imageUrl) {
3019 // Download the image if it has an HTTP or HTTPS URI.
3020 if (imageUrl.startsWith("http")) {
3021 // Get a handle for the system `DOWNLOAD_SERVICE`.
3022 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3024 // Parse `imageUrl`.
3025 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(imageUrl));
3027 // Get a handle for the cookie manager.
3028 CookieManager cookieManager = CookieManager.getInstance();
3030 // Pass cookies to download manager if cookies are enabled. This is required to download images from websites that require a login.
3031 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3032 if (cookieManager.acceptCookie()) {
3033 // Get the cookies for `imageUrl`.
3034 String cookies = cookieManager.getCookie(imageUrl);
3036 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3037 downloadRequest.addRequestHeader("Cookie", cookies);
3040 // Get the file name from the dialog fragment.
3041 EditText downloadImageNameEditText = dialogFragment.getDialog().findViewById(R.id.download_image_name);
3042 String imageName = downloadImageNameEditText.getText().toString();
3044 // Specify the download location.
3045 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3046 // Download to the public download directory.
3047 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, imageName);
3048 } else { // External write permission denied.
3049 // Download to the app's external download directory.
3050 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, imageName);
3053 // Allow `MediaScanner` to index the download if it is a media file.
3054 downloadRequest.allowScanningByMediaScanner();
3056 // Add the URL as the description for the download.
3057 downloadRequest.setDescription(imageUrl);
3059 // Show the download notification after the download is completed.
3060 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3062 // Remove the lint warning below that `downloadManager` might be `null`.
3063 assert downloadManager != null;
3065 // Initiate the download.
3066 downloadManager.enqueue(downloadRequest);
3067 } else { // The image is not an HTTP or HTTPS URI.
3068 Snackbar.make(currentWebView, R.string.cannot_download_image, Snackbar.LENGTH_INDEFINITE).show();
3073 public void onDownloadFile(DialogFragment dialogFragment, String downloadUrl) {
3074 // Download the file if it has an HTTP or HTTPS URI.
3075 if (downloadUrl.startsWith("http")) {
3076 // Get a handle for the system `DOWNLOAD_SERVICE`.
3077 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3079 // Parse `downloadUrl`.
3080 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(downloadUrl));
3082 // Get a handle for the cookie manager.
3083 CookieManager cookieManager = CookieManager.getInstance();
3085 // Pass cookies to download manager if cookies are enabled. This is required to download files from websites that require a login.
3086 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3087 if (cookieManager.acceptCookie()) {
3088 // Get the cookies for `downloadUrl`.
3089 String cookies = cookieManager.getCookie(downloadUrl);
3091 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3092 downloadRequest.addRequestHeader("Cookie", cookies);
3095 // Get the file name from the dialog fragment.
3096 EditText downloadFileNameEditText = dialogFragment.getDialog().findViewById(R.id.download_file_name);
3097 String fileName = downloadFileNameEditText.getText().toString();
3099 // Specify the download location.
3100 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3101 // Download to the public download directory.
3102 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, fileName);
3103 } else { // External write permission denied.
3104 // Download to the app's external download directory.
3105 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, fileName);
3108 // Allow `MediaScanner` to index the download if it is a media file.
3109 downloadRequest.allowScanningByMediaScanner();
3111 // Add the URL as the description for the download.
3112 downloadRequest.setDescription(downloadUrl);
3114 // Show the download notification after the download is completed.
3115 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3117 // Remove the lint warning below that `downloadManager` might be `null`.
3118 assert downloadManager != null;
3120 // Initiate the download.
3121 downloadManager.enqueue(downloadRequest);
3122 } else { // The download is not an HTTP or HTTPS URI.
3123 Snackbar.make(currentWebView, R.string.cannot_download_file, Snackbar.LENGTH_INDEFINITE).show();
3127 // Override `onBackPressed` to handle the navigation drawer and and the WebView.
3129 public void onBackPressed() {
3130 // Get a handle for the drawer layout and the tab layout.
3131 DrawerLayout drawerLayout = findViewById(R.id.drawerlayout);
3132 TabLayout tabLayout = findViewById(R.id.tablayout);
3134 if (drawerLayout.isDrawerVisible(GravityCompat.START)) { // The navigation drawer is open.
3135 // Close the navigation drawer.
3136 drawerLayout.closeDrawer(GravityCompat.START);
3137 } else if (drawerLayout.isDrawerVisible(GravityCompat.END)){ // The bookmarks drawer is open.
3138 if (currentBookmarksFolder.isEmpty()) { // The home folder is displayed.
3139 // close the bookmarks drawer.
3140 drawerLayout.closeDrawer(GravityCompat.END);
3141 } else { // A subfolder is displayed.
3142 // Place the former parent folder in `currentFolder`.
3143 currentBookmarksFolder = bookmarksDatabaseHelper.getParentFolderName(currentBookmarksFolder);
3145 // Load the new folder.
3146 loadBookmarksFolder();
3148 } else if (currentWebView.canGoBack()) { // There is at least one item in the current WebView history.
3149 // Reset the current domain name so that navigation works if third-party requests are blocked.
3150 currentWebView.resetCurrentDomainName();
3152 // Set navigating history so that the domain settings are applied when the new URL is loaded.
3153 currentWebView.setNavigatingHistory(true);
3156 currentWebView.goBack();
3157 } else if (tabLayout.getTabCount() > 1) { // There are at least two tabs.
3158 // Close the current tab.
3160 } else { // There isn't anything to do in Privacy Browser.
3161 // Run the default commands.
3162 super.onBackPressed();
3164 // Manually kill Privacy Browser. Otherwise, it is glitchy when restarted.
3169 // Process the results of an upload file chooser. Currently there is only one `startActivityForResult` in this activity, so the request code, used to differentiate them, is ignored.
3171 public void onActivityResult(int requestCode, int resultCode, Intent data) {
3172 // File uploads only work on API >= 21.
3173 if (Build.VERSION.SDK_INT >= 21) {
3174 // Pass the file to the WebView.
3175 fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(resultCode, data));
3179 private void loadUrlFromTextBox() {
3180 // Get a handle for the URL edit text.
3181 EditText urlEditText = findViewById(R.id.url_edittext);
3183 // Get the text from urlTextBox and convert it to a string. trim() removes white spaces from the beginning and end of the string.
3184 String unformattedUrlString = urlEditText.getText().toString().trim();
3186 // Initialize the formatted URL string.
3189 // Check to see if `unformattedUrlString` is a valid URL. Otherwise, convert it into a search.
3190 if (unformattedUrlString.startsWith("content://")) { // This is a Content URL.
3191 // Load the entire content URL.
3192 url = unformattedUrlString;
3193 } else if (Patterns.WEB_URL.matcher(unformattedUrlString).matches() || unformattedUrlString.startsWith("http://") || unformattedUrlString.startsWith("https://") ||
3194 unformattedUrlString.startsWith("file://")) { // This is a standard URL.
3195 // Add `https://` at the beginning if there is no protocol. Otherwise the app will segfault.
3196 if (!unformattedUrlString.startsWith("http") && !unformattedUrlString.startsWith("file://") && !unformattedUrlString.startsWith("content://")) {
3197 unformattedUrlString = "https://" + unformattedUrlString;
3200 // Initialize `unformattedUrl`.
3201 URL unformattedUrl = null;
3203 // Convert `unformattedUrlString` to a `URL`, then to a `URI`, and then back to a `String`, which sanitizes the input and adds in any missing components.
3205 unformattedUrl = new URL(unformattedUrlString);
3206 } catch (MalformedURLException e) {
3207 e.printStackTrace();
3210 // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if `.get` was called on a `null` value.
3211 String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
3212 String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
3213 String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
3214 String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
3215 String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
3218 Uri.Builder uri = new Uri.Builder();
3219 uri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
3221 // Decode the URI as a UTF-8 string in.
3223 url = URLDecoder.decode(uri.build().toString(), "UTF-8");
3224 } catch (UnsupportedEncodingException exception) {
3225 // Do nothing. The formatted URL string will remain blank.
3227 } else if (!unformattedUrlString.isEmpty()){ // This is not a URL, but rather a search string.
3228 // Create an encoded URL String.
3229 String encodedUrlString;
3231 // Sanitize the search input.
3233 encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
3234 } catch (UnsupportedEncodingException exception) {
3235 encodedUrlString = "";
3238 // Add the base search URL.
3239 url = searchURL + encodedUrlString;
3242 // 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.
3243 urlEditText.clearFocus();
3249 private void loadUrl(String url) {
3250 // Apply the domain settings.
3251 applyDomainSettings(currentWebView, url, true, false);
3254 currentWebView.loadUrl(url, customHeaders);
3257 public void findPreviousOnPage(View view) {
3258 // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards.
3259 currentWebView.findNext(false);
3262 public void findNextOnPage(View view) {
3263 // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
3264 currentWebView.findNext(true);
3267 public void closeFindOnPage(View view) {
3268 // Get a handle for the views.
3269 Toolbar toolbar = findViewById(R.id.toolbar);
3270 LinearLayout findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
3271 EditText findOnPageEditText = findViewById(R.id.find_on_page_edittext);
3273 // Delete the contents of `find_on_page_edittext`.
3274 findOnPageEditText.setText(null);
3276 // Clear the highlighted phrases if the WebView is not null.
3277 if (currentWebView != null) {
3278 currentWebView.clearMatches();
3281 // Hide the find on page linear layout.
3282 findOnPageLinearLayout.setVisibility(View.GONE);
3284 // Show the toolbar.
3285 toolbar.setVisibility(View.VISIBLE);
3287 // Get a handle for the input method manager.
3288 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
3290 // Remove the lint warning below that the input method manager might be null.
3291 assert inputMethodManager != null;
3293 // Hide the keyboard.
3294 inputMethodManager.hideSoftInputFromWindow(currentWebView.getWindowToken(), 0);
3297 private void applyAppSettings() {
3298 // Get a handle for the shared preferences.
3299 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3301 // Store the values from the shared preferences in variables.
3302 incognitoModeEnabled = sharedPreferences.getBoolean("incognito_mode", false);
3303 boolean doNotTrackEnabled = sharedPreferences.getBoolean("do_not_track", false);
3304 proxyThroughOrbot = sharedPreferences.getBoolean("proxy_through_orbot", false);
3305 fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean("full_screen_browsing_mode", false);
3306 hideAppBar = sharedPreferences.getBoolean("hide_app_bar", true);
3307 scrollAppBar = sharedPreferences.getBoolean("scroll_app_bar", true);
3309 // Get handles for the views that need to be modified.
3310 FrameLayout rootFrameLayout = findViewById(R.id.root_framelayout);
3311 AppBarLayout appBarLayout = findViewById(R.id.appbar_layout);
3312 ActionBar actionBar = getSupportActionBar();
3313 Toolbar toolbar = findViewById(R.id.toolbar);
3314 LinearLayout findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
3315 LinearLayout tabsLinearLayout = findViewById(R.id.tabs_linearlayout);
3316 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
3318 // Remove the incorrect lint warning below that the action bar might be null.
3319 assert actionBar != null;
3321 // Apply the proxy through Orbot settings.
3322 applyProxyThroughOrbot(false);
3324 // Set Do Not Track status.
3325 if (doNotTrackEnabled) {
3326 customHeaders.put("DNT", "1");
3328 customHeaders.remove("DNT");
3331 // Get the current layout parameters. Using coordinator layout parameters allows the `setBehavior()` command and using app bar layout parameters allows the `setScrollFlags()` command.
3332 CoordinatorLayout.LayoutParams swipeRefreshLayoutParams = (CoordinatorLayout.LayoutParams) swipeRefreshLayout.getLayoutParams();
3333 AppBarLayout.LayoutParams toolbarLayoutParams = (AppBarLayout.LayoutParams) toolbar.getLayoutParams();
3334 AppBarLayout.LayoutParams findOnPageLayoutParams = (AppBarLayout.LayoutParams) findOnPageLinearLayout.getLayoutParams();
3335 AppBarLayout.LayoutParams tabsLayoutParams = (AppBarLayout.LayoutParams) tabsLinearLayout.getLayoutParams();
3337 // Add the scrolling behavior to the layout parameters.
3339 // Enable scrolling of the app bar.
3340 swipeRefreshLayoutParams.setBehavior(new AppBarLayout.ScrollingViewBehavior());
3341 toolbarLayoutParams.setScrollFlags(AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP);
3342 findOnPageLayoutParams.setScrollFlags(AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP);
3343 tabsLayoutParams.setScrollFlags(AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP);
3345 // Disable scrolling of the app bar.
3346 swipeRefreshLayoutParams.setBehavior(null);
3347 toolbarLayoutParams.setScrollFlags(0);
3348 findOnPageLayoutParams.setScrollFlags(0);
3349 tabsLayoutParams.setScrollFlags(0);
3351 // Expand the app bar if it is currently collapsed.
3352 appBarLayout.setExpanded(true);
3355 // Apply the modified layout parameters.
3356 swipeRefreshLayout.setLayoutParams(swipeRefreshLayoutParams);
3357 toolbar.setLayoutParams(toolbarLayoutParams);
3358 findOnPageLinearLayout.setLayoutParams(findOnPageLayoutParams);
3359 tabsLinearLayout.setLayoutParams(tabsLayoutParams);
3361 // Set the app bar scrolling for each WebView.
3362 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
3363 // Get the WebView tab fragment.
3364 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
3366 // Get the fragment view.
3367 View fragmentView = webViewTabFragment.getView();
3369 // Only modify the WebViews if they exist.
3370 if (fragmentView != null) {
3371 // Get the nested scroll WebView from the tab fragment.
3372 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
3374 // Set the app bar scrolling.
3375 nestedScrollWebView.setNestedScrollingEnabled(scrollAppBar);
3379 // Update the full screen browsing mode settings.
3380 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
3381 // Update the visibility of the app bar, which might have changed in the settings.
3383 // Hide the tab linear layout.
3384 tabsLinearLayout.setVisibility(View.GONE);
3386 // Hide the action bar.
3389 // Show the tab linear layout.
3390 tabsLinearLayout.setVisibility(View.VISIBLE);
3392 // Show the action bar.
3396 // Hide the banner ad in the free flavor.
3397 if (BuildConfig.FLAVOR.contentEquals("free")) {
3398 AdHelper.hideAd(findViewById(R.id.adview));
3401 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
3402 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3404 /* Hide the system bars.
3405 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
3406 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
3407 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
3408 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
3410 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
3411 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
3412 } else { // Privacy Browser is not in full screen browsing mode.
3413 // 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.
3414 inFullScreenBrowsingMode = false;
3416 // Show the tab linear layout.
3417 tabsLinearLayout.setVisibility(View.VISIBLE);
3419 // Show the action bar.
3422 // Show the banner ad in the free flavor.
3423 if (BuildConfig.FLAVOR.contentEquals("free")) {
3424 // Initialize the ads. If this isn't the first run, `loadAd()` will be automatically called instead.
3425 AdHelper.initializeAds(findViewById(R.id.adview), getApplicationContext(), getSupportFragmentManager(), getString(R.string.google_app_id), getString(R.string.ad_unit_id));
3428 // Remove the `SYSTEM_UI` flags from the root frame layout.
3429 rootFrameLayout.setSystemUiVisibility(0);
3431 // Add the translucent status flag.
3432 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3437 // `reloadWebsite` is used if returning from the Domains activity. Otherwise JavaScript might not function correctly if it is newly enabled.
3438 @SuppressLint("SetJavaScriptEnabled")
3439 private boolean applyDomainSettings(NestedScrollWebView nestedScrollWebView, String url, boolean resetTab, boolean reloadWebsite) {
3440 // Store a copy of the current user agent to track changes for the return boolean.
3441 String initialUserAgent = nestedScrollWebView.getSettings().getUserAgentString();
3443 // Parse the URL into a URI.
3444 Uri uri = Uri.parse(url);
3446 // Extract the domain from `uri`.
3447 String newHostName = uri.getHost();
3449 // Strings don't like to be null.
3450 if (newHostName == null) {
3454 // Only apply the domain settings if a new domain is being loaded. This allows the user to set temporary settings for JavaScript, cookies, DOM storage, etc.
3455 if (!nestedScrollWebView.getCurrentDomainName().equals(newHostName)) {
3456 // Set the new host name as the current domain name.
3457 nestedScrollWebView.setCurrentDomainName(newHostName);
3459 // Reset the ignoring of pinned domain information.
3460 nestedScrollWebView.setIgnorePinnedDomainInformation(false);
3462 // Clear any pinned SSL certificate or IP addresses.
3463 nestedScrollWebView.clearPinnedSslCertificate();
3464 nestedScrollWebView.clearPinnedIpAddresses();
3466 // Reset the favorite icon if specified.
3468 // Initialize the favorite icon.
3469 nestedScrollWebView.initializeFavoriteIcon();
3471 // Get the current page position.
3472 int currentPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
3474 // Get a handle for the tab layout.
3475 TabLayout tabLayout = findViewById(R.id.tablayout);
3477 // Get the corresponding tab.
3478 TabLayout.Tab tab = tabLayout.getTabAt(currentPagePosition);
3480 // Update the tab if it isn't null, which sometimes happens when restarting from the background.
3482 // Get the tab custom view.
3483 View tabCustomView = tab.getCustomView();
3485 // Remove the warning below that the tab custom view might be null.
3486 assert tabCustomView != null;
3488 // Get the tab views.
3489 ImageView tabFavoriteIconImageView = tabCustomView.findViewById(R.id.favorite_icon_imageview);
3490 TextView tabTitleTextView = tabCustomView.findViewById(R.id.title_textview);
3492 // Set the default favorite icon as the favorite icon for this tab.
3493 tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(nestedScrollWebView.getFavoriteOrDefaultIcon(), 64, 64, true));
3495 // Set the loading title text.
3496 tabTitleTextView.setText(R.string.loading);
3500 // Initialize the database handler. The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
3501 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
3503 // Get a full cursor from `domainsDatabaseHelper`.
3504 Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain();
3506 // Initialize `domainSettingsSet`.
3507 Set<String> domainSettingsSet = new HashSet<>();
3509 // Get the domain name column index.
3510 int domainNameColumnIndex = domainNameCursor.getColumnIndex(DomainsDatabaseHelper.DOMAIN_NAME);
3512 // Populate `domainSettingsSet`.
3513 for (int i = 0; i < domainNameCursor.getCount(); i++) {
3514 // Move `domainsCursor` to the current row.
3515 domainNameCursor.moveToPosition(i);
3517 // Store the domain name in `domainSettingsSet`.
3518 domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex));
3521 // Close `domainNameCursor.
3522 domainNameCursor.close();
3524 // Initialize the domain name in database variable.
3525 String domainNameInDatabase = null;
3527 // Check the hostname against the domain settings set.
3528 if (domainSettingsSet.contains(newHostName)) { // The hostname is contained in the domain settings set.
3529 // Record the domain name in the database.
3530 domainNameInDatabase = newHostName;
3532 // Set the domain settings applied tracker to true.
3533 nestedScrollWebView.setDomainSettingsApplied(true);
3534 } else { // The hostname is not contained in the domain settings set.
3535 // Set the domain settings applied tracker to false.
3536 nestedScrollWebView.setDomainSettingsApplied(false);
3539 // Check all the subdomains of the host name against wildcard domains in the domain cursor.
3540 while (!nestedScrollWebView.getDomainSettingsApplied() && newHostName.contains(".")) { // Stop checking if domain settings are already applied or there are no more `.` in the host name.
3541 if (domainSettingsSet.contains("*." + newHostName)) { // Check the host name prepended by `*.`.
3542 // Set the domain settings applied tracker to true.
3543 nestedScrollWebView.setDomainSettingsApplied(true);
3545 // Store the applied domain names as it appears in the database.
3546 domainNameInDatabase = "*." + newHostName;
3549 // Strip out the lowest subdomain of of the host name.
3550 newHostName = newHostName.substring(newHostName.indexOf(".") + 1);
3554 // Get a handle for the shared preferences.
3555 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3557 // Store the general preference information.
3558 String defaultFontSizeString = sharedPreferences.getString("font_size", getString(R.string.font_size_default_value));
3559 String defaultUserAgentName = sharedPreferences.getString("user_agent", getString(R.string.user_agent_default_value));
3560 boolean defaultSwipeToRefresh = sharedPreferences.getBoolean("swipe_to_refresh", true);
3561 boolean displayWebpageImages = sharedPreferences.getBoolean("display_webpage_images", true);
3562 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
3564 // Get a handle for the cookie manager.
3565 CookieManager cookieManager = CookieManager.getInstance();
3567 // Get handles for the views.
3568 RelativeLayout urlRelativeLayout = findViewById(R.id.url_relativelayout);
3569 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
3571 // Initialize the user agent array adapter and string array.
3572 ArrayAdapter<CharSequence> userAgentNamesArray = ArrayAdapter.createFromResource(this, R.array.user_agent_names, R.layout.spinner_item);
3573 String[] userAgentDataArray = getResources().getStringArray(R.array.user_agent_data);
3575 if (nestedScrollWebView.getDomainSettingsApplied()) { // The url has custom domain settings.
3576 // Get a cursor for the current host and move it to the first position.
3577 Cursor currentDomainSettingsCursor = domainsDatabaseHelper.getCursorForDomainName(domainNameInDatabase);
3578 currentDomainSettingsCursor.moveToFirst();
3580 // Get the settings from the cursor.
3581 nestedScrollWebView.setDomainSettingsDatabaseId(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper._ID)));
3582 nestedScrollWebView.setDomainSettingsJavaScriptEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1);
3583 nestedScrollWebView.setAcceptFirstPartyCookies(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FIRST_PARTY_COOKIES)) == 1);
3584 boolean domainThirdPartyCookiesEnabled = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_THIRD_PARTY_COOKIES)) == 1);
3585 nestedScrollWebView.getSettings().setDomStorageEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1);
3586 // Form data can be removed once the minimum API >= 26.
3587 boolean saveFormData = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1);
3588 nestedScrollWebView.enableBlocklist(NestedScrollWebView.EASY_LIST,
3589 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYLIST)) == 1);
3590 nestedScrollWebView.enableBlocklist(NestedScrollWebView.EASY_PRIVACY,
3591 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYPRIVACY)) == 1);
3592 nestedScrollWebView.enableBlocklist(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST,
3593 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_ANNOYANCE_LIST)) == 1);
3594 nestedScrollWebView.enableBlocklist(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST,
3595 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST)) == 1);
3596 nestedScrollWebView.enableBlocklist(NestedScrollWebView.ULTRA_PRIVACY,
3597 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_ULTRAPRIVACY)) == 1);
3598 nestedScrollWebView.enableBlocklist(NestedScrollWebView.THIRD_PARTY_REQUESTS,
3599 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.BLOCK_ALL_THIRD_PARTY_REQUESTS)) == 1);
3600 String userAgentName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.USER_AGENT));
3601 int fontSize = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.FONT_SIZE));
3602 int swipeToRefreshInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SWIPE_TO_REFRESH));
3603 int nightModeInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.NIGHT_MODE));
3604 int displayWebpageImagesInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.DISPLAY_IMAGES));
3605 boolean pinnedSslCertificate = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.PINNED_SSL_CERTIFICATE)) == 1);
3606 String pinnedSslIssuedToCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_COMMON_NAME));
3607 String pinnedSslIssuedToOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATION));
3608 String pinnedSslIssuedToUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT));
3609 String pinnedSslIssuedByCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_COMMON_NAME));
3610 String pinnedSslIssuedByOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATION));
3611 String pinnedSslIssuedByUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT));
3612 boolean pinnedIpAddresses = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.PINNED_IP_ADDRESSES)) == 1);
3613 String pinnedHostIpAddresses = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.IP_ADDRESSES));
3615 // Create the pinned SSL date variables.
3616 Date pinnedSslStartDate;
3617 Date pinnedSslEndDate;
3619 // Set the pinned SSL certificate start date to `null` if the saved date `long` is 0 because creating a new Date results in an error if the input is 0.
3620 if (currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)) == 0) {
3621 pinnedSslStartDate = null;
3623 pinnedSslStartDate = new Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)));
3626 // Set the pinned SSL certificate end date to `null` if the saved date `long` is 0 because creating a new Date results in an error if the input is 0.
3627 if (currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)) == 0) {
3628 pinnedSslEndDate = null;
3630 pinnedSslEndDate = new Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)));
3633 // If there is a pinned SSL certificate, store it in the WebView.
3634 if (pinnedSslCertificate) {
3635 nestedScrollWebView.setPinnedSslCertificate(pinnedSslIssuedToCName, pinnedSslIssuedToOName, pinnedSslIssuedToUName, pinnedSslIssuedByCName, pinnedSslIssuedByOName, pinnedSslIssuedByUName,
3636 pinnedSslStartDate, pinnedSslEndDate);
3639 // If there is a pinned IP address, store it in the WebView.
3640 if (pinnedIpAddresses) {
3641 nestedScrollWebView.setPinnedIpAddresses(pinnedHostIpAddresses);
3644 // Set night mode according to the night mode int.
3645 switch (nightModeInt) {
3646 case DomainsDatabaseHelper.NIGHT_MODE_SYSTEM_DEFAULT:
3647 // Set night mode according to the current default.
3648 nestedScrollWebView.setNightMode(sharedPreferences.getBoolean("night_mode", false));
3651 case DomainsDatabaseHelper.NIGHT_MODE_ENABLED:
3652 // Enable night mode.
3653 nestedScrollWebView.setNightMode(true);
3656 case DomainsDatabaseHelper.NIGHT_MODE_DISABLED:
3657 // Disable night mode.
3658 nestedScrollWebView.setNightMode(false);
3662 // Enable JavaScript if night mode is enabled.
3663 if (nestedScrollWebView.getNightMode()) {
3664 // Enable JavaScript.
3665 nestedScrollWebView.getSettings().setJavaScriptEnabled(true);
3667 // Set JavaScript according to the domain settings.
3668 nestedScrollWebView.getSettings().setJavaScriptEnabled(nestedScrollWebView.getDomainSettingsJavaScriptEnabled());
3671 // Close the current host domain settings cursor.
3672 currentDomainSettingsCursor.close();
3674 // Apply the domain settings.
3675 cookieManager.setAcceptCookie(nestedScrollWebView.getAcceptFirstPartyCookies());
3677 // Set third-party cookies status if API >= 21.
3678 if (Build.VERSION.SDK_INT >= 21) {
3679 cookieManager.setAcceptThirdPartyCookies(nestedScrollWebView, domainThirdPartyCookiesEnabled);
3682 // Apply the form data setting if the API < 26.
3683 if (Build.VERSION.SDK_INT < 26) {
3684 nestedScrollWebView.getSettings().setSaveFormData(saveFormData);
3687 // Apply the font size.
3688 if (fontSize == 0) { // Apply the default font size.
3689 nestedScrollWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3690 } else { // Apply the specified font size.
3691 nestedScrollWebView.getSettings().setTextZoom(fontSize);
3694 // Only set the user agent if the webpage is not currently loading. Otherwise, changing the user agent on redirects can cause the original website to reload.
3695 // <https://redmine.stoutner.com/issues/160>
3696 if (nestedScrollWebView.getProgress() == 100) { // A URL is not loading.
3697 // Set the user agent.
3698 if (userAgentName.equals(getString(R.string.system_default_user_agent))) { // Use the system default user agent.
3699 // Get the array position of the default user agent name.
3700 int defaultUserAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3702 // Set the user agent according to the system default.
3703 switch (defaultUserAgentArrayPosition) {
3704 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
3705 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3706 nestedScrollWebView.getSettings().setUserAgentString(defaultUserAgentName);
3709 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3710 // Set the user agent to `""`, which uses the default value.
3711 nestedScrollWebView.getSettings().setUserAgentString("");
3714 case SETTINGS_CUSTOM_USER_AGENT:
3715 // Set the default custom user agent.
3716 nestedScrollWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", getString(R.string.custom_user_agent_default_value)));
3720 // Get the user agent string from the user agent data array
3721 nestedScrollWebView.getSettings().setUserAgentString(userAgentDataArray[defaultUserAgentArrayPosition]);
3723 } else { // Set the user agent according to the stored name.
3724 // Get the array position of the user agent name.
3725 int userAgentArrayPosition = userAgentNamesArray.getPosition(userAgentName);
3727 switch (userAgentArrayPosition) {
3728 case UNRECOGNIZED_USER_AGENT: // The user agent name contains a custom user agent.
3729 nestedScrollWebView.getSettings().setUserAgentString(userAgentName);
3732 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3733 // Set the user agent to `""`, which uses the default value.
3734 nestedScrollWebView.getSettings().setUserAgentString("");
3738 // Get the user agent string from the user agent data array.
3739 nestedScrollWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3744 // Set swipe to refresh.
3745 switch (swipeToRefreshInt) {
3746 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_SYSTEM_DEFAULT:
3747 // Store the swipe to refresh status in the nested scroll WebView.
3748 nestedScrollWebView.setSwipeToRefresh(defaultSwipeToRefresh);
3750 // Apply swipe to refresh according to the default. This can be removed once the minimum API >= 23 because it is continuously set by an on scroll change listener.
3751 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3754 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_ENABLED:
3755 // Store the swipe to refresh status in the nested scroll WebView.
3756 nestedScrollWebView.setSwipeToRefresh(true);
3758 // Enable swipe to refresh. This can be removed once the minimum API >= 23 because it is continuously set by an on scroll change listener.
3759 swipeRefreshLayout.setEnabled(true);
3762 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_DISABLED:
3763 // Store the swipe to refresh status in the nested scroll WebView.
3764 nestedScrollWebView.setSwipeToRefresh(false);
3766 // Disable swipe to refresh. This can be removed once the minimum API >= 23 because it is continuously set by an on scroll change listener.
3767 swipeRefreshLayout.setEnabled(false);
3770 // Set the loading of webpage images.
3771 switch (displayWebpageImagesInt) {
3772 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_SYSTEM_DEFAULT:
3773 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImages);
3776 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_ENABLED:
3777 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(true);
3780 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_DISABLED:
3781 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(false);
3785 // Set a green background on the URL relative layout to indicate that custom domain settings are being used. The deprecated `.getDrawable()` must be used until the minimum API >= 21.
3787 urlRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_dark_blue));
3789 urlRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_light_green));
3791 } else { // The new URL does not have custom domain settings. Load the defaults.
3792 // Store the values from the shared preferences.
3793 boolean defaultJavaScriptEnabled = sharedPreferences.getBoolean("javascript", false);
3794 nestedScrollWebView.setAcceptFirstPartyCookies(sharedPreferences.getBoolean("first_party_cookies", false));
3795 boolean defaultThirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies", false);
3796 nestedScrollWebView.getSettings().setDomStorageEnabled(sharedPreferences.getBoolean("dom_storage", false));
3797 boolean saveFormData = sharedPreferences.getBoolean("save_form_data", false); // Form data can be removed once the minimum API >= 26.
3798 nestedScrollWebView.enableBlocklist(NestedScrollWebView.EASY_LIST, sharedPreferences.getBoolean("easylist", true));
3799 nestedScrollWebView.enableBlocklist(NestedScrollWebView.EASY_PRIVACY, sharedPreferences.getBoolean("easyprivacy", true));
3800 nestedScrollWebView.enableBlocklist(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST, sharedPreferences.getBoolean("fanboys_annoyance_list", true));
3801 nestedScrollWebView.enableBlocklist(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST, sharedPreferences.getBoolean("fanboys_social_blocking_list", true));
3802 nestedScrollWebView.enableBlocklist(NestedScrollWebView.ULTRA_PRIVACY, sharedPreferences.getBoolean("ultraprivacy", true));
3803 nestedScrollWebView.enableBlocklist(NestedScrollWebView.THIRD_PARTY_REQUESTS, sharedPreferences.getBoolean("block_all_third_party_requests", false));
3804 nestedScrollWebView.setNightMode(sharedPreferences.getBoolean("night_mode", false));
3806 // Enable JavaScript if night mode is enabled.
3807 if (nestedScrollWebView.getNightMode()) {
3808 // Enable JavaScript.
3809 nestedScrollWebView.getSettings().setJavaScriptEnabled(true);
3811 // Set JavaScript according to the domain settings.
3812 nestedScrollWebView.getSettings().setJavaScriptEnabled(defaultJavaScriptEnabled);
3815 // Apply the default settings.
3816 cookieManager.setAcceptCookie(nestedScrollWebView.getAcceptFirstPartyCookies());
3817 nestedScrollWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3819 // Apply the form data setting if the API < 26.
3820 if (Build.VERSION.SDK_INT < 26) {
3821 nestedScrollWebView.getSettings().setSaveFormData(saveFormData);
3824 // Store the swipe to refresh status in the nested scroll WebView.
3825 nestedScrollWebView.setSwipeToRefresh(defaultSwipeToRefresh);
3827 // Apply swipe to refresh according to the default.
3828 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3830 // Reset the pinned variables.
3831 nestedScrollWebView.setDomainSettingsDatabaseId(-1);
3833 // Set third-party cookies status if API >= 21.
3834 if (Build.VERSION.SDK_INT >= 21) {
3835 cookieManager.setAcceptThirdPartyCookies(nestedScrollWebView, defaultThirdPartyCookiesEnabled);
3838 // Only set the user agent if the webpage is not currently loading. Otherwise, changing the user agent on redirects can cause the original website to reload.
3839 // <https://redmine.stoutner.com/issues/160>
3840 if (nestedScrollWebView.getProgress() == 100) { // A URL is not loading.
3841 // Get the array position of the user agent name.
3842 int userAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3844 // Set the user agent.
3845 switch (userAgentArrayPosition) {
3846 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
3847 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3848 nestedScrollWebView.getSettings().setUserAgentString(defaultUserAgentName);
3851 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3852 // Set the user agent to `""`, which uses the default value.
3853 nestedScrollWebView.getSettings().setUserAgentString("");
3856 case SETTINGS_CUSTOM_USER_AGENT:
3857 // Set the default custom user agent.
3858 nestedScrollWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", getString(R.string.custom_user_agent_default_value)));
3862 // Get the user agent string from the user agent data array
3863 nestedScrollWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3867 // Set the loading of webpage images.
3868 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImages);
3870 // Set a transparent background on URL edit text. The deprecated `getResources().getDrawable()` must be used until the minimum API >= 21.
3871 urlRelativeLayout.setBackground(getResources().getDrawable(R.color.transparent));
3874 // Close the domains database helper.
3875 domainsDatabaseHelper.close();
3877 // Update the privacy icons.
3878 updatePrivacyIcons(true);
3881 // Reload the website if returning from the Domains activity.
3882 if (reloadWebsite) {
3883 nestedScrollWebView.reload();
3886 // Return the user agent changed status.
3887 return !nestedScrollWebView.getSettings().getUserAgentString().equals(initialUserAgent);
3890 private void applyProxyThroughOrbot(boolean reloadWebsite) {
3891 // Get a handle for the shared preferences.
3892 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3894 // Get the search and theme preferences.
3895 String torSearchString = sharedPreferences.getString("tor_search", getString(R.string.tor_search_default_value));
3896 String torSearchCustomUrlString = sharedPreferences.getString("tor_search_custom_url", getString(R.string.tor_search_custom_url_default_value));
3897 String searchString = sharedPreferences.getString("search", getString(R.string.search_default_value));
3898 String searchCustomUrlString = sharedPreferences.getString("search_custom_url", getString(R.string.search_custom_url_default_value));
3899 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
3901 // Get a handle for the app bar layout.
3902 AppBarLayout appBarLayout = findViewById(R.id.appbar_layout);
3904 // Set the homepage, search, and proxy options.
3905 if (proxyThroughOrbot) { // Set the Tor options.
3906 // Set the search URL.
3907 if (torSearchString.equals("Custom URL")) { // Get the custom URL string.
3908 searchURL = torSearchCustomUrlString;
3909 } else { // Use the string from the pre-built list.
3910 searchURL = torSearchString;
3913 // Set the proxy. `this` refers to the current activity where an `AlertDialog` might be displayed.
3914 OrbotProxyHelper.setProxy(getApplicationContext(), this, "localhost", "8118");
3916 // Set the app bar background to indicate proxying through Orbot is enabled.
3918 appBarLayout.setBackgroundResource(R.color.dark_blue_30);
3920 appBarLayout.setBackgroundResource(R.color.blue_50);
3923 // Check to see if Orbot is ready.
3924 if (!orbotStatus.equals("ON")) { // Orbot is not ready.
3925 // Set `waitingForOrbot`.
3926 waitingForOrbot = true;
3928 // Disable the wide view port so that the waiting for Orbot text is displayed correctly.
3929 currentWebView.getSettings().setUseWideViewPort(false);
3931 // Load a waiting page. `null` specifies no encoding, which defaults to ASCII.
3932 currentWebView.loadData("<html><body><br/><center><h1>" + getString(R.string.waiting_for_orbot) + "</h1></center></body></html>", "text/html", null);
3933 } else if (reloadWebsite) { // Orbot is ready and the website should be reloaded.
3934 // Reload the website.
3935 currentWebView.reload();
3937 } else { // Set the non-Tor options.
3938 // Set the search URL.
3939 if (searchString.equals("Custom URL")) { // Get the custom URL string.
3940 searchURL = searchCustomUrlString;
3941 } else { // Use the string from the pre-built list.
3942 searchURL = searchString;
3945 // Reset the proxy to default. The host is `""` and the port is `"0"`.
3946 OrbotProxyHelper.setProxy(getApplicationContext(), this, "", "0");
3948 // Set the default app bar layout background.
3950 appBarLayout.setBackgroundResource(R.color.gray_900);
3952 appBarLayout.setBackgroundResource(R.color.gray_100);
3955 // Reset `waitingForOrbot.
3956 waitingForOrbot = false;
3958 // Reload the WebViews if requested.
3959 if (reloadWebsite) {
3960 // Reload the WebViews.
3961 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
3962 // Get the WebView tab fragment.
3963 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
3965 // Get the fragment view.
3966 View fragmentView = webViewTabFragment.getView();
3968 // Only reload the WebViews if they exist.
3969 if (fragmentView != null) {
3970 // Get the nested scroll WebView from the tab fragment.
3971 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
3973 // Reload the WebView.
3974 nestedScrollWebView.reload();
3981 private void updatePrivacyIcons(boolean runInvalidateOptionsMenu) {
3982 // Only update the privacy icons if the options menu and the current WebView have already been populated.
3983 if ((optionsMenu != null) && (currentWebView != null)) {
3984 // Get a handle for the shared preferences.
3985 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3987 // Get the theme and screenshot preferences.
3988 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
3990 // Get handles for the menu items.
3991 MenuItem privacyMenuItem = optionsMenu.findItem(R.id.toggle_javascript);
3992 MenuItem firstPartyCookiesMenuItem = optionsMenu.findItem(R.id.toggle_first_party_cookies);
3993 MenuItem domStorageMenuItem = optionsMenu.findItem(R.id.toggle_dom_storage);
3994 MenuItem refreshMenuItem = optionsMenu.findItem(R.id.refresh);
3996 // Update the privacy icon.
3997 if (currentWebView.getSettings().getJavaScriptEnabled()) { // JavaScript is enabled.
3998 privacyMenuItem.setIcon(R.drawable.javascript_enabled);
3999 } else if (currentWebView.getAcceptFirstPartyCookies()) { // JavaScript is disabled but cookies are enabled.
4000 privacyMenuItem.setIcon(R.drawable.warning);
4001 } else { // All the dangerous features are disabled.
4002 privacyMenuItem.setIcon(R.drawable.privacy_mode);
4005 // Update the first-party cookies icon.
4006 if (currentWebView.getAcceptFirstPartyCookies()) { // First-party cookies are enabled.
4007 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_enabled);
4008 } else { // First-party cookies are disabled.
4010 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_dark);
4012 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_light);
4016 // Update the DOM storage icon.
4017 if (currentWebView.getSettings().getJavaScriptEnabled() && currentWebView.getSettings().getDomStorageEnabled()) { // Both JavaScript and DOM storage are enabled.
4018 domStorageMenuItem.setIcon(R.drawable.dom_storage_enabled);
4019 } else if (currentWebView.getSettings().getJavaScriptEnabled()) { // JavaScript is enabled but DOM storage is disabled.
4021 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_dark);
4023 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_light);
4025 } else { // JavaScript is disabled, so DOM storage is ghosted.
4027 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_dark);
4029 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_light);
4033 // Update the refresh icon.
4035 refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
4037 refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
4040 // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`.
4041 if (runInvalidateOptionsMenu) {
4042 invalidateOptionsMenu();
4047 private void openUrlWithExternalApp(String url) {
4048 // Create a download intent. Not specifying the action type will display the maximum number of options.
4049 Intent downloadIntent = new Intent();
4051 // Set the URI and the MIME type. Specifying `text/html` displays a good number of options.
4052 downloadIntent.setDataAndType(Uri.parse(url), "text/html");
4054 // Flag the intent to open in a new task.
4055 downloadIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4057 // Show the chooser.
4058 startActivity(Intent.createChooser(downloadIntent, getString(R.string.open_with)));
4061 private void highlightUrlText() {
4062 // Get a handle for the URL edit text.
4063 EditText urlEditText = findViewById(R.id.url_edittext);
4065 // Only highlight the URL text if the box is not currently selected.
4066 if (!urlEditText.hasFocus()) {
4067 // Get the URL string.
4068 String urlString = urlEditText.getText().toString();
4070 // Highlight the URL according to the protocol.
4071 if (urlString.startsWith("file://")) { // This is a file URL.
4072 // De-emphasize only the protocol.
4073 urlEditText.getText().setSpan(initialGrayColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4074 } else if (urlString.startsWith("content://")) {
4075 // De-emphasize only the protocol.
4076 urlEditText.getText().setSpan(initialGrayColorSpan, 0, 10, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4077 } else { // This is a web URL.
4078 // Get the index of the `/` immediately after the domain name.
4079 int endOfDomainName = urlString.indexOf("/", (urlString.indexOf("//") + 2));
4081 // Create a base URL string.
4084 // Get the base URL.
4085 if (endOfDomainName > 0) { // There is at least one character after the base URL.
4086 // Get the base URL.
4087 baseUrl = urlString.substring(0, endOfDomainName);
4088 } else { // There are no characters after the base URL.
4089 // Set the base URL to be the entire URL string.
4090 baseUrl = urlString;
4093 // Get the index of the last `.` in the domain.
4094 int lastDotIndex = baseUrl.lastIndexOf(".");
4096 // Get the index of the penultimate `.` in the domain.
4097 int penultimateDotIndex = baseUrl.lastIndexOf(".", lastDotIndex - 1);
4099 // Markup the beginning of the URL.
4100 if (urlString.startsWith("http://")) { // Highlight the protocol of connections that are not encrypted.
4101 urlEditText.getText().setSpan(redColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4103 // De-emphasize subdomains.
4104 if (penultimateDotIndex > 0) { // There is more than one subdomain in the domain name.
4105 urlEditText.getText().setSpan(initialGrayColorSpan, 7, penultimateDotIndex + 1, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4107 } else if (urlString.startsWith("https://")) { // De-emphasize the protocol of connections that are encrypted.
4108 if (penultimateDotIndex > 0) { // There is more than one subdomain in the domain name.
4109 // De-emphasize the protocol and the additional subdomains.
4110 urlEditText.getText().setSpan(initialGrayColorSpan, 0, penultimateDotIndex + 1, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4111 } else { // There is only one subdomain in the domain name.
4112 // De-emphasize only the protocol.
4113 urlEditText.getText().setSpan(initialGrayColorSpan, 0, 8, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4117 // De-emphasize the text after the domain name.
4118 if (endOfDomainName > 0) {
4119 urlEditText.getText().setSpan(finalGrayColorSpan, endOfDomainName, urlString.length(), Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4125 private void loadBookmarksFolder() {
4126 // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
4127 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
4129 // Populate the bookmarks cursor adapter. `this` specifies the `Context`. `false` disables `autoRequery`.
4130 bookmarksCursorAdapter = new CursorAdapter(this, bookmarksCursor, false) {
4132 public View newView(Context context, Cursor cursor, ViewGroup parent) {
4133 // Inflate the individual item layout. `false` does not attach it to the root.
4134 return getLayoutInflater().inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false);
4138 public void bindView(View view, Context context, Cursor cursor) {
4139 // Get handles for the views.
4140 ImageView bookmarkFavoriteIcon = view.findViewById(R.id.bookmark_favorite_icon);
4141 TextView bookmarkNameTextView = view.findViewById(R.id.bookmark_name);
4143 // Get the favorite icon byte array from the cursor.
4144 byte[] favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
4146 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
4147 Bitmap favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.length);
4149 // Display the bitmap in `bookmarkFavoriteIcon`.
4150 bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap);
4152 // Get the bookmark name from the cursor and display it in `bookmarkNameTextView`.
4153 String bookmarkNameString = cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
4154 bookmarkNameTextView.setText(bookmarkNameString);
4156 // Make the font bold for folders.
4157 if (cursor.getInt(cursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {
4158 bookmarkNameTextView.setTypeface(Typeface.DEFAULT_BOLD);
4159 } else { // Reset the font to default for normal bookmarks.
4160 bookmarkNameTextView.setTypeface(Typeface.DEFAULT);
4165 // Get a handle for the bookmarks list view.
4166 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
4168 // Populate the list view with the adapter.
4169 bookmarksListView.setAdapter(bookmarksCursorAdapter);
4171 // Get a handle for the bookmarks title text view.
4172 TextView bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview);
4174 // Set the bookmarks drawer title.
4175 if (currentBookmarksFolder.isEmpty()) {
4176 bookmarksTitleTextView.setText(R.string.bookmarks);
4178 bookmarksTitleTextView.setText(currentBookmarksFolder);
4182 private void openWithApp(String url) {
4183 // Create the open with intent with `ACTION_VIEW`.
4184 Intent openWithAppIntent = new Intent(Intent.ACTION_VIEW);
4186 // Set the URI but not the MIME type. This should open all available apps.
4187 openWithAppIntent.setData(Uri.parse(url));
4189 // Flag the intent to open in a new task.
4190 openWithAppIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4192 // Show the chooser.
4193 startActivity(openWithAppIntent);
4196 private void openWithBrowser(String url) {
4197 // Create the open with intent with `ACTION_VIEW`.
4198 Intent openWithBrowserIntent = new Intent(Intent.ACTION_VIEW);
4200 // Set the URI and the MIME type. `"text/html"` should load browser options.
4201 openWithBrowserIntent.setDataAndType(Uri.parse(url), "text/html");
4203 // Flag the intent to open in a new task.
4204 openWithBrowserIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4206 // Show the chooser.
4207 startActivity(openWithBrowserIntent);
4210 public void addTab(View view) {
4211 // Get a handle for the tab layout and the view pager.
4212 TabLayout tabLayout = findViewById(R.id.tablayout);
4213 ViewPager webViewPager = findViewById(R.id.webviewpager);
4215 // Get the new page number. The page numbers are 0 indexed, so the new page number will match the current count.
4216 int newTabNumber = tabLayout.getTabCount();
4219 tabLayout.addTab(tabLayout.newTab());
4222 TabLayout.Tab newTab = tabLayout.getTabAt(newTabNumber);
4224 // Remove the lint warning below that the current tab might be null.
4225 assert newTab != null;
4227 // Set a custom view on the new tab.
4228 newTab.setCustomView(R.layout.tab_custom_view);
4230 // Add the new WebView page.
4231 webViewPagerAdapter.addPage(newTabNumber, webViewPager);
4234 private void closeCurrentTab() {
4235 // Get handles for the views.
4236 AppBarLayout appBarLayout = findViewById(R.id.appbar_layout);
4237 TabLayout tabLayout = findViewById(R.id.tablayout);
4238 ViewPager webViewPager = findViewById(R.id.webviewpager);
4240 // Get the current tab number.
4241 int currentTabNumber = tabLayout.getSelectedTabPosition();
4243 // Delete the current tab.
4244 tabLayout.removeTabAt(currentTabNumber);
4246 // Delete the current page. If the selected page number did not change during the delete, it will return true, meaning that the current WebView must be reset.
4247 if (webViewPagerAdapter.deletePage(currentTabNumber, webViewPager)) {
4248 setCurrentWebView(currentTabNumber);
4251 // Expand the app bar if it is currently collapsed.
4252 appBarLayout.setExpanded(true);
4255 private void setCurrentWebView(int pageNumber) {
4256 // Get a handle for the shared preferences.
4257 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
4259 // Get the theme preference.
4260 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
4262 // Get handles for the URL views.
4263 RelativeLayout urlRelativeLayout = findViewById(R.id.url_relativelayout);
4264 EditText urlEditText = findViewById(R.id.url_edittext);
4265 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
4267 //Stop the swipe to refresh indicator if it is running
4268 swipeRefreshLayout.setRefreshing(false);
4270 // Get the WebView tab fragment.
4271 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(pageNumber);
4273 // Get the fragment view.
4274 View fragmentView = webViewTabFragment.getView();
4276 // Set the current WebView if the fragment view is not null.
4277 if (fragmentView != null) {
4278 // Store the current WebView.
4279 currentWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
4281 // Update the status of swipe to refresh.
4282 if (currentWebView.getSwipeToRefresh()) { // Swipe to refresh is enabled.
4283 if (Build.VERSION.SDK_INT >= 23) { // For API >= 23, swipe refresh layout is continuously updated with an on scroll change listener and only enabled if the WebView is scrolled to the top.
4284 // Enable the swipe refresh layout if the WebView is scrolled all the way to the top.
4285 swipeRefreshLayout.setEnabled(currentWebView.getY() == 0);
4287 // Enable the swipe refresh layout.
4288 swipeRefreshLayout.setEnabled(true);
4290 } else { // Swipe to refresh is disabled.
4291 // Disable the swipe refresh layout.
4292 swipeRefreshLayout.setEnabled(false);
4295 // Get a handle for the cookie manager.
4296 CookieManager cookieManager = CookieManager.getInstance();
4298 // Set the first-party cookie status.
4299 cookieManager.setAcceptCookie(currentWebView.getAcceptFirstPartyCookies());
4301 // Update the privacy icons. `true` redraws the icons in the app bar.
4302 updatePrivacyIcons(true);
4304 // Get a handle for the input method manager.
4305 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
4307 // Remove the lint warning below that the input method manager might be null.
4308 assert inputMethodManager != null;
4310 // Get the current URL.
4311 String url = currentWebView.getUrl();
4313 // Update the URL edit text if not loading a new intent. Otherwise, this will be handled by `onPageStarted()` (if called) and `onPageFinished()`.
4314 if (!loadingNewIntent) { // A new intent is not being loaded.
4315 if ((url == null) || url.equals("about:blank")) { // The WebView is blank.
4316 // Display the hint in the URL edit text.
4317 urlEditText.setText("");
4319 // Request focus for the URL text box.
4320 urlEditText.requestFocus();
4322 // Display the keyboard.
4323 inputMethodManager.showSoftInput(urlEditText, 0);
4324 } else { // The WebView has a loaded URL.
4325 // Clear the focus from the URL text box.
4326 urlEditText.clearFocus();
4328 // Hide the soft keyboard.
4329 inputMethodManager.hideSoftInputFromWindow(currentWebView.getWindowToken(), 0);
4331 // Display the current URL in the URL text box.
4332 urlEditText.setText(url);
4334 // Highlight the URL text.
4337 } else { // A new intent is being loaded.
4338 // Reset the loading new intent tracker.
4339 loadingNewIntent = false;
4342 // Set the background to indicate the domain settings status.
4343 if (currentWebView.getDomainSettingsApplied()) {
4344 // Set a green background on the URL relative layout to indicate that custom domain settings are being used. The deprecated `.getDrawable()` must be used until the minimum API >= 21.
4346 urlRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_dark_blue));
4348 urlRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_light_green));
4351 urlRelativeLayout.setBackground(getResources().getDrawable(R.color.transparent));
4357 public void initializeWebView(NestedScrollWebView nestedScrollWebView, int pageNumber, ProgressBar progressBar) {
4358 // Get handles for the activity views.
4359 FrameLayout rootFrameLayout = findViewById(R.id.root_framelayout);
4360 DrawerLayout drawerLayout = findViewById(R.id.drawerlayout);
4361 RelativeLayout mainContentRelativeLayout = findViewById(R.id.main_content_relativelayout);
4362 ActionBar actionBar = getSupportActionBar();
4363 LinearLayout tabsLinearLayout = findViewById(R.id.tabs_linearlayout);
4364 EditText urlEditText = findViewById(R.id.url_edittext);
4365 TabLayout tabLayout = findViewById(R.id.tablayout);
4366 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
4368 // Remove the incorrect lint warning below that the action bar might be null.
4369 assert actionBar != null;
4371 // Get a handle for the activity
4372 Activity activity = this;
4374 // Get a handle for the input method manager.
4375 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
4377 // Instantiate the blocklist helper.
4378 BlockListHelper blockListHelper = new BlockListHelper();
4380 // Remove the lint warning below that the input method manager might be null.
4381 assert inputMethodManager != null;
4383 // Get a handle for the shared preferences.
4384 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
4386 // Get the relevant preferences.
4387 boolean downloadWithExternalApp = sharedPreferences.getBoolean("download_with_external_app", false);
4389 // Initialize the favorite icon.
4390 nestedScrollWebView.initializeFavoriteIcon();
4392 // Set the app bar scrolling.
4393 nestedScrollWebView.setNestedScrollingEnabled(sharedPreferences.getBoolean("scroll_app_bar", true));
4395 // Allow pinch to zoom.
4396 nestedScrollWebView.getSettings().setBuiltInZoomControls(true);
4398 // Hide zoom controls.
4399 nestedScrollWebView.getSettings().setDisplayZoomControls(false);
4401 // Don't allow mixed content (HTTP and HTTPS) on the same website.
4402 if (Build.VERSION.SDK_INT >= 21) {
4403 nestedScrollWebView.getSettings().setMixedContentMode(WebSettings.MIXED_CONTENT_NEVER_ALLOW);
4406 // Set the WebView to use a wide viewport. Otherwise, some web pages will be scrunched and some content will render outside the screen.
4407 nestedScrollWebView.getSettings().setUseWideViewPort(true);
4409 // Set the WebView to load in overview mode (zoomed out to the maximum width).
4410 nestedScrollWebView.getSettings().setLoadWithOverviewMode(true);
4412 // Explicitly disable geolocation.
4413 nestedScrollWebView.getSettings().setGeolocationEnabled(false);
4415 // Create a double-tap gesture detector to toggle full-screen mode.
4416 GestureDetector doubleTapGestureDetector = new GestureDetector(getApplicationContext(), new GestureDetector.SimpleOnGestureListener() {
4417 // Override `onDoubleTap()`. All other events are handled using the default settings.
4419 public boolean onDoubleTap(MotionEvent event) {
4420 if (fullScreenBrowsingModeEnabled) { // Only process the double-tap if full screen browsing mode is enabled.
4421 // Toggle the full screen browsing mode tracker.
4422 inFullScreenBrowsingMode = !inFullScreenBrowsingMode;
4424 // Toggle the full screen browsing mode.
4425 if (inFullScreenBrowsingMode) { // Switch to full screen mode.
4426 // Store the swipe refresh layout top padding.
4427 swipeRefreshLayoutPaddingTop = swipeRefreshLayout.getPaddingTop();
4429 // Hide the app bar if specified.
4431 // Close the find on page bar if it is visible.
4432 closeFindOnPage(null);
4434 // Hide the tab linear layout.
4435 tabsLinearLayout.setVisibility(View.GONE);
4437 // Hide the action bar.
4440 // Check to see if app bar scrolling is disabled.
4441 if (!scrollAppBar) {
4442 // Remove the padding from the top of the swipe refresh layout.
4443 swipeRefreshLayout.setPadding(0, 0, 0, 0);
4447 // Hide the banner ad in the free flavor.
4448 if (BuildConfig.FLAVOR.contentEquals("free")) {
4449 AdHelper.hideAd(findViewById(R.id.adview));
4452 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
4453 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4455 /* Hide the system bars.
4456 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
4457 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
4458 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
4459 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
4461 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
4462 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
4463 } else { // Switch to normal viewing mode.
4464 // Show the tab linear layout.
4465 tabsLinearLayout.setVisibility(View.VISIBLE);
4467 // Show the action bar.
4470 // Check to see if app bar scrolling is disabled.
4471 if (!scrollAppBar) {
4472 // Add the padding from the top of the swipe refresh layout.
4473 swipeRefreshLayout.setPadding(0, swipeRefreshLayoutPaddingTop, 0, 0);
4476 // Show the banner ad in the free flavor.
4477 if (BuildConfig.FLAVOR.contentEquals("free")) {
4479 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
4482 // Remove the `SYSTEM_UI` flags from the root frame layout.
4483 rootFrameLayout.setSystemUiVisibility(0);
4485 // Add the translucent status flag.
4486 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4489 // Consume the double-tap.
4491 } else { // Do not consume the double-tap because full screen browsing mode is disabled.
4497 // Pass all touch events on the WebView through the double-tap gesture detector.
4498 nestedScrollWebView.setOnTouchListener((View view, MotionEvent event) -> {
4499 // Call `performClick()` on the view, which is required for accessibility.
4500 view.performClick();
4502 // Send the event to the gesture detector.
4503 return doubleTapGestureDetector.onTouchEvent(event);
4506 // Register the WebView for a context menu. This is used to see link targets and download images.
4507 registerForContextMenu(nestedScrollWebView);
4509 // Allow the downloading of files.
4510 nestedScrollWebView.setDownloadListener((String url, String userAgent, String contentDisposition, String mimetype, long contentLength) -> {
4511 // Check if the download should be processed by an external app.
4512 if (downloadWithExternalApp) { // Download with an external app.
4513 // Create a download intent. Not specifying the action type will display the maximum number of options.
4514 Intent downloadIntent = new Intent();
4516 // Set the URI and the MIME type. Specifying `text/html` displays a good number of options.
4517 downloadIntent.setDataAndType(Uri.parse(url), "text/html");
4519 // Flag the intent to open in a new task.
4520 downloadIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4522 // Show the chooser.
4523 startActivity(Intent.createChooser(downloadIntent, getString(R.string.open_with)));
4524 } else { // Download with Android's download manager.
4525 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
4526 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) { // The storage permission has not been granted.
4527 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
4529 // Store the variables for future use by `onRequestPermissionsResult()`.
4531 downloadContentDisposition = contentDisposition;
4532 downloadContentLength = contentLength;
4534 // Show a dialog if the user has previously denied the permission.
4535 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
4536 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
4537 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
4539 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
4540 downloadLocationPermissionDialogFragment.show(getSupportFragmentManager(), getString(R.string.download_location));
4541 } else { // Show the permission request directly.
4542 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
4543 ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
4545 } else { // The storage permission has already been granted.
4546 // Get a handle for the download file alert dialog.
4547 DialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(url, contentDisposition, contentLength);
4549 // Show the download file alert dialog.
4550 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
4555 // Update the find on page count.
4556 nestedScrollWebView.setFindListener(new WebView.FindListener() {
4557 // Get a handle for `findOnPageCountTextView`.
4558 final TextView findOnPageCountTextView = findViewById(R.id.find_on_page_count_textview);
4561 public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, boolean isDoneCounting) {
4562 if ((isDoneCounting) && (numberOfMatches == 0)) { // There are no matches.
4563 // Set `findOnPageCountTextView` to `0/0`.
4564 findOnPageCountTextView.setText(R.string.zero_of_zero);
4565 } else if (isDoneCounting) { // There are matches.
4566 // `activeMatchOrdinal` is zero-based.
4567 int activeMatch = activeMatchOrdinal + 1;
4569 // Build the match string.
4570 String matchString = activeMatch + "/" + numberOfMatches;
4572 // Set `findOnPageCountTextView`.
4573 findOnPageCountTextView.setText(matchString);
4578 // Update the status of swipe to refresh based on the scroll position of the nested scroll WebView.
4579 // Once the minimum API >= 23 this can be replaced with `nestedScrollWebView.setOnScrollChangeListener()`.
4580 nestedScrollWebView.getViewTreeObserver().addOnScrollChangedListener(() -> {
4581 if (nestedScrollWebView.getSwipeToRefresh()) {
4582 // Only enable swipe to refresh if the WebView is scrolled to the top.
4583 swipeRefreshLayout.setEnabled(nestedScrollWebView.getScrollY() == 0);
4587 // Set the web chrome client.
4588 nestedScrollWebView.setWebChromeClient(new WebChromeClient() {
4589 // Update the progress bar when a page is loading.
4591 public void onProgressChanged(WebView view, int progress) {
4592 // Inject the night mode CSS if night mode is enabled.
4593 if (nestedScrollWebView.getNightMode()) { // Night mode is enabled.
4594 // `background-color: #212121` sets the background to be dark gray. `color: #BDBDBD` sets the text color to be light gray. `box-shadow: none` removes a lower underline on links
4595 // used by WordPress. `text-decoration: none` removes all text underlines. `text-shadow: none` removes text shadows, which usually have a hard coded color.
4596 // `border: none` removes all borders, which can also be used to underline text. `a {color: #1565C0}` sets links to be a dark blue.
4597 // `::selection {background: #0D47A1}' sets the text selection highlight color to be a dark blue. `!important` takes precedent over any existing sub-settings.
4598 nestedScrollWebView.evaluateJavascript("(function() {var parent = document.getElementsByTagName('head').item(0); var style = document.createElement('style'); style.type = 'text/css'; " +
4599 "style.innerHTML = '* {background-color: #212121 !important; color: #BDBDBD !important; box-shadow: none !important; text-decoration: none !important;" +
4600 "text-shadow: none !important; border: none !important;} a {color: #1565C0 !important;} ::selection {background: #0D47A1 !important;}'; parent.appendChild(style)})()", value -> {
4601 // Initialize a handler to display `mainWebView`.
4602 Handler displayWebViewHandler = new Handler();
4604 // Setup a runnable to display `mainWebView` after a delay to allow the CSS to be applied.
4605 Runnable displayWebViewRunnable = () -> {
4606 // Only display `mainWebView` if the progress bar is gone. This prevents the display of the `WebView` while it is still loading.
4607 if (progressBar.getVisibility() == View.GONE) {
4608 nestedScrollWebView.setVisibility(View.VISIBLE);
4612 // Display the WebView after 500 milliseconds.
4613 displayWebViewHandler.postDelayed(displayWebViewRunnable, 500);
4615 } else { // Night mode is disabled.
4616 // Display the nested scroll WebView if night mode is disabled.
4617 // Because of a race condition between `applyDomainSettings` and `onPageStarted`,
4618 // when night mode is set by domain settings the WebView may be hidden even if night mode is not currently enabled.
4619 nestedScrollWebView.setVisibility(View.VISIBLE);
4622 // Update the progress bar.
4623 progressBar.setProgress(progress);
4625 // Set the visibility of the progress bar.
4626 if (progress < 100) {
4627 // Show the progress bar.
4628 progressBar.setVisibility(View.VISIBLE);
4630 // Hide the progress bar.
4631 progressBar.setVisibility(View.GONE);
4633 //Stop the swipe to refresh indicator if it is running
4634 swipeRefreshLayout.setRefreshing(false);
4638 // Set the favorite icon when it changes.
4640 public void onReceivedIcon(WebView view, Bitmap icon) {
4641 // Only update the favorite icon if the website has finished loading.
4642 if (progressBar.getVisibility() == View.GONE) {
4643 // Store the new favorite icon.
4644 nestedScrollWebView.setFavoriteOrDefaultIcon(icon);
4646 // Get the current page position.
4647 int currentPosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
4649 // Get the current tab.
4650 TabLayout.Tab tab = tabLayout.getTabAt(currentPosition);
4652 // Check to see if the tab has been populated.
4654 // Get the custom view from the tab.
4655 View tabView = tab.getCustomView();
4657 // Check to see if the custom tab view has been populated.
4658 if (tabView != null) {
4659 // Get the favorite icon image view from the tab.
4660 ImageView tabFavoriteIconImageView = tabView.findViewById(R.id.favorite_icon_imageview);
4662 // Display the favorite icon in the tab.
4663 tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
4669 // Save a copy of the title when it changes.
4671 public void onReceivedTitle(WebView view, String title) {
4672 // Get the current page position.
4673 int currentPosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
4675 // Get the current tab.
4676 TabLayout.Tab tab = tabLayout.getTabAt(currentPosition);
4678 // Only populate the title text view if the tab has been fully created.
4680 // Get the custom view from the tab.
4681 View tabView = tab.getCustomView();
4683 // Remove the incorrect warning below that the current tab view might be null.
4684 assert tabView != null;
4686 // Get the title text view from the tab.
4687 TextView tabTitleTextView = tabView.findViewById(R.id.title_textview);
4689 // Set the title as the tab text.
4690 tabTitleTextView.setText(title);
4694 // Enter full screen video.
4696 public void onShowCustomView(View video, CustomViewCallback callback) {
4697 // Get a handle for the full screen video frame layout.
4698 FrameLayout fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
4700 // Set the full screen video flag.
4701 displayingFullScreenVideo = true;
4703 // Pause the ad if this is the free flavor.
4704 if (BuildConfig.FLAVOR.contentEquals("free")) {
4705 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
4706 AdHelper.pauseAd(findViewById(R.id.adview));
4709 // Hide the keyboard.
4710 inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.getWindowToken(), 0);
4712 // Hide the main content relative layout.
4713 mainContentRelativeLayout.setVisibility(View.GONE);
4715 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
4716 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
4718 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
4719 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4721 /* Hide the system bars.
4722 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
4723 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
4724 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
4725 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
4727 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
4728 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
4730 // Disable the sliding drawers.
4731 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED);
4733 // Add the video view to the full screen video frame layout.
4734 fullScreenVideoFrameLayout.addView(video);
4736 // Show the full screen video frame layout.
4737 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
4740 // Exit full screen video.
4742 public void onHideCustomView() {
4743 // Get a handle for the full screen video frame layout.
4744 FrameLayout fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
4746 // Unset the full screen video flag.
4747 displayingFullScreenVideo = false;
4749 // Remove all the views from the full screen video frame layout.
4750 fullScreenVideoFrameLayout.removeAllViews();
4752 // Hide the full screen video frame layout.
4753 fullScreenVideoFrameLayout.setVisibility(View.GONE);
4755 // Enable the sliding drawers.
4756 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED);
4758 // Show the main content relative layout.
4759 mainContentRelativeLayout.setVisibility(View.VISIBLE);
4761 // Apply the appropriate full screen mode flags.
4762 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
4763 // Hide the app bar if specified.
4765 // Hide the tab linear layout.
4766 tabsLinearLayout.setVisibility(View.GONE);
4768 // Hide the action bar.
4772 // Hide the banner ad in the free flavor.
4773 if (BuildConfig.FLAVOR.contentEquals("free")) {
4774 AdHelper.hideAd(findViewById(R.id.adview));
4777 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
4778 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4780 /* Hide the system bars.
4781 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
4782 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
4783 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
4784 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
4786 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
4787 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
4788 } else { // Switch to normal viewing mode.
4789 // Remove the `SYSTEM_UI` flags from the root frame layout.
4790 rootFrameLayout.setSystemUiVisibility(0);
4792 // Add the translucent status flag.
4793 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4796 // Reload the ad for the free flavor if not in full screen mode.
4797 if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
4799 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
4805 public boolean onShowFileChooser(WebView webView, ValueCallback<Uri[]> filePathCallback, FileChooserParams fileChooserParams) {
4806 // Show the file chooser if the device is running API >= 21.
4807 if (Build.VERSION.SDK_INT >= 21) {
4808 // Store the file path callback.
4809 fileChooserCallback = filePathCallback;
4811 // Create an intent to open a chooser based ont the file chooser parameters.
4812 Intent fileChooserIntent = fileChooserParams.createIntent();
4814 // Open the file chooser. Currently only one `startActivityForResult` exists in this activity, so the request code, used to differentiate them, is simply `0`.
4815 startActivityForResult(fileChooserIntent, 0);
4821 nestedScrollWebView.setWebViewClient(new WebViewClient() {
4822 // `shouldOverrideUrlLoading` makes this `WebView` the default handler for URLs inside the app, so that links are not kicked out to other apps.
4823 // The deprecated `shouldOverrideUrlLoading` must be used until API >= 24.
4825 public boolean shouldOverrideUrlLoading(WebView view, String url) {
4826 if (url.startsWith("http")) { // Load the URL in Privacy Browser.
4827 // Apply the domain settings for the new URL. This doesn't do anything if the domain has not changed.
4828 boolean userAgentChanged = applyDomainSettings(nestedScrollWebView, url, true, false);
4830 // Check if the user agent has changed.
4831 if (userAgentChanged) {
4832 // Manually load the URL. The changing of the user agent will cause WebView to reload the previous URL.
4833 nestedScrollWebView.loadUrl(url, customHeaders);
4835 // Returning true indicates that Privacy Browser is manually handling the loading of the URL.
4838 // Returning false causes the current WebView to handle the URL and prevents it from adding redirects to the history list.
4841 } else if (url.startsWith("mailto:")) { // Load the email address in an external email program.
4842 // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
4843 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
4845 // Parse the url and set it as the data for the intent.
4846 emailIntent.setData(Uri.parse(url));
4848 // Open the email program in a new task instead of as part of Privacy Browser.
4849 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4852 startActivity(emailIntent);
4854 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
4856 } else if (url.startsWith("tel:")) { // Load the phone number in the dialer.
4857 // Open the dialer and load the phone number, but wait for the user to place the call.
4858 Intent dialIntent = new Intent(Intent.ACTION_DIAL);
4860 // Add the phone number to the intent.
4861 dialIntent.setData(Uri.parse(url));
4863 // Open the dialer in a new task instead of as part of Privacy Browser.
4864 dialIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4867 startActivity(dialIntent);
4869 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
4871 } else { // Load a system chooser to select an app that can handle the URL.
4872 // Open an app that can handle the URL.
4873 Intent genericIntent = new Intent(Intent.ACTION_VIEW);
4875 // Add the URL to the intent.
4876 genericIntent.setData(Uri.parse(url));
4878 // List all apps that can handle the URL instead of just opening the first one.
4879 genericIntent.addCategory(Intent.CATEGORY_BROWSABLE);
4881 // Open the app in a new task instead of as part of Privacy Browser.
4882 genericIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4884 // Start the app or display a snackbar if no app is available to handle the URL.
4886 startActivity(genericIntent);
4887 } catch (ActivityNotFoundException exception) {
4888 Snackbar.make(nestedScrollWebView, getString(R.string.unrecognized_url) + " " + url, Snackbar.LENGTH_SHORT).show();
4891 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
4896 // Check requests against the block lists. The deprecated `shouldInterceptRequest()` must be used until minimum API >= 21.
4898 public WebResourceResponse shouldInterceptRequest(WebView view, String url) {
4899 // Get a handle for the navigation view.
4900 NavigationView navigationView = findViewById(R.id.navigationview);
4902 // Get a handle for the navigation menu.
4903 Menu navigationMenu = navigationView.getMenu();
4905 // Get a handle for the navigation requests menu item. The menu is 0 based.
4906 MenuItem navigationRequestsMenuItem = navigationMenu.getItem(6);
4908 // Create an empty web resource response to be used if the resource request is blocked.
4909 WebResourceResponse emptyWebResourceResponse = new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
4911 // Reset the whitelist results tracker.
4912 String[] whitelistResultStringArray = null;
4914 // Initialize the third party request tracker.
4915 boolean isThirdPartyRequest = false;
4917 // Get the current URL. `.getUrl()` throws an error because operations on the WebView cannot be made from this thread.
4918 String currentBaseDomain = nestedScrollWebView.getCurrentDomainName();
4920 // Store a copy of the current domain for use in later requests.
4921 String currentDomain = currentBaseDomain;
4923 // Nobody is happy when comparing null strings.
4924 if ((currentBaseDomain != null) && (url != null)) {
4925 // Convert the request URL to a URI.
4926 Uri requestUri = Uri.parse(url);
4928 // Get the request host name.
4929 String requestBaseDomain = requestUri.getHost();
4931 // Only check for third-party requests if the current base domain is not empty and the request domain is not null.
4932 if (!currentBaseDomain.isEmpty() && (requestBaseDomain != null)) {
4933 // Determine the current base domain.
4934 while (currentBaseDomain.indexOf(".", currentBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
4935 // Remove the first subdomain.
4936 currentBaseDomain = currentBaseDomain.substring(currentBaseDomain.indexOf(".") + 1);
4939 // Determine the request base domain.
4940 while (requestBaseDomain.indexOf(".", requestBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
4941 // Remove the first subdomain.
4942 requestBaseDomain = requestBaseDomain.substring(requestBaseDomain.indexOf(".") + 1);
4945 // Update the third party request tracker.
4946 isThirdPartyRequest = !currentBaseDomain.equals(requestBaseDomain);
4950 // Get the current WebView page position.
4951 int webViewPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
4953 // Determine if the WebView is currently displayed.
4954 boolean webViewDisplayed = (webViewPagePosition == tabLayout.getSelectedTabPosition());
4956 // Block third-party requests if enabled.
4957 if (isThirdPartyRequest && nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.THIRD_PARTY_REQUESTS)) {
4958 // Add the result to the resource requests.
4959 nestedScrollWebView.addResourceRequest(new String[]{BlockListHelper.REQUEST_THIRD_PARTY, url});
4961 // Increment the blocked requests counters.
4962 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
4963 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.THIRD_PARTY_REQUESTS);
4965 // Update the titles of the blocklist menu items if the WebView is currently displayed.
4966 if (webViewDisplayed) {
4967 // Updating the UI must be run from the UI thread.
4968 activity.runOnUiThread(() -> {
4969 // Update the menu item titles.
4970 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
4972 // Update the options menu if it has been populated.
4973 if (optionsMenu != null) {
4974 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
4975 optionsMenu.findItem(R.id.block_all_third_party_requests).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.THIRD_PARTY_REQUESTS) + " - " +
4976 getString(R.string.block_all_third_party_requests));
4981 // Return an empty web resource response.
4982 return emptyWebResourceResponse;
4985 // Check UltraPrivacy if it is enabled.
4986 if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.ULTRA_PRIVACY)) {
4987 // Check the URL against UltraPrivacy.
4988 String[] ultraPrivacyResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, ultraPrivacy);
4990 // Process the UltraPrivacy results.
4991 if (ultraPrivacyResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched UltraPrivacy's blacklist.
4992 // Add the result to the resource requests.
4993 nestedScrollWebView.addResourceRequest(new String[] {ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
4994 ultraPrivacyResults[5]});
4996 // Increment the blocked requests counters.
4997 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
4998 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.ULTRA_PRIVACY);
5000 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5001 if (webViewDisplayed) {
5002 // Updating the UI must be run from the UI thread.
5003 activity.runOnUiThread(() -> {
5004 // Update the menu item titles.
5005 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5007 // Update the options menu if it has been populated.
5008 if (optionsMenu != null) {
5009 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5010 optionsMenu.findItem(R.id.ultraprivacy).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.ULTRA_PRIVACY) + " - " + getString(R.string.ultraprivacy));
5015 // The resource request was blocked. Return an empty web resource response.
5016 return emptyWebResourceResponse;
5017 } else if (ultraPrivacyResults[0].equals(BlockListHelper.REQUEST_ALLOWED)) { // The resource request matched UltraPrivacy's whitelist.
5018 // Add a whitelist entry to the resource requests array.
5019 nestedScrollWebView.addResourceRequest(new String[] {ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
5020 ultraPrivacyResults[5]});
5022 // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
5027 // Check EasyList if it is enabled.
5028 if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.EASY_LIST)) {
5029 // Check the URL against EasyList.
5030 String[] easyListResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, easyList);
5032 // Process the EasyList results.
5033 if (easyListResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched EasyList's blacklist.
5034 // Add the result to the resource requests.
5035 nestedScrollWebView.addResourceRequest(new String[] {easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5]});
5037 // Increment the blocked requests counters.
5038 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5039 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.EASY_LIST);
5041 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5042 if (webViewDisplayed) {
5043 // Updating the UI must be run from the UI thread.
5044 activity.runOnUiThread(() -> {
5045 // Update the menu item titles.
5046 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5048 // Update the options menu if it has been populated.
5049 if (optionsMenu != null) {
5050 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5051 optionsMenu.findItem(R.id.easylist).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.EASY_LIST) + " - " + getString(R.string.easylist));
5056 // The resource request was blocked. Return an empty web resource response.
5057 return emptyWebResourceResponse;
5058 } else if (easyListResults[0].equals(BlockListHelper.REQUEST_ALLOWED)) { // The resource request matched EasyList's whitelist.
5059 // Update the whitelist result string array tracker.
5060 whitelistResultStringArray = new String[] {easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5]};
5064 // Check EasyPrivacy if it is enabled.
5065 if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.EASY_PRIVACY)) {
5066 // Check the URL against EasyPrivacy.
5067 String[] easyPrivacyResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, easyPrivacy);
5069 // Process the EasyPrivacy results.
5070 if (easyPrivacyResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched EasyPrivacy's blacklist.
5071 // Add the result to the resource requests.
5072 nestedScrollWebView.addResourceRequest(new String[] {easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4],
5073 easyPrivacyResults[5]});
5075 // Increment the blocked requests counters.
5076 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5077 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.EASY_PRIVACY);
5079 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5080 if (webViewDisplayed) {
5081 // Updating the UI must be run from the UI thread.
5082 activity.runOnUiThread(() -> {
5083 // Update the menu item titles.
5084 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5086 // Update the options menu if it has been populated.
5087 if (optionsMenu != null) {
5088 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5089 optionsMenu.findItem(R.id.easyprivacy).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.EASY_PRIVACY) + " - " + getString(R.string.easyprivacy));
5094 // The resource request was blocked. Return an empty web resource response.
5095 return emptyWebResourceResponse;
5096 } else if (easyPrivacyResults[0].equals(BlockListHelper.REQUEST_ALLOWED)) { // The resource request matched EasyPrivacy's whitelist.
5097 // Update the whitelist result string array tracker.
5098 whitelistResultStringArray = new String[] {easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4], easyPrivacyResults[5]};
5102 // Check Fanboy’s Annoyance List if it is enabled.
5103 if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST)) {
5104 // Check the URL against Fanboy's Annoyance List.
5105 String[] fanboysAnnoyanceListResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, fanboysAnnoyanceList);
5107 // Process the Fanboy's Annoyance List results.
5108 if (fanboysAnnoyanceListResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched Fanboy's Annoyance List's blacklist.
5109 // Add the result to the resource requests.
5110 nestedScrollWebView.addResourceRequest(new String[] {fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
5111 fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5]});
5113 // Increment the blocked requests counters.
5114 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5115 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST);
5117 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5118 if (webViewDisplayed) {
5119 // Updating the UI must be run from the UI thread.
5120 activity.runOnUiThread(() -> {
5121 // Update the menu item titles.
5122 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5124 // Update the options menu if it has been populated.
5125 if (optionsMenu != null) {
5126 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5127 optionsMenu.findItem(R.id.fanboys_annoyance_list).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST) + " - " +
5128 getString(R.string.fanboys_annoyance_list));
5133 // The resource request was blocked. Return an empty web resource response.
5134 return emptyWebResourceResponse;
5135 } else if (fanboysAnnoyanceListResults[0].equals(BlockListHelper.REQUEST_ALLOWED)){ // The resource request matched Fanboy's Annoyance List's whitelist.
5136 // Update the whitelist result string array tracker.
5137 whitelistResultStringArray = new String[] {fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
5138 fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5]};
5140 } else if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST)) { // Only check Fanboy’s Social Blocking List if Fanboy’s Annoyance List is disabled.
5141 // Check the URL against Fanboy's Annoyance List.
5142 String[] fanboysSocialListResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, fanboysSocialList);
5144 // Process the Fanboy's Social Blocking List results.
5145 if (fanboysSocialListResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched Fanboy's Social Blocking List's blacklist.
5146 // Add the result to the resource requests.
5147 nestedScrollWebView.addResourceRequest(new String[] {fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3],
5148 fanboysSocialListResults[4], fanboysSocialListResults[5]});
5150 // Increment the blocked requests counters.
5151 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5152 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST);
5154 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5155 if (webViewDisplayed) {
5156 // Updating the UI must be run from the UI thread.
5157 activity.runOnUiThread(() -> {
5158 // Update the menu item titles.
5159 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5161 // Update the options menu if it has been populated.
5162 if (optionsMenu != null) {
5163 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5164 optionsMenu.findItem(R.id.fanboys_social_blocking_list).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST) + " - " +
5165 getString(R.string.fanboys_social_blocking_list));
5170 // The resource request was blocked. Return an empty web resource response.
5171 return emptyWebResourceResponse;
5172 } else if (fanboysSocialListResults[0].equals(BlockListHelper.REQUEST_ALLOWED)) { // The resource request matched Fanboy's Social Blocking List's whitelist.
5173 // Update the whitelist result string array tracker.
5174 whitelistResultStringArray = new String[] {fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3],
5175 fanboysSocialListResults[4], fanboysSocialListResults[5]};
5179 // Add the request to the log because it hasn't been processed by any of the previous checks.
5180 if (whitelistResultStringArray != null) { // The request was processed by a whitelist.
5181 nestedScrollWebView.addResourceRequest(whitelistResultStringArray);
5182 } else { // The request didn't match any blocklist entry. Log it as a default request.
5183 nestedScrollWebView.addResourceRequest(new String[]{BlockListHelper.REQUEST_DEFAULT, url});
5186 // The resource request has not been blocked. `return null` loads the requested resource.
5190 // Handle HTTP authentication requests.
5192 public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) {
5193 // Store the handler.
5194 nestedScrollWebView.setHttpAuthHandler(handler);
5196 // Instantiate an HTTP authentication dialog.
5197 DialogFragment httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm, nestedScrollWebView.getWebViewFragmentId());
5199 // Show the HTTP authentication dialog.
5200 httpAuthenticationDialogFragment.show(getSupportFragmentManager(), getString(R.string.http_authentication));
5204 public void onPageStarted(WebView view, String url, Bitmap favicon) {
5205 // Get the preferences.
5206 boolean scrollAppBar = sharedPreferences.getBoolean("scroll_app_bar", true);
5207 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
5209 // Get a handler for the app bar layout.
5210 AppBarLayout appBarLayout = findViewById(R.id.appbar_layout);
5212 // Set the top padding of the swipe refresh layout according to the app bar scrolling preference.
5214 // No padding is needed because it will automatically be placed below the app bar layout due to the scrolling layout behavior.
5215 swipeRefreshLayout.setPadding(0, 0, 0, 0);
5217 // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
5218 swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10, defaultProgressViewEndOffset);
5220 // Get the app bar layout height. This can't be done in `applyAppSettings()` because the app bar is not yet populated.
5221 int appBarHeight = appBarLayout.getHeight();
5223 // The swipe refresh layout must be manually moved below the app bar layout.
5224 swipeRefreshLayout.setPadding(0, appBarHeight, 0, 0);
5226 // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
5227 swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10 + appBarHeight, defaultProgressViewEndOffset + appBarHeight);
5230 // Reset the list of resource requests.
5231 nestedScrollWebView.clearResourceRequests();
5233 // Reset the requests counters.
5234 nestedScrollWebView.resetRequestsCounters();
5236 // If night mode is enabled, hide `mainWebView` until after the night mode CSS is applied.
5237 if (nestedScrollWebView.getNightMode()) {
5238 nestedScrollWebView.setVisibility(View.INVISIBLE);
5240 nestedScrollWebView.setVisibility(View.VISIBLE);
5243 // Hide the keyboard.
5244 inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.getWindowToken(), 0);
5246 // Check to see if Privacy Browser is waiting on Orbot.
5247 if (!waitingForOrbot) { // Process the URL.
5248 // Get the current page position.
5249 int currentPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
5251 // Update the URL text bar if the page is currently selected.
5252 if (tabLayout.getSelectedTabPosition() == currentPagePosition) {
5253 // Clear the focus from the URL edit text.
5254 urlEditText.clearFocus();
5256 // Display the formatted URL text.
5257 urlEditText.setText(url);
5259 // Apply text highlighting to `urlTextBox`.
5263 // Reset the list of host IP addresses.
5264 nestedScrollWebView.clearCurrentIpAddresses();
5266 // Get a URI for the current URL.
5267 Uri currentUri = Uri.parse(url);
5269 // Get the IP addresses for the host.
5270 new GetHostIpAddresses(activity, getSupportFragmentManager(), nestedScrollWebView).execute(currentUri.getHost());
5272 // Apply any custom domain settings if the URL was loaded by navigating history.
5273 if (nestedScrollWebView.getNavigatingHistory()) {
5274 // Reset navigating history.
5275 nestedScrollWebView.setNavigatingHistory(false);
5277 // Apply the domain settings.
5278 boolean userAgentChanged = applyDomainSettings(nestedScrollWebView, url, true, false);
5280 // Manually load the URL if the user agent has changed, which will have caused the previous URL to be reloaded.
5281 if (userAgentChanged) {
5286 // Replace Refresh with Stop if the options menu has been created. (The WebView typically begins loading before the menu items are instantiated.)
5287 if (optionsMenu != null) {
5288 // Get a handle for the refresh menu item.
5289 MenuItem refreshMenuItem = optionsMenu.findItem(R.id.refresh);
5292 refreshMenuItem.setTitle(R.string.stop);
5294 // Get the app bar and theme preferences.
5295 boolean displayAdditionalAppBarIcons = sharedPreferences.getBoolean("display_additional_app_bar_icons", false);
5297 // If the icon is displayed in the AppBar, set it according to the theme.
5298 if (displayAdditionalAppBarIcons) {
5300 refreshMenuItem.setIcon(R.drawable.close_dark);
5302 refreshMenuItem.setIcon(R.drawable.close_light);
5310 public void onPageFinished(WebView view, String url) {
5311 // Reset the wide view port if it has been turned off by the waiting for Orbot message.
5312 if (!waitingForOrbot) {
5313 // Only use a wide view port if the URL starts with `http`, not for `file://` and `content://`.
5314 nestedScrollWebView.getSettings().setUseWideViewPort(url.startsWith("http"));
5317 // Flush any cookies to persistent storage. The cookie manager has become very lazy about flushing cookies in recent versions.
5318 if (nestedScrollWebView.getAcceptFirstPartyCookies() && Build.VERSION.SDK_INT >= 21) {
5319 CookieManager.getInstance().flush();
5322 // Update the Refresh menu item if the options menu has been created.
5323 if (optionsMenu != null) {
5324 // Get a handle for the refresh menu item.
5325 MenuItem refreshMenuItem = optionsMenu.findItem(R.id.refresh);
5327 // Reset the Refresh title.
5328 refreshMenuItem.setTitle(R.string.refresh);
5330 // Get the app bar and theme preferences.
5331 boolean displayAdditionalAppBarIcons = sharedPreferences.getBoolean("display_additional_app_bar_icons", false);
5332 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
5334 // If the icon is displayed in the AppBar, reset it according to the theme.
5335 if (displayAdditionalAppBarIcons) {
5337 refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
5339 refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
5344 // Clear the cache and history if Incognito Mode is enabled.
5345 if (incognitoModeEnabled) {
5346 // Clear the cache. `true` includes disk files.
5347 nestedScrollWebView.clearCache(true);
5349 // Clear the back/forward history.
5350 nestedScrollWebView.clearHistory();
5352 // Manually delete cache folders.
5354 // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
5355 // which links to `/data/data/com.stoutner.privacybrowser.standard`.
5356 String privateDataDirectoryString = getApplicationInfo().dataDir;
5358 // Delete the main cache directory.
5359 Runtime.getRuntime().exec("rm -rf " + privateDataDirectoryString + "/cache");
5361 // Delete the secondary `Service Worker` cache directory.
5362 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
5363 Runtime.getRuntime().exec(new String[]{"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
5364 } catch (IOException e) {
5365 // Do nothing if an error is thrown.
5369 // Update the URL text box and apply domain settings if not waiting on Orbot.
5370 if (!waitingForOrbot) {
5371 // Get the current page position.
5372 int currentPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
5374 // Check the current website information against any pinned domain information if the current IP addresses have been loaded.
5375 if ((nestedScrollWebView.hasPinnedSslCertificate() || nestedScrollWebView.hasPinnedIpAddresses()) && nestedScrollWebView.hasCurrentIpAddresses() &&
5376 !nestedScrollWebView.ignorePinnedDomainInformation()) {
5377 CheckPinnedMismatchHelper.checkPinnedMismatch(getSupportFragmentManager(), nestedScrollWebView);
5380 // 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.
5381 String currentUrl = nestedScrollWebView.getUrl();
5383 // Update the URL text bar if the page is currently selected and the user is not currently typing in the URL edit text.
5384 // Crash records show that, in some crazy way, it is possible for the current URL to be blank at this point.
5385 // Probably some sort of race condition when Privacy Browser is being resumed.
5386 if ((tabLayout.getSelectedTabPosition() == currentPagePosition) && !urlEditText.hasFocus() && (currentUrl != null)) {
5387 // Check to see if the URL is `about:blank`.
5388 if (currentUrl.equals("about:blank")) { // The WebView is blank.
5389 // Display the hint in the URL edit text.
5390 urlEditText.setText("");
5392 // Request focus for the URL text box.
5393 urlEditText.requestFocus();
5395 // Display the keyboard.
5396 inputMethodManager.showSoftInput(urlEditText, 0);
5398 // Hide the WebView, which causes the default background color to be displayed according to the theme.
5399 nestedScrollWebView.setVisibility(View.INVISIBLE);
5401 // Apply the domain settings. This clears any settings from the previous domain.
5402 applyDomainSettings(nestedScrollWebView, "", true, false);
5403 } else { // The WebView has loaded a webpage.
5404 // Display the final URL. Getting the URL from the WebView instead of using the one provided by `onPageFinished()` makes websites like YouTube function correctly.
5405 urlEditText.setText(currentUrl);
5407 // Apply text highlighting to the URL.
5412 // Get the current tab.
5413 TabLayout.Tab tab = tabLayout.getTabAt(currentPagePosition);
5415 // Only populate the title text view if the tab has been fully created.
5417 // Get the custom view from the tab.
5418 View tabView = tab.getCustomView();
5420 // Remove the incorrect warning below that the current tab view might be null.
5421 assert tabView != null;
5423 // Get the title text view from the tab.
5424 TextView tabTitleTextView = tabView.findViewById(R.id.title_textview);
5426 // Set the title as the tab text. Sometimes `onReceivedTitle()` is not called, especially when navigating history.
5427 tabTitleTextView.setText(nestedScrollWebView.getTitle());
5432 // Handle SSL Certificate errors.
5434 public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
5435 // Get the current website SSL certificate.
5436 SslCertificate currentWebsiteSslCertificate = error.getCertificate();
5438 // Extract the individual pieces of information from the current website SSL certificate.
5439 String currentWebsiteIssuedToCName = currentWebsiteSslCertificate.getIssuedTo().getCName();
5440 String currentWebsiteIssuedToOName = currentWebsiteSslCertificate.getIssuedTo().getOName();
5441 String currentWebsiteIssuedToUName = currentWebsiteSslCertificate.getIssuedTo().getUName();
5442 String currentWebsiteIssuedByCName = currentWebsiteSslCertificate.getIssuedBy().getCName();
5443 String currentWebsiteIssuedByOName = currentWebsiteSslCertificate.getIssuedBy().getOName();
5444 String currentWebsiteIssuedByUName = currentWebsiteSslCertificate.getIssuedBy().getUName();
5445 Date currentWebsiteSslStartDate = currentWebsiteSslCertificate.getValidNotBeforeDate();
5446 Date currentWebsiteSslEndDate = currentWebsiteSslCertificate.getValidNotAfterDate();
5448 // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
5449 if (nestedScrollWebView.hasPinnedSslCertificate()) {
5450 // Get the pinned SSL certificate.
5451 ArrayList<Object> pinnedSslCertificateArrayList = nestedScrollWebView.getPinnedSslCertificate();
5453 // Extract the arrays from the array list.
5454 String[] pinnedSslCertificateStringArray = (String[]) pinnedSslCertificateArrayList.get(0);
5455 Date[] pinnedSslCertificateDateArray = (Date[]) pinnedSslCertificateArrayList.get(1);
5457 // Check if the current SSL certificate matches the pinned certificate.
5458 if (currentWebsiteIssuedToCName.equals(pinnedSslCertificateStringArray[0]) && currentWebsiteIssuedToOName.equals(pinnedSslCertificateStringArray[1]) &&
5459 currentWebsiteIssuedToUName.equals(pinnedSslCertificateStringArray[2]) && currentWebsiteIssuedByCName.equals(pinnedSslCertificateStringArray[3]) &&
5460 currentWebsiteIssuedByOName.equals(pinnedSslCertificateStringArray[4]) && currentWebsiteIssuedByUName.equals(pinnedSslCertificateStringArray[5]) &&
5461 currentWebsiteSslStartDate.equals(pinnedSslCertificateDateArray[0]) && currentWebsiteSslEndDate.equals(pinnedSslCertificateDateArray[1])) {
5463 // An SSL certificate is pinned and matches the current domain certificate. Proceed to the website without displaying an error.
5466 } else { // Either there isn't a pinned SSL certificate or it doesn't match the current website certificate.
5467 // Store the SSL error handler.
5468 nestedScrollWebView.setSslErrorHandler(handler);
5470 // Instantiate an SSL certificate error alert dialog.
5471 DialogFragment sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error, nestedScrollWebView.getWebViewFragmentId());
5473 // Show the SSL certificate error dialog.
5474 sslCertificateErrorDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_error));
5479 // Check to see if this is the first page.
5480 if (pageNumber == 0) {
5481 // Set this nested scroll WebView as the current WebView.
5482 currentWebView = nestedScrollWebView;
5484 // Apply the app settings from the shared preferences.
5487 // Load the website if not waiting for Orbot to connect.
5488 if (!waitingForOrbot) {
5489 // Get the intent that started the app.
5490 Intent launchingIntent = getIntent();
5492 // Get the information from the intent.
5493 String launchingIntentAction = launchingIntent.getAction();
5494 Uri launchingIntentUriData = launchingIntent.getData();
5496 // If the intent action is a web search, perform the search.
5497 if ((launchingIntentAction != null) && launchingIntentAction.equals(Intent.ACTION_WEB_SEARCH)) {
5498 // Create an encoded URL string.
5499 String encodedUrlString;
5501 // Sanitize the search input and convert it to a search.
5503 encodedUrlString = URLEncoder.encode(launchingIntent.getStringExtra(SearchManager.QUERY), "UTF-8");
5504 } catch (UnsupportedEncodingException exception) {
5505 encodedUrlString = "";
5508 // Load the completed search URL.
5509 loadUrl(searchURL + encodedUrlString);
5510 } else if (launchingIntentUriData != null){ // Check to see if the intent contains a new URL.
5511 // Load the URL from the intent.
5512 loadUrl(launchingIntentUriData.toString());
5513 } else { // The is no URL in the intent.
5514 // Select the homepage based on the proxy through Orbot status.
5515 if (proxyThroughOrbot) {
5516 // Load the Tor homepage.
5517 loadUrl(sharedPreferences.getString("tor_homepage", getString(R.string.tor_homepage_default_value)));
5519 // Load the normal homepage.
5520 loadUrl(sharedPreferences.getString("homepage", getString(R.string.homepage_default_value)));