a7dfad7e6831f198d03bded1742a29a58c1e51d6
[PrivacyBrowser.git] / app / src / main / java / com / stoutner / privacybrowser / activities / MainWebViewActivity.java
1 /*
2  * Copyright 2015-2017 Soren Stoutner <soren@stoutner.com>.
3  *
4  * Download cookie code contributed 2017 Hendrik Knackstedt.  Copyright assigned to Soren Stoutner <soren@stoutner.com>.
5  *
6  * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
7  *
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.
12  *
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.
17  *
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/>.
20  */
21
22 package com.stoutner.privacybrowser.activities;
23
24 import android.annotation.SuppressLint;
25 import android.app.DialogFragment;
26 import android.app.DownloadManager;
27 import android.content.BroadcastReceiver;
28 import android.content.ClipData;
29 import android.content.ClipboardManager;
30 import android.content.Context;
31 import android.content.Intent;
32 import android.content.IntentFilter;
33 import android.content.SharedPreferences;
34 import android.content.res.Configuration;
35 import android.database.Cursor;
36 import android.graphics.Bitmap;
37 import android.graphics.drawable.BitmapDrawable;
38 import android.graphics.drawable.Drawable;
39 import android.net.Uri;
40 import android.net.http.SslCertificate;
41 import android.net.http.SslError;
42 import android.os.Build;
43 import android.os.Bundle;
44 import android.preference.PreferenceManager;
45 import android.print.PrintDocumentAdapter;
46 import android.print.PrintManager;
47 import android.support.annotation.NonNull;
48 import android.support.design.widget.CoordinatorLayout;
49 import android.support.design.widget.NavigationView;
50 import android.support.design.widget.Snackbar;
51 import android.support.v4.app.ActivityCompat;
52 import android.support.v4.content.ContextCompat;
53 import android.support.v4.view.GravityCompat;
54 import android.support.v4.widget.DrawerLayout;
55 import android.support.v4.widget.SwipeRefreshLayout;
56 import android.support.v7.app.ActionBar;
57 import android.support.v7.app.ActionBarDrawerToggle;
58 import android.support.v7.app.AppCompatActivity;
59 import android.support.v7.app.AppCompatDialogFragment;
60 import android.support.v7.widget.Toolbar;
61 import android.text.Editable;
62 import android.text.TextWatcher;
63 import android.util.Patterns;
64 import android.view.ContextMenu;
65 import android.view.GestureDetector;
66 import android.view.KeyEvent;
67 import android.view.Menu;
68 import android.view.MenuItem;
69 import android.view.MotionEvent;
70 import android.view.View;
71 import android.view.WindowManager;
72 import android.view.inputmethod.InputMethodManager;
73 import android.webkit.CookieManager;
74 import android.webkit.DownloadListener;
75 import android.webkit.SslErrorHandler;
76 import android.webkit.WebBackForwardList;
77 import android.webkit.WebChromeClient;
78 import android.webkit.WebResourceResponse;
79 import android.webkit.WebStorage;
80 import android.webkit.WebView;
81 import android.webkit.WebViewClient;
82 import android.webkit.WebViewDatabase;
83 import android.widget.EditText;
84 import android.widget.FrameLayout;
85 import android.widget.ImageView;
86 import android.widget.LinearLayout;
87 import android.widget.ProgressBar;
88 import android.widget.RelativeLayout;
89 import android.widget.TextView;
90
91 import com.stoutner.privacybrowser.BannerAd;
92 import com.stoutner.privacybrowser.BuildConfig;
93 import com.stoutner.privacybrowser.R;
94 import com.stoutner.privacybrowser.dialogs.CreateHomeScreenShortcutDialog;
95 import com.stoutner.privacybrowser.dialogs.DownloadImageDialog;
96 import com.stoutner.privacybrowser.dialogs.UrlHistoryDialog;
97 import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog;
98 import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper;
99 import com.stoutner.privacybrowser.helpers.OrbotProxyHelper;
100 import com.stoutner.privacybrowser.dialogs.DownloadFileDialog;
101 import com.stoutner.privacybrowser.dialogs.SslCertificateErrorDialog;
102
103 import java.io.BufferedReader;
104 import java.io.ByteArrayInputStream;
105 import java.io.IOException;
106 import java.io.InputStreamReader;
107 import java.io.UnsupportedEncodingException;
108 import java.net.MalformedURLException;
109 import java.net.URL;
110 import java.net.URLDecoder;
111 import java.net.URLEncoder;
112 import java.util.HashMap;
113 import java.util.HashSet;
114 import java.util.Map;
115 import java.util.Set;
116
117 // We need to use AppCompatActivity from android.support.v7.app.AppCompatActivity to have access to the SupportActionBar until the minimum API is >= 21.
118 public class MainWebViewActivity extends AppCompatActivity implements NavigationView.OnNavigationItemSelectedListener, CreateHomeScreenShortcutDialog.CreateHomeScreenSchortcutListener,
119         SslCertificateErrorDialog.SslCertificateErrorListener, DownloadFileDialog.DownloadFileListener, DownloadImageDialog.DownloadImageListener, UrlHistoryDialog.UrlHistoryListener {
120
121     // `appBar` is public static so it can be accessed from `OrbotProxyHelper`.  It is also used in `onCreate()`, `onOptionsItemSelected()`, `closeFindOnPage()`, and `applyAppSettings()`.
122     public static ActionBar appBar;
123
124     // `favoriteIconBitmap` is public static so it can be accessed from `CreateHomeScreenShortcutDialog`, `BookmarksActivity`, `CreateBookmarkDialog`, `CreateBookmarkFolderDialog`, `EditBookmarkDialog`, `EditBookmarkFolderDialog`, `ViewSslCertificateDialog`.
125     // It is also used in `onCreate()`, `onCreateHomeScreenShortcutCreate()`, and `applyDomainSettings`.
126     public static Bitmap favoriteIconBitmap;
127
128     // `formattedUrlString` is public static so it can be accessed from `BookmarksActivity`, `CreateBookmarkDialog`, and `AddDomainDialog`.
129     // It is also used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onCreateHomeScreenShortcutCreate()`, and `loadUrlFromTextBox()`.
130     public static String formattedUrlString;
131
132     // `sslCertificate` is public static so it can be accessed from `ViewSslCertificateDialog`.  It is also used in `onCreate()`.
133     public static SslCertificate sslCertificate;
134
135     // `orbotStatus` is public static so it can be accessed from `OrbotProxyHelper`.  It is also used in `onCreate()`.
136     public static String orbotStatus;
137
138     // `webViewTitle` is public static so it can be accessed from `CreateBookmarkDialog` and `CreateHomeScreenShortcutDialog`.  It is also used in `onCreate()`.
139     public static String webViewTitle;
140
141
142     // `navigatingHistory` is used in `onCreate()`, `onNavigationItemSelected()`, and `applyDomainSettings()`.
143     private boolean navigatingHistory;
144
145     // `favoriteIconDefaultBitmap` is used in `onCreate()` and `applyDomainSettings`.
146     private Bitmap favoriteIconDefaultBitmap;
147
148     // `drawerLayout` is used in `onCreate()`, `onNewIntent()`, and `onBackPressed()`.
149     private DrawerLayout drawerLayout;
150
151     // `rootCoordinatorLayout` is used in `onCreate()` and `applyAppSettings()`.
152     private CoordinatorLayout rootCoordinatorLayout;
153
154     // 'mainWebView' is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`, `findNextOnPage()`, `closeFindOnPage()`, and `loadUrlFromTextBox()`.
155     private WebView mainWebView;
156
157     // `fullScreenVideoFrameLayout` is used in `onCreate()` and `onConfigurationChanged()`.
158     private FrameLayout fullScreenVideoFrameLayout;
159
160     // `swipeRefreshLayout` is used in `onCreate()`, `onPrepareOptionsMenu`, and `onRestart()`.
161     private SwipeRefreshLayout swipeRefreshLayout;
162
163     // `urlAppBarRelativeLayout` is used in `onCreate()` and `applyDomainSettings()`.
164     private RelativeLayout urlAppBarRelativeLayout;
165
166     // `favoriteIconImageView` is used in `onCreate()` and `applyDomainSettings()`
167     private ImageView favoriteIconImageView;
168
169     // `cookieManager` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`, `loadUrlFromTextBox()`, `onDownloadImage()`, `onDownloadFile()`, and `onRestart()`.
170     private CookieManager cookieManager;
171
172     // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrl()`.
173     private final Map<String, String> customHeaders = new HashMap<>();
174
175     // `javaScriptEnabled` is also used in `onCreate()`, `onCreateOptionsMenu()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `applyAppSettings()`.
176     // It is `Boolean` instead of `boolean` because `applyAppSettings()` needs to know if it is `null`.
177     private Boolean javaScriptEnabled;
178
179     // `firstPartyCookiesEnabled` is used in `onCreate()`, `onCreateOptionsMenu()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onDownloadImage()`, `onDownloadFile()`, and `applyAppSettings()`.
180     private boolean firstPartyCookiesEnabled;
181
182     // `thirdPartyCookiesEnabled` used in `onCreate()`, `onCreateOptionsMenu()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
183     private boolean thirdPartyCookiesEnabled;
184
185     // `domStorageEnabled` is used in `onCreate()`, `onCreateOptionsMenu()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
186     private boolean domStorageEnabled;
187
188     // `saveFormDataEnabled` is used in `onCreate()`, `onCreateOptionsMenu()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
189     private boolean saveFormDataEnabled;
190
191     // `swipeToRefreshEnabled` is used in `onPrepareOptionsMenu()` and `applyAppSettings()`.
192     private boolean swipeToRefreshEnabled;
193
194     // 'homepage' is used in `onCreate()`, `onNavigationItemSelected()`, and `applyAppSettings()`.
195     private String homepage;
196
197     // `searchURL` is used in `loadURLFromTextBox()` and `applyAppSettings()`.
198     private String searchURL;
199
200     // `adBlockerEnabled` is used in `onCreate()` and `applyAppSettings()`.
201     private boolean adBlockerEnabled;
202
203     // `privacyBrowserRuntime` is used in `onCreate()` and `applyAppSettings()`.
204     Runtime privacyBrowserRuntime;
205
206     // `incognitoModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
207     private boolean incognitoModeEnabled;
208
209     // `fullScreenBrowsingModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
210     private boolean fullScreenBrowsingModeEnabled;
211
212     // `inFullScreenBrowsingMode` is used in `onCreate()`, `onConfigurationChanged()`, and `applyAppSettings()`.
213     private boolean inFullScreenBrowsingMode;
214
215     // `hideSystemBarsOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
216     private boolean hideSystemBarsOnFullscreen;
217
218     // `translucentNavigationBarOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
219     private boolean translucentNavigationBarOnFullscreen;
220
221     // `currentDomainName` is used in `onCreate(), `onNavigationItemSelected()`, and `applyDomainSettings()`.
222     private String currentDomainName;
223
224     // `waitingForOrbot` is used in `onCreate()` and `applyAppSettings()`.
225     private boolean waitingForOrbot;
226
227     // `waitingForOrbotData` is used in `onCreate()` and `applyAppSettings()`.
228     private String waitingForOrbotHTMLString;
229
230     // `privateDataDirectoryString` is used in `onCreate()` and `onNavigationItemSelected()`.
231     private String privateDataDirectoryString;
232
233     // `findOnPageLinearLayout` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
234     private LinearLayout findOnPageLinearLayout;
235
236     // `findOnPageEditText` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
237     private EditText findOnPageEditText;
238
239     // `mainMenu` is used in `onCreateOptionsMenu()` and `updatePrivacyIcons()`.
240     private Menu mainMenu;
241
242     // `drawerToggle` is used in `onCreate()`, `onPostCreate()`, `onConfigurationChanged()`, `onNewIntent()`, and `onNavigationItemSelected()`.
243     private ActionBarDrawerToggle drawerToggle;
244
245     // `supportAppBar` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
246     private Toolbar supportAppBar;
247
248     // `urlTextBox` is used in `onCreate()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `loadUrl()`.
249     private EditText urlTextBox;
250
251     // `adView` is used in `onCreate()` and `onConfigurationChanged()`.
252     private View adView;
253
254     // `sslErrorHandler` is used in `onCreate()`, `onSslErrorCancel()`, and `onSslErrorProceed`.
255     private SslErrorHandler sslErrorHandler;
256
257     // `inputMethodManager` is used in `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `closeFindOnPage()`.
258     private InputMethodManager inputMethodManager;
259
260     // `mainWebViewRelativeLayout` is used in `onCreate()` and `onNavigationItemSelected()`.
261     private RelativeLayout mainWebViewRelativeLayout;
262
263     @Override
264     // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.  The whole premise of Privacy Browser is built around an understanding of these dangers.
265     @SuppressLint("SetJavaScriptEnabled")
266     protected void onCreate(Bundle savedInstanceState) {
267         super.onCreate(savedInstanceState);
268         setContentView(R.layout.main_drawerlayout);
269
270         // Get a handle for `inputMethodManager`.
271         inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
272
273         // We need to use the `SupportActionBar` from `android.support.v7.app.ActionBar` until the minimum API is >= 21.
274         supportAppBar = (Toolbar) findViewById(R.id.app_bar);
275         setSupportActionBar(supportAppBar);
276         appBar = getSupportActionBar();
277
278         // This is needed to get rid of the Android Studio warning that `appBar` might be null.
279         assert appBar != null;
280
281         // Add the custom `url_app_bar` layout, which shows the favorite icon and the URL text bar.
282         appBar.setCustomView(R.layout.url_app_bar);
283         appBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
284
285         // Set the "go" button on the keyboard to load the URL in urlTextBox.
286         urlTextBox = (EditText) appBar.getCustomView().findViewById(R.id.url_edittext);
287         urlTextBox.setOnKeyListener(new View.OnKeyListener() {
288             @Override
289             public boolean onKey(View v, int keyCode, KeyEvent event) {
290                 // If the event is a key-down event on the `enter` button, load the URL.
291                 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
292                     // Load the URL into the mainWebView and consume the event.
293                     try {
294                         loadUrlFromTextBox();
295                     } catch (UnsupportedEncodingException e) {
296                         e.printStackTrace();
297                     }
298                     // If the enter key was pressed, consume the event.
299                     return true;
300                 } else {
301                     // If any other key was pressed, do not consume the event.
302                     return false;
303                 }
304             }
305         });
306
307         // Set `waitingForOrbotHTMLString`.
308         waitingForOrbotHTMLString = "<html><body><br/><center><h1>" + getString(R.string.waiting_for_orbot) + "</h1></center></body></html>";
309
310         // Initialize `currentDomainName`, `orbotStatus`, and `waitingForOrbot`.
311         currentDomainName = "";
312         orbotStatus = "unknown";
313         waitingForOrbot = false;
314
315         // Create an Orbot status `BroadcastReceiver`.
316         BroadcastReceiver orbotStatusBroadcastReceiver = new BroadcastReceiver() {
317             @Override
318             public void onReceive(Context context, Intent intent) {
319                 // Store the content of the status message in `orbotStatus`.
320                 orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS");
321
322                 // If we are waiting on Orbot, load the website now that Orbot is connected.
323                 if (orbotStatus.equals("ON") && waitingForOrbot) {
324                     // Reset `waitingForOrbot`.
325                     waitingForOrbot = false;
326
327                     // Load `formattedUrlString
328                     loadUrl(formattedUrlString);
329                 }
330             }
331         };
332
333         // Register `orbotStatusBroadcastReceiver` on `this` context.
334         this.registerReceiver(orbotStatusBroadcastReceiver, new IntentFilter("org.torproject.android.intent.action.STATUS"));
335
336         // Get handles for views that need to be accessed.
337         drawerLayout = (DrawerLayout) findViewById(R.id.drawerlayout);
338         rootCoordinatorLayout = (CoordinatorLayout) findViewById(R.id.root_coordinatorlayout);
339         mainWebViewRelativeLayout = (RelativeLayout) findViewById(R.id.main_webview_relativelayout);
340         mainWebView = (WebView) findViewById(R.id.main_webview);
341         findOnPageLinearLayout = (LinearLayout) findViewById(R.id.find_on_page_linearlayout);
342         findOnPageEditText = (EditText) findViewById(R.id.find_on_page_edittext);
343         fullScreenVideoFrameLayout = (FrameLayout) findViewById(R.id.full_screen_video_framelayout);
344         urlAppBarRelativeLayout = (RelativeLayout) findViewById(R.id.url_app_bar_relativelayout);
345         favoriteIconImageView = (ImageView) findViewById(R.id.favorite_icon);
346
347         // Create a double-tap listener to toggle full-screen mode.
348         final GestureDetector gestureDetector = new GestureDetector(this, new GestureDetector.SimpleOnGestureListener() {
349             // Override `onDoubleTap()`.  All other events are handled using the default settings.
350             @Override
351             public boolean onDoubleTap(MotionEvent event) {
352                 if (fullScreenBrowsingModeEnabled) {  // Only process the double-tap if full screen browsing mode is enabled.
353                     // Toggle `inFullScreenBrowsingMode`.
354                     inFullScreenBrowsingMode = !inFullScreenBrowsingMode;
355
356                     if (inFullScreenBrowsingMode) {  // Switch to full screen mode.
357                         // Hide the `appBar`.
358                         appBar.hide();
359
360                         // Hide the `BannerAd` in the free flavor.
361                         if (BuildConfig.FLAVOR.contentEquals("free")) {
362                             BannerAd.hideAd(adView);
363                         }
364
365                         // Modify the system bars.
366                         if (hideSystemBarsOnFullscreen) {  // Hide everything.
367                             // Remove the translucent overlays.
368                             getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
369
370                             // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
371                             drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
372
373                             /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
374                              * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
375                              * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically rehides them after they are shown.
376                              */
377                             rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
378
379                             // Set `rootCoordinatorLayout` to fill the whole screen.
380                             rootCoordinatorLayout.setFitsSystemWindows(false);
381                         } else {  // Hide everything except the status and navigation bars.
382                             // Set `rootCoordinatorLayout` to fit under the status and navigation bars.
383                             rootCoordinatorLayout.setFitsSystemWindows(false);
384
385                             if (translucentNavigationBarOnFullscreen) {  // There is an Android Support Library bug that causes a scrim to print on the right side of the `Drawer Layout` when the navigation bar is displayed on the right of the screen.
386                                 // Set the navigation bar to be translucent.
387                                 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
388                             }
389                         }
390                     } else {  // Switch to normal viewing mode.
391                         // Show the `appBar`.
392                         appBar.show();
393
394                         // Show the `BannerAd` in the free flavor.
395                         if (BuildConfig.FLAVOR.contentEquals("free")) {
396                             // Reload the ad.  Because the screen may have rotated, we need to use `reloadAfterRotate`.
397                             BannerAd.reloadAfterRotate(adView, getApplicationContext(), getString(R.string.ad_id));
398
399                             // Reinitialize the `adView` variable, as the `View` will have been removed and re-added by `BannerAd.reloadAfterRotate()`.
400                             adView = findViewById(R.id.adview);
401                         }
402
403                         // Remove the translucent navigation bar flag if it is set.
404                         getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
405
406                         // Add the translucent status flag if it is unset.  This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
407                         getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
408
409                         // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
410                         rootCoordinatorLayout.setSystemUiVisibility(0);
411
412                         // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
413                         rootCoordinatorLayout.setFitsSystemWindows(true);
414                     }
415
416                     // Consume the double-tap.
417                     return true;
418                 } else { // Do not consume the double-tap because full screen browsing mode is disabled.
419                     return false;
420                 }
421             }
422         });
423
424         // Pass all touch events on `mainWebView` through `gestureDetector` to check for double-taps.
425         mainWebView.setOnTouchListener(new View.OnTouchListener() {
426             @Override
427             public boolean onTouch(View v, MotionEvent event) {
428                 // Send the `event` to `gestureDetector`.
429                 return gestureDetector.onTouchEvent(event);
430             }
431         });
432
433         // Update `findOnPageCountTextView`.
434         mainWebView.setFindListener(new WebView.FindListener() {
435             // Get a handle for `findOnPageCountTextView`.
436             final TextView findOnPageCountTextView = (TextView) findViewById(R.id.find_on_page_count_textview);
437
438             @Override
439             public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, boolean isDoneCounting) {
440                 if ((isDoneCounting) && (numberOfMatches == 0)) {  // There are no matches.
441                     // Set `findOnPageCountTextView` to `0/0`.
442                     findOnPageCountTextView.setText(R.string.zero_of_zero);
443                 } else if (isDoneCounting) {  // There are matches.
444                     // `activeMatchOrdinal` is zero-based.
445                     int activeMatch = activeMatchOrdinal + 1;
446
447                     // Set `findOnPageCountTextView`.
448                     findOnPageCountTextView.setText(activeMatch + "/" + numberOfMatches);
449                 }
450             }
451         });
452
453         // Search for the string on the page whenever a character changes in the `findOnPageEditText`.
454         findOnPageEditText.addTextChangedListener(new TextWatcher() {
455             @Override
456             public void beforeTextChanged(CharSequence s, int start, int count, int after) {
457                 // Do nothing.
458             }
459
460             @Override
461             public void onTextChanged(CharSequence s, int start, int before, int count) {
462                 // Do nothing.
463             }
464
465             @Override
466             public void afterTextChanged(Editable s) {
467                 // Search for the text in `mainWebView`.
468                 mainWebView.findAllAsync(findOnPageEditText.getText().toString());
469             }
470         });
471
472         // Set the `check mark` button for the `findOnPageEditText` keyboard to close the soft keyboard.
473         findOnPageEditText.setOnKeyListener(new View.OnKeyListener() {
474             @Override
475             public boolean onKey(View v, int keyCode, KeyEvent event) {
476                 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {  // The `enter` key was pressed.
477                     // Hide the soft keyboard.  `0` indicates no additional flags.
478                     inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
479
480                     // Consume the event.
481                     return true;
482                 } else {  // A different key was pressed.
483                     // Do not consume the event.
484                     return false;
485                 }
486             }
487         });
488
489         // Implement swipe to refresh
490         swipeRefreshLayout = (SwipeRefreshLayout) findViewById(R.id.swipe_refreshlayout);
491         swipeRefreshLayout.setColorSchemeResources(R.color.blue_700);
492         swipeRefreshLayout.setOnRefreshListener(new SwipeRefreshLayout.OnRefreshListener() {
493             @Override
494             public void onRefresh() {
495                 mainWebView.reload();
496             }
497         });
498
499         // `DrawerTitle` identifies the `DrawerLayout` in accessibility mode.
500         drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer));
501
502         // Listen for touches on the navigation menu.
503         final NavigationView navigationView = (NavigationView) findViewById(R.id.navigationview);
504         navigationView.setNavigationItemSelectedListener(this);
505
506         // Get handles for `navigationMenu` and the back and forward menu items.  The menu is zero-based, so items 1, 2, and 3 are the second, third, and fourth entries in the menu.
507         final Menu navigationMenu = navigationView.getMenu();
508         final MenuItem navigationBackMenuItem = navigationMenu.getItem(1);
509         final MenuItem navigationForwardMenuItem = navigationMenu.getItem(2);
510         final MenuItem navigationHistoryMenuItem = navigationMenu.getItem(3);
511
512         // The `DrawerListener` allows us to update the Navigation Menu.
513         drawerLayout.addDrawerListener(new DrawerLayout.DrawerListener() {
514             @Override
515             public void onDrawerSlide(View drawerView, float slideOffset) {
516             }
517
518             @Override
519             public void onDrawerOpened(View drawerView) {
520             }
521
522             @Override
523             public void onDrawerClosed(View drawerView) {
524             }
525
526             @Override
527             public void onDrawerStateChanged(int newState) {
528                 if ((newState == DrawerLayout.STATE_SETTLING) || (newState == DrawerLayout.STATE_DRAGGING)) {  // The drawer is opening or closing.
529                     // Update the `Back`, `Forward`, and `History` menu items.
530                     navigationBackMenuItem.setEnabled(mainWebView.canGoBack());
531                     navigationForwardMenuItem.setEnabled(mainWebView.canGoForward());
532                     navigationHistoryMenuItem.setEnabled((mainWebView.canGoBack() || mainWebView.canGoForward()));
533
534                     // Hide the keyboard so we can see the navigation menu.  `0` indicates no additional flags.
535                     inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
536                 }
537             }
538         });
539
540         // drawerToggle creates the hamburger icon at the start of the AppBar.
541         drawerToggle = new ActionBarDrawerToggle(this, drawerLayout, supportAppBar, R.string.open_navigation_drawer, R.string.close_navigation_drawer);
542
543         // Initialize `adServerSet`.
544         final Set<String> adServersSet = new HashSet<>();
545
546         // Load the list of ad servers into memory.
547         try {
548             // Load `pgl.yoyo.org_adservers.txt` into a `BufferedReader`.
549             BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(getAssets().open("pgl.yoyo.org_adservers.txt")));
550
551             // Create a string for storing each ad server.
552             String adServer;
553
554             // Populate `adServersSet`.
555             while ((adServer = bufferedReader.readLine()) != null) {
556                 adServersSet.add(adServer);
557             }
558
559             // Close `bufferedReader`.
560             bufferedReader.close();
561         } catch (IOException ioException) {
562             // We're pretty sure the asset exists, so we don't need to worry about the `IOException` ever being thrown.
563         }
564
565         mainWebView.setWebViewClient(new WebViewClient() {
566             // `shouldOverrideUrlLoading` makes this `WebView` the default handler for URLs inside the app, so that links are not kicked out to other apps.
567             // We have to use the deprecated `shouldOverrideUrlLoading` until API >= 24.
568             @SuppressWarnings("deprecation")
569             @Override
570             public boolean shouldOverrideUrlLoading(WebView view, String url) {
571                 if (url.startsWith("mailto:")) {  // Load the URL in an external email program because it begins with `mailto:`.
572                     // We use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
573                     Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
574
575                     // Parse the url and set it as the data for the `Intent`.
576                     emailIntent.setData(Uri.parse(url));
577
578                     // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
579                     emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
580
581                     // Make it so.
582                     startActivity(emailIntent);
583
584                     // Returning `true` indicates the application is handling the URL.
585                     return true;
586                 } else {  // Load the URL in Privacy Browser.
587                     // Apply the domain settings for the new URL.
588                     applyDomainSettings(url);
589
590                     // Returning `false` causes the current `WebView` to handle the URL and prevents it from adding redirects to the history list.
591                     return false;
592                 }
593             }
594
595             // Block ads.  We have to use the deprecated `shouldInterceptRequest` until minimum API >= 21.
596             @SuppressWarnings("deprecation")
597             @Override
598             public WebResourceResponse shouldInterceptRequest(WebView view, String url){
599                 if (adBlockerEnabled) {  // Block ads.
600                     // Extract the host from `url`.
601                     Uri requestUri = Uri.parse(url);
602                     String requestHost = requestUri.getHost();
603
604                     // Initialize a variable to track if this is an ad server.
605                     boolean requestHostIsAdServer = false;
606
607                     // Check all the subdomains of `requestHost` if it is not `null` against the ad server database.
608                     if (requestHost != null) {
609                         while (requestHost.contains(".") && !requestHostIsAdServer) {  // Stop checking if we run out of `.` or if we already know that `requestHostIsAdServer` is `true`.
610                             if (adServersSet.contains(requestHost)) {
611                                 requestHostIsAdServer = true;
612                             }
613
614                             // Strip out the lowest subdomain of `requestHost`.
615                             requestHost = requestHost.substring(requestHost.indexOf(".") + 1);
616                         }
617                     }
618
619                     if (requestHostIsAdServer) {  // It is an ad server.
620                         // Return an empty `WebResourceResponse`.
621                         return new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
622                     } else {  // It is not an ad server.
623                         // `return null` loads the requested resource.
624                         return null;
625                     }
626                 } else {  // Ad blocking is disabled.
627                     // `return null` loads the requested resource.
628                     return null;
629                 }
630             }
631
632             // Update the URL in urlTextBox when the page starts to load.
633             @Override
634             public void onPageStarted(WebView view, String url, Bitmap favicon) {
635                 // Reset `webViewTitle`
636                 webViewTitle = getString(R.string.no_title);
637
638                 // Check to see if we are waiting on Orbot.
639                 if (!waitingForOrbot) {  // We are not waiting on Orbot, so we need to process the URL.
640                     // We need to update `formattedUrlString` at the beginning of the load, so that if the user toggles JavaScript during the load the new website is reloaded.
641                     formattedUrlString = url;
642
643                     // Display the loading URL is the URL text box.
644                     urlTextBox.setText(url);
645
646                     // Apply any custom domain settings if the URL was loaded by navigating history.
647                     if (navigatingHistory) {
648                         applyDomainSettings(url);
649                     }
650                 }
651             }
652
653             // Update formattedUrlString and urlTextBox.  It is necessary to do this after the page finishes loading because the final URL can change during load.
654             @Override
655             public void onPageFinished(WebView view, String url) {
656                 // Clear the cache and history if Incognito Mode is enabled.
657                 if (incognitoModeEnabled) {
658                     // Clear the cache.  `true` includes disk files.
659                     mainWebView.clearCache(true);
660
661                     // Clear the back/forward history.
662                     mainWebView.clearHistory();
663
664                     // Manually delete cache folders.
665                     try {
666                         // Delete the main `cache` folder.
667                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
668
669                         // Delete the `app_webview` folder, which contains an additional `WebView` cache.  See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
670                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
671                     } catch (IOException e) {
672                         // Do nothing if an error is thrown.
673                     }
674                 }
675
676                 // Update `urlTextBox` and apply domain settings if not waiting on Orbot.
677                 if (!waitingForOrbot) {
678                     // Check to see if `WebView` has set `url` to be `about:blank`.
679                     if (url.equals("about:blank")) {  // `WebView` is blank, so `formattedUrlString` should be `""` and `urlTextBox` should display a hint.
680                         // Set `formattedUrlString` to `""`.
681                         formattedUrlString = "";
682
683                         // Update `urlTextBox`.
684                         urlTextBox.setText(formattedUrlString);
685
686                         // Request focus for `urlTextBox`.
687                         urlTextBox.requestFocus();
688
689                         // Display the keyboard.
690                         inputMethodManager.showSoftInput(urlTextBox, 0);
691
692                         // Apply the domain settings.
693                         applyDomainSettings(formattedUrlString);
694                     } else {  // `WebView` has loaded a webpage.
695                         // Set `formattedUrlString`.
696                         formattedUrlString = url;
697
698                         // Only update `urlTextBox` if the user is not typing in it.
699                         if (!urlTextBox.hasFocus()) {
700                             urlTextBox.setText(formattedUrlString);
701                         }
702                     }
703
704                     // Store the SSL certificate so it can be accessed from `ViewSslCertificateDialog`.
705                     sslCertificate = mainWebView.getCertificate();
706                 }
707             }
708
709             // Handle SSL Certificate errors.
710             @Override
711             public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
712                 // Store `handler` so it can be accesses from `onSslErrorCancel()` and `onSslErrorProceed()`.
713                 sslErrorHandler = handler;
714
715                 // Display the SSL error `AlertDialog`.
716                 AppCompatDialogFragment sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error);
717                 sslCertificateErrorDialogFragment.show(getSupportFragmentManager(), getResources().getString(R.string.ssl_certificate_error));
718             }
719         });
720
721         // Get a handle for the progress bar.
722         final ProgressBar progressBar = (ProgressBar) findViewById(R.id.progress_bar);
723
724         mainWebView.setWebChromeClient(new WebChromeClient() {
725             // Update the progress bar when a page is loading.
726             @Override
727             public void onProgressChanged(WebView view, int progress) {
728                 progressBar.setProgress(progress);
729                 if (progress < 100) {
730                     progressBar.setVisibility(View.VISIBLE);
731                 } else {
732                     progressBar.setVisibility(View.GONE);
733
734                     //Stop the `SwipeToRefresh` indicator if it is running
735                     swipeRefreshLayout.setRefreshing(false);
736                 }
737             }
738
739             // Set the favorite icon when it changes.
740             @Override
741             public void onReceivedIcon(WebView view, Bitmap icon) {
742                 // Only update the favorite icon if the website has finished loading.
743                 if (progressBar.getVisibility() == View.GONE) {
744                     // Save a copy of the favorite icon.
745                     favoriteIconBitmap = icon;
746
747                     // Place the favorite icon in the appBar.
748                     favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
749                 }
750             }
751
752             // Save a copy of the title when it changes.
753             @Override
754             public void onReceivedTitle(WebView view, String title) {
755                 // Save a copy of the title.
756                 webViewTitle = title;
757             }
758
759             // Enter full screen video
760             @Override
761             public void onShowCustomView(View view, CustomViewCallback callback) {
762                 // Pause the ad if this is the free flavor.
763                 if (BuildConfig.FLAVOR.contentEquals("free")) {
764                     BannerAd.pauseAd(adView);
765                 }
766
767                 // Remove the translucent overlays.
768                 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
769
770                 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
771                 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
772
773                 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
774                  * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
775                  * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically rehides them after they are shown.
776                  */
777                 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
778
779                 // Set `rootCoordinatorLayout` to fill the entire screen.
780                 rootCoordinatorLayout.setFitsSystemWindows(false);
781
782                 // Add `view` to `fullScreenVideoFrameLayout` and display it on the screen.
783                 fullScreenVideoFrameLayout.addView(view);
784                 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
785             }
786
787             // Exit full screen video
788             public void onHideCustomView() {
789                 // Hide `fullScreenVideoFrameLayout`.
790                 fullScreenVideoFrameLayout.removeAllViews();
791                 fullScreenVideoFrameLayout.setVisibility(View.GONE);
792
793                 // Add the translucent status flag.  This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
794                 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
795
796                 // Set `rootCoordinatorLayout` to fit inside the status and navigation bars.  This also clears the `SYSTEM_UI` flags.
797                 rootCoordinatorLayout.setFitsSystemWindows(true);
798
799                 // Show the ad if this is the free flavor.
800                 if (BuildConfig.FLAVOR.contentEquals("free")) {
801                     // Reload the ad.  Because the screen may have rotated, we need to use `reloadAfterRotate`.
802                     BannerAd.reloadAfterRotate(adView, getApplicationContext(), getString(R.string.ad_id));
803
804                     // Reinitialize the `adView` variable, as the `View` will have been removed and re-added by `BannerAd.reloadAfterRotate()`.
805                     adView = findViewById(R.id.adview);
806                 }
807             }
808         });
809
810         // Register `mainWebView` for a context menu.  This is used to see link targets and download images.
811         registerForContextMenu(mainWebView);
812
813         // Allow the downloading of files.
814         mainWebView.setDownloadListener(new DownloadListener() {
815             @Override
816             public void onDownloadStart(String url, String userAgent, String contentDisposition, String mimetype, long contentLength) {
817                 // Show the `DownloadFileDialog` `AlertDialog` and name this instance `@string/download`.
818                 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(url, contentDisposition, contentLength);
819                 downloadFileDialogFragment.show(getSupportFragmentManager(), getResources().getString(R.string.download));
820             }
821         });
822
823         // Allow pinch to zoom.
824         mainWebView.getSettings().setBuiltInZoomControls(true);
825
826         // Hide zoom controls.
827         mainWebView.getSettings().setDisplayZoomControls(false);
828
829         // Set `mainWebView` to use a wide viewport.  Otherwise, some web pages will be scrunched and some content will render outside the screen.
830         mainWebView.getSettings().setUseWideViewPort(true);
831
832         // Set `mainWebView` to load in overview mode (zoomed out to the maximum width).
833         mainWebView.getSettings().setLoadWithOverviewMode(true);
834
835         // Initialize cookieManager.
836         cookieManager = CookieManager.getInstance();
837
838         // 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).
839         customHeaders.put("X-Requested-With", "");
840
841         // Initialize the default preference values the first time the program is run.  `this` is the context.  `false` keeps this command from resetting any current preferences back to default.
842         PreferenceManager.setDefaultValues(this, R.xml.preferences, false);
843
844         // Get the intent that started the app.
845         final Intent launchingIntent = getIntent();
846
847         // Extract the launching intent data as `launchingIntentUriData`.
848         final Uri launchingIntentUriData = launchingIntent.getData();
849
850         // Convert the launching intent URI data (if it exists) to a string and store it in `formattedUrlString`.
851         if (launchingIntentUriData != null) {
852             formattedUrlString = launchingIntentUriData.toString();
853         }
854
855         // Get a handle for the `Runtime`.
856         privacyBrowserRuntime = Runtime.getRuntime();
857
858         // Store the application's private data directory.
859         privateDataDirectoryString = getApplicationInfo().dataDir;  // `dataDir` will vary, but will be something like `/data/user/0/com.stoutner.privacybrowser.standard`, which links to `/data/data/com.stoutner.privacybrowser.standard`.
860
861         // Initialize `inFullScreenBrowsingMode`, which is always false at this point because Privacy Browser never starts in full screen browsing mode.
862         inFullScreenBrowsingMode = false;
863
864         // Initialize AdView for the free flavor.
865         adView = findViewById(R.id.adview);
866
867         // Initialize the privacy settings variables.
868         javaScriptEnabled = false;
869         firstPartyCookiesEnabled = false;
870         thirdPartyCookiesEnabled = false;
871         domStorageEnabled = false;
872         saveFormDataEnabled = false;
873
874         // Initialize `webViewTitle`.
875         webViewTitle = getString(R.string.no_title);
876
877         // Initialize `favoriteIconBitmap`.  We have to use `ContextCompat` until API >= 21.
878         Drawable favoriteIconDrawable = ContextCompat.getDrawable(getApplicationContext(), R.drawable.world);
879         BitmapDrawable favoriteIconBitmapDrawable = (BitmapDrawable) favoriteIconDrawable;
880         favoriteIconDefaultBitmap = favoriteIconBitmapDrawable.getBitmap();
881
882         // If the favorite icon is null, load the default.
883         if (favoriteIconBitmap == null) {
884             favoriteIconBitmap = favoriteIconDefaultBitmap;
885         }
886
887         // Apply the app settings from the shared preferences.
888         applyAppSettings();
889
890         // Load `formattedUrlString` if we are not waiting for Orbot to connect.
891         if (!waitingForOrbot) {
892             loadUrl(formattedUrlString);
893         }
894     }
895
896
897     @Override
898     protected void onNewIntent(Intent intent) {
899         // Sets the new intent as the activity intent, so that any future `getIntent()`s pick up this one instead of creating a new activity.
900         setIntent(intent);
901
902         if (intent.getData() != null) {
903             // Get the intent data and convert it to a string.
904             final Uri intentUriData = intent.getData();
905             formattedUrlString = intentUriData.toString();
906         }
907
908         // Close the navigation drawer if it is open.
909         if (drawerLayout.isDrawerVisible(GravityCompat.START)) {
910             drawerLayout.closeDrawer(GravityCompat.START);
911         }
912
913         // Load the website.
914         loadUrl(formattedUrlString);
915
916         // Clear the keyboard if displayed and remove the focus on the urlTextBar if it has it.
917         mainWebView.requestFocus();
918     }
919
920     @Override
921     public boolean onCreateOptionsMenu(Menu menu) {
922         // Inflate the menu; this adds items to the action bar if it is present.
923         getMenuInflater().inflate(R.menu.webview_options_menu, menu);
924
925         // Set mainMenu so it can be used by `onOptionsItemSelected()` and `updatePrivacyIcons`.
926         mainMenu = menu;
927
928         // Set the initial status of the privacy icons.  `false` does not call `invalidateOptionsMenu` as the last step.
929         updatePrivacyIcons(false);
930
931         // Get handles for the menu items.
932         MenuItem toggleFirstPartyCookies = menu.findItem(R.id.toggleFirstPartyCookies);
933         MenuItem toggleThirdPartyCookies = menu.findItem(R.id.toggleThirdPartyCookies);
934         MenuItem toggleDomStorage = menu.findItem(R.id.toggleDomStorage);
935         MenuItem toggleSaveFormData = menu.findItem(R.id.toggleSaveFormData);
936
937         // Only display third-party cookies if SDK >= 21
938         toggleThirdPartyCookies.setVisible(Build.VERSION.SDK_INT >= 21);
939
940         // Get the shared preference values.  `this` references the current context.
941         SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
942
943         // Set the status of the additional app bar icons.  The default is `false`.
944         if (sharedPreferences.getBoolean("display_additional_app_bar_icons", false)) {
945             toggleFirstPartyCookies.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
946             toggleDomStorage.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
947             toggleSaveFormData.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
948         } else { //Do not display the additional icons.
949             toggleFirstPartyCookies.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
950             toggleDomStorage.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
951             toggleSaveFormData.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
952         }
953
954         return true;
955     }
956
957     @Override
958     public boolean onPrepareOptionsMenu(Menu menu) {
959         // Get handles for the menu items.
960         MenuItem toggleFirstPartyCookies = menu.findItem(R.id.toggleFirstPartyCookies);
961         MenuItem toggleThirdPartyCookies = menu.findItem(R.id.toggleThirdPartyCookies);
962         MenuItem toggleDomStorage = menu.findItem(R.id.toggleDomStorage);
963         MenuItem toggleSaveFormData = menu.findItem(R.id.toggleSaveFormData);
964         MenuItem clearCookies = menu.findItem(R.id.clearCookies);
965         MenuItem clearFormData = menu.findItem(R.id.clearFormData);
966         MenuItem refreshMenuItem = menu.findItem(R.id.refresh);
967
968         // Set the status of the menu item checkboxes.
969         toggleFirstPartyCookies.setChecked(firstPartyCookiesEnabled);
970         toggleThirdPartyCookies.setChecked(thirdPartyCookiesEnabled);
971         toggleDomStorage.setChecked(domStorageEnabled);
972         toggleSaveFormData.setChecked(saveFormDataEnabled);
973
974         // Enable third-party cookies if first-party cookies are enabled.
975         toggleThirdPartyCookies.setEnabled(firstPartyCookiesEnabled);
976
977         // Enable DOM Storage if JavaScript is enabled.
978         toggleDomStorage.setEnabled(javaScriptEnabled);
979
980         // Enable Clear Cookies if there are any.
981         clearCookies.setEnabled(cookieManager.hasCookies());
982
983         // Enable Clear Form Data is there is any.
984         WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(this);
985         clearFormData.setEnabled(mainWebViewDatabase.hasFormData());
986
987         // Only show `Refresh` if `swipeToRefresh` is disabled.
988         refreshMenuItem.setVisible(!swipeToRefreshEnabled);
989
990         // Initialize font size variables.
991         int fontSize = mainWebView.getSettings().getTextZoom();
992         String fontSizeTitle;
993         MenuItem selectedFontSizeMenuItem;
994
995         // Prepare the font size title and current size menu item.
996         switch (fontSize) {
997             case 25:
998                 fontSizeTitle = getResources().getString(R.string.font_size) + " - " + getResources().getString(R.string.twenty_five_percent);
999                 selectedFontSizeMenuItem = menu.findItem(R.id.fontSizeTwentyFivePercent);
1000                 break;
1001
1002             case 50:
1003                 fontSizeTitle = getResources().getString(R.string.font_size) + " - " + getResources().getString(R.string.fifty_percent);
1004                 selectedFontSizeMenuItem = menu.findItem(R.id.fontSizeFiftyPercent);
1005                 break;
1006
1007             case 75:
1008                 fontSizeTitle = getResources().getString(R.string.font_size) + " - " + getResources().getString(R.string.seventy_five_percent);
1009                 selectedFontSizeMenuItem = menu.findItem(R.id.fontSizeSeventyFivePercent);
1010                 break;
1011
1012             case 100:
1013                 fontSizeTitle = getResources().getString(R.string.font_size) + " - " + getResources().getString(R.string.one_hundred_percent);
1014                 selectedFontSizeMenuItem = menu.findItem(R.id.fontSizeOneHundredPercent);
1015                 break;
1016
1017             case 125:
1018                 fontSizeTitle = getResources().getString(R.string.font_size) + " - " + getResources().getString(R.string.one_hundred_twenty_five_percent);
1019                 selectedFontSizeMenuItem = menu.findItem(R.id.fontSizeOneHundredTwentyFivePercent);
1020                 break;
1021
1022             case 150:
1023                 fontSizeTitle = getResources().getString(R.string.font_size) + " - " + getResources().getString(R.string.one_hundred_fifty_percent);
1024                 selectedFontSizeMenuItem = menu.findItem(R.id.fontSizeOneHundredFiftyPercent);
1025                 break;
1026
1027             case 175:
1028                 fontSizeTitle = getResources().getString(R.string.font_size) + " - " + getResources().getString(R.string.one_hundred_seventy_five_percent);
1029                 selectedFontSizeMenuItem = menu.findItem(R.id.fontSizeOneHundredSeventyFivePercent);
1030                 break;
1031
1032             case 200:
1033                 fontSizeTitle = getResources().getString(R.string.font_size) + " - " + getResources().getString(R.string.two_hundred_percent);
1034                 selectedFontSizeMenuItem = menu.findItem(R.id.fontSizeTwoHundredPercent);
1035                 break;
1036
1037             default:
1038                 fontSizeTitle = getResources().getString(R.string.font_size) + " - " + getResources().getString(R.string.one_hundred_percent);
1039                 selectedFontSizeMenuItem = menu.findItem(R.id.fontSizeOneHundredPercent);
1040                 break;
1041         }
1042
1043         // Set the font size title and select the current size menu item.
1044         MenuItem fontSizeMenuItem = menu.findItem(R.id.fontSize);
1045         fontSizeMenuItem.setTitle(fontSizeTitle);
1046         selectedFontSizeMenuItem.setChecked(true);
1047
1048         // Run all the other default commands.
1049         super.onPrepareOptionsMenu(menu);
1050
1051         // `return true` displays the menu.
1052         return true;
1053     }
1054
1055     @Override
1056     // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
1057     @SuppressLint("SetJavaScriptEnabled")
1058     // removeAllCookies is deprecated, but it is required for API < 21.
1059     @SuppressWarnings("deprecation")
1060     public boolean onOptionsItemSelected(MenuItem menuItem) {
1061         int menuItemId = menuItem.getItemId();
1062
1063         // Set the commands that relate to the menu entries.
1064         switch (menuItemId) {
1065             case R.id.toggleJavaScript:
1066                 // Switch the status of javaScriptEnabled.
1067                 javaScriptEnabled = !javaScriptEnabled;
1068
1069                 // Apply the new JavaScript status.
1070                 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
1071
1072                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1073                 updatePrivacyIcons(true);
1074
1075                 // Display a `Snackbar`.
1076                 if (javaScriptEnabled) {  // JavaScrip is enabled.
1077                     Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show();
1078                 } else if (firstPartyCookiesEnabled) {  // JavaScript is disabled, but first-party cookies are enabled.
1079                     Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show();
1080                 } else {  // Privacy mode.
1081                     Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1082                 }
1083
1084                 // Reload the WebView.
1085                 mainWebView.reload();
1086                 return true;
1087
1088             case R.id.toggleFirstPartyCookies:
1089                 // Switch the status of firstPartyCookiesEnabled.
1090                 firstPartyCookiesEnabled = !firstPartyCookiesEnabled;
1091
1092                 // Update the menu checkbox.
1093                 menuItem.setChecked(firstPartyCookiesEnabled);
1094
1095                 // Apply the new cookie status.
1096                 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
1097
1098                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1099                 updatePrivacyIcons(true);
1100
1101                 // Display a `Snackbar`.
1102                 if (firstPartyCookiesEnabled) {  // First-party cookies are enabled.
1103                     Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1104                 } else if (javaScriptEnabled){  // JavaScript is still enabled.
1105                     Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1106                 } else {  // Privacy mode.
1107                     Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1108                 }
1109
1110                 // Reload the WebView.
1111                 mainWebView.reload();
1112                 return true;
1113
1114             case R.id.toggleThirdPartyCookies:
1115                 if (Build.VERSION.SDK_INT >= 21) {
1116                     // Switch the status of thirdPartyCookiesEnabled.
1117                     thirdPartyCookiesEnabled = !thirdPartyCookiesEnabled;
1118
1119                     // Update the menu checkbox.
1120                     menuItem.setChecked(thirdPartyCookiesEnabled);
1121
1122                     // Apply the new cookie status.
1123                     cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
1124
1125                     // Display a `Snackbar`.
1126                     if (thirdPartyCookiesEnabled) {
1127                         Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1128                     } else {
1129                         Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1130                     }
1131
1132                     // Reload the WebView.
1133                     mainWebView.reload();
1134                 } // Else do nothing because SDK < 21.
1135                 return true;
1136
1137             case R.id.toggleDomStorage:
1138                 // Switch the status of domStorageEnabled.
1139                 domStorageEnabled = !domStorageEnabled;
1140
1141                 // Update the menu checkbox.
1142                 menuItem.setChecked(domStorageEnabled);
1143
1144                 // Apply the new DOM Storage status.
1145                 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
1146
1147                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1148                 updatePrivacyIcons(true);
1149
1150                 // Display a `Snackbar`.
1151                 if (domStorageEnabled) {
1152                     Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show();
1153                 } else {
1154                     Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show();
1155                 }
1156
1157                 // Reload the WebView.
1158                 mainWebView.reload();
1159                 return true;
1160
1161             case R.id.toggleSaveFormData:
1162                 // Switch the status of saveFormDataEnabled.
1163                 saveFormDataEnabled = !saveFormDataEnabled;
1164
1165                 // Update the menu checkbox.
1166                 menuItem.setChecked(saveFormDataEnabled);
1167
1168                 // Apply the new form data status.
1169                 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
1170
1171                 // Display a `Snackbar`.
1172                 if (saveFormDataEnabled) {
1173                     Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show();
1174                 } else {
1175                     Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show();
1176                 }
1177
1178                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1179                 updatePrivacyIcons(true);
1180
1181                 // Reload the WebView.
1182                 mainWebView.reload();
1183                 return true;
1184
1185             case R.id.clearCookies:
1186                 if (Build.VERSION.SDK_INT < 21) {
1187                     cookieManager.removeAllCookie();
1188                 } else {
1189                     cookieManager.removeAllCookies(null);
1190                 }
1191                 Snackbar.make(findViewById(R.id.main_webview), R.string.cookies_deleted, Snackbar.LENGTH_SHORT).show();
1192                 return true;
1193
1194             case R.id.clearDomStorage:
1195                 WebStorage webStorage = WebStorage.getInstance();
1196                 webStorage.deleteAllData();
1197                 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_deleted, Snackbar.LENGTH_SHORT).show();
1198                 return true;
1199
1200             case R.id.clearFormData:
1201                 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(this);
1202                 mainWebViewDatabase.clearFormData();
1203                 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_deleted, Snackbar.LENGTH_SHORT).show();
1204                 return true;
1205
1206             case R.id.fontSizeTwentyFivePercent:
1207                 mainWebView.getSettings().setTextZoom(25);
1208                 return true;
1209
1210             case R.id.fontSizeFiftyPercent:
1211                 mainWebView.getSettings().setTextZoom(50);
1212                 return true;
1213
1214             case R.id.fontSizeSeventyFivePercent:
1215                 mainWebView.getSettings().setTextZoom(75);
1216                 return true;
1217
1218             case R.id.fontSizeOneHundredPercent:
1219                 mainWebView.getSettings().setTextZoom(100);
1220                 return true;
1221
1222             case R.id.fontSizeOneHundredTwentyFivePercent:
1223                 mainWebView.getSettings().setTextZoom(125);
1224                 return true;
1225
1226             case R.id.fontSizeOneHundredFiftyPercent:
1227                 mainWebView.getSettings().setTextZoom(150);
1228                 return true;
1229
1230             case R.id.fontSizeOneHundredSeventyFivePercent:
1231                 mainWebView.getSettings().setTextZoom(175);
1232                 return true;
1233
1234             case R.id.fontSizeTwoHundredPercent:
1235                 mainWebView.getSettings().setTextZoom(200);
1236                 return true;
1237
1238             case R.id.share:
1239                 Intent shareIntent = new Intent();
1240                 shareIntent.setAction(Intent.ACTION_SEND);
1241                 shareIntent.putExtra(Intent.EXTRA_TEXT, urlTextBox.getText().toString());
1242                 shareIntent.setType("text/plain");
1243                 startActivity(Intent.createChooser(shareIntent, "Share URL"));
1244                 return true;
1245
1246             case R.id.find_on_page:
1247                 // Hide the URL app bar.
1248                 supportAppBar.setVisibility(View.GONE);
1249
1250                 // Show the Find on Page `RelativeLayout`.
1251                 findOnPageLinearLayout.setVisibility(View.VISIBLE);
1252
1253                 // Display the keyboard.  We have to wait 200 ms before running the command to work around a bug in Android.
1254                 // http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
1255                 findOnPageEditText.postDelayed(new Runnable()
1256                 {
1257                     @Override
1258                     public void run()
1259                     {
1260                         // Set the focus on `findOnPageEditText`.
1261                         findOnPageEditText.requestFocus();
1262
1263                         // Display the keyboard.
1264                         inputMethodManager.showSoftInput(findOnPageEditText, 0);
1265                     }
1266                 }, 200);
1267                 return true;
1268
1269             case R.id.refresh:
1270                 mainWebView.reload();
1271                 return true;
1272
1273             case R.id.print:
1274                 // Get a `PrintManager` instance.
1275                 PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
1276
1277                 // Convert `mainWebView` to `printDocumentAdapter`.
1278                 PrintDocumentAdapter printDocumentAdapter = mainWebView.createPrintDocumentAdapter();
1279
1280                 // Print the document.  The print attributes are `null`.
1281                 printManager.print(getResources().getString(R.string.privacy_browser_web_page), printDocumentAdapter, null);
1282                 return true;
1283
1284             case R.id.addToHomescreen:
1285                 // Show the `CreateHomeScreenShortcutDialog` `AlertDialog` and name this instance `R.string.create_shortcut`.
1286                 AppCompatDialogFragment createHomeScreenShortcutDialogFragment = new CreateHomeScreenShortcutDialog();
1287                 createHomeScreenShortcutDialogFragment.show(getSupportFragmentManager(), getResources().getString(R.string.create_shortcut));
1288
1289                 //Everything else will be handled by `CreateHomeScreenShortcutDialog` and the associated listener below.
1290                 return true;
1291
1292             default:
1293                 // Don't consume the event.
1294                 return super.onOptionsItemSelected(menuItem);
1295         }
1296     }
1297
1298     // removeAllCookies is deprecated, but it is required for API < 21.
1299     @SuppressWarnings("deprecation")
1300     @Override
1301     public boolean onNavigationItemSelected(@NonNull MenuItem menuItem) {
1302         int menuItemId = menuItem.getItemId();
1303
1304         switch (menuItemId) {
1305             case R.id.home:
1306                 loadUrl(homepage);
1307                 break;
1308
1309             case R.id.back:
1310                 if (mainWebView.canGoBack()) {
1311                     // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
1312                     navigatingHistory = true;
1313
1314                     // Load the previous website in the history.
1315                     mainWebView.goBack();
1316                 }
1317                 break;
1318
1319             case R.id.forward:
1320                 if (mainWebView.canGoForward()) {
1321                     // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
1322                     navigatingHistory = true;
1323
1324                     // Load the next website in the history.
1325                     mainWebView.goForward();
1326                 }
1327                 break;
1328
1329             case R.id.history:
1330                 // Get the `WebBackForwardList`.
1331                 WebBackForwardList webBackForwardList = mainWebView.copyBackForwardList();
1332
1333                 // Show the `UrlHistoryDialog` `AlertDialog` and name this instance `R.string.history`.  `this` is the `Context`.
1334                 AppCompatDialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(this, webBackForwardList);
1335                 urlHistoryDialogFragment.show(getSupportFragmentManager(), getResources().getString(R.string.history));
1336                 break;
1337
1338             case R.id.bookmarks:
1339                 // Launch BookmarksActivity.
1340                 Intent bookmarksIntent = new Intent(this, BookmarksActivity.class);
1341                 startActivity(bookmarksIntent);
1342                 break;
1343
1344             case R.id.downloads:
1345                 // Launch the system Download Manager.
1346                 Intent downloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
1347
1348                 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
1349                 downloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1350
1351                 startActivity(downloadManagerIntent);
1352                 break;
1353
1354             case R.id.settings:
1355                 // Reset `currentDomainName` so that domain settings are reapplied after returning to `MainWebViewActivity`.
1356                 currentDomainName = "";
1357
1358                 // Launch `SettingsActivity`.
1359                 Intent settingsIntent = new Intent(this, SettingsActivity.class);
1360                 startActivity(settingsIntent);
1361                 break;
1362
1363             case R.id.domains:
1364                 // Reset `currentDomainName` so that domain settings are reapplied after returning to `MainWebViewActivity`.
1365                 currentDomainName = "";
1366
1367                 // Launch `DomainsActivity`.
1368                 Intent domainsIntent = new Intent(this, DomainsActivity.class);
1369                 startActivity(domainsIntent);
1370                 break;
1371
1372             case R.id.guide:
1373                 // Launch `GuideActivity`.
1374                 Intent guideIntent = new Intent(this, GuideActivity.class);
1375                 startActivity(guideIntent);
1376                 break;
1377
1378             case R.id.about:
1379                 // Launch `AboutActivity`.
1380                 Intent aboutIntent = new Intent(this, AboutActivity.class);
1381                 startActivity(aboutIntent);
1382                 break;
1383
1384             case R.id.clearAndExit:
1385                 // Clear cookies.  The commands changed slightly in API 21.
1386                 if (Build.VERSION.SDK_INT >= 21) {
1387                     cookieManager.removeAllCookies(null);
1388                 } else {
1389                     cookieManager.removeAllCookie();
1390                 }
1391
1392                 // Clear DOM storage.
1393                 WebStorage domStorage = WebStorage.getInstance();
1394                 domStorage.deleteAllData();
1395
1396                 // Clear form data.
1397                 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
1398                 webViewDatabase.clearFormData();
1399
1400                 // Clear the cache.  `true` includes disk files.
1401                 mainWebView.clearCache(true);
1402
1403                 // Clear the back/forward history.
1404                 mainWebView.clearHistory();
1405
1406                 // Clear any SSL certificate preferences.
1407                 mainWebView.clearSslPreferences();
1408
1409                 // Clear `formattedUrlString`.
1410                 formattedUrlString = null;
1411
1412                 // Clear `customHeaders`.
1413                 customHeaders.clear();
1414
1415                 // Detach all views from `mainWebViewRelativeLayout`.
1416                 mainWebViewRelativeLayout.removeAllViews();
1417
1418                 // Destroy the internal state of `mainWebView`.
1419                 mainWebView.destroy();
1420
1421                 // Manually delete cache folders.
1422                 try {
1423                     // Delete the main `cache` folder.
1424                     privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
1425
1426                     // Delete the `app_webview` folder, which contains an additional `WebView` cache.  See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
1427                     privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
1428                 } catch (IOException e) {
1429                     // Do nothing if an error is thrown.
1430                 }
1431
1432                 // Close Privacy Browser.  `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
1433                 if (Build.VERSION.SDK_INT >= 21) {
1434                     finishAndRemoveTask();
1435                 } else {
1436                     finish();
1437                 }
1438
1439                 // Remove the terminated program from RAM.  The status code is `0`.
1440                 System.exit(0);
1441                 break;
1442
1443             default:
1444                 break;
1445         }
1446
1447         // Close the navigation drawer.
1448         drawerLayout.closeDrawer(GravityCompat.START);
1449         return true;
1450     }
1451
1452     @Override
1453     public void onPostCreate(Bundle savedInstanceState) {
1454         super.onPostCreate(savedInstanceState);
1455
1456         // Sync the state of the DrawerToggle after onRestoreInstanceState has finished.
1457         drawerToggle.syncState();
1458     }
1459
1460     @Override
1461     public void onConfigurationChanged(Configuration newConfig) {
1462         super.onConfigurationChanged(newConfig);
1463
1464         // Reload the ad for the free flavor if we are not in full screen mode.
1465         if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
1466             // Reload the ad.
1467             BannerAd.reloadAfterRotate(adView, getApplicationContext(), getString(R.string.ad_id));
1468
1469             // Reinitialize the `adView` variable, as the `View` will have been removed and re-added by `BannerAd.reloadAfterRotate()`.
1470             adView = findViewById(R.id.adview);
1471         }
1472
1473         // `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:  https://code.google.com/p/android/issues/detail?id=20493#c8
1474         // ActivityCompat.invalidateOptionsMenu(this);
1475     }
1476
1477     @Override
1478     public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
1479         // Store the `HitTestResult`.
1480         final WebView.HitTestResult hitTestResult = mainWebView.getHitTestResult();
1481
1482         // Create strings.
1483         final String imageUrl;
1484         final String linkUrl;
1485
1486         // Get a handle for the `ClipboardManager`.
1487         final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
1488
1489         switch (hitTestResult.getType()) {
1490             // `SRC_ANCHOR_TYPE` is a link.
1491             case WebView.HitTestResult.SRC_ANCHOR_TYPE:
1492                 // Get the target URL.
1493                 linkUrl = hitTestResult.getExtra();
1494
1495                 // Set the target URL as the title of the `ContextMenu`.
1496                 menu.setHeaderTitle(linkUrl);
1497
1498                 // Add a `Load URL` entry.
1499                 menu.add(R.string.load_url).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1500                     @Override
1501                     public boolean onMenuItemClick(MenuItem item) {
1502                         loadUrl(linkUrl);
1503                         return false;
1504                     }
1505                 });
1506
1507                 // Add a `Copy URL` entry.
1508                 menu.add(R.string.copy_url).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1509                     @Override
1510                     public boolean onMenuItemClick(MenuItem item) {
1511                         // Save the link URL in a `ClipData`.
1512                         ClipData srcAnchorTypeClipData = ClipData.newPlainText(getResources().getString(R.string.url), linkUrl);
1513
1514                         // Set the `ClipData` as the clipboard's primary clip.
1515                         clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
1516                         return false;
1517                     }
1518                 });
1519
1520                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
1521                 menu.add(R.string.cancel);
1522                 break;
1523
1524             case WebView.HitTestResult.EMAIL_TYPE:
1525                 // Get the target URL.
1526                 linkUrl = hitTestResult.getExtra();
1527
1528                 // Set the target URL as the title of the `ContextMenu`.
1529                 menu.setHeaderTitle(linkUrl);
1530
1531                 // Add a `Write Email` entry.
1532                 menu.add(R.string.write_email).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1533                     @Override
1534                     public boolean onMenuItemClick(MenuItem item) {
1535                         // We use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
1536                         Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
1537
1538                         // Parse the url and set it as the data for the `Intent`.
1539                         emailIntent.setData(Uri.parse("mailto:" + linkUrl));
1540
1541                         // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
1542                         emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1543
1544                         // Make it so.
1545                         startActivity(emailIntent);
1546                         return false;
1547                     }
1548                 });
1549
1550                 // Add a `Copy Email Address` entry.
1551                 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1552                     @Override
1553                     public boolean onMenuItemClick(MenuItem item) {
1554                         // Save the email address in a `ClipData`.
1555                         ClipData srcEmailTypeClipData = ClipData.newPlainText(getResources().getString(R.string.email_address), linkUrl);
1556
1557                         // Set the `ClipData` as the clipboard's primary clip.
1558                         clipboardManager.setPrimaryClip(srcEmailTypeClipData);
1559                         return false;
1560                     }
1561                 });
1562
1563                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
1564                 menu.add(R.string.cancel);
1565                 break;
1566
1567             // `IMAGE_TYPE` is an image.
1568             case WebView.HitTestResult.IMAGE_TYPE:
1569                 // Get the image URL.
1570                 imageUrl = hitTestResult.getExtra();
1571
1572                 // Set the image URL as the title of the `ContextMenu`.
1573                 menu.setHeaderTitle(imageUrl);
1574
1575                 // Add a `View Image` entry.
1576                 menu.add(R.string.view_image).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1577                     @Override
1578                     public boolean onMenuItemClick(MenuItem item) {
1579                         loadUrl(imageUrl);
1580                         return false;
1581                     }
1582                 });
1583
1584                 // Add a `Download Image` entry.
1585                 menu.add(R.string.download_image).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1586                     @Override
1587                     public boolean onMenuItemClick(MenuItem item) {
1588                         // Show the `DownloadImageDialog` `AlertDialog` and name this instance `@string/download`.
1589                         AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
1590                         downloadImageDialogFragment.show(getSupportFragmentManager(), getResources().getString(R.string.download));
1591                         return false;
1592                     }
1593                 });
1594
1595                 // Add a `Copy URL` entry.
1596                 menu.add(R.string.copy_url).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1597                     @Override
1598                     public boolean onMenuItemClick(MenuItem item) {
1599                         // Save the image URL in a `ClipData`.
1600                         ClipData srcImageTypeClipData = ClipData.newPlainText(getResources().getString(R.string.url), imageUrl);
1601
1602                         // Set the `ClipData` as the clipboard's primary clip.
1603                         clipboardManager.setPrimaryClip(srcImageTypeClipData);
1604                         return false;
1605                     }
1606                 });
1607
1608                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
1609                 menu.add(R.string.cancel);
1610                 break;
1611
1612
1613             // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
1614             case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
1615                 // Get the image URL.
1616                 imageUrl = hitTestResult.getExtra();
1617
1618                 // Set the image URL as the title of the `ContextMenu`.
1619                 menu.setHeaderTitle(imageUrl);
1620
1621                 // Add a `View Image` entry.
1622                 menu.add(R.string.view_image).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1623                     @Override
1624                     public boolean onMenuItemClick(MenuItem item) {
1625                         loadUrl(imageUrl);
1626                         return false;
1627                     }
1628                 });
1629
1630                 // Add a `Download Image` entry.
1631                 menu.add(R.string.download_image).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1632                     @Override
1633                     public boolean onMenuItemClick(MenuItem item) {
1634                         // Show the `DownloadImageDialog` `AlertDialog` and name this instance `@string/download`.
1635                         AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
1636                         downloadImageDialogFragment.show(getSupportFragmentManager(), getResources().getString(R.string.download));
1637                         return false;
1638                     }
1639                 });
1640
1641                 // Add a `Copy URL` entry.
1642                 menu.add(R.string.copy_url).setOnMenuItemClickListener(new MenuItem.OnMenuItemClickListener() {
1643                     @Override
1644                     public boolean onMenuItemClick(MenuItem item) {
1645                         // Save the image URL in a `ClipData`.
1646                         ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getResources().getString(R.string.url), imageUrl);
1647
1648                         // Set the `ClipData` as the clipboard's primary clip.
1649                         clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
1650                         return false;
1651                     }
1652                 });
1653
1654                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
1655                 menu.add(R.string.cancel);
1656                 break;
1657         }
1658     }
1659
1660     @Override
1661     public void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment) {
1662         // Get shortcutNameEditText from the alert dialog.
1663         EditText shortcutNameEditText = (EditText) dialogFragment.getDialog().findViewById(R.id.shortcut_name_edittext);
1664
1665         // Create the bookmark shortcut based on formattedUrlString.
1666         Intent bookmarkShortcut = new Intent();
1667         bookmarkShortcut.setAction(Intent.ACTION_VIEW);
1668         bookmarkShortcut.setData(Uri.parse(formattedUrlString));
1669
1670         // Place the bookmark shortcut on the home screen.
1671         Intent placeBookmarkShortcut = new Intent();
1672         placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.INTENT", bookmarkShortcut);
1673         placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.NAME", shortcutNameEditText.getText().toString());
1674         placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.ICON", favoriteIconBitmap);
1675         placeBookmarkShortcut.setAction("com.android.launcher.action.INSTALL_SHORTCUT");
1676         sendBroadcast(placeBookmarkShortcut);
1677     }
1678
1679     @Override
1680     public void onDownloadImage(AppCompatDialogFragment dialogFragment, String imageUrl) {
1681         // Download the image if it has an HTTP or HTTPS URI.
1682         if (imageUrl.startsWith("http")) {
1683             // Get a handle for the system `DOWNLOAD_SERVICE`.
1684             DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
1685
1686             // Parse `imageUrl`.
1687             DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(imageUrl));
1688
1689             // Pass cookies to download manager if cookies are enabled.  This is required to download images from websites that require a login.
1690             if (firstPartyCookiesEnabled) {
1691                 // Get the cookies for `imageUrl`.
1692                 String cookies = cookieManager.getCookie(imageUrl);
1693
1694                 // Add the cookies to `downloadRequest`.  In the HTTP request header, cookies are named `Cookie`.
1695                 downloadRequest.addRequestHeader("Cookie", cookies);
1696             }
1697
1698             // Get the file name from `dialogFragment`.
1699             EditText downloadImageNameEditText = (EditText) dialogFragment.getDialog().findViewById(R.id.download_image_name);
1700             String imageName = downloadImageNameEditText.getText().toString();
1701
1702             // Once we have `WRITE_EXTERNAL_STORAGE` permissions we can use `setDestinationInExternalPublicDir`.
1703             if (Build.VERSION.SDK_INT >= 23) { // If API >= 23, set the download save in the the `DIRECTORY_DOWNLOADS` using `imageName`.
1704                 downloadRequest.setDestinationInExternalFilesDir(this, "/", imageName);
1705             } else { // Only set the title using `imageName`.
1706                 downloadRequest.setTitle(imageName);
1707             }
1708
1709             // Allow `MediaScanner` to index the download if it is a media file.
1710             downloadRequest.allowScanningByMediaScanner();
1711
1712             // Add the URL as the description for the download.
1713             downloadRequest.setDescription(imageUrl);
1714
1715             // Show the download notification after the download is completed.
1716             downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
1717
1718             // Initiate the download.
1719             downloadManager.enqueue(downloadRequest);
1720         } else {  // The image is not an HTTP or HTTPS URI.
1721             Snackbar.make(mainWebView, R.string.cannot_download_image, Snackbar.LENGTH_INDEFINITE).show();
1722         }
1723     }
1724
1725     @Override
1726     public void onDownloadFile(AppCompatDialogFragment dialogFragment, String downloadUrl) {
1727         // Download the file if it has an HTTP or HTTPS URI.
1728         if (downloadUrl.startsWith("http")) {
1729
1730             // Get a handle for the system `DOWNLOAD_SERVICE`.
1731             DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
1732
1733             // Parse `downloadUrl`.
1734             DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(downloadUrl));
1735
1736             // Pass cookies to download manager if cookies are enabled.  This is required to download files from websites that require a login.
1737             if (firstPartyCookiesEnabled) {
1738                 // Get the cookies for `downloadUrl`.
1739                 String cookies = cookieManager.getCookie(downloadUrl);
1740
1741                 // Add the cookies to `downloadRequest`.  In the HTTP request header, cookies are named `Cookie`.
1742                 downloadRequest.addRequestHeader("Cookie", cookies);
1743             }
1744
1745             // Get the file name from `dialogFragment`.
1746             EditText downloadFileNameEditText = (EditText) dialogFragment.getDialog().findViewById(R.id.download_file_name);
1747             String fileName = downloadFileNameEditText.getText().toString();
1748
1749             // Once we have `WRITE_EXTERNAL_STORAGE` permissions we can use `setDestinationInExternalPublicDir`.
1750             if (Build.VERSION.SDK_INT >= 23) { // If API >= 23, set the download location to `/sdcard/Android/data/com.stoutner.privacybrowser.standard/files` named `fileName`.
1751                 downloadRequest.setDestinationInExternalFilesDir(this, "/", fileName);
1752             } else { // Only set the title using `fileName`.
1753                 downloadRequest.setTitle(fileName);
1754             }
1755
1756             // Allow `MediaScanner` to index the download if it is a media file.
1757             downloadRequest.allowScanningByMediaScanner();
1758
1759             // Add the URL as the description for the download.
1760             downloadRequest.setDescription(downloadUrl);
1761
1762             // Show the download notification after the download is completed.
1763             downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
1764
1765             // Initiate the download.
1766             downloadManager.enqueue(downloadRequest);
1767         } else {  // The download is not an HTTP or HTTPS URI.
1768             Snackbar.make(mainWebView, R.string.cannot_download_file, Snackbar.LENGTH_INDEFINITE).show();
1769         }
1770     }
1771
1772     public void viewSslCertificate(View view) {
1773         // Show the `ViewSslCertificateDialog` `AlertDialog` and name this instance `@string/view_ssl_certificate`.
1774         DialogFragment viewSslCertificateDialogFragment = new ViewSslCertificateDialog();
1775         viewSslCertificateDialogFragment.show(getFragmentManager(), getResources().getString(R.string.view_ssl_certificate));
1776     }
1777
1778     @Override
1779     public void onSslErrorCancel() {
1780         sslErrorHandler.cancel();
1781     }
1782
1783     @Override
1784     public void onSslErrorProceed() {
1785         sslErrorHandler.proceed();
1786     }
1787
1788     @Override
1789     public void onUrlHistoryEntrySelected(int moveBackOrForwardSteps) {
1790         // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
1791         navigatingHistory = true;
1792
1793         // Load the history entry.
1794         mainWebView.goBackOrForward(moveBackOrForwardSteps);
1795     }
1796
1797     @Override
1798     public void onClearHistory() {
1799         // Clear the history.
1800         mainWebView.clearHistory();
1801     }
1802
1803     // Override `onBackPressed` to handle the navigation drawer and `mainWebView`.
1804     @Override
1805     public void onBackPressed() {
1806         // Close the navigation drawer if it is available.  GravityCompat.START is the drawer on the left on Left-to-Right layout text.
1807         if (drawerLayout.isDrawerVisible(GravityCompat.START)) {
1808             drawerLayout.closeDrawer(GravityCompat.START);
1809         } else {
1810             // Load the previous URL if available.
1811             if (mainWebView.canGoBack()) {
1812                 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
1813                 navigatingHistory = true;
1814
1815                 // Go back.
1816                 mainWebView.goBack();
1817             } else {
1818                 // Pass `onBackPressed()` to the system.
1819                 super.onBackPressed();
1820             }
1821         }
1822     }
1823
1824     @Override
1825     public void onPause() {
1826         // Pause `mainWebView`.
1827         mainWebView.onPause();
1828
1829         // Stop all JavaScript.
1830         mainWebView.pauseTimers();
1831
1832         // Pause the adView or it will continue to consume resources in the background on the free flavor.
1833         if (BuildConfig.FLAVOR.contentEquals("free")) {
1834             BannerAd.pauseAd(adView);
1835         }
1836
1837         super.onPause();
1838     }
1839
1840     @Override
1841     public void onResume() {  // `onResume()` also runs every time the app starts after `onCreate()` and `onStart()`.
1842         super.onResume();
1843
1844         // Resume JavaScript (if enabled).
1845         mainWebView.resumeTimers();
1846
1847         // Resume `mainWebView`.
1848         mainWebView.onResume();
1849
1850         // Resume the adView for the free flavor.
1851         if (BuildConfig.FLAVOR.contentEquals("free")) {
1852             BannerAd.resumeAd(adView);
1853         }
1854     }
1855
1856     @Override
1857     public void onRestart() {
1858         super.onRestart();
1859
1860         // Apply the settings from shared preferences, which might have been changed in `SettingsActivity`.
1861         applyAppSettings();
1862
1863         // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1864         updatePrivacyIcons(true);
1865
1866     }
1867
1868     private void loadUrlFromTextBox() throws UnsupportedEncodingException {
1869         // Get the text from urlTextBox and convert it to a string.  trim() removes white spaces from the beginning and end of the string.
1870         String unformattedUrlString = urlTextBox.getText().toString().trim();
1871
1872         // Check to see if `unformattedUrlString` is a valid URL.  Otherwise, convert it into a search.
1873         if ((Patterns.WEB_URL.matcher(unformattedUrlString).matches()) || (unformattedUrlString.startsWith("http://")) || (unformattedUrlString.startsWith("https://"))) {
1874             // Add `http://` at the beginning if it is missing.  Otherwise the app will segfault.
1875             if (!unformattedUrlString.startsWith("http")) {
1876                 unformattedUrlString = "http://" + unformattedUrlString;
1877             }
1878
1879             // Initialize `unformattedUrl`.
1880             URL unformattedUrl = null;
1881
1882             // 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.
1883             try {
1884                 unformattedUrl = new URL(unformattedUrlString);
1885             } catch (MalformedURLException e) {
1886                 e.printStackTrace();
1887             }
1888
1889             // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if `.get` was called on a `null` value.
1890             final String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
1891             final String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
1892             final String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
1893             final String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
1894             final String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
1895
1896             // Build the URI.
1897             Uri.Builder formattedUri = new Uri.Builder();
1898             formattedUri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
1899
1900             // Decode `formattedUri` as a `String` in `UTF-8`.
1901             formattedUrlString = URLDecoder.decode(formattedUri.build().toString(), "UTF-8");
1902         } else {
1903             // Sanitize the search input and convert it to a search.
1904             final String encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
1905
1906             // Add the base search URL.
1907             formattedUrlString = searchURL + encodedUrlString;
1908         }
1909
1910         loadUrl(formattedUrlString);
1911
1912         // Hide the keyboard so we can see the webpage.  `0` indicates no additional flags.
1913         inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
1914     }
1915
1916
1917     private void loadUrl(String url) {
1918         // Apply any custom domain settings.
1919         applyDomainSettings(url);
1920
1921         // Load the URL.
1922         mainWebView.loadUrl(url, customHeaders);
1923     }
1924
1925     // We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
1926     @SuppressWarnings("deprecation")
1927     private void applyDomainSettings(String url) {
1928         // Reset `navigatingHistory`.
1929         navigatingHistory = false;
1930
1931         // Parse the URL into a URI.
1932         Uri uri = Uri.parse(url);
1933
1934         // Extract the domain from `uri`.
1935         String hostName = uri.getHost();
1936
1937         // Initialize `loadingNewDomainName`.
1938         boolean loadingNewDomainName;
1939
1940         // If either `hostName` or `currentDomainName` are `null`, run the options for loading a new domain name.
1941         // The lint suggestion to simplify the `if` statement is incorrect, because `hostName.equals(currentDomainName)` can produce a `null object reference.`
1942         //noinspection SimplifiableIfStatement
1943         if ((hostName == null) || (currentDomainName == null)) {
1944             loadingNewDomainName = true;
1945         } else {  // Determine if `hostName` equals `currentDomainName`.
1946             loadingNewDomainName = !hostName.equals(currentDomainName);
1947         }
1948
1949         // Only apply the domain settings if we are loading a new domain.  This allows the user to set temporary settings for JavaScript, cookies, DOM storage, etc.
1950         if (loadingNewDomainName) {
1951             // Set the new `hostname` as the `currentDomainName`.
1952             currentDomainName = hostName;
1953
1954             // Reset `favoriteIconBitmap` and display it in the `appbar`.
1955             favoriteIconBitmap = favoriteIconDefaultBitmap;
1956             favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(favoriteIconBitmap, 64, 64, true));
1957
1958             // Initialize the database handler.  `this` specifies the context.  The two `nulls` do not specify the database name or a `CursorFactory`.
1959             // The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
1960             DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
1961
1962             // Get a full cursor from `domainsDatabaseHelper`.
1963             Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain();
1964
1965             // Initialize `domainSettingsSet`.
1966             Set<String> domainSettingsSet = new HashSet<>();
1967
1968             // Get the domain name column index.
1969             int domainNameColumnIndex = domainNameCursor.getColumnIndex(DomainsDatabaseHelper.DOMAIN_NAME);
1970
1971             // Populate `domainSettingsSet`.
1972             for (int i = 0; i < domainNameCursor.getCount(); i++) {
1973                 // Move `domainsCursor` to the current row.
1974                 domainNameCursor.moveToPosition(i);
1975
1976                 // Store the domain name in `domainSettingsSet`.
1977                 domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex));
1978             }
1979
1980             // Close `domainNameCursor.
1981             domainNameCursor.close();
1982
1983             // Initialize variables to track if this domain has stored domain settings, and if so, under which name.
1984             boolean hostHasDomainSettings = false;
1985             String domainNameInDatabase = null;
1986
1987             // Check the hostname.
1988             if (domainSettingsSet.contains(hostName)) {
1989                 hostHasDomainSettings = true;
1990                 domainNameInDatabase = hostName;
1991             }
1992
1993             // If `hostName` is not `null`, check all the subdomains of `hostName` against wildcard domains in `domainCursor`.
1994             if (hostName != null) {
1995                 while (hostName.contains(".") && !hostHasDomainSettings) {  // Stop checking if we run out of  `.` or if we already know that `hostHasDomainSettings` is `true`.
1996                     if (domainSettingsSet.contains("*." + hostName)) {  // Check the host name prepended by `*.`.
1997                         hostHasDomainSettings = true;
1998                         domainNameInDatabase = "*." + hostName;
1999                     }
2000
2001                     // Strip out the lowest subdomain of `host`.
2002                     hostName = hostName.substring(hostName.indexOf(".") + 1);
2003                 }
2004             }
2005
2006             if (hostHasDomainSettings) {  // The url we are loading has custom domain settings.
2007                 // Get a cursor for the current host and move it to the first position.
2008                 Cursor currentHostDomainSettingsCursor = domainsDatabaseHelper.getCursorForDomainName(domainNameInDatabase);
2009                 currentHostDomainSettingsCursor.moveToFirst();
2010
2011                 // Get the settings from the cursor.
2012                 javaScriptEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1);
2013                 firstPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FIRST_PARTY_COOKIES)) == 1);
2014                 thirdPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_THIRD_PARTY_COOKIES)) == 1);
2015                 domStorageEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1);
2016                 saveFormDataEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1);
2017                 String userAgentString = (currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.USER_AGENT)));
2018                 int fontSize = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.FONT_SIZE)));
2019
2020                 // Close `currentHostDomainSettingsCursor`.
2021                 currentHostDomainSettingsCursor.close();
2022
2023                 // Apply the domain settings.
2024                 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
2025                 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
2026                 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
2027                 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
2028                 mainWebView.getSettings().setTextZoom(fontSize);
2029
2030                 // Set third-party cookies status if API >= 21.
2031                 if (Build.VERSION.SDK_INT >= 21) {
2032                     cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
2033                 }
2034
2035                 // Set the user agent.
2036                 if (userAgentString.equals("WebView default user agent")) {
2037                     // Set the user agent to `""`, which uses the default value.
2038                     mainWebView.getSettings().setUserAgentString("");
2039                 } else {
2040                     // Use the selected user agent.
2041                     mainWebView.getSettings().setUserAgentString(userAgentString);
2042                 }
2043
2044                 // Set a green background on `urlTextBox` to indicate that custom domain settings are being used.  We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
2045                 urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_green));
2046             } else {  // The URL we are loading does not have custom domain settings.  Load the defaults.
2047                 // Get the shared preference values.  `this` references the current context.
2048                 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2049
2050                 // Store the values from `sharedPreferences` in variables.
2051                 javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
2052                 firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
2053                 thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
2054                 domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
2055                 saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false);
2056                 String userAgentString = sharedPreferences.getString("user_agent", "PrivacyBrowser/1.0");
2057                 String customUserAgentString = sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0");
2058                 String defaultFontSizeString = sharedPreferences.getString("default_font_size", "100");
2059
2060                 // Apply the default settings.
2061                 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
2062                 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
2063                 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
2064                 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
2065                 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
2066
2067                 // Set third-party cookies status if API >= 21.
2068                 if (Build.VERSION.SDK_INT >= 21) {
2069                     cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
2070                 }
2071
2072                 // Set the default user agent.
2073                 switch (userAgentString) {
2074                     case "WebView default user agent":
2075                         // Set the user agent to `""`, which uses the default value.
2076                         mainWebView.getSettings().setUserAgentString("");
2077                         break;
2078
2079                     case "Custom user agent":
2080                         // Set the custom user agent.
2081                         mainWebView.getSettings().setUserAgentString(customUserAgentString);
2082                         break;
2083
2084                     default:
2085                         // Use the selected user agent.
2086                         mainWebView.getSettings().setUserAgentString(userAgentString);
2087                         break;
2088                 }
2089
2090                 // Set a transparent background on `urlTextBox`.  We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
2091                 urlAppBarRelativeLayout.setBackgroundDrawable(getResources().getDrawable(R.drawable.url_bar_background_transparent));
2092             }
2093
2094             // Close `domainsDatabaseHelper`.
2095             domainsDatabaseHelper.close();
2096
2097             // Update the privacy icons, but only if `mainMenu` has already been populated.
2098             if (mainMenu != null) {
2099                 updatePrivacyIcons(true);
2100             }
2101         }
2102     }
2103
2104     public void findPreviousOnPage(View view) {
2105         // Go to the previous highlighted phrase on the page.  `false` goes backwards instead of forwards.
2106         mainWebView.findNext(false);
2107     }
2108
2109     public void findNextOnPage(View view) {
2110         // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
2111         mainWebView.findNext(true);
2112     }
2113
2114     public void closeFindOnPage(View view) {
2115         // Delete the contents of `find_on_page_edittext`.
2116         findOnPageEditText.setText(null);
2117
2118         // Clear the highlighted phrases.
2119         mainWebView.clearMatches();
2120
2121         // Hide the Find on Page `RelativeLayout`.
2122         findOnPageLinearLayout.setVisibility(View.GONE);
2123
2124         // Show the URL app bar.
2125         supportAppBar.setVisibility(View.VISIBLE);
2126
2127         // Hide the keyboard so we can see the webpage.  `0` indicates no additional flags.
2128         inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
2129     }
2130
2131     private void applyAppSettings() {
2132         // Get the shared preference values.  `this` references the current context.
2133         SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2134
2135         // Store the values from `sharedPreferences` in variables.
2136         String homepageString = sharedPreferences.getString("homepage", "https://duckduckgo.com");
2137         String torHomepageString = sharedPreferences.getString("tor_homepage", "https://3g2upl4pq6kufc4m.onion");
2138         String torSearchString = sharedPreferences.getString("tor_search", "https://3g2upl4pq6kufc4m.onion/html/?q=");
2139         String torSearchCustomURLString = sharedPreferences.getString("tor_search_custom_url", "");
2140         String searchString = sharedPreferences.getString("search", "https://duckduckgo.com/html/?q=");
2141         String searchCustomURLString = sharedPreferences.getString("search_custom_url", "");
2142         adBlockerEnabled = sharedPreferences.getBoolean("block_ads", true);
2143         incognitoModeEnabled = sharedPreferences.getBoolean("incognito_mode", false);
2144         boolean doNotTrackEnabled = sharedPreferences.getBoolean("do_not_track", false);
2145         boolean proxyThroughOrbot = sharedPreferences.getBoolean("proxy_through_orbot", false);
2146         fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean("enable_full_screen_browsing_mode", false);
2147         hideSystemBarsOnFullscreen = sharedPreferences.getBoolean("hide_system_bars", false);
2148         translucentNavigationBarOnFullscreen = sharedPreferences.getBoolean("translucent_navigation_bar", true);
2149         swipeToRefreshEnabled = sharedPreferences.getBoolean("swipe_to_refresh", false);
2150
2151         // Set the homepage, search, and proxy options.
2152         if (proxyThroughOrbot) {  // Set the Tor options.
2153             // Set `torHomepageString` as `homepage`.
2154             homepage = torHomepageString;
2155
2156             // If formattedUrlString is null assign the homepage to it.
2157             if (formattedUrlString == null) {
2158                 formattedUrlString = homepage;
2159             }
2160
2161             // Set the search URL.
2162             if (torSearchString.equals("Custom URL")) {  // Get the custom URL string.
2163                 searchURL = torSearchCustomURLString;
2164             } else {  // Use the string from the pre-built list.
2165                 searchURL = torSearchString;
2166             }
2167
2168             // Set the proxy.  `this` refers to the current activity where an `AlertDialog` might be displayed.
2169             OrbotProxyHelper.setProxy(getApplicationContext(), this, "localhost", "8118");
2170
2171             // Display a message to the user if we are waiting on Orbot.
2172             if (!orbotStatus.equals("ON")) {
2173                 // Set `waitingForOrbot`.
2174                 waitingForOrbot = true;
2175
2176                 // Load a waiting page.  `null` specifies no encoding, which defaults to ASCII.
2177                 mainWebView.loadData(waitingForOrbotHTMLString, "text/html", null);
2178             }
2179         } else {  // Set the non-Tor options.
2180             // Set `homepageString` as `homepage`.
2181             homepage = homepageString;
2182
2183             // If formattedUrlString is null assign the homepage to it.
2184             if (formattedUrlString == null) {
2185                 formattedUrlString = homepage;
2186             }
2187
2188             // Set the search URL.
2189             if (searchString.equals("Custom URL")) {  // Get the custom URL string.
2190                 searchURL = searchCustomURLString;
2191             } else {  // Use the string from the pre-built list.
2192                 searchURL = searchString;
2193             }
2194
2195             // Reset the proxy to default.  The host is `""` and the port is `"0"`.
2196             OrbotProxyHelper.setProxy(getApplicationContext(), this, "", "0");
2197
2198             // Reset `waitingForOrbot.
2199             waitingForOrbot = false;
2200         }
2201
2202         // Set swipe to refresh.
2203         swipeRefreshLayout.setEnabled(swipeToRefreshEnabled);
2204
2205         // Set Do Not Track status.
2206         if (doNotTrackEnabled) {
2207             customHeaders.put("DNT", "1");
2208         } else {
2209             customHeaders.remove("DNT");
2210         }
2211
2212         // Apply the appropriate full screen mode the `SYSTEM_UI` flags.
2213         if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) {
2214             if (hideSystemBarsOnFullscreen) {  // Hide everything.
2215                 // Remove the translucent navigation setting if it is currently flagged.
2216                 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
2217
2218                 // Remove the translucent status bar overlay.
2219                 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
2220
2221                 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
2222                 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
2223
2224                 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
2225                  * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
2226                  * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically rehides them after they are shown.
2227                  */
2228                 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
2229             } else {  // Hide everything except the status and navigation bars.
2230                 // Add the translucent status flag if it is unset.
2231                 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
2232
2233                 if (translucentNavigationBarOnFullscreen) {
2234                     // Set the navigation bar to be translucent.
2235                     getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
2236                 } else {
2237                     // Set the navigation bar to be black.
2238                     getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
2239                 }
2240             }
2241         } else {  // Switch to normal viewing mode.
2242             // Reset `inFullScreenBrowsingMode` to `false`.
2243             inFullScreenBrowsingMode = false;
2244
2245             // Show the `appBar` if `findOnPageLinearLayout` is not visible.
2246             if (findOnPageLinearLayout.getVisibility() == View.GONE) {
2247                 appBar.show();
2248             }
2249
2250             // Show the `BannerAd` in the free flavor.
2251             if (BuildConfig.FLAVOR.contentEquals("free")) {
2252                 // Reload the ad.  Because the screen may have rotated, we need to use `reloadAfterRotate`.
2253                 BannerAd.reloadAfterRotate(adView, getApplicationContext(), getString(R.string.ad_id));
2254
2255                 // Reinitialize the `adView` variable, as the `View` will have been removed and re-added by `BannerAd.reloadAfterRotate()`.
2256                 adView = findViewById(R.id.adview);
2257             }
2258
2259             // Remove the translucent navigation bar flag if it is set.
2260             getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
2261
2262             // Add the translucent status flag if it is unset.  This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
2263             getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
2264
2265             // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
2266             rootCoordinatorLayout.setSystemUiVisibility(0);
2267
2268             // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
2269             rootCoordinatorLayout.setFitsSystemWindows(true);
2270         }
2271     }
2272
2273     private void updatePrivacyIcons(boolean runInvalidateOptionsMenu) {
2274         // Get handles for the icons.
2275         MenuItem privacyIcon = mainMenu.findItem(R.id.toggleJavaScript);
2276         MenuItem firstPartyCookiesIcon = mainMenu.findItem(R.id.toggleFirstPartyCookies);
2277         MenuItem domStorageIcon = mainMenu.findItem(R.id.toggleDomStorage);
2278         MenuItem formDataIcon = mainMenu.findItem(R.id.toggleSaveFormData);
2279
2280         // Update `privacyIcon`.
2281         if (javaScriptEnabled) {  // JavaScript is enabled.
2282             privacyIcon.setIcon(R.drawable.javascript_enabled);
2283         } else if (firstPartyCookiesEnabled) {  // JavaScript is disabled but cookies are enabled.
2284             privacyIcon.setIcon(R.drawable.warning);
2285         } else {  // All the dangerous features are disabled.
2286             privacyIcon.setIcon(R.drawable.privacy_mode);
2287         }
2288
2289         // Update `firstPartyCookiesIcon`.
2290         if (firstPartyCookiesEnabled) {  // First-party cookies are enabled.
2291             firstPartyCookiesIcon.setIcon(R.drawable.cookies_enabled);
2292         } else {  // First-party cookies are disabled.
2293             firstPartyCookiesIcon.setIcon(R.drawable.cookies_disabled);
2294         }
2295
2296         // Update `domStorageIcon`.
2297         if (javaScriptEnabled && domStorageEnabled) {  // Both JavaScript and DOM storage are enabled.
2298             domStorageIcon.setIcon(R.drawable.dom_storage_enabled);
2299         } else if (javaScriptEnabled) {  // JavaScript is enabled but DOM storage is disabled.
2300             domStorageIcon.setIcon(R.drawable.dom_storage_disabled);
2301         } else {  // JavaScript is disabled, so DOM storage is ghosted.
2302             domStorageIcon.setIcon(R.drawable.dom_storage_ghosted);
2303         }
2304
2305         // Update `formDataIcon`.
2306         if (saveFormDataEnabled) {  // Form data is enabled.
2307             formDataIcon.setIcon(R.drawable.form_data_enabled);
2308         } else {  // Form data is disabled.
2309             formDataIcon.setIcon(R.drawable.form_data_disabled);
2310         }
2311
2312         // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`.  `this` references the current activity.
2313         if (runInvalidateOptionsMenu) {
2314             ActivityCompat.invalidateOptionsMenu(this);
2315         }
2316     }
2317 }