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