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