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