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 // Only process the URI if it contains data. If the user pressed the desktop icon after the app was already running the URI will be null.
814 if (intentUriData != null) {
815 // Sets the new intent as the activity intent, which replaces the one that originally started the app.
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.
834 if ((intentAction != null) && intentAction.equals(Intent.ACTION_WEB_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 // Get a handle for the tab layout and the view pager.
2081 TabLayout tabLayout = findViewById(R.id.tablayout);
2082 ViewPager webViewPager = findViewById(R.id.webviewpager);
2084 // Get the current tab number.
2085 int currentTabNumber = tabLayout.getSelectedTabPosition();
2087 // Delete the current tab.
2088 tabLayout.removeTabAt(currentTabNumber);
2090 // 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.
2091 if (webViewPagerAdapter.deletePage(currentTabNumber, webViewPager)) {
2092 setCurrentWebView(currentTabNumber);
2096 case R.id.clear_and_exit:
2097 // Close the bookmarks cursor and database.
2098 bookmarksCursor.close();
2099 bookmarksDatabaseHelper.close();
2101 // Get the status of the clear everything preference.
2102 boolean clearEverything = sharedPreferences.getBoolean("clear_everything", true);
2104 // Get a handle for the runtime.
2105 Runtime runtime = Runtime.getRuntime();
2107 // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
2108 // which links to `/data/data/com.stoutner.privacybrowser.standard`.
2109 String privateDataDirectoryString = getApplicationInfo().dataDir;
2112 if (clearEverything || sharedPreferences.getBoolean("clear_cookies", true)) {
2113 // The command to remove cookies changed slightly in API 21.
2114 if (Build.VERSION.SDK_INT >= 21) {
2115 CookieManager.getInstance().removeAllCookies(null);
2117 CookieManager.getInstance().removeAllCookie();
2120 // Manually delete the cookies database, as `CookieManager` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2122 // Two commands must be used because `Runtime.exec()` does not like `*`.
2123 Process deleteCookiesProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies");
2124 Process deleteCookiesJournalProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies-journal");
2126 // Wait until the processes have finished.
2127 deleteCookiesProcess.waitFor();
2128 deleteCookiesJournalProcess.waitFor();
2129 } catch (Exception exception) {
2130 // Do nothing if an error is thrown.
2134 // Clear DOM storage.
2135 if (clearEverything || sharedPreferences.getBoolean("clear_dom_storage", true)) {
2136 // Ask `WebStorage` to clear the DOM storage.
2137 WebStorage webStorage = WebStorage.getInstance();
2138 webStorage.deleteAllData();
2140 // Manually delete the DOM storage files and directories, as `WebStorage` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2142 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2143 Process deleteLocalStorageProcess = runtime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2145 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2146 Process deleteIndexProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2147 Process deleteQuotaManagerProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2148 Process deleteQuotaManagerJournalProcess = runtime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2149 Process deleteDatabaseProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2151 // Wait until the processes have finished.
2152 deleteLocalStorageProcess.waitFor();
2153 deleteIndexProcess.waitFor();
2154 deleteQuotaManagerProcess.waitFor();
2155 deleteQuotaManagerJournalProcess.waitFor();
2156 deleteDatabaseProcess.waitFor();
2157 } catch (Exception exception) {
2158 // Do nothing if an error is thrown.
2162 // Clear form data if the API < 26.
2163 if ((Build.VERSION.SDK_INT < 26) && (clearEverything || sharedPreferences.getBoolean("clear_form_data", true))) {
2164 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
2165 webViewDatabase.clearFormData();
2167 // Manually delete the form data database, as `WebViewDatabase` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2169 // A string array must be used because the database contains a space and `Runtime.exec` will not otherwise escape the string correctly.
2170 Process deleteWebDataProcess = runtime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data"});
2171 Process deleteWebDataJournalProcess = runtime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data-journal"});
2173 // Wait until the processes have finished.
2174 deleteWebDataProcess.waitFor();
2175 deleteWebDataJournalProcess.waitFor();
2176 } catch (Exception exception) {
2177 // Do nothing if an error is thrown.
2182 if (clearEverything || sharedPreferences.getBoolean("clear_cache", true)) {
2183 // Clear the cache from each WebView.
2184 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
2185 // Get the WebView tab fragment.
2186 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
2188 // Get the fragment view.
2189 View fragmentView = webViewTabFragment.getView();
2191 // Only clear the cache if the WebView exists.
2192 if (fragmentView != null) {
2193 // Get the nested scroll WebView from the tab fragment.
2194 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
2196 // Clear the cache for this WebView.
2197 nestedScrollWebView.clearCache(true);
2201 // Manually delete the cache directories.
2203 // Delete the main cache directory.
2204 Process deleteCacheProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/cache");
2206 // Delete the secondary `Service Worker` cache directory.
2207 // A string array must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2208 Process deleteServiceWorkerProcess = runtime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
2210 // Wait until the processes have finished.
2211 deleteCacheProcess.waitFor();
2212 deleteServiceWorkerProcess.waitFor();
2213 } catch (Exception exception) {
2214 // Do nothing if an error is thrown.
2218 // Wipe out each WebView.
2219 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
2220 // Get the WebView tab fragment.
2221 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
2223 // Get the fragment view.
2224 View fragmentView = webViewTabFragment.getView();
2226 // Only wipe out the WebView if it exists.
2227 if (fragmentView != null) {
2228 // Get the nested scroll WebView from the tab fragment.
2229 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
2231 // Clear SSL certificate preferences for this WebView.
2232 nestedScrollWebView.clearSslPreferences();
2234 // Clear the back/forward history for this WebView.
2235 nestedScrollWebView.clearHistory();
2237 // Destroy the internal state of `mainWebView`.
2238 nestedScrollWebView.destroy();
2242 // Clear the custom headers.
2243 customHeaders.clear();
2245 // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
2246 // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
2247 if (clearEverything) {
2249 // Delete the folder.
2250 Process deleteAppWebviewProcess = runtime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
2252 // Wait until the process has finished.
2253 deleteAppWebviewProcess.waitFor();
2254 } catch (Exception exception) {
2255 // Do nothing if an error is thrown.
2259 // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
2260 if (Build.VERSION.SDK_INT >= 21) {
2261 finishAndRemoveTask();
2266 // Remove the terminated program from RAM. The status code is `0`.
2271 // Select the homepage based on the proxy through Orbot status.
2272 if (proxyThroughOrbot) {
2273 // Load the Tor homepage.
2274 loadUrl(sharedPreferences.getString("tor_homepage", getString(R.string.tor_homepage_default_value)));
2276 // Load the normal homepage.
2277 loadUrl(sharedPreferences.getString("homepage", getString(R.string.homepage_default_value)));
2282 if (currentWebView.canGoBack()) {
2283 // Reset the current domain name so that navigation works if third-party requests are blocked.
2284 currentWebView.resetCurrentDomainName();
2286 // Set navigating history so that the domain settings are applied when the new URL is loaded.
2287 currentWebView.setNavigatingHistory(true);
2289 // Load the previous website in the history.
2290 currentWebView.goBack();
2295 if (currentWebView.canGoForward()) {
2296 // Reset the current domain name so that navigation works if third-party requests are blocked.
2297 currentWebView.resetCurrentDomainName();
2299 // Set navigating history so that the domain settings are applied when the new URL is loaded.
2300 currentWebView.setNavigatingHistory(true);
2302 // Load the next website in the history.
2303 currentWebView.goForward();
2308 // Instantiate the URL history dialog.
2309 DialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(currentWebView.getWebViewFragmentId());
2311 // Show the URL history dialog.
2312 urlHistoryDialogFragment.show(getSupportFragmentManager(), getString(R.string.history));
2316 // Populate the resource requests.
2317 RequestsActivity.resourceRequests = currentWebView.getResourceRequests();
2319 // Create an intent to launch the Requests activity.
2320 Intent requestsIntent = new Intent(this, RequestsActivity.class);
2322 // Add the block third-party requests status to the intent.
2323 requestsIntent.putExtra("block_all_third_party_requests", currentWebView.isBlocklistEnabled(NestedScrollWebView.THIRD_PARTY_REQUESTS));
2326 startActivity(requestsIntent);
2329 case R.id.downloads:
2330 // Launch the system Download Manager.
2331 Intent downloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
2333 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
2334 downloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2336 startActivity(downloadManagerIntent);
2340 // Set the flag to reapply the domain settings on restart when returning from Domain Settings.
2341 reapplyDomainSettingsOnRestart = true;
2343 // Launch the domains activity.
2344 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2346 // Add the extra information to the intent.
2347 domainsIntent.putExtra("current_url", currentWebView.getUrl());
2349 // Get the current certificate.
2350 SslCertificate sslCertificate = currentWebView.getCertificate();
2352 // Check to see if the SSL certificate is populated.
2353 if (sslCertificate != null) {
2354 // Extract the certificate to strings.
2355 String issuedToCName = sslCertificate.getIssuedTo().getCName();
2356 String issuedToOName = sslCertificate.getIssuedTo().getOName();
2357 String issuedToUName = sslCertificate.getIssuedTo().getUName();
2358 String issuedByCName = sslCertificate.getIssuedBy().getCName();
2359 String issuedByOName = sslCertificate.getIssuedBy().getOName();
2360 String issuedByUName = sslCertificate.getIssuedBy().getUName();
2361 long startDateLong = sslCertificate.getValidNotBeforeDate().getTime();
2362 long endDateLong = sslCertificate.getValidNotAfterDate().getTime();
2364 // Add the certificate to the intent.
2365 domainsIntent.putExtra("ssl_issued_to_cname", issuedToCName);
2366 domainsIntent.putExtra("ssl_issued_to_oname", issuedToOName);
2367 domainsIntent.putExtra("ssl_issued_to_uname", issuedToUName);
2368 domainsIntent.putExtra("ssl_issued_by_cname", issuedByCName);
2369 domainsIntent.putExtra("ssl_issued_by_oname", issuedByOName);
2370 domainsIntent.putExtra("ssl_issued_by_uname", issuedByUName);
2371 domainsIntent.putExtra("ssl_start_date", startDateLong);
2372 domainsIntent.putExtra("ssl_end_date", endDateLong);
2375 // Check to see if the current IP addresses have been received.
2376 if (currentWebView.hasCurrentIpAddresses()) {
2377 // Add the current IP addresses to the intent.
2378 domainsIntent.putExtra("current_ip_addresses", currentWebView.getCurrentIpAddresses());
2382 startActivity(domainsIntent);
2386 // Set the flag to reapply app settings on restart when returning from Settings.
2387 reapplyAppSettingsOnRestart = true;
2389 // Set the flag to reapply the domain settings on restart when returning from Settings.
2390 reapplyDomainSettingsOnRestart = true;
2392 // Launch the settings activity.
2393 Intent settingsIntent = new Intent(this, SettingsActivity.class);
2394 startActivity(settingsIntent);
2397 case R.id.import_export:
2398 // Launch the import/export activity.
2399 Intent importExportIntent = new Intent (this, ImportExportActivity.class);
2400 startActivity(importExportIntent);
2404 // Launch the logcat activity.
2405 Intent logcatIntent = new Intent(this, LogcatActivity.class);
2406 startActivity(logcatIntent);
2410 // Launch `GuideActivity`.
2411 Intent guideIntent = new Intent(this, GuideActivity.class);
2412 startActivity(guideIntent);
2416 // Create an intent to launch the about activity.
2417 Intent aboutIntent = new Intent(this, AboutActivity.class);
2419 // Create a string array for the blocklist versions.
2420 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],
2421 ultraPrivacy.get(0).get(0)[0]};
2423 // Add the blocklist versions to the intent.
2424 aboutIntent.putExtra("blocklist_versions", blocklistVersions);
2427 startActivity(aboutIntent);
2431 // Get a handle for the drawer layout.
2432 DrawerLayout drawerLayout = findViewById(R.id.drawerlayout);
2434 // Close the navigation drawer.
2435 drawerLayout.closeDrawer(GravityCompat.START);
2440 public void onPostCreate(Bundle savedInstanceState) {
2441 // Run the default commands.
2442 super.onPostCreate(savedInstanceState);
2444 // Sync the state of the DrawerToggle after the default `onRestoreInstanceState()` has finished. This creates the navigation drawer icon.
2445 actionBarDrawerToggle.syncState();
2449 public void onConfigurationChanged(Configuration newConfig) {
2450 // Run the default commands.
2451 super.onConfigurationChanged(newConfig);
2453 // Get the status bar pixel size.
2454 int statusBarResourceId = getResources().getIdentifier("status_bar_height", "dimen", "android");
2455 int statusBarPixelSize = getResources().getDimensionPixelSize(statusBarResourceId);
2457 // Get the resource density.
2458 float screenDensity = getResources().getDisplayMetrics().density;
2460 // Recalculate the drawer header padding.
2461 drawerHeaderPaddingLeftAndRight = (int) (15 * screenDensity);
2462 drawerHeaderPaddingTop = statusBarPixelSize + (int) (4 * screenDensity);
2463 drawerHeaderPaddingBottom = (int) (8 * screenDensity);
2465 // Reload the ad for the free flavor if not in full screen mode.
2466 if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
2467 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
2468 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
2471 // `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:
2472 // https://code.google.com/p/android/issues/detail?id=20493#c8
2473 // ActivityCompat.invalidateOptionsMenu(this);
2477 public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
2478 // Store the hit test result.
2479 final WebView.HitTestResult hitTestResult = currentWebView.getHitTestResult();
2481 // Create the URL strings.
2482 final String imageUrl;
2483 final String linkUrl;
2485 // Get handles for the system managers.
2486 final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
2487 FragmentManager fragmentManager = getSupportFragmentManager();
2488 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2490 // Remove the lint errors below that the clipboard manager might be null.
2491 assert clipboardManager != null;
2493 // Process the link according to the type.
2494 switch (hitTestResult.getType()) {
2495 // `SRC_ANCHOR_TYPE` is a link.
2496 case WebView.HitTestResult.SRC_ANCHOR_TYPE:
2497 // Get the target URL.
2498 linkUrl = hitTestResult.getExtra();
2500 // Set the target URL as the title of the `ContextMenu`.
2501 menu.setHeaderTitle(linkUrl);
2503 // Add a Load URL entry.
2504 menu.add(R.string.open_in_new_tab).setOnMenuItemClickListener((MenuItem item) -> {
2513 // Add an Open with App entry.
2514 menu.add(R.string.open_with_app).setOnMenuItemClickListener((MenuItem item) -> {
2515 openWithApp(linkUrl);
2519 // Add an Open with Browser entry.
2520 menu.add(R.string.open_with_browser).setOnMenuItemClickListener((MenuItem item) -> {
2521 openWithBrowser(linkUrl);
2525 // Add a Copy URL entry.
2526 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
2527 // Save the link URL in a `ClipData`.
2528 ClipData srcAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
2530 // Set the `ClipData` as the clipboard's primary clip.
2531 clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
2535 // Add a Download URL entry.
2536 menu.add(R.string.download_url).setOnMenuItemClickListener((MenuItem item) -> {
2537 // Check if the download should be processed by an external app.
2538 if (sharedPreferences.getBoolean("download_with_external_app", false)) { // Download with an external app.
2539 openUrlWithExternalApp(linkUrl);
2540 } else { // Download with Android's download manager.
2541 // Check to see if the storage permission has already been granted.
2542 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) { // The storage permission needs to be requested.
2543 // Store the variables for future use by `onRequestPermissionsResult()`.
2544 downloadUrl = linkUrl;
2545 downloadContentDisposition = "none";
2546 downloadContentLength = -1;
2548 // Show a dialog if the user has previously denied the permission.
2549 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2550 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
2551 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
2553 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
2554 downloadLocationPermissionDialogFragment.show(fragmentManager, getString(R.string.download_location));
2555 } else { // Show the permission request directly.
2556 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
2557 ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
2559 } else { // The storage permission has already been granted.
2560 // Get a handle for the download file alert dialog.
2561 DialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(linkUrl, "none", -1);
2563 // Show the download file alert dialog.
2564 downloadFileDialogFragment.show(fragmentManager, getString(R.string.download));
2570 // Add a Cancel entry, which by default closes the context menu.
2571 menu.add(R.string.cancel);
2574 case WebView.HitTestResult.EMAIL_TYPE:
2575 // Get the target URL.
2576 linkUrl = hitTestResult.getExtra();
2578 // Set the target URL as the title of the `ContextMenu`.
2579 menu.setHeaderTitle(linkUrl);
2581 // Add a Write Email entry.
2582 menu.add(R.string.write_email).setOnMenuItemClickListener(item -> {
2583 // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
2584 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
2586 // Parse the url and set it as the data for the `Intent`.
2587 emailIntent.setData(Uri.parse("mailto:" + linkUrl));
2589 // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
2590 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2593 startActivity(emailIntent);
2597 // Add a Copy Email Address entry.
2598 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(item -> {
2599 // Save the email address in a `ClipData`.
2600 ClipData srcEmailTypeClipData = ClipData.newPlainText(getString(R.string.email_address), linkUrl);
2602 // Set the `ClipData` as the clipboard's primary clip.
2603 clipboardManager.setPrimaryClip(srcEmailTypeClipData);
2607 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2608 menu.add(R.string.cancel);
2611 // `IMAGE_TYPE` is an image.
2612 case WebView.HitTestResult.IMAGE_TYPE:
2613 // Get the image URL.
2614 imageUrl = hitTestResult.getExtra();
2616 // Set the image URL as the title of the `ContextMenu`.
2617 menu.setHeaderTitle(imageUrl);
2619 // Add a View Image entry.
2620 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2625 // Add a Download Image entry.
2626 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2627 // Check if the download should be processed by an external app.
2628 if (sharedPreferences.getBoolean("download_with_external_app", false)) { // Download with an external app.
2629 openUrlWithExternalApp(imageUrl);
2630 } else { // Download with Android's download manager.
2631 // Check to see if the storage permission has already been granted.
2632 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) { // The storage permission needs to be requested.
2633 // Store the image URL for use by `onRequestPermissionResult()`.
2634 downloadImageUrl = imageUrl;
2636 // Show a dialog if the user has previously denied the permission.
2637 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2638 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2639 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2641 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
2642 downloadLocationPermissionDialogFragment.show(fragmentManager, getString(R.string.download_location));
2643 } else { // Show the permission request directly.
2644 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
2645 ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2647 } else { // The storage permission has already been granted.
2648 // Get a handle for the download image alert dialog.
2649 DialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2651 // Show the download image alert dialog.
2652 downloadImageDialogFragment.show(fragmentManager, getString(R.string.download));
2658 // Add a Copy URL entry.
2659 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2660 // Save the image URL in a `ClipData`.
2661 ClipData srcImageTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2663 // Set the `ClipData` as the clipboard's primary clip.
2664 clipboardManager.setPrimaryClip(srcImageTypeClipData);
2668 // Add an Open with App entry.
2669 menu.add(R.string.open_with_app).setOnMenuItemClickListener((MenuItem item) -> {
2670 openWithApp(imageUrl);
2674 // Add an Open with Browser entry.
2675 menu.add(R.string.open_with_browser).setOnMenuItemClickListener((MenuItem item) -> {
2676 openWithBrowser(imageUrl);
2680 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2681 menu.add(R.string.cancel);
2685 // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
2686 case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
2687 // Get the image URL.
2688 imageUrl = hitTestResult.getExtra();
2690 // Set the image URL as the title of the `ContextMenu`.
2691 menu.setHeaderTitle(imageUrl);
2693 // Add a `View Image` entry.
2694 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2699 // Add a `Download Image` entry.
2700 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2701 // Check if the download should be processed by an external app.
2702 if (sharedPreferences.getBoolean("download_with_external_app", false)) { // Download with an external app.
2703 openUrlWithExternalApp(imageUrl);
2704 } else { // Download with Android's download manager.
2705 // Check to see if the storage permission has already been granted.
2706 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) { // The storage permission needs to be requested.
2707 // Store the image URL for use by `onRequestPermissionResult()`.
2708 downloadImageUrl = imageUrl;
2710 // Show a dialog if the user has previously denied the permission.
2711 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2712 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2713 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2715 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
2716 downloadLocationPermissionDialogFragment.show(fragmentManager, getString(R.string.download_location));
2717 } else { // Show the permission request directly.
2718 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
2719 ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2721 } else { // The storage permission has already been granted.
2722 // Get a handle for the download image alert dialog.
2723 DialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2725 // Show the download image alert dialog.
2726 downloadImageDialogFragment.show(fragmentManager, getString(R.string.download));
2732 // Add a `Copy URL` entry.
2733 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2734 // Save the image URL in a `ClipData`.
2735 ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2737 // Set the `ClipData` as the clipboard's primary clip.
2738 clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
2742 // Add an Open with App entry.
2743 menu.add(R.string.open_with_app).setOnMenuItemClickListener((MenuItem item) -> {
2744 openWithApp(imageUrl);
2748 // Add an Open with Browser entry.
2749 menu.add(R.string.open_with_browser).setOnMenuItemClickListener((MenuItem item) -> {
2750 openWithBrowser(imageUrl);
2754 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2755 menu.add(R.string.cancel);
2761 public void onCreateBookmark(DialogFragment dialogFragment, Bitmap favoriteIconBitmap) {
2762 // Get a handle for the bookmarks list view.
2763 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
2765 // Get the views from the dialog fragment.
2766 EditText createBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_name_edittext);
2767 EditText createBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_url_edittext);
2769 // Extract the strings from the edit texts.
2770 String bookmarkNameString = createBookmarkNameEditText.getText().toString();
2771 String bookmarkUrlString = createBookmarkUrlEditText.getText().toString();
2773 // Create a favorite icon byte array output stream.
2774 ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2776 // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2777 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
2779 // Convert the favorite icon byte array stream to a byte array.
2780 byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
2782 // Display the new bookmark below the current items in the (0 indexed) list.
2783 int newBookmarkDisplayOrder = bookmarksListView.getCount();
2785 // Create the bookmark.
2786 bookmarksDatabaseHelper.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray);
2788 // Update the bookmarks cursor with the current contents of this folder.
2789 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2791 // Update the list view.
2792 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2794 // Scroll to the new bookmark.
2795 bookmarksListView.setSelection(newBookmarkDisplayOrder);
2799 public void onCreateBookmarkFolder(DialogFragment dialogFragment, Bitmap favoriteIconBitmap) {
2800 // Get a handle for the bookmarks list view.
2801 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
2803 // Get handles for the views in the dialog fragment.
2804 EditText createFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.create_folder_name_edittext);
2805 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon_radiobutton);
2806 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon);
2808 // Get new folder name string.
2809 String folderNameString = createFolderNameEditText.getText().toString();
2811 // Create a folder icon bitmap.
2812 Bitmap folderIconBitmap;
2814 // Set the folder icon bitmap according to the dialog.
2815 if (defaultFolderIconRadioButton.isChecked()) { // Use the default folder icon.
2816 // Get the default folder icon drawable.
2817 Drawable folderIconDrawable = folderIconImageView.getDrawable();
2819 // Convert the folder icon drawable to a bitmap drawable.
2820 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2822 // Convert the folder icon bitmap drawable to a bitmap.
2823 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2824 } else { // Use the WebView favorite icon.
2825 // Copy the favorite icon bitmap to the folder icon bitmap.
2826 folderIconBitmap = favoriteIconBitmap;
2829 // Create a folder icon byte array output stream.
2830 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2832 // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2833 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
2835 // Convert the folder icon byte array stream to a byte array.
2836 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
2838 // Move all the bookmarks down one in the display order.
2839 for (int i = 0; i < bookmarksListView.getCount(); i++) {
2840 int databaseId = (int) bookmarksListView.getItemIdAtPosition(i);
2841 bookmarksDatabaseHelper.updateDisplayOrder(databaseId, i + 1);
2844 // Create the folder, which will be placed at the top of the `ListView`.
2845 bookmarksDatabaseHelper.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray);
2847 // Update the bookmarks cursor with the current contents of this folder.
2848 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2850 // Update the `ListView`.
2851 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2853 // Scroll to the new folder.
2854 bookmarksListView.setSelection(0);
2858 public void onSaveBookmark(DialogFragment dialogFragment, int selectedBookmarkDatabaseId, Bitmap favoriteIconBitmap) {
2859 // Get handles for the views from `dialogFragment`.
2860 EditText editBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_name_edittext);
2861 EditText editBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_url_edittext);
2862 RadioButton currentBookmarkIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_current_icon_radiobutton);
2864 // Store the bookmark strings.
2865 String bookmarkNameString = editBookmarkNameEditText.getText().toString();
2866 String bookmarkUrlString = editBookmarkUrlEditText.getText().toString();
2868 // Update the bookmark.
2869 if (currentBookmarkIconRadioButton.isChecked()) { // Update the bookmark without changing the favorite icon.
2870 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString);
2871 } else { // Update the bookmark using the `WebView` favorite icon.
2872 // Create a favorite icon byte array output stream.
2873 ByteArrayOutputStream newFavoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2875 // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2876 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFavoriteIconByteArrayOutputStream);
2878 // Convert the favorite icon byte array stream to a byte array.
2879 byte[] newFavoriteIconByteArray = newFavoriteIconByteArrayOutputStream.toByteArray();
2881 // Update the bookmark and the favorite icon.
2882 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString, newFavoriteIconByteArray);
2885 // Update the bookmarks cursor with the current contents of this folder.
2886 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2888 // Update the list view.
2889 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2893 public void onSaveBookmarkFolder(DialogFragment dialogFragment, int selectedFolderDatabaseId, Bitmap favoriteIconBitmap) {
2894 // Get handles for the views from `dialogFragment`.
2895 EditText editFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_folder_name_edittext);
2896 RadioButton currentFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_current_icon_radiobutton);
2897 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_radiobutton);
2898 ImageView defaultFolderIconImageView = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_imageview);
2900 // Get the new folder name.
2901 String newFolderNameString = editFolderNameEditText.getText().toString();
2903 // Check if the favorite icon has changed.
2904 if (currentFolderIconRadioButton.isChecked()) { // Only the name has changed.
2905 // Update the name in the database.
2906 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString);
2907 } else if (!currentFolderIconRadioButton.isChecked() && newFolderNameString.equals(oldFolderNameString)) { // Only the icon has changed.
2908 // Create the new folder icon Bitmap.
2909 Bitmap folderIconBitmap;
2911 // Populate the new folder icon bitmap.
2912 if (defaultFolderIconRadioButton.isChecked()) {
2913 // Get the default folder icon drawable.
2914 Drawable folderIconDrawable = defaultFolderIconImageView.getDrawable();
2916 // Convert the folder icon drawable to a bitmap drawable.
2917 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2919 // Convert the folder icon bitmap drawable to a bitmap.
2920 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2921 } else { // Use the `WebView` favorite icon.
2922 // Copy the favorite icon bitmap to the folder icon bitmap.
2923 folderIconBitmap = favoriteIconBitmap;
2926 // Create a folder icon byte array output stream.
2927 ByteArrayOutputStream newFolderIconByteArrayOutputStream = new ByteArrayOutputStream();
2929 // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2930 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFolderIconByteArrayOutputStream);
2932 // Convert the folder icon byte array stream to a byte array.
2933 byte[] newFolderIconByteArray = newFolderIconByteArrayOutputStream.toByteArray();
2935 // Update the folder icon in the database.
2936 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, newFolderIconByteArray);
2937 } else { // The folder icon and the name have changed.
2938 // Get the new folder icon `Bitmap`.
2939 Bitmap folderIconBitmap;
2940 if (defaultFolderIconRadioButton.isChecked()) {
2941 // Get the default folder icon drawable.
2942 Drawable folderIconDrawable = defaultFolderIconImageView.getDrawable();
2944 // Convert the folder icon drawable to a bitmap drawable.
2945 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2947 // Convert the folder icon bitmap drawable to a bitmap.
2948 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2949 } else { // Use the `WebView` favorite icon.
2950 // Copy the favorite icon bitmap to the folder icon bitmap.
2951 folderIconBitmap = favoriteIconBitmap;
2954 // Create a folder icon byte array output stream.
2955 ByteArrayOutputStream newFolderIconByteArrayOutputStream = new ByteArrayOutputStream();
2957 // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2958 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFolderIconByteArrayOutputStream);
2960 // Convert the folder icon byte array stream to a byte array.
2961 byte[] newFolderIconByteArray = newFolderIconByteArrayOutputStream.toByteArray();
2963 // Update the folder name and icon in the database.
2964 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString, newFolderIconByteArray);
2967 // Update the bookmarks cursor with the current contents of this folder.
2968 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
2970 // Update the `ListView`.
2971 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2975 public void onCloseDownloadLocationPermissionDialog(int downloadType) {
2976 switch (downloadType) {
2977 case DownloadLocationPermissionDialog.DOWNLOAD_FILE:
2978 // Request the WRITE_EXTERNAL_STORAGE permission with a file request code.
2979 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
2982 case DownloadLocationPermissionDialog.DOWNLOAD_IMAGE:
2983 // Request the WRITE_EXTERNAL_STORAGE permission with an image request code.
2984 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2990 public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
2991 // Get a handle for the fragment manager.
2992 FragmentManager fragmentManager = getSupportFragmentManager();
2994 switch (requestCode) {
2995 case DOWNLOAD_FILE_REQUEST_CODE:
2996 // Show the download file alert dialog. When the dialog closes, the correct command will be used based on the permission status.
2997 DialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(downloadUrl, downloadContentDisposition, downloadContentLength);
2999 // On API 23, displaying the fragment must be delayed or the app will crash.
3000 if (Build.VERSION.SDK_INT == 23) {
3001 new Handler().postDelayed(() -> downloadFileDialogFragment.show(fragmentManager, getString(R.string.download)), 500);
3003 downloadFileDialogFragment.show(fragmentManager, getString(R.string.download));
3006 // Reset the download variables.
3008 downloadContentDisposition = "";
3009 downloadContentLength = 0;
3012 case DOWNLOAD_IMAGE_REQUEST_CODE:
3013 // Show the download image alert dialog. When the dialog closes, the correct command will be used based on the permission status.
3014 DialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(downloadImageUrl);
3016 // On API 23, displaying the fragment must be delayed or the app will crash.
3017 if (Build.VERSION.SDK_INT == 23) {
3018 new Handler().postDelayed(() -> downloadImageDialogFragment.show(fragmentManager, getString(R.string.download)), 500);
3020 downloadImageDialogFragment.show(fragmentManager, getString(R.string.download));
3023 // Reset the image URL variable.
3024 downloadImageUrl = "";
3030 public void onDownloadImage(DialogFragment dialogFragment, String imageUrl) {
3031 // Download the image if it has an HTTP or HTTPS URI.
3032 if (imageUrl.startsWith("http")) {
3033 // Get a handle for the system `DOWNLOAD_SERVICE`.
3034 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3036 // Parse `imageUrl`.
3037 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(imageUrl));
3039 // Get a handle for the cookie manager.
3040 CookieManager cookieManager = CookieManager.getInstance();
3042 // Pass cookies to download manager if cookies are enabled. This is required to download images from websites that require a login.
3043 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3044 if (cookieManager.acceptCookie()) {
3045 // Get the cookies for `imageUrl`.
3046 String cookies = cookieManager.getCookie(imageUrl);
3048 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3049 downloadRequest.addRequestHeader("Cookie", cookies);
3052 // Get the file name from the dialog fragment.
3053 EditText downloadImageNameEditText = dialogFragment.getDialog().findViewById(R.id.download_image_name);
3054 String imageName = downloadImageNameEditText.getText().toString();
3056 // Specify the download location.
3057 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3058 // Download to the public download directory.
3059 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, imageName);
3060 } else { // External write permission denied.
3061 // Download to the app's external download directory.
3062 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, imageName);
3065 // Allow `MediaScanner` to index the download if it is a media file.
3066 downloadRequest.allowScanningByMediaScanner();
3068 // Add the URL as the description for the download.
3069 downloadRequest.setDescription(imageUrl);
3071 // Show the download notification after the download is completed.
3072 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3074 // Remove the lint warning below that `downloadManager` might be `null`.
3075 assert downloadManager != null;
3077 // Initiate the download.
3078 downloadManager.enqueue(downloadRequest);
3079 } else { // The image is not an HTTP or HTTPS URI.
3080 Snackbar.make(currentWebView, R.string.cannot_download_image, Snackbar.LENGTH_INDEFINITE).show();
3085 public void onDownloadFile(DialogFragment dialogFragment, String downloadUrl) {
3086 // Download the file if it has an HTTP or HTTPS URI.
3087 if (downloadUrl.startsWith("http")) {
3088 // Get a handle for the system `DOWNLOAD_SERVICE`.
3089 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3091 // Parse `downloadUrl`.
3092 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(downloadUrl));
3094 // Get a handle for the cookie manager.
3095 CookieManager cookieManager = CookieManager.getInstance();
3097 // Pass cookies to download manager if cookies are enabled. This is required to download files from websites that require a login.
3098 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3099 if (cookieManager.acceptCookie()) {
3100 // Get the cookies for `downloadUrl`.
3101 String cookies = cookieManager.getCookie(downloadUrl);
3103 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3104 downloadRequest.addRequestHeader("Cookie", cookies);
3107 // Get the file name from the dialog fragment.
3108 EditText downloadFileNameEditText = dialogFragment.getDialog().findViewById(R.id.download_file_name);
3109 String fileName = downloadFileNameEditText.getText().toString();
3111 // Specify the download location.
3112 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3113 // Download to the public download directory.
3114 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, fileName);
3115 } else { // External write permission denied.
3116 // Download to the app's external download directory.
3117 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, fileName);
3120 // Allow `MediaScanner` to index the download if it is a media file.
3121 downloadRequest.allowScanningByMediaScanner();
3123 // Add the URL as the description for the download.
3124 downloadRequest.setDescription(downloadUrl);
3126 // Show the download notification after the download is completed.
3127 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3129 // Remove the lint warning below that `downloadManager` might be `null`.
3130 assert downloadManager != null;
3132 // Initiate the download.
3133 downloadManager.enqueue(downloadRequest);
3134 } else { // The download is not an HTTP or HTTPS URI.
3135 Snackbar.make(currentWebView, R.string.cannot_download_file, Snackbar.LENGTH_INDEFINITE).show();
3139 // Override `onBackPressed` to handle the navigation drawer and and the WebView.
3141 public void onBackPressed() {
3142 // Get a handle for the drawer layout.
3143 DrawerLayout drawerLayout = findViewById(R.id.drawerlayout);
3145 if (drawerLayout.isDrawerVisible(GravityCompat.START)) { // The navigation drawer is open.
3146 // Close the navigation drawer.
3147 drawerLayout.closeDrawer(GravityCompat.START);
3148 } else if (drawerLayout.isDrawerVisible(GravityCompat.END)){ // The bookmarks drawer is open.
3149 if (currentBookmarksFolder.isEmpty()) { // The home folder is displayed.
3150 // close the bookmarks drawer.
3151 drawerLayout.closeDrawer(GravityCompat.END);
3152 } else { // A subfolder is displayed.
3153 // Place the former parent folder in `currentFolder`.
3154 currentBookmarksFolder = bookmarksDatabaseHelper.getParentFolderName(currentBookmarksFolder);
3156 // Load the new folder.
3157 loadBookmarksFolder();
3159 } else if (currentWebView.canGoBack()) { // There is at least one item in the current WebView history.
3160 // Reset the current domain name so that navigation works if third-party requests are blocked.
3161 currentWebView.resetCurrentDomainName();
3163 // Set navigating history so that the domain settings are applied when the new URL is loaded.
3164 currentWebView.setNavigatingHistory(true);
3167 currentWebView.goBack();
3168 } else { // There is nothing else to do.
3169 // Load a blank website.
3174 // 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.
3176 public void onActivityResult(int requestCode, int resultCode, Intent data) {
3177 // File uploads only work on API >= 21.
3178 if (Build.VERSION.SDK_INT >= 21) {
3179 // Pass the file to the WebView.
3180 fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(resultCode, data));
3184 private void loadUrlFromTextBox() {
3185 // Get a handle for the URL edit text.
3186 EditText urlEditText = findViewById(R.id.url_edittext);
3188 // Get the text from urlTextBox and convert it to a string. trim() removes white spaces from the beginning and end of the string.
3189 String unformattedUrlString = urlEditText.getText().toString().trim();
3191 // Initialize the formatted URL string.
3194 // Check to see if `unformattedUrlString` is a valid URL. Otherwise, convert it into a search.
3195 if (unformattedUrlString.startsWith("content://")) { // This is a Content URL.
3196 // Load the entire content URL.
3197 url = unformattedUrlString;
3198 } else if (Patterns.WEB_URL.matcher(unformattedUrlString).matches() || unformattedUrlString.startsWith("http://") || unformattedUrlString.startsWith("https://") ||
3199 unformattedUrlString.startsWith("file://")) { // This is a standard URL.
3200 // Add `https://` at the beginning if there is no protocol. Otherwise the app will segfault.
3201 if (!unformattedUrlString.startsWith("http") && !unformattedUrlString.startsWith("file://") && !unformattedUrlString.startsWith("content://")) {
3202 unformattedUrlString = "https://" + unformattedUrlString;
3205 // Initialize `unformattedUrl`.
3206 URL unformattedUrl = null;
3208 // 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.
3210 unformattedUrl = new URL(unformattedUrlString);
3211 } catch (MalformedURLException e) {
3212 e.printStackTrace();
3215 // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if `.get` was called on a `null` value.
3216 String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
3217 String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
3218 String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
3219 String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
3220 String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
3223 Uri.Builder uri = new Uri.Builder();
3224 uri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
3226 // Decode the URI as a UTF-8 string in.
3228 url = URLDecoder.decode(uri.build().toString(), "UTF-8");
3229 } catch (UnsupportedEncodingException exception) {
3230 // Do nothing. The formatted URL string will remain blank.
3232 } else if (!unformattedUrlString.isEmpty()){ // This is not a URL, but rather a search string.
3233 // Create an encoded URL String.
3234 String encodedUrlString;
3236 // Sanitize the search input.
3238 encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
3239 } catch (UnsupportedEncodingException exception) {
3240 encodedUrlString = "";
3243 // Add the base search URL.
3244 url = searchURL + encodedUrlString;
3247 // 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.
3248 urlEditText.clearFocus();
3254 private void loadUrl(String url) {
3255 // Apply the domain settings.
3256 applyDomainSettings(currentWebView, url, true, false);
3259 currentWebView.loadUrl(url, customHeaders);
3262 public void findPreviousOnPage(View view) {
3263 // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards.
3264 currentWebView.findNext(false);
3267 public void findNextOnPage(View view) {
3268 // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
3269 currentWebView.findNext(true);
3272 public void closeFindOnPage(View view) {
3273 // Get a handle for the views.
3274 Toolbar toolbar = findViewById(R.id.toolbar);
3275 LinearLayout findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
3276 EditText findOnPageEditText = findViewById(R.id.find_on_page_edittext);
3278 // Delete the contents of `find_on_page_edittext`.
3279 findOnPageEditText.setText(null);
3281 // Clear the highlighted phrases if the WebView is not null.
3282 if (currentWebView != null) {
3283 currentWebView.clearMatches();
3286 // Hide the find on page linear layout.
3287 findOnPageLinearLayout.setVisibility(View.GONE);
3289 // Show the toolbar.
3290 toolbar.setVisibility(View.VISIBLE);
3292 // Get a handle for the input method manager.
3293 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
3295 // Remove the lint warning below that the input method manager might be null.
3296 assert inputMethodManager != null;
3298 // Hide the keyboard.
3299 inputMethodManager.hideSoftInputFromWindow(currentWebView.getWindowToken(), 0);
3302 private void applyAppSettings() {
3303 // Get a handle for the shared preferences.
3304 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3306 // Store the values from the shared preferences in variables.
3307 incognitoModeEnabled = sharedPreferences.getBoolean("incognito_mode", false);
3308 boolean doNotTrackEnabled = sharedPreferences.getBoolean("do_not_track", false);
3309 proxyThroughOrbot = sharedPreferences.getBoolean("proxy_through_orbot", false);
3310 fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean("full_screen_browsing_mode", false);
3311 hideAppBar = sharedPreferences.getBoolean("hide_app_bar", true);
3312 scrollAppBar = sharedPreferences.getBoolean("scroll_app_bar", true);
3314 // Get handles for the views that need to be modified.
3315 FrameLayout rootFrameLayout = findViewById(R.id.root_framelayout);
3316 AppBarLayout appBarLayout = findViewById(R.id.appbar_layout);
3317 ActionBar actionBar = getSupportActionBar();
3318 Toolbar toolbar = findViewById(R.id.toolbar);
3319 LinearLayout findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
3320 LinearLayout tabsLinearLayout = findViewById(R.id.tabs_linearlayout);
3321 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
3323 // Remove the incorrect lint warning below that the action bar might be null.
3324 assert actionBar != null;
3326 // Apply the proxy through Orbot settings.
3327 applyProxyThroughOrbot(false);
3329 // Set Do Not Track status.
3330 if (doNotTrackEnabled) {
3331 customHeaders.put("DNT", "1");
3333 customHeaders.remove("DNT");
3336 // Get the current layout parameters. Using coordinator layout parameters allows the `setBehavior()` command and using app bar layout parameters allows the `setScrollFlags()` command.
3337 CoordinatorLayout.LayoutParams swipeRefreshLayoutParams = (CoordinatorLayout.LayoutParams) swipeRefreshLayout.getLayoutParams();
3338 AppBarLayout.LayoutParams toolbarLayoutParams = (AppBarLayout.LayoutParams) toolbar.getLayoutParams();
3339 AppBarLayout.LayoutParams findOnPageLayoutParams = (AppBarLayout.LayoutParams) findOnPageLinearLayout.getLayoutParams();
3340 AppBarLayout.LayoutParams tabsLayoutParams = (AppBarLayout.LayoutParams) tabsLinearLayout.getLayoutParams();
3342 // Add the scrolling behavior to the layout parameters.
3344 // Enable scrolling of the app bar.
3345 swipeRefreshLayoutParams.setBehavior(new AppBarLayout.ScrollingViewBehavior());
3346 toolbarLayoutParams.setScrollFlags(AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP);
3347 findOnPageLayoutParams.setScrollFlags(AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP);
3348 tabsLayoutParams.setScrollFlags(AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL | AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS | AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP);
3350 // Disable scrolling of the app bar.
3351 swipeRefreshLayoutParams.setBehavior(null);
3352 toolbarLayoutParams.setScrollFlags(0);
3353 findOnPageLayoutParams.setScrollFlags(0);
3354 tabsLayoutParams.setScrollFlags(0);
3356 // Expand the app bar if it is currently collapsed.
3357 appBarLayout.setExpanded(true);
3360 // Apply the modified layout parameters.
3361 swipeRefreshLayout.setLayoutParams(swipeRefreshLayoutParams);
3362 toolbar.setLayoutParams(toolbarLayoutParams);
3363 findOnPageLinearLayout.setLayoutParams(findOnPageLayoutParams);
3364 tabsLinearLayout.setLayoutParams(tabsLayoutParams);
3366 // Set the app bar scrolling for each WebView.
3367 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
3368 // Get the WebView tab fragment.
3369 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
3371 // Get the fragment view.
3372 View fragmentView = webViewTabFragment.getView();
3374 // Only modify the WebViews if they exist.
3375 if (fragmentView != null) {
3376 // Get the nested scroll WebView from the tab fragment.
3377 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
3379 // Set the app bar scrolling.
3380 nestedScrollWebView.setNestedScrollingEnabled(scrollAppBar);
3384 // Update the full screen browsing mode settings.
3385 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
3386 // Update the visibility of the app bar, which might have changed in the settings.
3388 // Hide the tab linear layout.
3389 tabsLinearLayout.setVisibility(View.GONE);
3391 // Hide the action bar.
3394 // Show the tab linear layout.
3395 tabsLinearLayout.setVisibility(View.VISIBLE);
3397 // Show the action bar.
3401 // Hide the banner ad in the free flavor.
3402 if (BuildConfig.FLAVOR.contentEquals("free")) {
3403 AdHelper.hideAd(findViewById(R.id.adview));
3406 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
3407 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3409 /* Hide the system bars.
3410 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
3411 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
3412 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
3413 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
3415 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
3416 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
3417 } else { // Privacy Browser is not in full screen browsing mode.
3418 // 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.
3419 inFullScreenBrowsingMode = false;
3421 // Show the tab linear layout.
3422 tabsLinearLayout.setVisibility(View.VISIBLE);
3424 // Show the action bar.
3427 // Show the banner ad in the free flavor.
3428 if (BuildConfig.FLAVOR.contentEquals("free")) {
3429 // Initialize the ads. If this isn't the first run, `loadAd()` will be automatically called instead.
3430 AdHelper.initializeAds(findViewById(R.id.adview), getApplicationContext(), getSupportFragmentManager(), getString(R.string.google_app_id), getString(R.string.ad_unit_id));
3433 // Remove the `SYSTEM_UI` flags from the root frame layout.
3434 rootFrameLayout.setSystemUiVisibility(0);
3436 // Add the translucent status flag.
3437 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3442 // `reloadWebsite` is used if returning from the Domains activity. Otherwise JavaScript might not function correctly if it is newly enabled.
3443 @SuppressLint("SetJavaScriptEnabled")
3444 private boolean applyDomainSettings(NestedScrollWebView nestedScrollWebView, String url, boolean resetTab, boolean reloadWebsite) {
3445 // Store a copy of the current user agent to track changes for the return boolean.
3446 String initialUserAgent = nestedScrollWebView.getSettings().getUserAgentString();
3448 // Parse the URL into a URI.
3449 Uri uri = Uri.parse(url);
3451 // Extract the domain from `uri`.
3452 String newHostName = uri.getHost();
3454 // Strings don't like to be null.
3455 if (newHostName == null) {
3459 // 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.
3460 if (!nestedScrollWebView.getCurrentDomainName().equals(newHostName)) {
3461 // Set the new host name as the current domain name.
3462 nestedScrollWebView.setCurrentDomainName(newHostName);
3464 // Reset the ignoring of pinned domain information.
3465 nestedScrollWebView.setIgnorePinnedDomainInformation(false);
3467 // Clear any pinned SSL certificate or IP addresses.
3468 nestedScrollWebView.clearPinnedSslCertificate();
3469 nestedScrollWebView.clearPinnedIpAddresses();
3471 // Reset the favorite icon if specified.
3473 // Initialize the favorite icon.
3474 nestedScrollWebView.initializeFavoriteIcon();
3476 // Get the current page position.
3477 int currentPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
3479 // Get a handle for the tab layout.
3480 TabLayout tabLayout = findViewById(R.id.tablayout);
3482 // Get the corresponding tab.
3483 TabLayout.Tab tab = tabLayout.getTabAt(currentPagePosition);
3485 // Update the tab if it isn't null, which sometimes happens when restarting from the background.
3487 // Get the tab custom view.
3488 View tabCustomView = tab.getCustomView();
3490 // Remove the warning below that the tab custom view might be null.
3491 assert tabCustomView != null;
3493 // Get the tab views.
3494 ImageView tabFavoriteIconImageView = tabCustomView.findViewById(R.id.favorite_icon_imageview);
3495 TextView tabTitleTextView = tabCustomView.findViewById(R.id.title_textview);
3497 // Set the default favorite icon as the favorite icon for this tab.
3498 tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(nestedScrollWebView.getFavoriteOrDefaultIcon(), 64, 64, true));
3500 // Set the loading title text.
3501 tabTitleTextView.setText(R.string.loading);
3505 // Initialize the database handler. The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
3506 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
3508 // Get a full cursor from `domainsDatabaseHelper`.
3509 Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain();
3511 // Initialize `domainSettingsSet`.
3512 Set<String> domainSettingsSet = new HashSet<>();
3514 // Get the domain name column index.
3515 int domainNameColumnIndex = domainNameCursor.getColumnIndex(DomainsDatabaseHelper.DOMAIN_NAME);
3517 // Populate `domainSettingsSet`.
3518 for (int i = 0; i < domainNameCursor.getCount(); i++) {
3519 // Move `domainsCursor` to the current row.
3520 domainNameCursor.moveToPosition(i);
3522 // Store the domain name in `domainSettingsSet`.
3523 domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex));
3526 // Close `domainNameCursor.
3527 domainNameCursor.close();
3529 // Initialize the domain name in database variable.
3530 String domainNameInDatabase = null;
3532 // Check the hostname against the domain settings set.
3533 if (domainSettingsSet.contains(newHostName)) { // The hostname is contained in the domain settings set.
3534 // Record the domain name in the database.
3535 domainNameInDatabase = newHostName;
3537 // Set the domain settings applied tracker to true.
3538 nestedScrollWebView.setDomainSettingsApplied(true);
3539 } else { // The hostname is not contained in the domain settings set.
3540 // Set the domain settings applied tracker to false.
3541 nestedScrollWebView.setDomainSettingsApplied(false);
3544 // Check all the subdomains of the host name against wildcard domains in the domain cursor.
3545 while (!nestedScrollWebView.getDomainSettingsApplied() && newHostName.contains(".")) { // Stop checking if domain settings are already applied or there are no more `.` in the host name.
3546 if (domainSettingsSet.contains("*." + newHostName)) { // Check the host name prepended by `*.`.
3547 // Set the domain settings applied tracker to true.
3548 nestedScrollWebView.setDomainSettingsApplied(true);
3550 // Store the applied domain names as it appears in the database.
3551 domainNameInDatabase = "*." + newHostName;
3554 // Strip out the lowest subdomain of of the host name.
3555 newHostName = newHostName.substring(newHostName.indexOf(".") + 1);
3559 // Get a handle for the shared preferences.
3560 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3562 // Store the general preference information.
3563 String defaultFontSizeString = sharedPreferences.getString("font_size", getString(R.string.font_size_default_value));
3564 String defaultUserAgentName = sharedPreferences.getString("user_agent", getString(R.string.user_agent_default_value));
3565 boolean defaultSwipeToRefresh = sharedPreferences.getBoolean("swipe_to_refresh", true);
3566 boolean displayWebpageImages = sharedPreferences.getBoolean("display_webpage_images", true);
3567 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
3569 // Get a handle for the cookie manager.
3570 CookieManager cookieManager = CookieManager.getInstance();
3572 // Get handles for the views.
3573 RelativeLayout urlRelativeLayout = findViewById(R.id.url_relativelayout);
3574 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
3576 // Initialize the user agent array adapter and string array.
3577 ArrayAdapter<CharSequence> userAgentNamesArray = ArrayAdapter.createFromResource(this, R.array.user_agent_names, R.layout.spinner_item);
3578 String[] userAgentDataArray = getResources().getStringArray(R.array.user_agent_data);
3580 if (nestedScrollWebView.getDomainSettingsApplied()) { // The url has custom domain settings.
3581 // Get a cursor for the current host and move it to the first position.
3582 Cursor currentDomainSettingsCursor = domainsDatabaseHelper.getCursorForDomainName(domainNameInDatabase);
3583 currentDomainSettingsCursor.moveToFirst();
3585 // Get the settings from the cursor.
3586 nestedScrollWebView.setDomainSettingsDatabaseId(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper._ID)));
3587 nestedScrollWebView.setDomainSettingsJavaScriptEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1);
3588 nestedScrollWebView.setAcceptFirstPartyCookies(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FIRST_PARTY_COOKIES)) == 1);
3589 boolean domainThirdPartyCookiesEnabled = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_THIRD_PARTY_COOKIES)) == 1);
3590 nestedScrollWebView.getSettings().setDomStorageEnabled(currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1);
3591 // Form data can be removed once the minimum API >= 26.
3592 boolean saveFormData = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1);
3593 nestedScrollWebView.enableBlocklist(NestedScrollWebView.EASY_LIST,
3594 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYLIST)) == 1);
3595 nestedScrollWebView.enableBlocklist(NestedScrollWebView.EASY_PRIVACY,
3596 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYPRIVACY)) == 1);
3597 nestedScrollWebView.enableBlocklist(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST,
3598 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_ANNOYANCE_LIST)) == 1);
3599 nestedScrollWebView.enableBlocklist(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST,
3600 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST)) == 1);
3601 nestedScrollWebView.enableBlocklist(NestedScrollWebView.ULTRA_PRIVACY,
3602 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_ULTRAPRIVACY)) == 1);
3603 nestedScrollWebView.enableBlocklist(NestedScrollWebView.THIRD_PARTY_REQUESTS,
3604 currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.BLOCK_ALL_THIRD_PARTY_REQUESTS)) == 1);
3605 String userAgentName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.USER_AGENT));
3606 int fontSize = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.FONT_SIZE));
3607 int swipeToRefreshInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SWIPE_TO_REFRESH));
3608 int nightModeInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.NIGHT_MODE));
3609 int displayWebpageImagesInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.DISPLAY_IMAGES));
3610 boolean pinnedSslCertificate = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.PINNED_SSL_CERTIFICATE)) == 1);
3611 String pinnedSslIssuedToCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_COMMON_NAME));
3612 String pinnedSslIssuedToOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATION));
3613 String pinnedSslIssuedToUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT));
3614 String pinnedSslIssuedByCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_COMMON_NAME));
3615 String pinnedSslIssuedByOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATION));
3616 String pinnedSslIssuedByUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT));
3617 boolean pinnedIpAddresses = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.PINNED_IP_ADDRESSES)) == 1);
3618 String pinnedHostIpAddresses = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.IP_ADDRESSES));
3620 // Create the pinned SSL date variables.
3621 Date pinnedSslStartDate;
3622 Date pinnedSslEndDate;
3624 // 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.
3625 if (currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)) == 0) {
3626 pinnedSslStartDate = null;
3628 pinnedSslStartDate = new Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)));
3631 // 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.
3632 if (currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)) == 0) {
3633 pinnedSslEndDate = null;
3635 pinnedSslEndDate = new Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)));
3638 // If there is a pinned SSL certificate, store it in the WebView.
3639 if (pinnedSslCertificate) {
3640 nestedScrollWebView.setPinnedSslCertificate(pinnedSslIssuedToCName, pinnedSslIssuedToOName, pinnedSslIssuedToUName, pinnedSslIssuedByCName, pinnedSslIssuedByOName, pinnedSslIssuedByUName,
3641 pinnedSslStartDate, pinnedSslEndDate);
3644 // If there is a pinned IP address, store it in the WebView.
3645 if (pinnedIpAddresses) {
3646 nestedScrollWebView.setPinnedIpAddresses(pinnedHostIpAddresses);
3649 // Set night mode according to the night mode int.
3650 switch (nightModeInt) {
3651 case DomainsDatabaseHelper.NIGHT_MODE_SYSTEM_DEFAULT:
3652 // Set night mode according to the current default.
3653 nestedScrollWebView.setNightMode(sharedPreferences.getBoolean("night_mode", false));
3656 case DomainsDatabaseHelper.NIGHT_MODE_ENABLED:
3657 // Enable night mode.
3658 nestedScrollWebView.setNightMode(true);
3661 case DomainsDatabaseHelper.NIGHT_MODE_DISABLED:
3662 // Disable night mode.
3663 nestedScrollWebView.setNightMode(false);
3667 // Enable JavaScript if night mode is enabled.
3668 if (nestedScrollWebView.getNightMode()) {
3669 // Enable JavaScript.
3670 nestedScrollWebView.getSettings().setJavaScriptEnabled(true);
3672 // Set JavaScript according to the domain settings.
3673 nestedScrollWebView.getSettings().setJavaScriptEnabled(nestedScrollWebView.getDomainSettingsJavaScriptEnabled());
3676 // Close the current host domain settings cursor.
3677 currentDomainSettingsCursor.close();
3679 // Apply the domain settings.
3680 cookieManager.setAcceptCookie(nestedScrollWebView.getAcceptFirstPartyCookies());
3682 // Set third-party cookies status if API >= 21.
3683 if (Build.VERSION.SDK_INT >= 21) {
3684 cookieManager.setAcceptThirdPartyCookies(nestedScrollWebView, domainThirdPartyCookiesEnabled);
3687 // Apply the form data setting if the API < 26.
3688 if (Build.VERSION.SDK_INT < 26) {
3689 nestedScrollWebView.getSettings().setSaveFormData(saveFormData);
3692 // Apply the font size.
3693 if (fontSize == 0) { // Apply the default font size.
3694 nestedScrollWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3695 } else { // Apply the specified font size.
3696 nestedScrollWebView.getSettings().setTextZoom(fontSize);
3699 // 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.
3700 // <https://redmine.stoutner.com/issues/160>
3701 if (nestedScrollWebView.getProgress() == 100) { // A URL is not loading.
3702 // Set the user agent.
3703 if (userAgentName.equals(getString(R.string.system_default_user_agent))) { // Use the system default user agent.
3704 // Get the array position of the default user agent name.
3705 int defaultUserAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3707 // Set the user agent according to the system default.
3708 switch (defaultUserAgentArrayPosition) {
3709 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
3710 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3711 nestedScrollWebView.getSettings().setUserAgentString(defaultUserAgentName);
3714 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3715 // Set the user agent to `""`, which uses the default value.
3716 nestedScrollWebView.getSettings().setUserAgentString("");
3719 case SETTINGS_CUSTOM_USER_AGENT:
3720 // Set the default custom user agent.
3721 nestedScrollWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", getString(R.string.custom_user_agent_default_value)));
3725 // Get the user agent string from the user agent data array
3726 nestedScrollWebView.getSettings().setUserAgentString(userAgentDataArray[defaultUserAgentArrayPosition]);
3728 } else { // Set the user agent according to the stored name.
3729 // Get the array position of the user agent name.
3730 int userAgentArrayPosition = userAgentNamesArray.getPosition(userAgentName);
3732 switch (userAgentArrayPosition) {
3733 case UNRECOGNIZED_USER_AGENT: // The user agent name contains a custom user agent.
3734 nestedScrollWebView.getSettings().setUserAgentString(userAgentName);
3737 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3738 // Set the user agent to `""`, which uses the default value.
3739 nestedScrollWebView.getSettings().setUserAgentString("");
3743 // Get the user agent string from the user agent data array.
3744 nestedScrollWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3749 // Set swipe to refresh.
3750 switch (swipeToRefreshInt) {
3751 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_SYSTEM_DEFAULT:
3752 // Store the swipe to refresh status in the nested scroll WebView.
3753 nestedScrollWebView.setSwipeToRefresh(defaultSwipeToRefresh);
3755 // 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.
3756 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3759 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_ENABLED:
3760 // Store the swipe to refresh status in the nested scroll WebView.
3761 nestedScrollWebView.setSwipeToRefresh(true);
3763 // Enable swipe to refresh. This can be removed once the minimum API >= 23 because it is continuously set by an on scroll change listener.
3764 swipeRefreshLayout.setEnabled(true);
3767 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_DISABLED:
3768 // Store the swipe to refresh status in the nested scroll WebView.
3769 nestedScrollWebView.setSwipeToRefresh(false);
3771 // Disable swipe to refresh. This can be removed once the minimum API >= 23 because it is continuously set by an on scroll change listener.
3772 swipeRefreshLayout.setEnabled(false);
3775 // Set the loading of webpage images.
3776 switch (displayWebpageImagesInt) {
3777 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_SYSTEM_DEFAULT:
3778 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImages);
3781 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_ENABLED:
3782 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(true);
3785 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_DISABLED:
3786 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(false);
3790 // 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.
3792 urlRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_dark_blue));
3794 urlRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_light_green));
3796 } else { // The new URL does not have custom domain settings. Load the defaults.
3797 // Store the values from the shared preferences.
3798 boolean defaultJavaScriptEnabled = sharedPreferences.getBoolean("javascript", false);
3799 nestedScrollWebView.setAcceptFirstPartyCookies(sharedPreferences.getBoolean("first_party_cookies", false));
3800 boolean defaultThirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies", false);
3801 nestedScrollWebView.getSettings().setDomStorageEnabled(sharedPreferences.getBoolean("dom_storage", false));
3802 boolean saveFormData = sharedPreferences.getBoolean("save_form_data", false); // Form data can be removed once the minimum API >= 26.
3803 nestedScrollWebView.enableBlocklist(NestedScrollWebView.EASY_LIST, sharedPreferences.getBoolean("easylist", true));
3804 nestedScrollWebView.enableBlocklist(NestedScrollWebView.EASY_PRIVACY, sharedPreferences.getBoolean("easyprivacy", true));
3805 nestedScrollWebView.enableBlocklist(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST, sharedPreferences.getBoolean("fanboys_annoyance_list", true));
3806 nestedScrollWebView.enableBlocklist(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST, sharedPreferences.getBoolean("fanboys_social_blocking_list", true));
3807 nestedScrollWebView.enableBlocklist(NestedScrollWebView.ULTRA_PRIVACY, sharedPreferences.getBoolean("ultraprivacy", true));
3808 nestedScrollWebView.enableBlocklist(NestedScrollWebView.THIRD_PARTY_REQUESTS, sharedPreferences.getBoolean("block_all_third_party_requests", false));
3809 nestedScrollWebView.setNightMode(sharedPreferences.getBoolean("night_mode", false));
3811 // Enable JavaScript if night mode is enabled.
3812 if (nestedScrollWebView.getNightMode()) {
3813 // Enable JavaScript.
3814 nestedScrollWebView.getSettings().setJavaScriptEnabled(true);
3816 // Set JavaScript according to the domain settings.
3817 nestedScrollWebView.getSettings().setJavaScriptEnabled(defaultJavaScriptEnabled);
3820 // Apply the default settings.
3821 cookieManager.setAcceptCookie(nestedScrollWebView.getAcceptFirstPartyCookies());
3822 nestedScrollWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3824 // Apply the form data setting if the API < 26.
3825 if (Build.VERSION.SDK_INT < 26) {
3826 nestedScrollWebView.getSettings().setSaveFormData(saveFormData);
3829 // Store the swipe to refresh status in the nested scroll WebView.
3830 nestedScrollWebView.setSwipeToRefresh(defaultSwipeToRefresh);
3832 // Apply swipe to refresh according to the default.
3833 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3835 // Reset the pinned variables.
3836 nestedScrollWebView.setDomainSettingsDatabaseId(-1);
3838 // Set third-party cookies status if API >= 21.
3839 if (Build.VERSION.SDK_INT >= 21) {
3840 cookieManager.setAcceptThirdPartyCookies(nestedScrollWebView, defaultThirdPartyCookiesEnabled);
3843 // 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.
3844 // <https://redmine.stoutner.com/issues/160>
3845 if (nestedScrollWebView.getProgress() == 100) { // A URL is not loading.
3846 // Get the array position of the user agent name.
3847 int userAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3849 // Set the user agent.
3850 switch (userAgentArrayPosition) {
3851 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
3852 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3853 nestedScrollWebView.getSettings().setUserAgentString(defaultUserAgentName);
3856 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3857 // Set the user agent to `""`, which uses the default value.
3858 nestedScrollWebView.getSettings().setUserAgentString("");
3861 case SETTINGS_CUSTOM_USER_AGENT:
3862 // Set the default custom user agent.
3863 nestedScrollWebView.getSettings().setUserAgentString(sharedPreferences.getString("custom_user_agent", getString(R.string.custom_user_agent_default_value)));
3867 // Get the user agent string from the user agent data array
3868 nestedScrollWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3872 // Set the loading of webpage images.
3873 nestedScrollWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImages);
3875 // Set a transparent background on URL edit text. The deprecated `getResources().getDrawable()` must be used until the minimum API >= 21.
3876 urlRelativeLayout.setBackground(getResources().getDrawable(R.color.transparent));
3879 // Close the domains database helper.
3880 domainsDatabaseHelper.close();
3882 // Update the privacy icons.
3883 updatePrivacyIcons(true);
3886 // Reload the website if returning from the Domains activity.
3887 if (reloadWebsite) {
3888 nestedScrollWebView.reload();
3891 // Return the user agent changed status.
3892 return !nestedScrollWebView.getSettings().getUserAgentString().equals(initialUserAgent);
3895 private void applyProxyThroughOrbot(boolean reloadWebsite) {
3896 // Get a handle for the shared preferences.
3897 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3899 // Get the search and theme preferences.
3900 String torSearchString = sharedPreferences.getString("tor_search", getString(R.string.tor_search_default_value));
3901 String torSearchCustomUrlString = sharedPreferences.getString("tor_search_custom_url", getString(R.string.tor_search_custom_url_default_value));
3902 String searchString = sharedPreferences.getString("search", getString(R.string.search_default_value));
3903 String searchCustomUrlString = sharedPreferences.getString("search_custom_url", getString(R.string.search_custom_url_default_value));
3904 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
3906 // Get a handle for the app bar layout.
3907 AppBarLayout appBarLayout = findViewById(R.id.appbar_layout);
3909 // Set the homepage, search, and proxy options.
3910 if (proxyThroughOrbot) { // Set the Tor options.
3911 // Set the search URL.
3912 if (torSearchString.equals("Custom URL")) { // Get the custom URL string.
3913 searchURL = torSearchCustomUrlString;
3914 } else { // Use the string from the pre-built list.
3915 searchURL = torSearchString;
3918 // Set the proxy. `this` refers to the current activity where an `AlertDialog` might be displayed.
3919 OrbotProxyHelper.setProxy(getApplicationContext(), this, "localhost", "8118");
3921 // Set the app bar background to indicate proxying through Orbot is enabled.
3923 appBarLayout.setBackgroundResource(R.color.dark_blue_30);
3925 appBarLayout.setBackgroundResource(R.color.blue_50);
3928 // Check to see if Orbot is ready.
3929 if (!orbotStatus.equals("ON")) { // Orbot is not ready.
3930 // Set `waitingForOrbot`.
3931 waitingForOrbot = true;
3933 // Disable the wide view port so that the waiting for Orbot text is displayed correctly.
3934 currentWebView.getSettings().setUseWideViewPort(false);
3936 // Load a waiting page. `null` specifies no encoding, which defaults to ASCII.
3937 currentWebView.loadData("<html><body><br/><center><h1>" + getString(R.string.waiting_for_orbot) + "</h1></center></body></html>", "text/html", null);
3938 } else if (reloadWebsite) { // Orbot is ready and the website should be reloaded.
3939 // Reload the website.
3940 currentWebView.reload();
3942 } else { // Set the non-Tor options.
3943 // Set the search URL.
3944 if (searchString.equals("Custom URL")) { // Get the custom URL string.
3945 searchURL = searchCustomUrlString;
3946 } else { // Use the string from the pre-built list.
3947 searchURL = searchString;
3950 // Reset the proxy to default. The host is `""` and the port is `"0"`.
3951 OrbotProxyHelper.setProxy(getApplicationContext(), this, "", "0");
3953 // Set the default app bar layout background.
3955 appBarLayout.setBackgroundResource(R.color.gray_900);
3957 appBarLayout.setBackgroundResource(R.color.gray_100);
3960 // Reset `waitingForOrbot.
3961 waitingForOrbot = false;
3963 // Reload the WebViews if requested.
3964 if (reloadWebsite) {
3965 // Reload the WebViews.
3966 for (int i = 0; i < webViewPagerAdapter.getCount(); i++) {
3967 // Get the WebView tab fragment.
3968 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(i);
3970 // Get the fragment view.
3971 View fragmentView = webViewTabFragment.getView();
3973 // Only reload the WebViews if they exist.
3974 if (fragmentView != null) {
3975 // Get the nested scroll WebView from the tab fragment.
3976 NestedScrollWebView nestedScrollWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
3978 // Reload the WebView.
3979 nestedScrollWebView.reload();
3986 private void updatePrivacyIcons(boolean runInvalidateOptionsMenu) {
3987 // Only update the privacy icons if the options menu and the current WebView have already been populated.
3988 if ((optionsMenu != null) && (currentWebView != null)) {
3989 // Get a handle for the shared preferences.
3990 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3992 // Get the theme and screenshot preferences.
3993 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
3995 // Get handles for the menu items.
3996 MenuItem privacyMenuItem = optionsMenu.findItem(R.id.toggle_javascript);
3997 MenuItem firstPartyCookiesMenuItem = optionsMenu.findItem(R.id.toggle_first_party_cookies);
3998 MenuItem domStorageMenuItem = optionsMenu.findItem(R.id.toggle_dom_storage);
3999 MenuItem refreshMenuItem = optionsMenu.findItem(R.id.refresh);
4001 // Update the privacy icon.
4002 if (currentWebView.getSettings().getJavaScriptEnabled()) { // JavaScript is enabled.
4003 privacyMenuItem.setIcon(R.drawable.javascript_enabled);
4004 } else if (currentWebView.getAcceptFirstPartyCookies()) { // JavaScript is disabled but cookies are enabled.
4005 privacyMenuItem.setIcon(R.drawable.warning);
4006 } else { // All the dangerous features are disabled.
4007 privacyMenuItem.setIcon(R.drawable.privacy_mode);
4010 // Update the first-party cookies icon.
4011 if (currentWebView.getAcceptFirstPartyCookies()) { // First-party cookies are enabled.
4012 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_enabled);
4013 } else { // First-party cookies are disabled.
4015 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_dark);
4017 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_light);
4021 // Update the DOM storage icon.
4022 if (currentWebView.getSettings().getJavaScriptEnabled() && currentWebView.getSettings().getDomStorageEnabled()) { // Both JavaScript and DOM storage are enabled.
4023 domStorageMenuItem.setIcon(R.drawable.dom_storage_enabled);
4024 } else if (currentWebView.getSettings().getJavaScriptEnabled()) { // JavaScript is enabled but DOM storage is disabled.
4026 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_dark);
4028 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_light);
4030 } else { // JavaScript is disabled, so DOM storage is ghosted.
4032 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_dark);
4034 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_light);
4038 // Update the refresh icon.
4040 refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
4042 refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
4045 // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`.
4046 if (runInvalidateOptionsMenu) {
4047 invalidateOptionsMenu();
4052 private void openUrlWithExternalApp(String url) {
4053 // Create a download intent. Not specifying the action type will display the maximum number of options.
4054 Intent downloadIntent = new Intent();
4056 // Set the URI and the MIME type. Specifying `text/html` displays a good number of options.
4057 downloadIntent.setDataAndType(Uri.parse(url), "text/html");
4059 // Flag the intent to open in a new task.
4060 downloadIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4062 // Show the chooser.
4063 startActivity(Intent.createChooser(downloadIntent, getString(R.string.open_with)));
4066 private void highlightUrlText() {
4067 // Get a handle for the URL edit text.
4068 EditText urlEditText = findViewById(R.id.url_edittext);
4070 // Only highlight the URL text if the box is not currently selected.
4071 if (!urlEditText.hasFocus()) {
4072 // Get the URL string.
4073 String urlString = urlEditText.getText().toString();
4075 // Highlight the URL according to the protocol.
4076 if (urlString.startsWith("file://")) { // This is a file URL.
4077 // De-emphasize only the protocol.
4078 urlEditText.getText().setSpan(initialGrayColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4079 } else if (urlString.startsWith("content://")) {
4080 // De-emphasize only the protocol.
4081 urlEditText.getText().setSpan(initialGrayColorSpan, 0, 10, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4082 } else { // This is a web URL.
4083 // Get the index of the `/` immediately after the domain name.
4084 int endOfDomainName = urlString.indexOf("/", (urlString.indexOf("//") + 2));
4086 // Create a base URL string.
4089 // Get the base URL.
4090 if (endOfDomainName > 0) { // There is at least one character after the base URL.
4091 // Get the base URL.
4092 baseUrl = urlString.substring(0, endOfDomainName);
4093 } else { // There are no characters after the base URL.
4094 // Set the base URL to be the entire URL string.
4095 baseUrl = urlString;
4098 // Get the index of the last `.` in the domain.
4099 int lastDotIndex = baseUrl.lastIndexOf(".");
4101 // Get the index of the penultimate `.` in the domain.
4102 int penultimateDotIndex = baseUrl.lastIndexOf(".", lastDotIndex - 1);
4104 // Markup the beginning of the URL.
4105 if (urlString.startsWith("http://")) { // Highlight the protocol of connections that are not encrypted.
4106 urlEditText.getText().setSpan(redColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4108 // De-emphasize subdomains.
4109 if (penultimateDotIndex > 0) { // There is more than one subdomain in the domain name.
4110 urlEditText.getText().setSpan(initialGrayColorSpan, 7, penultimateDotIndex + 1, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4112 } else if (urlString.startsWith("https://")) { // De-emphasize the protocol of connections that are encrypted.
4113 if (penultimateDotIndex > 0) { // There is more than one subdomain in the domain name.
4114 // De-emphasize the protocol and the additional subdomains.
4115 urlEditText.getText().setSpan(initialGrayColorSpan, 0, penultimateDotIndex + 1, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4116 } else { // There is only one subdomain in the domain name.
4117 // De-emphasize only the protocol.
4118 urlEditText.getText().setSpan(initialGrayColorSpan, 0, 8, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4122 // De-emphasize the text after the domain name.
4123 if (endOfDomainName > 0) {
4124 urlEditText.getText().setSpan(finalGrayColorSpan, endOfDomainName, urlString.length(), Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4130 private void loadBookmarksFolder() {
4131 // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
4132 bookmarksCursor = bookmarksDatabaseHelper.getBookmarksByDisplayOrder(currentBookmarksFolder);
4134 // Populate the bookmarks cursor adapter. `this` specifies the `Context`. `false` disables `autoRequery`.
4135 bookmarksCursorAdapter = new CursorAdapter(this, bookmarksCursor, false) {
4137 public View newView(Context context, Cursor cursor, ViewGroup parent) {
4138 // Inflate the individual item layout. `false` does not attach it to the root.
4139 return getLayoutInflater().inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false);
4143 public void bindView(View view, Context context, Cursor cursor) {
4144 // Get handles for the views.
4145 ImageView bookmarkFavoriteIcon = view.findViewById(R.id.bookmark_favorite_icon);
4146 TextView bookmarkNameTextView = view.findViewById(R.id.bookmark_name);
4148 // Get the favorite icon byte array from the cursor.
4149 byte[] favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
4151 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
4152 Bitmap favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.length);
4154 // Display the bitmap in `bookmarkFavoriteIcon`.
4155 bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap);
4157 // Get the bookmark name from the cursor and display it in `bookmarkNameTextView`.
4158 String bookmarkNameString = cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
4159 bookmarkNameTextView.setText(bookmarkNameString);
4161 // Make the font bold for folders.
4162 if (cursor.getInt(cursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {
4163 bookmarkNameTextView.setTypeface(Typeface.DEFAULT_BOLD);
4164 } else { // Reset the font to default for normal bookmarks.
4165 bookmarkNameTextView.setTypeface(Typeface.DEFAULT);
4170 // Get a handle for the bookmarks list view.
4171 ListView bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
4173 // Populate the list view with the adapter.
4174 bookmarksListView.setAdapter(bookmarksCursorAdapter);
4176 // Get a handle for the bookmarks title text view.
4177 TextView bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview);
4179 // Set the bookmarks drawer title.
4180 if (currentBookmarksFolder.isEmpty()) {
4181 bookmarksTitleTextView.setText(R.string.bookmarks);
4183 bookmarksTitleTextView.setText(currentBookmarksFolder);
4187 private void openWithApp(String url) {
4188 // Create the open with intent with `ACTION_VIEW`.
4189 Intent openWithAppIntent = new Intent(Intent.ACTION_VIEW);
4191 // Set the URI but not the MIME type. This should open all available apps.
4192 openWithAppIntent.setData(Uri.parse(url));
4194 // Flag the intent to open in a new task.
4195 openWithAppIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4197 // Show the chooser.
4198 startActivity(openWithAppIntent);
4201 private void openWithBrowser(String url) {
4202 // Create the open with intent with `ACTION_VIEW`.
4203 Intent openWithBrowserIntent = new Intent(Intent.ACTION_VIEW);
4205 // Set the URI and the MIME type. `"text/html"` should load browser options.
4206 openWithBrowserIntent.setDataAndType(Uri.parse(url), "text/html");
4208 // Flag the intent to open in a new task.
4209 openWithBrowserIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4211 // Show the chooser.
4212 startActivity(openWithBrowserIntent);
4215 public void addTab(View view) {
4216 // Get a handle for the tab layout and the view pager.
4217 TabLayout tabLayout = findViewById(R.id.tablayout);
4218 ViewPager webViewPager = findViewById(R.id.webviewpager);
4220 // Get the new page number. The page numbers are 0 indexed, so the new page number will match the current count.
4221 int newTabNumber = tabLayout.getTabCount();
4224 tabLayout.addTab(tabLayout.newTab());
4227 TabLayout.Tab newTab = tabLayout.getTabAt(newTabNumber);
4229 // Remove the lint warning below that the current tab might be null.
4230 assert newTab != null;
4232 // Set a custom view on the new tab.
4233 newTab.setCustomView(R.layout.tab_custom_view);
4235 // Add the new WebView page.
4236 webViewPagerAdapter.addPage(newTabNumber, webViewPager);
4239 private void setCurrentWebView(int pageNumber) {
4240 // Get a handle for the shared preferences.
4241 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
4243 // Get the theme preference.
4244 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
4246 // Get handles for the URL views.
4247 RelativeLayout urlRelativeLayout = findViewById(R.id.url_relativelayout);
4248 EditText urlEditText = findViewById(R.id.url_edittext);
4249 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
4251 //Stop the swipe to refresh indicator if it is running
4252 swipeRefreshLayout.setRefreshing(false);
4254 // Get the WebView tab fragment.
4255 WebViewTabFragment webViewTabFragment = webViewPagerAdapter.getPageFragment(pageNumber);
4257 // Get the fragment view.
4258 View fragmentView = webViewTabFragment.getView();
4260 // Set the current WebView if the fragment view is not null.
4261 if (fragmentView != null) {
4262 // Store the current WebView.
4263 currentWebView = fragmentView.findViewById(R.id.nestedscroll_webview);
4265 // Update the status of swipe to refresh.
4266 if (currentWebView.getSwipeToRefresh()) { // Swipe to refresh is enabled.
4267 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.
4268 // Enable the swipe refresh layout if the WebView is scrolled all the way to the top.
4269 swipeRefreshLayout.setEnabled(currentWebView.getY() == 0);
4271 // Enable the swipe refresh layout.
4272 swipeRefreshLayout.setEnabled(true);
4274 } else { // Swipe to refresh is disabled.
4275 // Disable the swipe refresh layout.
4276 swipeRefreshLayout.setEnabled(false);
4279 // Get a handle for the cookie manager.
4280 CookieManager cookieManager = CookieManager.getInstance();
4282 // Set the first-party cookie status.
4283 cookieManager.setAcceptCookie(currentWebView.getAcceptFirstPartyCookies());
4285 // Update the privacy icons. `true` redraws the icons in the app bar.
4286 updatePrivacyIcons(true);
4288 // Get a handle for the input method manager.
4289 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
4291 // Remove the lint warning below that the input method manager might be null.
4292 assert inputMethodManager != null;
4294 // Get the current URL.
4295 String url = currentWebView.getUrl();
4297 // Update the URL edit text if not loading a new intent. Otherwise, this will be handled by `onPageStarted()` (if called) and `onPageFinished()`.
4298 if (!loadingNewIntent) { // A new intent is not being loaded.
4299 if ((url == null) || url.equals("about:blank")) { // The WebView is blank.
4300 // Display the hint in the URL edit text.
4301 urlEditText.setText("");
4303 // Request focus for the URL text box.
4304 urlEditText.requestFocus();
4306 // Display the keyboard.
4307 inputMethodManager.showSoftInput(urlEditText, 0);
4308 } else { // The WebView has a loaded URL.
4309 // Clear the focus from the URL text box.
4310 urlEditText.clearFocus();
4312 // Hide the soft keyboard.
4313 inputMethodManager.hideSoftInputFromWindow(currentWebView.getWindowToken(), 0);
4315 // Display the current URL in the URL text box.
4316 urlEditText.setText(url);
4318 // Highlight the URL text.
4321 } else { // A new intent is being loaded.
4322 // Reset the loading new intent tracker.
4323 loadingNewIntent = false;
4326 // Set the background to indicate the domain settings status.
4327 if (currentWebView.getDomainSettingsApplied()) {
4328 // 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.
4330 urlRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_dark_blue));
4332 urlRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_light_green));
4335 urlRelativeLayout.setBackground(getResources().getDrawable(R.color.transparent));
4341 public void initializeWebView(NestedScrollWebView nestedScrollWebView, int pageNumber, ProgressBar progressBar) {
4342 // Get handles for the activity views.
4343 FrameLayout rootFrameLayout = findViewById(R.id.root_framelayout);
4344 DrawerLayout drawerLayout = findViewById(R.id.drawerlayout);
4345 RelativeLayout mainContentRelativeLayout = findViewById(R.id.main_content_relativelayout);
4346 ActionBar actionBar = getSupportActionBar();
4347 LinearLayout tabsLinearLayout = findViewById(R.id.tabs_linearlayout);
4348 EditText urlEditText = findViewById(R.id.url_edittext);
4349 TabLayout tabLayout = findViewById(R.id.tablayout);
4350 SwipeRefreshLayout swipeRefreshLayout = findViewById(R.id.swiperefreshlayout);
4352 // Remove the incorrect lint warning below that the action bar might be null.
4353 assert actionBar != null;
4355 // Get a handle for the activity
4356 Activity activity = this;
4358 // Get a handle for the input method manager.
4359 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
4361 // Instantiate the blocklist helper.
4362 BlockListHelper blockListHelper = new BlockListHelper();
4364 // Remove the lint warning below that the input method manager might be null.
4365 assert inputMethodManager != null;
4367 // Get a handle for the shared preferences.
4368 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
4370 // Get the relevant preferences.
4371 boolean downloadWithExternalApp = sharedPreferences.getBoolean("download_with_external_app", false);
4373 // Initialize the favorite icon.
4374 nestedScrollWebView.initializeFavoriteIcon();
4376 // Set the app bar scrolling.
4377 nestedScrollWebView.setNestedScrollingEnabled(sharedPreferences.getBoolean("scroll_app_bar", true));
4379 // Allow pinch to zoom.
4380 nestedScrollWebView.getSettings().setBuiltInZoomControls(true);
4382 // Hide zoom controls.
4383 nestedScrollWebView.getSettings().setDisplayZoomControls(false);
4385 // Don't allow mixed content (HTTP and HTTPS) on the same website.
4386 if (Build.VERSION.SDK_INT >= 21) {
4387 nestedScrollWebView.getSettings().setMixedContentMode(WebSettings.MIXED_CONTENT_NEVER_ALLOW);
4390 // Set the WebView to use a wide viewport. Otherwise, some web pages will be scrunched and some content will render outside the screen.
4391 nestedScrollWebView.getSettings().setUseWideViewPort(true);
4393 // Set the WebView to load in overview mode (zoomed out to the maximum width).
4394 nestedScrollWebView.getSettings().setLoadWithOverviewMode(true);
4396 // Explicitly disable geolocation.
4397 nestedScrollWebView.getSettings().setGeolocationEnabled(false);
4399 // Create a double-tap gesture detector to toggle full-screen mode.
4400 GestureDetector doubleTapGestureDetector = new GestureDetector(getApplicationContext(), new GestureDetector.SimpleOnGestureListener() {
4401 // Override `onDoubleTap()`. All other events are handled using the default settings.
4403 public boolean onDoubleTap(MotionEvent event) {
4404 if (fullScreenBrowsingModeEnabled) { // Only process the double-tap if full screen browsing mode is enabled.
4405 // Toggle the full screen browsing mode tracker.
4406 inFullScreenBrowsingMode = !inFullScreenBrowsingMode;
4408 // Toggle the full screen browsing mode.
4409 if (inFullScreenBrowsingMode) { // Switch to full screen mode.
4410 // Store the swipe refresh layout top padding.
4411 swipeRefreshLayoutPaddingTop = swipeRefreshLayout.getPaddingTop();
4413 // Hide the app bar if specified.
4415 // Close the find on page bar if it is visible.
4416 closeFindOnPage(null);
4418 // Hide the tab linear layout.
4419 tabsLinearLayout.setVisibility(View.GONE);
4421 // Hide the action bar.
4424 // Check to see if app bar scrolling is disabled.
4425 if (!scrollAppBar) {
4426 // Remove the padding from the top of the swipe refresh layout.
4427 swipeRefreshLayout.setPadding(0, 0, 0, 0);
4431 // Hide the banner ad in the free flavor.
4432 if (BuildConfig.FLAVOR.contentEquals("free")) {
4433 AdHelper.hideAd(findViewById(R.id.adview));
4436 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
4437 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4439 /* Hide the system bars.
4440 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
4441 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
4442 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
4443 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
4445 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
4446 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
4447 } else { // Switch to normal viewing mode.
4448 // Show the tab linear layout.
4449 tabsLinearLayout.setVisibility(View.VISIBLE);
4451 // Show the action bar.
4454 // Check to see if app bar scrolling is disabled.
4455 if (!scrollAppBar) {
4456 // Add the padding from the top of the swipe refresh layout.
4457 swipeRefreshLayout.setPadding(0, swipeRefreshLayoutPaddingTop, 0, 0);
4460 // Show the banner ad in the free flavor.
4461 if (BuildConfig.FLAVOR.contentEquals("free")) {
4463 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
4466 // Remove the `SYSTEM_UI` flags from the root frame layout.
4467 rootFrameLayout.setSystemUiVisibility(0);
4469 // Add the translucent status flag.
4470 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4473 // Consume the double-tap.
4475 } else { // Do not consume the double-tap because full screen browsing mode is disabled.
4481 // Pass all touch events on the WebView through the double-tap gesture detector.
4482 nestedScrollWebView.setOnTouchListener((View view, MotionEvent event) -> {
4483 // Call `performClick()` on the view, which is required for accessibility.
4484 view.performClick();
4486 // Send the event to the gesture detector.
4487 return doubleTapGestureDetector.onTouchEvent(event);
4490 // Register the WebView for a context menu. This is used to see link targets and download images.
4491 registerForContextMenu(nestedScrollWebView);
4493 // Allow the downloading of files.
4494 nestedScrollWebView.setDownloadListener((String url, String userAgent, String contentDisposition, String mimetype, long contentLength) -> {
4495 // Check if the download should be processed by an external app.
4496 if (downloadWithExternalApp) { // Download with an external app.
4497 // Create a download intent. Not specifying the action type will display the maximum number of options.
4498 Intent downloadIntent = new Intent();
4500 // Set the URI and the MIME type. Specifying `text/html` displays a good number of options.
4501 downloadIntent.setDataAndType(Uri.parse(url), "text/html");
4503 // Flag the intent to open in a new task.
4504 downloadIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4506 // Show the chooser.
4507 startActivity(Intent.createChooser(downloadIntent, getString(R.string.open_with)));
4508 } else { // Download with Android's download manager.
4509 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
4510 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) { // The storage permission has not been granted.
4511 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
4513 // Store the variables for future use by `onRequestPermissionsResult()`.
4515 downloadContentDisposition = contentDisposition;
4516 downloadContentLength = contentLength;
4518 // Show a dialog if the user has previously denied the permission.
4519 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
4520 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
4521 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
4523 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
4524 downloadLocationPermissionDialogFragment.show(getSupportFragmentManager(), getString(R.string.download_location));
4525 } else { // Show the permission request directly.
4526 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
4527 ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
4529 } else { // The storage permission has already been granted.
4530 // Get a handle for the download file alert dialog.
4531 DialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(url, contentDisposition, contentLength);
4533 // Show the download file alert dialog.
4534 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
4539 // Update the find on page count.
4540 nestedScrollWebView.setFindListener(new WebView.FindListener() {
4541 // Get a handle for `findOnPageCountTextView`.
4542 final TextView findOnPageCountTextView = findViewById(R.id.find_on_page_count_textview);
4545 public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, boolean isDoneCounting) {
4546 if ((isDoneCounting) && (numberOfMatches == 0)) { // There are no matches.
4547 // Set `findOnPageCountTextView` to `0/0`.
4548 findOnPageCountTextView.setText(R.string.zero_of_zero);
4549 } else if (isDoneCounting) { // There are matches.
4550 // `activeMatchOrdinal` is zero-based.
4551 int activeMatch = activeMatchOrdinal + 1;
4553 // Build the match string.
4554 String matchString = activeMatch + "/" + numberOfMatches;
4556 // Set `findOnPageCountTextView`.
4557 findOnPageCountTextView.setText(matchString);
4562 // Update the status of swipe to refresh based on the scroll position of the nested scroll WebView.
4563 // Once the minimum API >= 23 this can be replaced with `nestedScrollWebView.setOnScrollChangeListener()`.
4564 nestedScrollWebView.getViewTreeObserver().addOnScrollChangedListener(() -> {
4565 if (nestedScrollWebView.getSwipeToRefresh()) {
4566 // Only enable swipe to refresh if the WebView is scrolled to the top.
4567 swipeRefreshLayout.setEnabled(nestedScrollWebView.getScrollY() == 0);
4571 // Set the web chrome client.
4572 nestedScrollWebView.setWebChromeClient(new WebChromeClient() {
4573 // Update the progress bar when a page is loading.
4575 public void onProgressChanged(WebView view, int progress) {
4576 // Inject the night mode CSS if night mode is enabled.
4577 if (nestedScrollWebView.getNightMode()) { // Night mode is enabled.
4578 // `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
4579 // used by WordPress. `text-decoration: none` removes all text underlines. `text-shadow: none` removes text shadows, which usually have a hard coded color.
4580 // `border: none` removes all borders, which can also be used to underline text. `a {color: #1565C0}` sets links to be a dark blue.
4581 // `::selection {background: #0D47A1}' sets the text selection highlight color to be a dark blue. `!important` takes precedent over any existing sub-settings.
4582 nestedScrollWebView.evaluateJavascript("(function() {var parent = document.getElementsByTagName('head').item(0); var style = document.createElement('style'); style.type = 'text/css'; " +
4583 "style.innerHTML = '* {background-color: #212121 !important; color: #BDBDBD !important; box-shadow: none !important; text-decoration: none !important;" +
4584 "text-shadow: none !important; border: none !important;} a {color: #1565C0 !important;} ::selection {background: #0D47A1 !important;}'; parent.appendChild(style)})()", value -> {
4585 // Initialize a handler to display `mainWebView`.
4586 Handler displayWebViewHandler = new Handler();
4588 // Setup a runnable to display `mainWebView` after a delay to allow the CSS to be applied.
4589 Runnable displayWebViewRunnable = () -> {
4590 // Only display `mainWebView` if the progress bar is gone. This prevents the display of the `WebView` while it is still loading.
4591 if (progressBar.getVisibility() == View.GONE) {
4592 nestedScrollWebView.setVisibility(View.VISIBLE);
4596 // Display the WebView after 500 milliseconds.
4597 displayWebViewHandler.postDelayed(displayWebViewRunnable, 500);
4599 } else { // Night mode is disabled.
4600 // Display the nested scroll WebView if night mode is disabled.
4601 // Because of a race condition between `applyDomainSettings` and `onPageStarted`,
4602 // when night mode is set by domain settings the WebView may be hidden even if night mode is not currently enabled.
4603 nestedScrollWebView.setVisibility(View.VISIBLE);
4606 // Update the progress bar.
4607 progressBar.setProgress(progress);
4609 // Set the visibility of the progress bar.
4610 if (progress < 100) {
4611 // Show the progress bar.
4612 progressBar.setVisibility(View.VISIBLE);
4614 // Hide the progress bar.
4615 progressBar.setVisibility(View.GONE);
4617 //Stop the swipe to refresh indicator if it is running
4618 swipeRefreshLayout.setRefreshing(false);
4622 // Set the favorite icon when it changes.
4624 public void onReceivedIcon(WebView view, Bitmap icon) {
4625 // Only update the favorite icon if the website has finished loading.
4626 if (progressBar.getVisibility() == View.GONE) {
4627 // Store the new favorite icon.
4628 nestedScrollWebView.setFavoriteOrDefaultIcon(icon);
4630 // Get the current page position.
4631 int currentPosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
4633 // Get the current tab.
4634 TabLayout.Tab tab = tabLayout.getTabAt(currentPosition);
4636 // Check to see if the tab has been populated.
4638 // Get the custom view from the tab.
4639 View tabView = tab.getCustomView();
4641 // Check to see if the custom tab view has been populated.
4642 if (tabView != null) {
4643 // Get the favorite icon image view from the tab.
4644 ImageView tabFavoriteIconImageView = tabView.findViewById(R.id.favorite_icon_imageview);
4646 // Display the favorite icon in the tab.
4647 tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
4653 // Save a copy of the title when it changes.
4655 public void onReceivedTitle(WebView view, String title) {
4656 // Get the current page position.
4657 int currentPosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
4659 // Get the current tab.
4660 TabLayout.Tab tab = tabLayout.getTabAt(currentPosition);
4662 // Only populate the title text view if the tab has been fully created.
4664 // Get the custom view from the tab.
4665 View tabView = tab.getCustomView();
4667 // Remove the incorrect warning below that the current tab view might be null.
4668 assert tabView != null;
4670 // Get the title text view from the tab.
4671 TextView tabTitleTextView = tabView.findViewById(R.id.title_textview);
4673 // Set the title as the tab text.
4674 tabTitleTextView.setText(title);
4678 // Enter full screen video.
4680 public void onShowCustomView(View video, CustomViewCallback callback) {
4681 // Get a handle for the full screen video frame layout.
4682 FrameLayout fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
4684 // Set the full screen video flag.
4685 displayingFullScreenVideo = true;
4687 // Pause the ad if this is the free flavor.
4688 if (BuildConfig.FLAVOR.contentEquals("free")) {
4689 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
4690 AdHelper.pauseAd(findViewById(R.id.adview));
4693 // Hide the keyboard.
4694 inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.getWindowToken(), 0);
4696 // Hide the main content relative layout.
4697 mainContentRelativeLayout.setVisibility(View.GONE);
4699 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
4700 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
4702 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
4703 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4705 /* Hide the system bars.
4706 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
4707 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
4708 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
4709 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
4711 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
4712 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
4714 // Disable the sliding drawers.
4715 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED);
4717 // Add the video view to the full screen video frame layout.
4718 fullScreenVideoFrameLayout.addView(video);
4720 // Show the full screen video frame layout.
4721 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
4724 // Exit full screen video.
4726 public void onHideCustomView() {
4727 // Get a handle for the full screen video frame layout.
4728 FrameLayout fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
4730 // Unset the full screen video flag.
4731 displayingFullScreenVideo = false;
4733 // Remove all the views from the full screen video frame layout.
4734 fullScreenVideoFrameLayout.removeAllViews();
4736 // Hide the full screen video frame layout.
4737 fullScreenVideoFrameLayout.setVisibility(View.GONE);
4739 // Enable the sliding drawers.
4740 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED);
4742 // Show the main content relative layout.
4743 mainContentRelativeLayout.setVisibility(View.VISIBLE);
4745 // Apply the appropriate full screen mode flags.
4746 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
4747 // Hide the app bar if specified.
4749 // Hide the tab linear layout.
4750 tabsLinearLayout.setVisibility(View.GONE);
4752 // Hide the action bar.
4756 // Hide the banner ad in the free flavor.
4757 if (BuildConfig.FLAVOR.contentEquals("free")) {
4758 AdHelper.hideAd(findViewById(R.id.adview));
4761 // Remove the translucent status flag. This is necessary so the root frame layout can fill the entire screen.
4762 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4764 /* Hide the system bars.
4765 * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
4766 * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
4767 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
4768 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
4770 rootFrameLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION |
4771 View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
4772 } else { // Switch to normal viewing mode.
4773 // Remove the `SYSTEM_UI` flags from the root frame layout.
4774 rootFrameLayout.setSystemUiVisibility(0);
4776 // Add the translucent status flag.
4777 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4780 // Reload the ad for the free flavor if not in full screen mode.
4781 if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
4783 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
4789 public boolean onShowFileChooser(WebView webView, ValueCallback<Uri[]> filePathCallback, FileChooserParams fileChooserParams) {
4790 // Show the file chooser if the device is running API >= 21.
4791 if (Build.VERSION.SDK_INT >= 21) {
4792 // Store the file path callback.
4793 fileChooserCallback = filePathCallback;
4795 // Create an intent to open a chooser based ont the file chooser parameters.
4796 Intent fileChooserIntent = fileChooserParams.createIntent();
4798 // Open the file chooser. Currently only one `startActivityForResult` exists in this activity, so the request code, used to differentiate them, is simply `0`.
4799 startActivityForResult(fileChooserIntent, 0);
4805 nestedScrollWebView.setWebViewClient(new WebViewClient() {
4806 // `shouldOverrideUrlLoading` makes this `WebView` the default handler for URLs inside the app, so that links are not kicked out to other apps.
4807 // The deprecated `shouldOverrideUrlLoading` must be used until API >= 24.
4809 public boolean shouldOverrideUrlLoading(WebView view, String url) {
4810 if (url.startsWith("http")) { // Load the URL in Privacy Browser.
4811 // Apply the domain settings for the new URL. This doesn't do anything if the domain has not changed.
4812 boolean userAgentChanged = applyDomainSettings(nestedScrollWebView, url, true, false);
4814 // Check if the user agent has changed.
4815 if (userAgentChanged) {
4816 // Manually load the URL. The changing of the user agent will cause WebView to reload the previous URL.
4817 nestedScrollWebView.loadUrl(url, customHeaders);
4819 // Returning true indicates that Privacy Browser is manually handling the loading of the URL.
4822 // Returning false causes the current WebView to handle the URL and prevents it from adding redirects to the history list.
4825 } else if (url.startsWith("mailto:")) { // Load the email address in an external email program.
4826 // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
4827 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
4829 // Parse the url and set it as the data for the intent.
4830 emailIntent.setData(Uri.parse(url));
4832 // Open the email program in a new task instead of as part of Privacy Browser.
4833 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4836 startActivity(emailIntent);
4838 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
4840 } else if (url.startsWith("tel:")) { // Load the phone number in the dialer.
4841 // Open the dialer and load the phone number, but wait for the user to place the call.
4842 Intent dialIntent = new Intent(Intent.ACTION_DIAL);
4844 // Add the phone number to the intent.
4845 dialIntent.setData(Uri.parse(url));
4847 // Open the dialer in a new task instead of as part of Privacy Browser.
4848 dialIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4851 startActivity(dialIntent);
4853 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
4855 } else { // Load a system chooser to select an app that can handle the URL.
4856 // Open an app that can handle the URL.
4857 Intent genericIntent = new Intent(Intent.ACTION_VIEW);
4859 // Add the URL to the intent.
4860 genericIntent.setData(Uri.parse(url));
4862 // List all apps that can handle the URL instead of just opening the first one.
4863 genericIntent.addCategory(Intent.CATEGORY_BROWSABLE);
4865 // Open the app in a new task instead of as part of Privacy Browser.
4866 genericIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
4868 // Start the app or display a snackbar if no app is available to handle the URL.
4870 startActivity(genericIntent);
4871 } catch (ActivityNotFoundException exception) {
4872 Snackbar.make(nestedScrollWebView, getString(R.string.unrecognized_url) + " " + url, Snackbar.LENGTH_SHORT).show();
4875 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
4880 // Check requests against the block lists. The deprecated `shouldInterceptRequest()` must be used until minimum API >= 21.
4882 public WebResourceResponse shouldInterceptRequest(WebView view, String url) {
4883 // Get a handle for the navigation view.
4884 NavigationView navigationView = findViewById(R.id.navigationview);
4886 // Get a handle for the navigation menu.
4887 Menu navigationMenu = navigationView.getMenu();
4889 // Get a handle for the navigation requests menu item. The menu is 0 based.
4890 MenuItem navigationRequestsMenuItem = navigationMenu.getItem(6);
4892 // Create an empty web resource response to be used if the resource request is blocked.
4893 WebResourceResponse emptyWebResourceResponse = new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
4895 // Reset the whitelist results tracker.
4896 String[] whitelistResultStringArray = null;
4898 // Initialize the third party request tracker.
4899 boolean isThirdPartyRequest = false;
4901 // Get the current URL. `.getUrl()` throws an error because operations on the WebView cannot be made from this thread.
4902 String currentBaseDomain = nestedScrollWebView.getCurrentDomainName();
4904 // Store a copy of the current domain for use in later requests.
4905 String currentDomain = currentBaseDomain;
4907 // Nobody is happy when comparing null strings.
4908 if ((currentBaseDomain != null) && (url != null)) {
4909 // Convert the request URL to a URI.
4910 Uri requestUri = Uri.parse(url);
4912 // Get the request host name.
4913 String requestBaseDomain = requestUri.getHost();
4915 // Only check for third-party requests if the current base domain is not empty and the request domain is not null.
4916 if (!currentBaseDomain.isEmpty() && (requestBaseDomain != null)) {
4917 // Determine the current base domain.
4918 while (currentBaseDomain.indexOf(".", currentBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
4919 // Remove the first subdomain.
4920 currentBaseDomain = currentBaseDomain.substring(currentBaseDomain.indexOf(".") + 1);
4923 // Determine the request base domain.
4924 while (requestBaseDomain.indexOf(".", requestBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
4925 // Remove the first subdomain.
4926 requestBaseDomain = requestBaseDomain.substring(requestBaseDomain.indexOf(".") + 1);
4929 // Update the third party request tracker.
4930 isThirdPartyRequest = !currentBaseDomain.equals(requestBaseDomain);
4934 // Get the current WebView page position.
4935 int webViewPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
4937 // Determine if the WebView is currently displayed.
4938 boolean webViewDisplayed = (webViewPagePosition == tabLayout.getSelectedTabPosition());
4940 // Block third-party requests if enabled.
4941 if (isThirdPartyRequest && nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.THIRD_PARTY_REQUESTS)) {
4942 // Add the result to the resource requests.
4943 nestedScrollWebView.addResourceRequest(new String[]{BlockListHelper.REQUEST_THIRD_PARTY, url});
4945 // Increment the blocked requests counters.
4946 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
4947 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.THIRD_PARTY_REQUESTS);
4949 // Update the titles of the blocklist menu items if the WebView is currently displayed.
4950 if (webViewDisplayed) {
4951 // Updating the UI must be run from the UI thread.
4952 activity.runOnUiThread(() -> {
4953 // Update the menu item titles.
4954 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
4956 // Update the options menu if it has been populated.
4957 if (optionsMenu != null) {
4958 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
4959 optionsMenu.findItem(R.id.block_all_third_party_requests).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.THIRD_PARTY_REQUESTS) + " - " +
4960 getString(R.string.block_all_third_party_requests));
4965 // Return an empty web resource response.
4966 return emptyWebResourceResponse;
4969 // Check UltraPrivacy if it is enabled.
4970 if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.ULTRA_PRIVACY)) {
4971 // Check the URL against UltraPrivacy.
4972 String[] ultraPrivacyResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, ultraPrivacy);
4974 // Process the UltraPrivacy results.
4975 if (ultraPrivacyResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched UltraPrivacy's blacklist.
4976 // Add the result to the resource requests.
4977 nestedScrollWebView.addResourceRequest(new String[] {ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
4978 ultraPrivacyResults[5]});
4980 // Increment the blocked requests counters.
4981 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
4982 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.ULTRA_PRIVACY);
4984 // Update the titles of the blocklist menu items if the WebView is currently displayed.
4985 if (webViewDisplayed) {
4986 // Updating the UI must be run from the UI thread.
4987 activity.runOnUiThread(() -> {
4988 // Update the menu item titles.
4989 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
4991 // Update the options menu if it has been populated.
4992 if (optionsMenu != null) {
4993 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
4994 optionsMenu.findItem(R.id.ultraprivacy).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.ULTRA_PRIVACY) + " - " + getString(R.string.ultraprivacy));
4999 // The resource request was blocked. Return an empty web resource response.
5000 return emptyWebResourceResponse;
5001 } else if (ultraPrivacyResults[0].equals(BlockListHelper.REQUEST_ALLOWED)) { // The resource request matched UltraPrivacy's whitelist.
5002 // Add a whitelist entry to the resource requests array.
5003 nestedScrollWebView.addResourceRequest(new String[] {ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
5004 ultraPrivacyResults[5]});
5006 // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
5011 // Check EasyList if it is enabled.
5012 if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.EASY_LIST)) {
5013 // Check the URL against EasyList.
5014 String[] easyListResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, easyList);
5016 // Process the EasyList results.
5017 if (easyListResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched EasyList's blacklist.
5018 // Add the result to the resource requests.
5019 nestedScrollWebView.addResourceRequest(new String[] {easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5]});
5021 // Increment the blocked requests counters.
5022 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5023 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.EASY_LIST);
5025 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5026 if (webViewDisplayed) {
5027 // Updating the UI must be run from the UI thread.
5028 activity.runOnUiThread(() -> {
5029 // Update the menu item titles.
5030 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5032 // Update the options menu if it has been populated.
5033 if (optionsMenu != null) {
5034 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5035 optionsMenu.findItem(R.id.easylist).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.EASY_LIST) + " - " + getString(R.string.easylist));
5040 // The resource request was blocked. Return an empty web resource response.
5041 return emptyWebResourceResponse;
5042 } else if (easyListResults[0].equals(BlockListHelper.REQUEST_ALLOWED)) { // The resource request matched EasyList's whitelist.
5043 // Update the whitelist result string array tracker.
5044 whitelistResultStringArray = new String[] {easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5]};
5048 // Check EasyPrivacy if it is enabled.
5049 if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.EASY_PRIVACY)) {
5050 // Check the URL against EasyPrivacy.
5051 String[] easyPrivacyResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, easyPrivacy);
5053 // Process the EasyPrivacy results.
5054 if (easyPrivacyResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched EasyPrivacy's blacklist.
5055 // Add the result to the resource requests.
5056 nestedScrollWebView.addResourceRequest(new String[] {easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4],
5057 easyPrivacyResults[5]});
5059 // Increment the blocked requests counters.
5060 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5061 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.EASY_PRIVACY);
5063 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5064 if (webViewDisplayed) {
5065 // Updating the UI must be run from the UI thread.
5066 activity.runOnUiThread(() -> {
5067 // Update the menu item titles.
5068 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5070 // Update the options menu if it has been populated.
5071 if (optionsMenu != null) {
5072 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5073 optionsMenu.findItem(R.id.easyprivacy).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.EASY_PRIVACY) + " - " + getString(R.string.easyprivacy));
5078 // The resource request was blocked. Return an empty web resource response.
5079 return emptyWebResourceResponse;
5080 } else if (easyPrivacyResults[0].equals(BlockListHelper.REQUEST_ALLOWED)) { // The resource request matched EasyPrivacy's whitelist.
5081 // Update the whitelist result string array tracker.
5082 whitelistResultStringArray = new String[] {easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4], easyPrivacyResults[5]};
5086 // Check Fanboy’s Annoyance List if it is enabled.
5087 if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST)) {
5088 // Check the URL against Fanboy's Annoyance List.
5089 String[] fanboysAnnoyanceListResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, fanboysAnnoyanceList);
5091 // Process the Fanboy's Annoyance List results.
5092 if (fanboysAnnoyanceListResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched Fanboy's Annoyance List's blacklist.
5093 // Add the result to the resource requests.
5094 nestedScrollWebView.addResourceRequest(new String[] {fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
5095 fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5]});
5097 // Increment the blocked requests counters.
5098 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5099 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST);
5101 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5102 if (webViewDisplayed) {
5103 // Updating the UI must be run from the UI thread.
5104 activity.runOnUiThread(() -> {
5105 // Update the menu item titles.
5106 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5108 // Update the options menu if it has been populated.
5109 if (optionsMenu != null) {
5110 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5111 optionsMenu.findItem(R.id.fanboys_annoyance_list).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.FANBOYS_ANNOYANCE_LIST) + " - " +
5112 getString(R.string.fanboys_annoyance_list));
5117 // The resource request was blocked. Return an empty web resource response.
5118 return emptyWebResourceResponse;
5119 } else if (fanboysAnnoyanceListResults[0].equals(BlockListHelper.REQUEST_ALLOWED)){ // The resource request matched Fanboy's Annoyance List's whitelist.
5120 // Update the whitelist result string array tracker.
5121 whitelistResultStringArray = new String[] {fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
5122 fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5]};
5124 } else if (nestedScrollWebView.isBlocklistEnabled(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST)) { // Only check Fanboy’s Social Blocking List if Fanboy’s Annoyance List is disabled.
5125 // Check the URL against Fanboy's Annoyance List.
5126 String[] fanboysSocialListResults = blockListHelper.checkBlocklist(currentDomain, url, isThirdPartyRequest, fanboysSocialList);
5128 // Process the Fanboy's Social Blocking List results.
5129 if (fanboysSocialListResults[0].equals(BlockListHelper.REQUEST_BLOCKED)) { // The resource request matched Fanboy's Social Blocking List's blacklist.
5130 // Add the result to the resource requests.
5131 nestedScrollWebView.addResourceRequest(new String[] {fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3],
5132 fanboysSocialListResults[4], fanboysSocialListResults[5]});
5134 // Increment the blocked requests counters.
5135 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS);
5136 nestedScrollWebView.incrementRequestsCount(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST);
5138 // Update the titles of the blocklist menu items if the WebView is currently displayed.
5139 if (webViewDisplayed) {
5140 // Updating the UI must be run from the UI thread.
5141 activity.runOnUiThread(() -> {
5142 // Update the menu item titles.
5143 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5145 // Update the options menu if it has been populated.
5146 if (optionsMenu != null) {
5147 optionsMenu.findItem(R.id.blocklists).setTitle(getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(NestedScrollWebView.BLOCKED_REQUESTS));
5148 optionsMenu.findItem(R.id.fanboys_social_blocking_list).setTitle(nestedScrollWebView.getRequestsCount(NestedScrollWebView.FANBOYS_SOCIAL_BLOCKING_LIST) + " - " +
5149 getString(R.string.fanboys_social_blocking_list));
5154 // The resource request was blocked. Return an empty web resource response.
5155 return emptyWebResourceResponse;
5156 } else if (fanboysSocialListResults[0].equals(BlockListHelper.REQUEST_ALLOWED)) { // The resource request matched Fanboy's Social Blocking List's whitelist.
5157 // Update the whitelist result string array tracker.
5158 whitelistResultStringArray = new String[] {fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3],
5159 fanboysSocialListResults[4], fanboysSocialListResults[5]};
5163 // Add the request to the log because it hasn't been processed by any of the previous checks.
5164 if (whitelistResultStringArray != null) { // The request was processed by a whitelist.
5165 nestedScrollWebView.addResourceRequest(whitelistResultStringArray);
5166 } else { // The request didn't match any blocklist entry. Log it as a default request.
5167 nestedScrollWebView.addResourceRequest(new String[]{BlockListHelper.REQUEST_DEFAULT, url});
5170 // The resource request has not been blocked. `return null` loads the requested resource.
5174 // Handle HTTP authentication requests.
5176 public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) {
5177 // Store the handler.
5178 nestedScrollWebView.setHttpAuthHandler(handler);
5180 // Instantiate an HTTP authentication dialog.
5181 DialogFragment httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm, nestedScrollWebView.getWebViewFragmentId());
5183 // Show the HTTP authentication dialog.
5184 httpAuthenticationDialogFragment.show(getSupportFragmentManager(), getString(R.string.http_authentication));
5188 public void onPageStarted(WebView view, String url, Bitmap favicon) {
5189 // Get the preferences.
5190 boolean scrollAppBar = sharedPreferences.getBoolean("scroll_app_bar", true);
5191 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
5193 // Get a handler for the app bar layout.
5194 AppBarLayout appBarLayout = findViewById(R.id.appbar_layout);
5196 // Set the top padding of the swipe refresh layout according to the app bar scrolling preference.
5198 // No padding is needed because it will automatically be placed below the app bar layout due to the scrolling layout behavior.
5199 swipeRefreshLayout.setPadding(0, 0, 0, 0);
5201 // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
5202 swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10, defaultProgressViewEndOffset);
5204 // Get the app bar layout height. This can't be done in `applyAppSettings()` because the app bar is not yet populated.
5205 int appBarHeight = appBarLayout.getHeight();
5207 // The swipe refresh layout must be manually moved below the app bar layout.
5208 swipeRefreshLayout.setPadding(0, appBarHeight, 0, 0);
5210 // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
5211 swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10 + appBarHeight, defaultProgressViewEndOffset + appBarHeight);
5214 // Reset the list of resource requests.
5215 nestedScrollWebView.clearResourceRequests();
5217 // Reset the requests counters.
5218 nestedScrollWebView.resetRequestsCounters();
5220 // If night mode is enabled, hide `mainWebView` until after the night mode CSS is applied.
5221 if (nestedScrollWebView.getNightMode()) {
5222 nestedScrollWebView.setVisibility(View.INVISIBLE);
5224 nestedScrollWebView.setVisibility(View.VISIBLE);
5227 // Hide the keyboard.
5228 inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.getWindowToken(), 0);
5230 // Check to see if Privacy Browser is waiting on Orbot.
5231 if (!waitingForOrbot) { // Process the URL.
5232 // Get the current page position.
5233 int currentPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
5235 // Update the URL text bar if the page is currently selected.
5236 if (tabLayout.getSelectedTabPosition() == currentPagePosition) {
5237 // Clear the focus from the URL edit text.
5238 urlEditText.clearFocus();
5240 // Display the formatted URL text.
5241 urlEditText.setText(url);
5243 // Apply text highlighting to `urlTextBox`.
5247 // Reset the list of host IP addresses.
5248 nestedScrollWebView.clearCurrentIpAddresses();
5250 // Get a URI for the current URL.
5251 Uri currentUri = Uri.parse(url);
5253 // Get the IP addresses for the host.
5254 new GetHostIpAddresses(activity, getSupportFragmentManager(), nestedScrollWebView).execute(currentUri.getHost());
5256 // Apply any custom domain settings if the URL was loaded by navigating history.
5257 if (nestedScrollWebView.getNavigatingHistory()) {
5258 // Reset navigating history.
5259 nestedScrollWebView.setNavigatingHistory(false);
5261 // Apply the domain settings.
5262 boolean userAgentChanged = applyDomainSettings(nestedScrollWebView, url, true, false);
5264 // Manually load the URL if the user agent has changed, which will have caused the previous URL to be reloaded.
5265 if (userAgentChanged) {
5270 // Replace Refresh with Stop if the options menu has been created. (The WebView typically begins loading before the menu items are instantiated.)
5271 if (optionsMenu != null) {
5272 // Get a handle for the refresh menu item.
5273 MenuItem refreshMenuItem = optionsMenu.findItem(R.id.refresh);
5276 refreshMenuItem.setTitle(R.string.stop);
5278 // Get the app bar and theme preferences.
5279 boolean displayAdditionalAppBarIcons = sharedPreferences.getBoolean("display_additional_app_bar_icons", false);
5281 // If the icon is displayed in the AppBar, set it according to the theme.
5282 if (displayAdditionalAppBarIcons) {
5284 refreshMenuItem.setIcon(R.drawable.close_dark);
5286 refreshMenuItem.setIcon(R.drawable.close_light);
5294 public void onPageFinished(WebView view, String url) {
5295 // Reset the wide view port if it has been turned off by the waiting for Orbot message.
5296 if (!waitingForOrbot) {
5297 // Only use a wide view port if the URL starts with `http`, not for `file://` and `content://`.
5298 nestedScrollWebView.getSettings().setUseWideViewPort(url.startsWith("http"));
5301 // Flush any cookies to persistent storage. The cookie manager has become very lazy about flushing cookies in recent versions.
5302 if (nestedScrollWebView.getAcceptFirstPartyCookies() && Build.VERSION.SDK_INT >= 21) {
5303 CookieManager.getInstance().flush();
5306 // Update the Refresh menu item if the options menu has been created.
5307 if (optionsMenu != null) {
5308 // Get a handle for the refresh menu item.
5309 MenuItem refreshMenuItem = optionsMenu.findItem(R.id.refresh);
5311 // Reset the Refresh title.
5312 refreshMenuItem.setTitle(R.string.refresh);
5314 // Get the app bar and theme preferences.
5315 boolean displayAdditionalAppBarIcons = sharedPreferences.getBoolean("display_additional_app_bar_icons", false);
5316 boolean darkTheme = sharedPreferences.getBoolean("dark_theme", false);
5318 // If the icon is displayed in the AppBar, reset it according to the theme.
5319 if (displayAdditionalAppBarIcons) {
5321 refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
5323 refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
5328 // Clear the cache and history if Incognito Mode is enabled.
5329 if (incognitoModeEnabled) {
5330 // Clear the cache. `true` includes disk files.
5331 nestedScrollWebView.clearCache(true);
5333 // Clear the back/forward history.
5334 nestedScrollWebView.clearHistory();
5336 // Manually delete cache folders.
5338 // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
5339 // which links to `/data/data/com.stoutner.privacybrowser.standard`.
5340 String privateDataDirectoryString = getApplicationInfo().dataDir;
5342 // Delete the main cache directory.
5343 Runtime.getRuntime().exec("rm -rf " + privateDataDirectoryString + "/cache");
5345 // Delete the secondary `Service Worker` cache directory.
5346 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
5347 Runtime.getRuntime().exec(new String[]{"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
5348 } catch (IOException e) {
5349 // Do nothing if an error is thrown.
5353 // Update the URL text box and apply domain settings if not waiting on Orbot.
5354 if (!waitingForOrbot) {
5355 // Get the current page position.
5356 int currentPagePosition = webViewPagerAdapter.getPositionForId(nestedScrollWebView.getWebViewFragmentId());
5358 // Check the current website information against any pinned domain information if the current IP addresses have been loaded.
5359 if ((nestedScrollWebView.hasPinnedSslCertificate() || nestedScrollWebView.hasPinnedIpAddresses()) && nestedScrollWebView.hasCurrentIpAddresses() &&
5360 !nestedScrollWebView.ignorePinnedDomainInformation()) {
5361 CheckPinnedMismatchHelper.checkPinnedMismatch(getSupportFragmentManager(), nestedScrollWebView);
5364 // Update the URL text bar if the page is currently selected and the user is not currently typing in the URL edit text.
5365 if ((tabLayout.getSelectedTabPosition() == currentPagePosition) && !urlEditText.hasFocus()) {
5366 // Check to see if the URL is `about:blank`.
5367 if (nestedScrollWebView.getUrl().equals("about:blank")) { // The WebView is blank.
5368 // Display the hint in the URL edit text.
5369 urlEditText.setText("");
5371 // Request focus for the URL text box.
5372 urlEditText.requestFocus();
5374 // Display the keyboard.
5375 inputMethodManager.showSoftInput(urlEditText, 0);
5377 // Hide the WebView, which causes the default background color to be displayed according to the theme.
5378 nestedScrollWebView.setVisibility(View.INVISIBLE);
5380 // Apply the domain settings. This clears any settings from the previous domain.
5381 applyDomainSettings(nestedScrollWebView, "", true, false);
5382 } else { // The WebView has loaded a webpage.
5383 // Display the final URL. Getting the URL from the WebView instead of using the one provided by `onPageFinished()` makes websites like YouTube function correctly.
5384 urlEditText.setText(nestedScrollWebView.getUrl());
5386 // Apply text highlighting to the URL.
5393 // Handle SSL Certificate errors.
5395 public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
5396 // Get the current website SSL certificate.
5397 SslCertificate currentWebsiteSslCertificate = error.getCertificate();
5399 // Extract the individual pieces of information from the current website SSL certificate.
5400 String currentWebsiteIssuedToCName = currentWebsiteSslCertificate.getIssuedTo().getCName();
5401 String currentWebsiteIssuedToOName = currentWebsiteSslCertificate.getIssuedTo().getOName();
5402 String currentWebsiteIssuedToUName = currentWebsiteSslCertificate.getIssuedTo().getUName();
5403 String currentWebsiteIssuedByCName = currentWebsiteSslCertificate.getIssuedBy().getCName();
5404 String currentWebsiteIssuedByOName = currentWebsiteSslCertificate.getIssuedBy().getOName();
5405 String currentWebsiteIssuedByUName = currentWebsiteSslCertificate.getIssuedBy().getUName();
5406 Date currentWebsiteSslStartDate = currentWebsiteSslCertificate.getValidNotBeforeDate();
5407 Date currentWebsiteSslEndDate = currentWebsiteSslCertificate.getValidNotAfterDate();
5409 // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
5410 if (nestedScrollWebView.hasPinnedSslCertificate()) {
5411 // Get the pinned SSL certificate.
5412 ArrayList<Object> pinnedSslCertificateArrayList = nestedScrollWebView.getPinnedSslCertificate();
5414 // Extract the arrays from the array list.
5415 String[] pinnedSslCertificateStringArray = (String[]) pinnedSslCertificateArrayList.get(0);
5416 Date[] pinnedSslCertificateDateArray = (Date[]) pinnedSslCertificateArrayList.get(1);
5418 // Check if the current SSL certificate matches the pinned certificate.
5419 if (currentWebsiteIssuedToCName.equals(pinnedSslCertificateStringArray[0]) && currentWebsiteIssuedToOName.equals(pinnedSslCertificateStringArray[1]) &&
5420 currentWebsiteIssuedToUName.equals(pinnedSslCertificateStringArray[2]) && currentWebsiteIssuedByCName.equals(pinnedSslCertificateStringArray[3]) &&
5421 currentWebsiteIssuedByOName.equals(pinnedSslCertificateStringArray[4]) && currentWebsiteIssuedByUName.equals(pinnedSslCertificateStringArray[5]) &&
5422 currentWebsiteSslStartDate.equals(pinnedSslCertificateDateArray[0]) && currentWebsiteSslEndDate.equals(pinnedSslCertificateDateArray[1])) {
5424 // An SSL certificate is pinned and matches the current domain certificate. Proceed to the website without displaying an error.
5427 } else { // Either there isn't a pinned SSL certificate or it doesn't match the current website certificate.
5428 // Store the SSL error handler.
5429 nestedScrollWebView.setSslErrorHandler(handler);
5431 // Instantiate an SSL certificate error alert dialog.
5432 DialogFragment sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error, nestedScrollWebView.getWebViewFragmentId());
5434 // Show the SSL certificate error dialog.
5435 sslCertificateErrorDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_error));
5440 // Check to see if this is the first page.
5441 if (pageNumber == 0) {
5442 // Set this nested scroll WebView as the current WebView.
5443 currentWebView = nestedScrollWebView;
5445 // Apply the app settings from the shared preferences.
5448 // Load the website if not waiting for Orbot to connect.
5449 if (!waitingForOrbot) {
5450 // Get the intent that started the app.
5451 Intent launchingIntent = getIntent();
5453 // Get the information from the intent.
5454 String launchingIntentAction = launchingIntent.getAction();
5455 Uri launchingIntentUriData = launchingIntent.getData();
5457 // If the intent action is a web search, perform the search.
5458 if ((launchingIntentAction != null) && launchingIntentAction.equals(Intent.ACTION_WEB_SEARCH)) {
5459 // Create an encoded URL string.
5460 String encodedUrlString;
5462 // Sanitize the search input and convert it to a search.
5464 encodedUrlString = URLEncoder.encode(launchingIntent.getStringExtra(SearchManager.QUERY), "UTF-8");
5465 } catch (UnsupportedEncodingException exception) {
5466 encodedUrlString = "";
5469 // Load the completed search URL.
5470 loadUrl(searchURL + encodedUrlString);
5471 } else if (launchingIntentUriData != null){ // Check to see if the intent contains a new URL.
5472 // Load the URL from the intent.
5473 loadUrl(launchingIntentUriData.toString());
5474 } else { // The is no URL in the intent.
5475 // Select the homepage based on the proxy through Orbot status.
5476 if (proxyThroughOrbot) {
5477 // Load the Tor homepage.
5478 loadUrl(sharedPreferences.getString("tor_homepage", getString(R.string.tor_homepage_default_value)));
5480 // Load the normal homepage.
5481 loadUrl(sharedPreferences.getString("homepage", getString(R.string.homepage_default_value)));