Add support for `tel:` links. https://redmine.stoutner.com/issues/226
[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.BitmapFactory;
38 import android.graphics.Typeface;
39 import android.graphics.drawable.BitmapDrawable;
40 import android.graphics.drawable.Drawable;
41 import android.net.Uri;
42 import android.net.http.SslCertificate;
43 import android.net.http.SslError;
44 import android.os.Build;
45 import android.os.Bundle;
46 import android.os.Handler;
47 import android.preference.PreferenceManager;
48 import android.print.PrintDocumentAdapter;
49 import android.print.PrintManager;
50 import android.support.annotation.NonNull;
51 import android.support.design.widget.CoordinatorLayout;
52 import android.support.design.widget.FloatingActionButton;
53 import android.support.design.widget.NavigationView;
54 import android.support.design.widget.Snackbar;
55 import android.support.v4.app.ActivityCompat;
56 import android.support.v4.content.ContextCompat;
57 import android.support.v4.view.GravityCompat;
58 import android.support.v4.widget.DrawerLayout;
59 import android.support.v4.widget.SwipeRefreshLayout;
60 import android.support.v7.app.ActionBar;
61 import android.support.v7.app.ActionBarDrawerToggle;
62 import android.support.v7.app.AppCompatActivity;
63 import android.support.v7.app.AppCompatDialogFragment;
64 import android.support.v7.widget.Toolbar;
65 import android.text.Editable;
66 import android.text.Spanned;
67 import android.text.TextWatcher;
68 import android.text.style.ForegroundColorSpan;
69 import android.util.Patterns;
70 import android.view.ContextMenu;
71 import android.view.GestureDetector;
72 import android.view.KeyEvent;
73 import android.view.Menu;
74 import android.view.MenuItem;
75 import android.view.MotionEvent;
76 import android.view.View;
77 import android.view.ViewGroup;
78 import android.view.WindowManager;
79 import android.view.inputmethod.InputMethodManager;
80 import android.webkit.CookieManager;
81 import android.webkit.HttpAuthHandler;
82 import android.webkit.SslErrorHandler;
83 import android.webkit.WebBackForwardList;
84 import android.webkit.WebChromeClient;
85 import android.webkit.WebResourceResponse;
86 import android.webkit.WebStorage;
87 import android.webkit.WebView;
88 import android.webkit.WebViewClient;
89 import android.webkit.WebViewDatabase;
90 import android.widget.CursorAdapter;
91 import android.widget.EditText;
92 import android.widget.FrameLayout;
93 import android.widget.ImageView;
94 import android.widget.LinearLayout;
95 import android.widget.ListView;
96 import android.widget.ProgressBar;
97 import android.widget.RadioButton;
98 import android.widget.RelativeLayout;
99 import android.widget.TextView;
100
101 import com.stoutner.privacybrowser.BannerAd;
102 import com.stoutner.privacybrowser.BuildConfig;
103 import com.stoutner.privacybrowser.R;
104 import com.stoutner.privacybrowser.dialogs.CreateBookmarkDialog;
105 import com.stoutner.privacybrowser.dialogs.CreateBookmarkFolderDialog;
106 import com.stoutner.privacybrowser.dialogs.CreateHomeScreenShortcutDialog;
107 import com.stoutner.privacybrowser.dialogs.DownloadImageDialog;
108 import com.stoutner.privacybrowser.dialogs.EditBookmarkDialog;
109 import com.stoutner.privacybrowser.dialogs.EditBookmarkFolderDialog;
110 import com.stoutner.privacybrowser.dialogs.HttpAuthenticationDialog;
111 import com.stoutner.privacybrowser.dialogs.PinnedSslCertificateMismatchDialog;
112 import com.stoutner.privacybrowser.dialogs.UrlHistoryDialog;
113 import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog;
114 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
115 import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper;
116 import com.stoutner.privacybrowser.helpers.OrbotProxyHelper;
117 import com.stoutner.privacybrowser.dialogs.DownloadFileDialog;
118 import com.stoutner.privacybrowser.dialogs.SslCertificateErrorDialog;
119
120 import java.io.BufferedReader;
121 import java.io.ByteArrayInputStream;
122 import java.io.ByteArrayOutputStream;
123 import java.io.File;
124 import java.io.IOException;
125 import java.io.InputStreamReader;
126 import java.io.UnsupportedEncodingException;
127 import java.net.MalformedURLException;
128 import java.net.URL;
129 import java.net.URLDecoder;
130 import java.net.URLEncoder;
131 import java.util.Date;
132 import java.util.HashMap;
133 import java.util.HashSet;
134 import java.util.Map;
135 import java.util.Set;
136
137 // We need to use AppCompatActivity from android.support.v7.app.AppCompatActivity to have access to the SupportActionBar until the minimum API is >= 21.
138 public class MainWebViewActivity extends AppCompatActivity implements CreateBookmarkDialog.CreateBookmarkListener, CreateBookmarkFolderDialog.CreateBookmarkFolderListener, CreateHomeScreenShortcutDialog.CreateHomeScreenSchortcutListener,
139         DownloadFileDialog.DownloadFileListener, DownloadImageDialog.DownloadImageListener, EditBookmarkDialog.EditBookmarkListener, EditBookmarkFolderDialog.EditBookmarkFolderListener, HttpAuthenticationDialog.HttpAuthenticationListener,
140         NavigationView.OnNavigationItemSelectedListener, PinnedSslCertificateMismatchDialog.PinnedSslCertificateMismatchListener, SslCertificateErrorDialog.SslCertificateErrorListener, UrlHistoryDialog.UrlHistoryListener {
141
142     // `darkTheme` is public static so it can be accessed from `AboutActivity`, `GuideActivity`, `AddDomainDialog`, `SettingsActivity`, `DomainsActivity`, `DomainsListFragment`, `BookmarksActivity`, `BookmarksDatabaseViewActivity`,
143     // `CreateBookmarkDialog`, `CreateBookmarkFolderDialog`, `DownloadFileDialog`, `DownloadImageDialog`, `EditBookmarkDialog`, `EditBookmarkFolderDialog`, `EditBookmarkDatabaseViewDialog`, `HttpAuthenticationDialog`, `MoveToFolderDialog`,
144     // `SslCertificateErrorDialog`, `UrlHistoryDialog`, `ViewSslCertificateDialog`, `CreateHomeScreenShortcutDialog`, and `OrbotProxyHelper`. It is also used in `onCreate()`, `applyAppSettings()`, `applyDomainSettings()`, and `updatePrivacyIcons()`.
145     public static boolean darkTheme;
146
147     // `favoriteIconBitmap` is public static so it can be accessed from `CreateHomeScreenShortcutDialog`, `BookmarksActivity`, `BookmarksDatabaseViewActivity`, `CreateBookmarkDialog`, `CreateBookmarkFolderDialog`, `EditBookmarkDialog`,
148     // `EditBookmarkFolderDialog`, `EditBookmarkDatabaseViewDialog`, and `ViewSslCertificateDialog`.  It is also used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onCreateHomeScreenShortcutCreate()`, `onSaveEditBookmark()`,
149     // `onSaveEditBookmarkFolder()`, and `applyDomainSettings()`.
150     public static Bitmap favoriteIconBitmap;
151
152     // `formattedUrlString` is public static so it can be accessed from `BookmarksActivity`, `CreateBookmarkDialog`, and `AddDomainDialog`.
153     // It is also used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onCreateHomeScreenShortcutCreate()`, and `loadUrlFromTextBox()`.
154     public static String formattedUrlString;
155
156     // `sslCertificate` is public static so it can be accessed from `DomainsActivity`, `DomainsListFragment`, `DomainSettingsFragment`, `PinnedSslCertificateMismatchDialog`, and `ViewSslCertificateDialog`.  It is also used in `onCreate()`.
157     public static SslCertificate sslCertificate;
158
159     // `orbotStatus` is public static so it can be accessed from `OrbotProxyHelper`.  It is also used in `onCreate()`.
160     public static String orbotStatus;
161
162     // `webViewTitle` is public static so it can be accessed from `CreateBookmarkDialog` and `CreateHomeScreenShortcutDialog`.  It is also used in `onCreate()`.
163     public static String webViewTitle;
164
165     // `displayWebpageImagesBoolean` is public static so it can be accessed from `DomainSettingsFragment`.  It is also used in `applyAppSettings()` and `applyDomainSettings()`.
166     public static boolean displayWebpageImagesBoolean;
167
168     // `reloadOnRestart` is public static so it can be accessed from `SettingsFragment`.  It is also used in `onRestart()`
169     public static boolean reloadOnRestart;
170
171     // `reloadUrlOnRestart` is public static so it can be accessed from `SettingsFragment`.  It is also used in `onRestart()`.
172     public static boolean loadUrlOnRestart;
173
174     // `restartFromBookmarksActivity` is public static so it can be accessed from `BookmarksActivity`.  It is also used in `onRestart()`.
175     public static boolean restartFromBookmarksActivity;
176
177     // `currentBookmarksFolder` is public static so it can be accessed from `BookmarksActivity`.  It is also used in `onCreate()`, `onBackPressed()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and
178     // `loadBookmarksFolder()`.
179     public static String currentBookmarksFolder;
180
181     // The pinned domain SSL Certificate variables are public static so they can be accessed from `PinnedSslCertificateMismatchDialog`.  They are also used in `onCreate()` and `applyDomainSettings()`.
182     public static int domainSettingsDatabaseId;
183     public static String pinnedDomainSslIssuedToCNameString;
184     public static String pinnedDomainSslIssuedToONameString;
185     public static String pinnedDomainSslIssuedToUNameString;
186     public static String pinnedDomainSslIssuedByCNameString;
187     public static String pinnedDomainSslIssuedByONameString;
188     public static String pinnedDomainSslIssuedByUNameString;
189     public static Date pinnedDomainSslStartDate;
190     public static Date pinnedDomainSslEndDate;
191
192
193     // `appBar` is used in `onCreate()`, `onOptionsItemSelected()`, `closeFindOnPage()`, and `applyAppSettings()`.
194     private ActionBar appBar;
195
196     // `navigatingHistory` is used in `onCreate()`, `onNavigationItemSelected()`, `onSslMismatchBack()`, and `applyDomainSettings()`.
197     private boolean navigatingHistory;
198
199     // `favoriteIconDefaultBitmap` is used in `onCreate()` and `applyDomainSettings`.
200     private Bitmap favoriteIconDefaultBitmap;
201
202     // `drawerLayout` is used in `onCreate()`, `onNewIntent()`, `onBackPressed()`, and `onRestart()`.
203     private DrawerLayout drawerLayout;
204
205     // `rootCoordinatorLayout` is used in `onCreate()` and `applyAppSettings()`.
206     private CoordinatorLayout rootCoordinatorLayout;
207
208     // `mainWebView` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`, `findNextOnPage()`, `closeFindOnPage()`, `loadUrlFromTextBox()`
209     // `onSslMismatchBack()`, and `setDisplayWebpageImages()`.
210     private WebView mainWebView;
211
212     // `fullScreenVideoFrameLayout` is used in `onCreate()` and `onConfigurationChanged()`.
213     private FrameLayout fullScreenVideoFrameLayout;
214
215     // `swipeRefreshLayout` is used in `onCreate()`, `onPrepareOptionsMenu`, and `onRestart()`.
216     private SwipeRefreshLayout swipeRefreshLayout;
217
218     // `urlAppBarRelativeLayout` is used in `onCreate()` and `applyDomainSettings()`.
219     private RelativeLayout urlAppBarRelativeLayout;
220
221     // `favoriteIconImageView` is used in `onCreate()` and `applyDomainSettings()`
222     private ImageView favoriteIconImageView;
223
224     // `cookieManager` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`, `loadUrlFromTextBox()`, `onDownloadImage()`, `onDownloadFile()`, and `onRestart()`.
225     private CookieManager cookieManager;
226
227     // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrl()`.
228     private final Map<String, String> customHeaders = new HashMap<>();
229
230     // `javaScriptEnabled` is also used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `applyDomainSettings()`, and `updatePrivacyIcons()`.
231     private boolean javaScriptEnabled;
232
233     // `firstPartyCookiesEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onDownloadImage()`, `onDownloadFile()`, and `applyDomainSettings()`.
234     private boolean firstPartyCookiesEnabled;
235
236     // `thirdPartyCookiesEnabled` used in `onCreate()`, `onPrepareOptionsMenu()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
237     private boolean thirdPartyCookiesEnabled;
238
239     // `domStorageEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
240     private boolean domStorageEnabled;
241
242     // `saveFormDataEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
243     private boolean saveFormDataEnabled;
244
245     // `nightMode` is used in `onCreate()` and  `applyDomainSettings()`.
246     private boolean nightMode;
247
248     // `swipeToRefreshEnabled` is used in `onPrepareOptionsMenu()` and `applyAppSettings()`.
249     private boolean swipeToRefreshEnabled;
250
251     // 'homepage' is used in `onCreate()`, `onNavigationItemSelected()`, and `applyAppSettings()`.
252     private String homepage;
253
254     // `searchURL` is used in `loadURLFromTextBox()` and `applyAppSettings()`.
255     private String searchURL;
256
257     // `adBlockerEnabled` is used in `onCreate()` and `applyAppSettings()`.
258     private boolean adBlockerEnabled;
259
260     // `privacyBrowserRuntime` is used in `onCreate()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
261     private Runtime privacyBrowserRuntime;
262
263     // `incognitoModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
264     private boolean incognitoModeEnabled;
265
266     // `fullScreenBrowsingModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
267     private boolean fullScreenBrowsingModeEnabled;
268
269     // `inFullScreenBrowsingMode` is used in `onCreate()`, `onConfigurationChanged()`, and `applyAppSettings()`.
270     private boolean inFullScreenBrowsingMode;
271
272     // `hideSystemBarsOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
273     private boolean hideSystemBarsOnFullscreen;
274
275     // `translucentNavigationBarOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
276     private boolean translucentNavigationBarOnFullscreen;
277
278     // `currentDomainName` is used in `onCreate()`, `onNavigationItemSelected()`, `onSslMismatchProceed()`, and `applyDomainSettings()`.
279     private String currentDomainName;
280
281     // `ignorePinnedSslCertificateForDomain` is used in `onCreate()`, `onSslMismatchProceed()`, and `applyDomainSettings()`.
282     private boolean ignorePinnedSslCertificate;
283
284     // `waitingForOrbot` is used in `onCreate()` and `applyAppSettings()`.
285     private boolean waitingForOrbot;
286
287     // `domainSettingsApplied` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
288     private boolean domainSettingsApplied;
289
290     // `displayWebpageImagesInt` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
291     private int displayWebpageImagesInt;
292
293     // `onTheFlyDisplayImagesSet` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
294     private boolean onTheFlyDisplayImagesSet;
295
296     // `waitingForOrbotData` is used in `onCreate()` and `applyAppSettings()`.
297     private String waitingForOrbotHTMLString;
298
299     // `privateDataDirectoryString` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`.
300     private String privateDataDirectoryString;
301
302     // `findOnPageLinearLayout` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
303     private LinearLayout findOnPageLinearLayout;
304
305     // `findOnPageEditText` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
306     private EditText findOnPageEditText;
307
308     // `mainMenu` is used in `onCreateOptionsMenu()` and `updatePrivacyIcons()`.
309     private Menu mainMenu;
310
311     // `drawerToggle` is used in `onCreate()`, `onPostCreate()`, `onConfigurationChanged()`, `onNewIntent()`, and `onNavigationItemSelected()`.
312     private ActionBarDrawerToggle drawerToggle;
313
314     // `supportAppBar` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
315     private Toolbar supportAppBar;
316
317     // `urlTextBox` is used in `onCreate()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, `loadUrl()`, and `highlightUrlText()`.
318     private EditText urlTextBox;
319
320     // `redColorSpan` is used in `onCreate()` and `highlightUrlText()`.
321     private ForegroundColorSpan redColorSpan;
322
323     // `initialGrayColorSpan` is sued in `onCreate()` and `highlightUrlText()`.
324     private ForegroundColorSpan initialGrayColorSpan;
325
326     // `finalGrayColorSpam` is used in `onCreate()` and `highlightUrlText()`.
327     private ForegroundColorSpan finalGrayColorSpan;
328
329     // `adView` is used in `onCreate()` and `onConfigurationChanged()`.
330     private View adView;
331
332     // `sslErrorHandler` is used in `onCreate()`, `onSslErrorCancel()`, and `onSslErrorProceed`.
333     private SslErrorHandler sslErrorHandler;
334
335     // `httpAuthHandler` is used in `onCreate()`, `onHttpAuthenticationCancel()`, and `onHttpAuthenticationProceed()`.
336     private static HttpAuthHandler httpAuthHandler;
337
338     // `inputMethodManager` is used in `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `closeFindOnPage()`.
339     private InputMethodManager inputMethodManager;
340
341     // `mainWebViewRelativeLayout` is used in `onCreate()` and `onNavigationItemSelected()`.
342     private RelativeLayout mainWebViewRelativeLayout;
343
344     // `urlIsLoading` is used in `onCreate()`, `loadUrl()`, and `applyDomainSettings()`.
345     private boolean urlIsLoading;
346
347     // `pinnedDomainSslCertificate` is used in `onCreate()` and `applyDomainSettings()`.
348     private boolean pinnedDomainSslCertificate;
349
350     // `bookmarksDatabaseHelper` is used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
351     private BookmarksDatabaseHelper bookmarksDatabaseHelper;
352
353     // `bookmarksListView` is used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, and `loadBookmarksFolder()`.
354     private ListView bookmarksListView;
355
356     // `bookmarksTitleTextView` is used in `onCreate()` and `loadBookmarksFolder()`.
357     private TextView bookmarksTitleTextView;
358
359     // `bookmarksCursor` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
360     private Cursor bookmarksCursor;
361
362     // `bookmarksCursorAdapter` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()` `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
363     private CursorAdapter bookmarksCursorAdapter;
364
365     // `oldFolderNameString` is used in `onCreate()` and `onSaveEditBookmarkFolder()`.
366     private String oldFolderNameString;
367
368     @Override
369     // 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.
370     @SuppressLint({"SetJavaScriptEnabled"})
371     // Remove Android Studio's warning about deprecations.  We have to use the deprecated `getColor()` until API >= 23.
372     @SuppressWarnings("deprecation")
373     protected void onCreate(Bundle savedInstanceState) {
374         // Get a handle for `sharedPreferences`.  `this` references the current context.
375         SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
376
377         // Get the theme preference.
378         darkTheme = sharedPreferences.getBoolean("dark_theme", false);
379
380         // Set the activity theme.
381         if (darkTheme) {
382             setTheme(R.style.PrivacyBrowserDark);
383         } else {
384             setTheme(R.style.PrivacyBrowserLight);
385         }
386
387         // Run the default commands.
388         super.onCreate(savedInstanceState);
389
390         // Set the content view.
391         setContentView(R.layout.main_drawerlayout);
392
393         // Get a handle for `inputMethodManager`.
394         inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
395
396         // `SupportActionBar` from `android.support.v7.app.ActionBar` must be used until the minimum API is >= 21.
397         supportAppBar = findViewById(R.id.app_bar);
398         setSupportActionBar(supportAppBar);
399         appBar = getSupportActionBar();
400
401         // This is needed to get rid of the Android Studio warning that `appBar` might be null.
402         assert appBar != null;
403
404         // Add the custom `url_app_bar` layout, which shows the favorite icon and the URL text bar.
405         appBar.setCustomView(R.layout.url_app_bar);
406         appBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
407
408         // Initialize the `ForegroundColorSpans` and `StyleSpan` for highlighting `urlTextBox`.  We have to use the deprecated `getColor()` until API >= 23.
409         redColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.red_a700));
410         initialGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
411         finalGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
412
413         // Get a handle for `urlTextBox`.
414         urlTextBox = appBar.getCustomView().findViewById(R.id.url_edittext);
415
416         // Remove the formatting from `urlTextBar` when the user is editing the text.
417         urlTextBox.setOnFocusChangeListener((v, hasFocus) -> {
418             if (hasFocus) {  // The user is editing `urlTextBox`.
419                 // Remove the highlighting.
420                 urlTextBox.getText().removeSpan(redColorSpan);
421                 urlTextBox.getText().removeSpan(initialGrayColorSpan);
422                 urlTextBox.getText().removeSpan(finalGrayColorSpan);
423             } else {  // The user has stopped editing `urlTextBox`.
424                 // Reapply the highlighting.
425                 highlightUrlText();
426             }
427         });
428
429         // Set the `Go` button on the keyboard to load the URL in `urlTextBox`.
430         urlTextBox.setOnKeyListener((v, keyCode, event) -> {
431             // If the event is a key-down event on the `enter` button, load the URL.
432             if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
433                 // Load the URL into the mainWebView and consume the event.
434                 try {
435                     loadUrlFromTextBox();
436                 } catch (UnsupportedEncodingException e) {
437                     e.printStackTrace();
438                 }
439                 // If the enter key was pressed, consume the event.
440                 return true;
441             } else {
442                 // If any other key was pressed, do not consume the event.
443                 return false;
444             }
445         });
446
447         // Set `waitingForOrbotHTMLString`.
448         waitingForOrbotHTMLString = "<html><body><br/><center><h1>" + getString(R.string.waiting_for_orbot) + "</h1></center></body></html>";
449
450         // Initialize `currentDomainName`, `orbotStatus`, and `waitingForOrbot`.
451         currentDomainName = "";
452         orbotStatus = "unknown";
453         waitingForOrbot = false;
454
455         // Create an Orbot status `BroadcastReceiver`.
456         BroadcastReceiver orbotStatusBroadcastReceiver = new BroadcastReceiver() {
457             @Override
458             public void onReceive(Context context, Intent intent) {
459                 // Store the content of the status message in `orbotStatus`.
460                 orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS");
461
462                 // If we are waiting on Orbot, load the website now that Orbot is connected.
463                 if (orbotStatus.equals("ON") && waitingForOrbot) {
464                     // Reset `waitingForOrbot`.
465                     waitingForOrbot = false;
466
467                     // Load `formattedUrlString
468                     loadUrl(formattedUrlString);
469                 }
470             }
471         };
472
473         // Register `orbotStatusBroadcastReceiver` on `this` context.
474         this.registerReceiver(orbotStatusBroadcastReceiver, new IntentFilter("org.torproject.android.intent.action.STATUS"));
475
476         // Get handles for views that need to be accessed.
477         drawerLayout = findViewById(R.id.drawerlayout);
478         rootCoordinatorLayout = findViewById(R.id.root_coordinatorlayout);
479         bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
480         bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview);
481         FloatingActionButton launchBookmarksActivityFab = findViewById(R.id.launch_bookmarks_activity_fab);
482         FloatingActionButton createBookmarkFolderFab = findViewById(R.id.create_bookmark_folder_fab);
483         FloatingActionButton createBookmarkFab = findViewById(R.id.create_bookmark_fab);
484         mainWebViewRelativeLayout = findViewById(R.id.main_webview_relativelayout);
485         mainWebView = findViewById(R.id.main_webview);
486         findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
487         findOnPageEditText = findViewById(R.id.find_on_page_edittext);
488         fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
489         urlAppBarRelativeLayout = findViewById(R.id.url_app_bar_relativelayout);
490         favoriteIconImageView = findViewById(R.id.favorite_icon);
491
492         // Set the bookmarks drawer resources according to the theme.  This can't be done in the layout due to compatibility issues with the `DrawerLayout` support widget.
493         if (darkTheme) {
494             launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_dark));
495             createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_dark));
496             createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_dark));
497             bookmarksListView.setBackgroundColor(getResources().getColor(R.color.gray_850));
498         } else {
499             launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_light));
500             createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_light));
501             createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_light));
502             bookmarksListView.setBackgroundColor(getResources().getColor(R.color.white));
503         }
504
505         // Set the launch bookmarks activity FAB to launch the bookmarks activity.
506         launchBookmarksActivityFab.setOnClickListener(v -> {
507             // Create an intent to launch the bookmarks activity.
508             Intent bookmarksIntent = new Intent(getApplicationContext(), BookmarksActivity.class);
509
510             // Include the current folder with the `Intent`.
511             bookmarksIntent.putExtra("Current Folder", currentBookmarksFolder);
512
513             // Make it so.
514             startActivity(bookmarksIntent);
515         });
516
517         // Set the create new bookmark folder FAB to display the `AlertDialog`.
518         createBookmarkFolderFab.setOnClickListener(v -> {
519             // Show the `CreateBookmarkFolderDialog` `AlertDialog` and name the instance `@string/create_folder`.
520             AppCompatDialogFragment createBookmarkFolderDialog = new CreateBookmarkFolderDialog();
521             createBookmarkFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_folder));
522         });
523
524         // Set the create new bookmark FAB to display the `AlertDialog`.
525         createBookmarkFab.setOnClickListener(view -> {
526             // Show the `CreateBookmarkDialog` `AlertDialog` and name the instance `@string/create_bookmark`.
527             AppCompatDialogFragment createBookmarkDialog = new CreateBookmarkDialog();
528             createBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_bookmark));
529         });
530
531         // Create a double-tap listener to toggle full-screen mode.
532         final GestureDetector gestureDetector = new GestureDetector(this, new GestureDetector.SimpleOnGestureListener() {
533             // Override `onDoubleTap()`.  All other events are handled using the default settings.
534             @Override
535             public boolean onDoubleTap(MotionEvent event) {
536                 if (fullScreenBrowsingModeEnabled) {  // Only process the double-tap if full screen browsing mode is enabled.
537                     // Toggle `inFullScreenBrowsingMode`.
538                     inFullScreenBrowsingMode = !inFullScreenBrowsingMode;
539
540                     if (inFullScreenBrowsingMode) {  // Switch to full screen mode.
541                         // Hide the `appBar`.
542                         appBar.hide();
543
544                         // Hide the `BannerAd` in the free flavor.
545                         if (BuildConfig.FLAVOR.contentEquals("free")) {
546                             BannerAd.hideAd(adView);
547                         }
548
549                         // Modify the system bars.
550                         if (hideSystemBarsOnFullscreen) {  // Hide everything.
551                             // Remove the translucent overlays.
552                             getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
553
554                             // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
555                             drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
556
557                             /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
558                              * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
559                              * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically rehides them after they are shown.
560                              */
561                             rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
562
563                             // Set `rootCoordinatorLayout` to fill the whole screen.
564                             rootCoordinatorLayout.setFitsSystemWindows(false);
565                         } else {  // Hide everything except the status and navigation bars.
566                             // Set `rootCoordinatorLayout` to fit under the status and navigation bars.
567                             rootCoordinatorLayout.setFitsSystemWindows(false);
568
569                             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.
570                                 // Set the navigation bar to be translucent.
571                                 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
572                             }
573                         }
574                     } else {  // Switch to normal viewing mode.
575                         // Show the `appBar`.
576                         appBar.show();
577
578                         // Show the `BannerAd` in the free flavor.
579                         if (BuildConfig.FLAVOR.contentEquals("free")) {
580                             // Reload the ad.  Because the screen may have rotated, we need to use `reloadAfterRotate`.
581                             BannerAd.reloadAfterRotate(adView, getApplicationContext(), getString(R.string.ad_id));
582
583                             // Reinitialize the `adView` variable, as the `View` will have been removed and re-added by `BannerAd.reloadAfterRotate()`.
584                             adView = findViewById(R.id.adview);
585                         }
586
587                         // Remove the translucent navigation bar flag if it is set.
588                         getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
589
590                         // Add the translucent status flag if it is unset.  This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
591                         getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
592
593                         // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
594                         rootCoordinatorLayout.setSystemUiVisibility(0);
595
596                         // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
597                         rootCoordinatorLayout.setFitsSystemWindows(true);
598                     }
599
600                     // Consume the double-tap.
601                     return true;
602                 } else { // Do not consume the double-tap because full screen browsing mode is disabled.
603                     return false;
604                 }
605             }
606         });
607
608         // Pass all touch events on `mainWebView` through `gestureDetector` to check for double-taps.
609         mainWebView.setOnTouchListener((View v, MotionEvent event) -> {
610             // Call `performClick()` on the view, which is required for accessibility.
611             v.performClick();
612
613             // Send the `event` to `gestureDetector`.
614             return gestureDetector.onTouchEvent(event);
615         });
616
617         // Update `findOnPageCountTextView`.
618         mainWebView.setFindListener(new WebView.FindListener() {
619             // Get a handle for `findOnPageCountTextView`.
620             final TextView findOnPageCountTextView = (TextView) findViewById(R.id.find_on_page_count_textview);
621
622             @Override
623             public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, boolean isDoneCounting) {
624                 if ((isDoneCounting) && (numberOfMatches == 0)) {  // There are no matches.
625                     // Set `findOnPageCountTextView` to `0/0`.
626                     findOnPageCountTextView.setText(R.string.zero_of_zero);
627                 } else if (isDoneCounting) {  // There are matches.
628                     // `activeMatchOrdinal` is zero-based.
629                     int activeMatch = activeMatchOrdinal + 1;
630
631                     // Build the match string.
632                     String matchString = activeMatch + "/" + numberOfMatches;
633
634                     // Set `findOnPageCountTextView`.
635                     findOnPageCountTextView.setText(matchString);
636                 }
637             }
638         });
639
640         // Search for the string on the page whenever a character changes in the `findOnPageEditText`.
641         findOnPageEditText.addTextChangedListener(new TextWatcher() {
642             @Override
643             public void beforeTextChanged(CharSequence s, int start, int count, int after) {
644                 // Do nothing.
645             }
646
647             @Override
648             public void onTextChanged(CharSequence s, int start, int before, int count) {
649                 // Do nothing.
650             }
651
652             @Override
653             public void afterTextChanged(Editable s) {
654                 // Search for the text in `mainWebView`.
655                 mainWebView.findAllAsync(findOnPageEditText.getText().toString());
656             }
657         });
658
659         // Set the `check mark` button for the `findOnPageEditText` keyboard to close the soft keyboard.
660         findOnPageEditText.setOnKeyListener((v, keyCode, event) -> {
661             if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {  // The `enter` key was pressed.
662                 // Hide the soft keyboard.  `0` indicates no additional flags.
663                 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
664
665                 // Consume the event.
666                 return true;
667             } else {  // A different key was pressed.
668                 // Do not consume the event.
669                 return false;
670             }
671         });
672
673         // Implement swipe to refresh
674         swipeRefreshLayout = findViewById(R.id.swipe_refreshlayout);
675         swipeRefreshLayout.setColorSchemeResources(R.color.blue_700);
676         swipeRefreshLayout.setOnRefreshListener(() -> mainWebView.reload());
677
678         // `DrawerTitle` identifies the `DrawerLayouts` in accessibility mode.
679         drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer));
680         drawerLayout.setDrawerTitle(GravityCompat.END, getString(R.string.bookmarks));
681
682         // Listen for touches on the navigation menu.
683         final NavigationView navigationView = findViewById(R.id.navigationview);
684         navigationView.setNavigationItemSelectedListener(this);
685
686         // 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.
687         final Menu navigationMenu = navigationView.getMenu();
688         final MenuItem navigationBackMenuItem = navigationMenu.getItem(1);
689         final MenuItem navigationForwardMenuItem = navigationMenu.getItem(2);
690         final MenuItem navigationHistoryMenuItem = navigationMenu.getItem(3);
691
692         // Initialize the bookmarks database helper.  `this` specifies the context.  The two `nulls` do not specify the database name or a `CursorFactory`.
693         // The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
694         bookmarksDatabaseHelper = new BookmarksDatabaseHelper(this, null, null, 0);
695
696         // Initialize `currentBookmarksFolder`.  `""` is the home folder in the database.
697         currentBookmarksFolder = "";
698
699         // Load the home folder, which is `""` in the database.
700         loadBookmarksFolder();
701
702         bookmarksListView.setOnItemClickListener((parent, view, position, id) -> {
703             // Convert the id from long to int to match the format of the bookmarks database.
704             int databaseID = (int) id;
705
706             // Get the bookmark `Cursor` for this ID and move it to the first row.
707             Cursor bookmarkCursor = bookmarksDatabaseHelper.getBookmarkCursor(databaseID);
708             bookmarkCursor.moveToFirst();
709
710             // Act upon the bookmark according to the type.
711             if (bookmarkCursor.getInt(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {  // The selected bookmark is a folder.
712                 // Store the new folder name in `currentBookmarksFolder`.
713                 currentBookmarksFolder = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
714
715                 // Load the new folder.
716                 loadBookmarksFolder();
717             } else {  // The selected bookmark is not a folder.
718                 // Load the bookmark URL.
719                 loadUrl(bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_URL)));
720
721                 // Close the bookmarks drawer.
722                 drawerLayout.closeDrawer(GravityCompat.END);
723             }
724
725             // Close the `Cursor`.
726             bookmarkCursor.close();
727         });
728
729         bookmarksListView.setOnItemLongClickListener((parent, view, position, id) -> {
730             // Convert the database ID from `long` to `int`.
731             int databaseId = (int) id;
732
733             // Find out if the selected bookmark is a folder.
734             boolean isFolder = bookmarksDatabaseHelper.isFolder(databaseId);
735
736             if (isFolder) {
737                 // Save the current folder name, which is used in `onSaveEditBookmarkFolder()`.
738                 oldFolderNameString = bookmarksCursor.getString(bookmarksCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
739
740                 // Show the edit bookmark folder `AlertDialog` and name the instance `@string/edit_folder`.
741                 AppCompatDialogFragment editFolderDialog = EditBookmarkFolderDialog.folderDatabaseId(databaseId);
742                 editFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_folder));
743             } else {
744                 // Show the edit bookmark `AlertDialog` and name the instance `@string/edit_bookmark`.
745                 AppCompatDialogFragment editBookmarkDialog = EditBookmarkDialog.bookmarkDatabaseId(databaseId);
746                 editBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_bookmark));
747             }
748
749             // Consume the event.
750             return true;
751         });
752
753         // The `DrawerListener` allows us to update the Navigation Menu.
754         drawerLayout.addDrawerListener(new DrawerLayout.DrawerListener() {
755             @Override
756             public void onDrawerSlide(View drawerView, float slideOffset) {
757             }
758
759             @Override
760             public void onDrawerOpened(View drawerView) {
761             }
762
763             @Override
764             public void onDrawerClosed(View drawerView) {
765             }
766
767             @Override
768             public void onDrawerStateChanged(int newState) {
769                 if ((newState == DrawerLayout.STATE_SETTLING) || (newState == DrawerLayout.STATE_DRAGGING)) {  // The drawer is opening or closing.
770                     // Update the `Back`, `Forward`, and `History` menu items.
771                     navigationBackMenuItem.setEnabled(mainWebView.canGoBack());
772                     navigationForwardMenuItem.setEnabled(mainWebView.canGoForward());
773                     navigationHistoryMenuItem.setEnabled((mainWebView.canGoBack() || mainWebView.canGoForward()));
774
775                     // Hide the keyboard (if displayed) so we can see the navigation menu.  `0` indicates no additional flags.
776                     inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
777
778                     // Clear the focus from `urlTextBox` if it has it.
779                     urlTextBox.clearFocus();
780                 }
781             }
782         });
783
784         // drawerToggle creates the hamburger icon at the start of the AppBar.
785         drawerToggle = new ActionBarDrawerToggle(this, drawerLayout, supportAppBar, R.string.open_navigation_drawer, R.string.close_navigation_drawer);
786
787         // Initialize `adServerSet`.
788         final Set<String> adServersSet = new HashSet<>();
789
790         // Load the list of ad servers into memory.
791         try {
792             // Load `pgl.yoyo.org_adservers.txt` into a `BufferedReader`.
793             BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(getAssets().open("pgl.yoyo.org_adservers.txt")));
794
795             // Create a string for storing each ad server.
796             String adServer;
797
798             // Populate `adServersSet`.
799             while ((adServer = bufferedReader.readLine()) != null) {
800                 adServersSet.add(adServer);
801             }
802
803             // Close `bufferedReader`.
804             bufferedReader.close();
805         } catch (IOException ioException) {
806             // We're pretty sure the asset exists, so we don't need to worry about the `IOException` ever being thrown.
807         }
808
809         mainWebView.setWebViewClient(new WebViewClient() {
810             // `shouldOverrideUrlLoading` makes this `WebView` the default handler for URLs inside the app, so that links are not kicked out to other apps.
811             // We have to use the deprecated `shouldOverrideUrlLoading` until API >= 24.
812             @SuppressWarnings("deprecation")
813             @Override
814             public boolean shouldOverrideUrlLoading(WebView view, String url) {
815                 if (url.startsWith("mailto:")) {  // Load the email address in an external email program.
816                     // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
817                     Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
818
819                     // Parse the url and set it as the data for the `Intent`.
820                     emailIntent.setData(Uri.parse(url));
821
822                     // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
823                     emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
824
825                     // Make it so.
826                     startActivity(emailIntent);
827
828                     // Returning `true` indicates the application is handling the URL.
829                     return true;
830                 } else if (url.startsWith("tel:")) {  // Load the phone number in the dialer.
831                     // `ACTION_DIAL` open the dialer and loads the phone number, but waits for the user to place the call.
832                     Intent dialIntent = new Intent(Intent.ACTION_DIAL);
833
834                     // Add the phone number to the intent.
835                     dialIntent.setData(Uri.parse(url));
836
837                     // `FLAG_ACTIVITY_NEW_TASK` opens the dialer in a new task instead as part of Privacy Browser.
838                     dialIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
839
840                     // Make it so.
841                     startActivity(dialIntent);
842
843                     // Returning `true` indicates the application is handling the URL.
844                     return true;
845                 } else {  // Load the URL in Privacy Browser.
846                     // Apply the domain settings for the new URL.
847                     applyDomainSettings(url);
848
849                     // Returning `false` causes the current `WebView` to handle the URL and prevents it from adding redirects to the history list.
850                     return false;
851                 }
852             }
853
854             // Block ads.  We have to use the deprecated `shouldInterceptRequest` until minimum API >= 21.
855             @SuppressWarnings("deprecation")
856             @Override
857             public WebResourceResponse shouldInterceptRequest(WebView view, String url){
858                 if (adBlockerEnabled) {  // Block ads.
859                     // Extract the host from `url`.
860                     Uri requestUri = Uri.parse(url);
861                     String requestHost = requestUri.getHost();
862
863                     // Initialize a variable to track if this is an ad server.
864                     boolean requestHostIsAdServer = false;
865
866                     // Check all the subdomains of `requestHost` if it is not `null` against the ad server database.
867                     if (requestHost != null) {
868                         while (requestHost.contains(".") && !requestHostIsAdServer) {  // Stop checking if we run out of `.` or if we already know that `requestHostIsAdServer` is `true`.
869                             if (adServersSet.contains(requestHost)) {
870                                 requestHostIsAdServer = true;
871                             }
872
873                             // Strip out the lowest subdomain of `requestHost`.
874                             requestHost = requestHost.substring(requestHost.indexOf(".") + 1);
875                         }
876                     }
877
878                     if (requestHostIsAdServer) {  // It is an ad server.
879                         // Return an empty `WebResourceResponse`.
880                         return new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
881                     } else {  // It is not an ad server.
882                         // `return null` loads the requested resource.
883                         return null;
884                     }
885                 } else {  // Ad blocking is disabled.
886                     // `return null` loads the requested resource.
887                     return null;
888                 }
889             }
890
891             // Handle HTTP authentication requests.
892             @Override
893             public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) {
894                 // Store `handler` so it can be accessed from `onHttpAuthenticationCancel()` and `onHttpAuthenticationProceed()`.
895                 httpAuthHandler = handler;
896
897                 // Display the HTTP authentication dialog.
898                 AppCompatDialogFragment httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm);
899                 httpAuthenticationDialogFragment.show(getSupportFragmentManager(), getString(R.string.http_authentication));
900             }
901
902             // Update the URL in urlTextBox when the page starts to load.
903             @Override
904             public void onPageStarted(WebView view, String url, Bitmap favicon) {
905                 // If night mode is enabled, hide `mainWebView` until after the night mode CSS is applied.
906                 if (nightMode) {
907                     mainWebView.setVisibility(View.INVISIBLE);
908                 }
909
910                 // Hide the keyboard.  `0` indicates no additional flags.
911                 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
912
913                 // Check to see if we are waiting on Orbot.
914                 if (!waitingForOrbot) {  // We are not waiting on Orbot, so we need to process the URL.
915                     // 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.
916                     formattedUrlString = url;
917
918                     // Display the formatted URL text.
919                     urlTextBox.setText(formattedUrlString);
920
921                     // Apply text highlighting to `urlTextBox`.
922                     highlightUrlText();
923
924                     // Apply any custom domain settings if the URL was loaded by navigating history.
925                     if (navigatingHistory) {
926                         applyDomainSettings(url);
927                     }
928
929                     // Set `urlIsLoading` to `true`, so that redirects while loading do not trigger changes in the user agent, which forces another reload of the existing page.
930                     urlIsLoading = true;
931                 }
932             }
933
934             // It is necessary to update `formattedUrlString` and `urlTextBox` after the page finishes loading because the final URL can change during load.
935             @Override
936             public void onPageFinished(WebView view, String url) {
937                 // Reset `urlIsLoading`, which is used to prevent reloads on redirect if the user agent changes.
938                 urlIsLoading = false;
939
940                 // Clear the cache and history if Incognito Mode is enabled.
941                 if (incognitoModeEnabled) {
942                     // Clear the cache.  `true` includes disk files.
943                     mainWebView.clearCache(true);
944
945                     // Clear the back/forward history.
946                     mainWebView.clearHistory();
947
948                     // Manually delete cache folders.
949                     try {
950                         // Delete the main `cache` folder.
951                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
952
953                         // 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`.
954                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
955                     } catch (IOException e) {
956                         // Do nothing if an error is thrown.
957                     }
958                 }
959
960                 // Update `urlTextBox` and apply domain settings if not waiting on Orbot.
961                 if (!waitingForOrbot) {
962                     // Check to see if `WebView` has set `url` to be `about:blank`.
963                     if (url.equals("about:blank")) {  // `WebView` is blank, so `formattedUrlString` should be `""` and `urlTextBox` should display a hint.
964                         // Set `formattedUrlString` to `""`.
965                         formattedUrlString = "";
966
967                         urlTextBox.setText(formattedUrlString);
968
969                         // Request focus for `urlTextBox`.
970                         urlTextBox.requestFocus();
971
972                         // Display the keyboard.
973                         inputMethodManager.showSoftInput(urlTextBox, 0);
974
975                         // Apply the domain settings.  This clears any settings from the previous domain.
976                         applyDomainSettings(formattedUrlString);
977                     } else {  // `WebView` has loaded a webpage.
978                         // Set `formattedUrlString`.
979                         formattedUrlString = url;
980
981                         // Only update `urlTextBox` if the user is not typing in it.
982                         if (!urlTextBox.hasFocus()) {
983                             // Display the formatted URL text.
984                             urlTextBox.setText(formattedUrlString);
985
986                             // Apply text highlighting to `urlTextBox`.
987                             highlightUrlText();
988                         }
989                     }
990
991                     // Store the SSL certificate so it can be accessed from `ViewSslCertificateDialog` and `PinnedSslCertificateMismatchDialog`.
992                     sslCertificate = mainWebView.getCertificate();
993
994                     // Check the current website SSL certificate against the pinned SSL certificate if there is a pinned SSL certificate the user has not chosen to ignore it for this session.
995                     if (pinnedDomainSslCertificate && !ignorePinnedSslCertificate) {
996                         // Initialize the current SSL certificate variables.
997                         String currentWebsiteIssuedToCName = "";
998                         String currentWebsiteIssuedToOName = "";
999                         String currentWebsiteIssuedToUName = "";
1000                         String currentWebsiteIssuedByCName = "";
1001                         String currentWebsiteIssuedByOName = "";
1002                         String currentWebsiteIssuedByUName = "";
1003                         Date currentWebsiteSslStartDate = null;
1004                         Date currentWebsiteSslEndDate = null;
1005
1006
1007                         // Extract the individual pieces of information from the current website SSL certificate if it is not null.
1008                         if (sslCertificate != null) {
1009                             currentWebsiteIssuedToCName = sslCertificate.getIssuedTo().getCName();
1010                             currentWebsiteIssuedToOName = sslCertificate.getIssuedTo().getOName();
1011                             currentWebsiteIssuedToUName = sslCertificate.getIssuedTo().getUName();
1012                             currentWebsiteIssuedByCName = sslCertificate.getIssuedBy().getCName();
1013                             currentWebsiteIssuedByOName = sslCertificate.getIssuedBy().getOName();
1014                             currentWebsiteIssuedByUName = sslCertificate.getIssuedBy().getUName();
1015                             currentWebsiteSslStartDate = sslCertificate.getValidNotBeforeDate();
1016                             currentWebsiteSslEndDate = sslCertificate.getValidNotAfterDate();
1017                         }
1018
1019                         // Initialize `String` variables to store the SSL certificate dates.  `Strings` are needed to compare the values below, which doesn't work with `Dates` if they are `null`.
1020                         String currentWebsiteSslStartDateString = "";
1021                         String currentWebsiteSslEndDateString = "";
1022                         String pinnedDomainSslStartDateString = "";
1023                         String pinnedDomainSslEndDateString = "";
1024
1025                         // Convert the `Dates` to `Strings` if they are not `null`.
1026                         if (currentWebsiteSslStartDate != null) {
1027                             currentWebsiteSslStartDateString = currentWebsiteSslStartDate.toString();
1028                         }
1029
1030                         if (currentWebsiteSslEndDate != null) {
1031                             currentWebsiteSslEndDateString = currentWebsiteSslEndDate.toString();
1032                         }
1033
1034                         if (pinnedDomainSslStartDate != null) {
1035                             pinnedDomainSslStartDateString = pinnedDomainSslStartDate.toString();
1036                         }
1037
1038                         if (pinnedDomainSslEndDate != null) {
1039                             pinnedDomainSslEndDateString = pinnedDomainSslEndDate.toString();
1040                         }
1041
1042                         // Check to see if the pinned SSL certificate matches the current website certificate.
1043                         if (!currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) || !currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) || !currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) ||
1044                                 !currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) || !currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) || !currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) ||
1045                                 !currentWebsiteSslStartDateString.equals(pinnedDomainSslStartDateString) || !currentWebsiteSslEndDateString.equals(pinnedDomainSslEndDateString)) {  // The pinned SSL certificate doesn't match the current domain certificate.
1046                             //Display the pinned SSL certificate mismatch `AlertDialog`.
1047                             AppCompatDialogFragment pinnedSslCertificateMismatchDialogFragment = new PinnedSslCertificateMismatchDialog();
1048                             pinnedSslCertificateMismatchDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_mismatch));
1049                         }
1050                     }
1051                 }
1052             }
1053
1054             // Handle SSL Certificate errors.
1055             @Override
1056             public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
1057                 // Get the current website SSL certificate.
1058                 SslCertificate currentWebsiteSslCertificate = error.getCertificate();
1059
1060                 // Extract the individual pieces of information from the current website SSL certificate.
1061                 String currentWebsiteIssuedToCName = currentWebsiteSslCertificate.getIssuedTo().getCName();
1062                 String currentWebsiteIssuedToOName = currentWebsiteSslCertificate.getIssuedTo().getOName();
1063                 String currentWebsiteIssuedToUName = currentWebsiteSslCertificate.getIssuedTo().getUName();
1064                 String currentWebsiteIssuedByCName = currentWebsiteSslCertificate.getIssuedBy().getCName();
1065                 String currentWebsiteIssuedByOName = currentWebsiteSslCertificate.getIssuedBy().getOName();
1066                 String currentWebsiteIssuedByUName = currentWebsiteSslCertificate.getIssuedBy().getUName();
1067                 Date currentWebsiteSslStartDate = currentWebsiteSslCertificate.getValidNotBeforeDate();
1068                 Date currentWebsiteSslEndDate = currentWebsiteSslCertificate.getValidNotAfterDate();
1069
1070                 // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
1071                 if (pinnedDomainSslCertificate &&
1072                         currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) && currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) && currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) &&
1073                         currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) && currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) && currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) &&
1074                         currentWebsiteSslStartDate.equals(pinnedDomainSslStartDate) && currentWebsiteSslEndDate.equals(pinnedDomainSslEndDate)) {  // An SSL certificate is pinned and matches the current domain certificate.
1075                     // Proceed to the website without displaying an error.
1076                     handler.proceed();
1077                 } else {  // Either there isn't a pinned SSL certificate or it doesn't match the current website certificate.
1078                     // Store `handler` so it can be accesses from `onSslErrorCancel()` and `onSslErrorProceed()`.
1079                     sslErrorHandler = handler;
1080
1081                     // Display the SSL error `AlertDialog`.
1082                     AppCompatDialogFragment sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error);
1083                     sslCertificateErrorDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_error));
1084                 }
1085             }
1086         });
1087
1088         // Get a handle for the progress bar.
1089         final ProgressBar progressBar = findViewById(R.id.progress_bar);
1090
1091         mainWebView.setWebChromeClient(new WebChromeClient() {
1092             // Update the progress bar when a page is loading.
1093             @Override
1094             public void onProgressChanged(WebView view, int progress) {
1095                 // Inject the night mode CSS if night mode is enabled.
1096                 if (nightMode) {
1097                     // `background-color: #212121` sets the background to be dark gray.  `color: #BDBDBD` sets the text color to be light gray.  `box-shadow: none` removes a lower underline on links used by WordPress.
1098                     // `text-decoration: none` removes all text underlines.  `text-shadow: none` removes text shadows, which usually have a hard coded color.  `border: none` removes all borders, which can also be used to underline text.
1099                     // `a {color: #1565C0}` sets links to be a dark blue.  `!important` takes precedent over any existing sub-settings.
1100                     mainWebView.evaluateJavascript("(function() {var parent = document.getElementsByTagName('head').item(0); var style = document.createElement('style'); style.type = 'text/css'; style.innerHTML = '" +
1101                             "* {background-color: #212121 !important; color: #BDBDBD !important; box-shadow: none !important; text-decoration: none !important; text-shadow: none !important; border: none !important;}" +
1102                             "a {color: #1565C0 !important;}" +
1103                             "'; parent.appendChild(style)})()", value -> {
1104                                 // Initialize a `Handler` to display `mainWebView`.
1105                                 Handler displayWebViewHandler = new Handler();
1106
1107                                 // Setup a `Runnable` to display `mainWebView` after a delay to allow the CSS to be applied.
1108                                 Runnable displayWebViewRunnable = () -> {
1109                                     // Only display `mainWebView` if the progress bar is one.  This prevents the display of the `WebView` while it is still loading.
1110                                     if (progressBar.getVisibility() == View.GONE) {
1111                                         mainWebView.setVisibility(View.VISIBLE);
1112                                     }
1113                                 };
1114
1115                                 // Use `displayWebViewHandler` to delay the displaying of `mainWebView` for 500 milliseconds.
1116                                 displayWebViewHandler.postDelayed(displayWebViewRunnable, 500);
1117                             });
1118                 }
1119
1120                 progressBar.setProgress(progress);
1121                 if (progress < 100) {
1122                     // Show the progress bar.
1123                     progressBar.setVisibility(View.VISIBLE);
1124                 } else {
1125                     // Hide the progress bar.
1126                     progressBar.setVisibility(View.GONE);
1127
1128                     // Display `mainWebView` if night mode is disabled.
1129                     // Because of a race condition between `applyDomainSettings` and `onPageStarted`, when night mode is set by domain settings the `WebView` may be hidden even if night mode is not currently enabled.
1130                     if (!nightMode) {
1131                         mainWebView.setVisibility(View.VISIBLE);
1132                     }
1133
1134                     //Stop the `SwipeToRefresh` indicator if it is running
1135                     swipeRefreshLayout.setRefreshing(false);
1136                 }
1137             }
1138
1139             // Set the favorite icon when it changes.
1140             @Override
1141             public void onReceivedIcon(WebView view, Bitmap icon) {
1142                 // Only update the favorite icon if the website has finished loading.
1143                 if (progressBar.getVisibility() == View.GONE) {
1144                     // Save a copy of the favorite icon.
1145                     favoriteIconBitmap = icon;
1146
1147                     // Place the favorite icon in the appBar.
1148                     favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
1149                 }
1150             }
1151
1152             // Save a copy of the title when it changes.
1153             @Override
1154             public void onReceivedTitle(WebView view, String title) {
1155                 // Save a copy of the title.
1156                 webViewTitle = title;
1157             }
1158
1159             // Enter full screen video
1160             @Override
1161             public void onShowCustomView(View view, CustomViewCallback callback) {
1162                 // Pause the ad if this is the free flavor.
1163                 if (BuildConfig.FLAVOR.contentEquals("free")) {
1164                     BannerAd.pauseAd(adView);
1165                 }
1166
1167                 // Remove the translucent overlays.
1168                 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1169
1170                 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
1171                 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
1172
1173                 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
1174                  * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
1175                  * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically rehides them after they are shown.
1176                  */
1177                 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
1178
1179                 // Set `rootCoordinatorLayout` to fill the entire screen.
1180                 rootCoordinatorLayout.setFitsSystemWindows(false);
1181
1182                 // Add `view` to `fullScreenVideoFrameLayout` and display it on the screen.
1183                 fullScreenVideoFrameLayout.addView(view);
1184                 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
1185             }
1186
1187             // Exit full screen video
1188             public void onHideCustomView() {
1189                 // Hide `fullScreenVideoFrameLayout`.
1190                 fullScreenVideoFrameLayout.removeAllViews();
1191                 fullScreenVideoFrameLayout.setVisibility(View.GONE);
1192
1193                 // Add the translucent status flag.  This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
1194                 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1195
1196                 // Set `rootCoordinatorLayout` to fit inside the status and navigation bars.  This also clears the `SYSTEM_UI` flags.
1197                 rootCoordinatorLayout.setFitsSystemWindows(true);
1198
1199                 // Show the ad if this is the free flavor.
1200                 if (BuildConfig.FLAVOR.contentEquals("free")) {
1201                     // Reload the ad.  Because the screen may have rotated, we need to use `reloadAfterRotate`.
1202                     BannerAd.reloadAfterRotate(adView, getApplicationContext(), getString(R.string.ad_id));
1203
1204                     // Reinitialize the `adView` variable, as the `View` will have been removed and re-added by `BannerAd.reloadAfterRotate()`.
1205                     adView = findViewById(R.id.adview);
1206                 }
1207             }
1208         });
1209
1210         // Register `mainWebView` for a context menu.  This is used to see link targets and download images.
1211         registerForContextMenu(mainWebView);
1212
1213         // Allow the downloading of files.
1214         mainWebView.setDownloadListener((url, userAgent, contentDisposition, mimetype, contentLength) -> {
1215             // Show the `DownloadFileDialog` `AlertDialog` and name this instance `@string/download`.
1216             AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(url, contentDisposition, contentLength);
1217             downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
1218         });
1219
1220         // Allow pinch to zoom.
1221         mainWebView.getSettings().setBuiltInZoomControls(true);
1222
1223         // Hide zoom controls.
1224         mainWebView.getSettings().setDisplayZoomControls(false);
1225
1226         // Set `mainWebView` to use a wide viewport.  Otherwise, some web pages will be scrunched and some content will render outside the screen.
1227         mainWebView.getSettings().setUseWideViewPort(true);
1228
1229         // Set `mainWebView` to load in overview mode (zoomed out to the maximum width).
1230         mainWebView.getSettings().setLoadWithOverviewMode(true);
1231
1232         // Explicitly disable geolocation.
1233         mainWebView.getSettings().setGeolocationEnabled(false);
1234
1235         // Initialize cookieManager.
1236         cookieManager = CookieManager.getInstance();
1237
1238         // 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).
1239         customHeaders.put("X-Requested-With", "");
1240
1241         // 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.
1242         PreferenceManager.setDefaultValues(this, R.xml.preferences, false);
1243
1244         // Get the intent that started the app.
1245         final Intent launchingIntent = getIntent();
1246
1247         // Extract the launching intent data as `launchingIntentUriData`.
1248         final Uri launchingIntentUriData = launchingIntent.getData();
1249
1250         // Convert the launching intent URI data (if it exists) to a string and store it in `formattedUrlString`.
1251         if (launchingIntentUriData != null) {
1252             formattedUrlString = launchingIntentUriData.toString();
1253         }
1254
1255         // Get a handle for the `Runtime`.
1256         privacyBrowserRuntime = Runtime.getRuntime();
1257
1258         // Store the application's private data directory.
1259         privateDataDirectoryString = getApplicationInfo().dataDir;  // `dataDir` will vary, but will be something like `/data/user/0/com.stoutner.privacybrowser.standard`, which links to `/data/data/com.stoutner.privacybrowser.standard`.
1260
1261         // Initialize `inFullScreenBrowsingMode`, which is always false at this point because Privacy Browser never starts in full screen browsing mode.
1262         inFullScreenBrowsingMode = false;
1263
1264         // Initialize AdView for the free flavor.
1265         adView = findViewById(R.id.adview);
1266
1267         // Initialize the privacy settings variables.
1268         javaScriptEnabled = false;
1269         firstPartyCookiesEnabled = false;
1270         thirdPartyCookiesEnabled = false;
1271         domStorageEnabled = false;
1272         saveFormDataEnabled = false;
1273         nightMode = false;
1274
1275         // Initialize `webViewTitle`.
1276         webViewTitle = getString(R.string.no_title);
1277
1278         // Initialize `favoriteIconBitmap`.  We have to use `ContextCompat` until API >= 21.
1279         Drawable favoriteIconDrawable = ContextCompat.getDrawable(getApplicationContext(), R.drawable.world);
1280         BitmapDrawable favoriteIconBitmapDrawable = (BitmapDrawable) favoriteIconDrawable;
1281         favoriteIconDefaultBitmap = favoriteIconBitmapDrawable.getBitmap();
1282
1283         // If the favorite icon is null, load the default.
1284         if (favoriteIconBitmap == null) {
1285             favoriteIconBitmap = favoriteIconDefaultBitmap;
1286         }
1287
1288         // Apply the app settings from the shared preferences.
1289         applyAppSettings();
1290
1291         // Load `formattedUrlString` if we are not waiting for Orbot to connect.
1292         if (!waitingForOrbot) {
1293             loadUrl(formattedUrlString);
1294         }
1295     }
1296
1297     @Override
1298     protected void onNewIntent(Intent intent) {
1299         // Sets the new intent as the activity intent, so that any future `getIntent()`s pick up this one instead of creating a new activity.
1300         setIntent(intent);
1301
1302         if (intent.getData() != null) {
1303             // Get the intent data and convert it to a string.
1304             final Uri intentUriData = intent.getData();
1305             formattedUrlString = intentUriData.toString();
1306         }
1307
1308         // Close the navigation drawer if it is open.
1309         if (drawerLayout.isDrawerVisible(GravityCompat.START)) {
1310             drawerLayout.closeDrawer(GravityCompat.START);
1311         }
1312
1313         // Load the website.
1314         loadUrl(formattedUrlString);
1315
1316         // Clear the keyboard if displayed and remove the focus on the urlTextBar if it has it.
1317         mainWebView.requestFocus();
1318     }
1319
1320     @Override
1321     public void onRestart() {
1322         super.onRestart();
1323
1324         // Apply the app settings, which may have been changed in `SettingsActivity`.
1325         applyAppSettings();
1326
1327         // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1328         updatePrivacyIcons(true);
1329
1330         // Set the display webpage images mode.
1331         setDisplayWebpageImages();
1332
1333         // Reload the webpage if displaying of images has been disabled in `SettingsFragment`.
1334         if (reloadOnRestart) {
1335             // Reload `mainWebView`.
1336             mainWebView.reload();
1337
1338             // Reset `reloadOnRestartBoolean`.
1339             reloadOnRestart = false;
1340         }
1341
1342         // Load the URL on restart to apply changes to night mode.
1343         if (loadUrlOnRestart) {
1344             // Load the current `formattedUrlString`.
1345             loadUrl(formattedUrlString);
1346
1347             // Reset `loadUrlOnRestart.
1348             loadUrlOnRestart = false;
1349         }
1350
1351         //
1352         if (restartFromBookmarksActivity) {
1353             // Close the bookmarks drawer.
1354             drawerLayout.closeDrawer(GravityCompat.END);
1355
1356             // Reload the bookmarks drawer.
1357             loadBookmarksFolder();
1358
1359             // Reset `restartFromBookmarksActivity`.
1360             restartFromBookmarksActivity = false;
1361         }
1362     }
1363
1364     // `onResume()` runs after `onStart()`, which runs after `onCreate()` and `onRestart()`.
1365     @Override
1366     public void onResume() {
1367         super.onResume();
1368
1369         // Resume JavaScript (if enabled).
1370         mainWebView.resumeTimers();
1371
1372         // Resume `mainWebView`.
1373         mainWebView.onResume();
1374
1375         // Resume the adView for the free flavor.
1376         if (BuildConfig.FLAVOR.contentEquals("free")) {
1377             BannerAd.resumeAd(adView);
1378         }
1379     }
1380
1381     @Override
1382     public void onPause() {
1383         // Pause `mainWebView`.
1384         mainWebView.onPause();
1385
1386         // Stop all JavaScript.
1387         mainWebView.pauseTimers();
1388
1389         // Pause the adView or it will continue to consume resources in the background on the free flavor.
1390         if (BuildConfig.FLAVOR.contentEquals("free")) {
1391             BannerAd.pauseAd(adView);
1392         }
1393
1394         super.onPause();
1395     }
1396
1397     @Override
1398     public boolean onCreateOptionsMenu(Menu menu) {
1399         // Inflate the menu; this adds items to the action bar if it is present.
1400         getMenuInflater().inflate(R.menu.webview_options_menu, menu);
1401
1402         // Set mainMenu so it can be used by `onOptionsItemSelected()` and `updatePrivacyIcons`.
1403         mainMenu = menu;
1404
1405         // Set the initial status of the privacy icons.  `false` does not call `invalidateOptionsMenu` as the last step.
1406         updatePrivacyIcons(false);
1407
1408         // Get handles for the menu items.
1409         MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1410         MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1411         MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1412         MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data);
1413
1414         // Only display third-party cookies if SDK >= 21
1415         toggleThirdPartyCookiesMenuItem.setVisible(Build.VERSION.SDK_INT >= 21);
1416
1417         // Get the shared preference values.  `this` references the current context.
1418         SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
1419
1420         // Set the status of the additional app bar icons.  The default is `false`.
1421         if (sharedPreferences.getBoolean("display_additional_app_bar_icons", false)) {
1422             toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1423             toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1424             toggleSaveFormDataMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1425         } else { //Do not display the additional icons.
1426             toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1427             toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1428             toggleSaveFormDataMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1429         }
1430
1431         return true;
1432     }
1433
1434     @Override
1435     public boolean onPrepareOptionsMenu(Menu menu) {
1436         // Get handles for the menu items.
1437         MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1438         MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1439         MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1440         MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data);
1441         MenuItem clearCookiesMenuItem = menu.findItem(R.id.clear_cookies);
1442         MenuItem clearDOMStorageMenuItem = menu.findItem(R.id.clear_dom_storage);
1443         MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data);
1444         MenuItem fontSizeMenuItem = menu.findItem(R.id.font_size);
1445         MenuItem displayImagesMenuItem = menu.findItem(R.id.display_images);
1446         MenuItem refreshMenuItem = menu.findItem(R.id.refresh);
1447
1448         // Set the status of the menu item checkboxes.
1449         toggleFirstPartyCookiesMenuItem.setChecked(firstPartyCookiesEnabled);
1450         toggleThirdPartyCookiesMenuItem.setChecked(thirdPartyCookiesEnabled);
1451         toggleDomStorageMenuItem.setChecked(domStorageEnabled);
1452         toggleSaveFormDataMenuItem.setChecked(saveFormDataEnabled);
1453         displayImagesMenuItem.setChecked(mainWebView.getSettings().getLoadsImagesAutomatically());
1454
1455         // Enable third-party cookies if first-party cookies are enabled.
1456         toggleThirdPartyCookiesMenuItem.setEnabled(firstPartyCookiesEnabled);
1457
1458         // Enable `DOM Storage` if JavaScript is enabled.
1459         toggleDomStorageMenuItem.setEnabled(javaScriptEnabled);
1460
1461         // Enable `Clear Cookies` if there are any.
1462         clearCookiesMenuItem.setEnabled(cookieManager.hasCookies());
1463
1464         // Get a count of the number of files in the `Local Storage` directory.
1465         File localStorageDirectory = new File (privateDataDirectoryString + "/app_webview/Local Storage/");
1466         int localStorageDirectoryNumberOfFiles = 0;
1467         if (localStorageDirectory.exists()) {
1468             localStorageDirectoryNumberOfFiles = localStorageDirectory.list().length;
1469         }
1470
1471         // Get a count of the number of files in the `IndexedDB` directory.
1472         File indexedDBDirectory = new File (privateDataDirectoryString + "/app_webview/IndexedDB");
1473         int indexedDBDirectoryNumberOfFiles = 0;
1474         if (indexedDBDirectory.exists()) {
1475             indexedDBDirectoryNumberOfFiles = indexedDBDirectory.list().length;
1476         }
1477
1478         // Enable `Clear DOM Storage` if there is any.
1479         clearDOMStorageMenuItem.setEnabled(localStorageDirectoryNumberOfFiles > 0 || indexedDBDirectoryNumberOfFiles > 0);
1480
1481         // Enable `Clear Form Data` is there is any.
1482         WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(this);
1483         clearFormDataMenuItem.setEnabled(mainWebViewDatabase.hasFormData());
1484
1485         // Initialize font size variables.
1486         int fontSize = mainWebView.getSettings().getTextZoom();
1487         String fontSizeTitle;
1488         MenuItem selectedFontSizeMenuItem;
1489
1490         // Prepare the font size title and current size menu item.
1491         switch (fontSize) {
1492             case 25:
1493                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.twenty_five_percent);
1494                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_twenty_five_percent);
1495                 break;
1496
1497             case 50:
1498                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.fifty_percent);
1499                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_fifty_percent);
1500                 break;
1501
1502             case 75:
1503                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.seventy_five_percent);
1504                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_seventy_five_percent);
1505                 break;
1506
1507             case 100:
1508                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1509                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1510                 break;
1511
1512             case 125:
1513                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_twenty_five_percent);
1514                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_twenty_five_percent);
1515                 break;
1516
1517             case 150:
1518                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_fifty_percent);
1519                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_fifty_percent);
1520                 break;
1521
1522             case 175:
1523                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_seventy_five_percent);
1524                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_seventy_five_percent);
1525                 break;
1526
1527             case 200:
1528                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.two_hundred_percent);
1529                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_two_hundred_percent);
1530                 break;
1531
1532             default:
1533                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1534                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1535                 break;
1536         }
1537
1538         // Set the font size title and select the current size menu item.
1539         fontSizeMenuItem.setTitle(fontSizeTitle);
1540         selectedFontSizeMenuItem.setChecked(true);
1541
1542         // Only show `Refresh` if `swipeToRefresh` is disabled.
1543         refreshMenuItem.setVisible(!swipeToRefreshEnabled);
1544
1545         // Run all the other default commands.
1546         super.onPrepareOptionsMenu(menu);
1547
1548         // `return true` displays the menu.
1549         return true;
1550     }
1551
1552     @Override
1553     // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
1554     @SuppressLint("SetJavaScriptEnabled")
1555     // removeAllCookies is deprecated, but it is required for API < 21.
1556     @SuppressWarnings("deprecation")
1557     public boolean onOptionsItemSelected(MenuItem menuItem) {
1558         int menuItemId = menuItem.getItemId();
1559
1560         // Set the commands that relate to the menu entries.
1561         switch (menuItemId) {
1562             case R.id.toggle_javascript:
1563                 // Switch the status of javaScriptEnabled.
1564                 javaScriptEnabled = !javaScriptEnabled;
1565
1566                 // Apply the new JavaScript status.
1567                 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
1568
1569                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1570                 updatePrivacyIcons(true);
1571
1572                 // Display a `Snackbar`.
1573                 if (javaScriptEnabled) {  // JavaScrip is enabled.
1574                     Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show();
1575                 } else if (firstPartyCookiesEnabled) {  // JavaScript is disabled, but first-party cookies are enabled.
1576                     Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show();
1577                 } else {  // Privacy mode.
1578                     Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1579                 }
1580
1581                 // Reload the WebView.
1582                 mainWebView.reload();
1583                 return true;
1584
1585             case R.id.toggle_first_party_cookies:
1586                 // Switch the status of firstPartyCookiesEnabled.
1587                 firstPartyCookiesEnabled = !firstPartyCookiesEnabled;
1588
1589                 // Update the menu checkbox.
1590                 menuItem.setChecked(firstPartyCookiesEnabled);
1591
1592                 // Apply the new cookie status.
1593                 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
1594
1595                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1596                 updatePrivacyIcons(true);
1597
1598                 // Display a `Snackbar`.
1599                 if (firstPartyCookiesEnabled) {  // First-party cookies are enabled.
1600                     Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1601                 } else if (javaScriptEnabled){  // JavaScript is still enabled.
1602                     Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1603                 } else {  // Privacy mode.
1604                     Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1605                 }
1606
1607                 // Reload the WebView.
1608                 mainWebView.reload();
1609                 return true;
1610
1611             case R.id.toggle_third_party_cookies:
1612                 if (Build.VERSION.SDK_INT >= 21) {
1613                     // Switch the status of thirdPartyCookiesEnabled.
1614                     thirdPartyCookiesEnabled = !thirdPartyCookiesEnabled;
1615
1616                     // Update the menu checkbox.
1617                     menuItem.setChecked(thirdPartyCookiesEnabled);
1618
1619                     // Apply the new cookie status.
1620                     cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
1621
1622                     // Display a `Snackbar`.
1623                     if (thirdPartyCookiesEnabled) {
1624                         Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1625                     } else {
1626                         Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1627                     }
1628
1629                     // Reload the WebView.
1630                     mainWebView.reload();
1631                 } // Else do nothing because SDK < 21.
1632                 return true;
1633
1634             case R.id.toggle_dom_storage:
1635                 // Switch the status of domStorageEnabled.
1636                 domStorageEnabled = !domStorageEnabled;
1637
1638                 // Update the menu checkbox.
1639                 menuItem.setChecked(domStorageEnabled);
1640
1641                 // Apply the new DOM Storage status.
1642                 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
1643
1644                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1645                 updatePrivacyIcons(true);
1646
1647                 // Display a `Snackbar`.
1648                 if (domStorageEnabled) {
1649                     Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show();
1650                 } else {
1651                     Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show();
1652                 }
1653
1654                 // Reload the WebView.
1655                 mainWebView.reload();
1656                 return true;
1657
1658             case R.id.toggle_save_form_data:
1659                 // Switch the status of saveFormDataEnabled.
1660                 saveFormDataEnabled = !saveFormDataEnabled;
1661
1662                 // Update the menu checkbox.
1663                 menuItem.setChecked(saveFormDataEnabled);
1664
1665                 // Apply the new form data status.
1666                 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
1667
1668                 // Display a `Snackbar`.
1669                 if (saveFormDataEnabled) {
1670                     Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show();
1671                 } else {
1672                     Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show();
1673                 }
1674
1675                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1676                 updatePrivacyIcons(true);
1677
1678                 // Reload the WebView.
1679                 mainWebView.reload();
1680                 return true;
1681
1682             case R.id.clear_cookies:
1683                 Snackbar.make(findViewById(R.id.main_webview), R.string.cookies_deleted, Snackbar.LENGTH_LONG)
1684                         .setAction(R.string.undo, v -> {
1685                             // Do nothing because everything will be handled by `onDismissed()` below.
1686                         })
1687                         .addCallback(new Snackbar.Callback() {
1688                             @Override
1689                             public void onDismissed(Snackbar snackbar, int event) {
1690                                 switch (event) {
1691                                     // The user pushed the `Undo` button.
1692                                     case Snackbar.Callback.DISMISS_EVENT_ACTION:
1693                                         // Do nothing.
1694                                         break;
1695
1696                                     // The `Snackbar` was dismissed without the `Undo` button being pushed.
1697                                     default:
1698                                         // `cookieManager.removeAllCookie()` varies by SDK.
1699                                         if (Build.VERSION.SDK_INT < 21) {
1700                                             cookieManager.removeAllCookie();
1701                                         } else {
1702                                             // `null` indicates no callback.
1703                                             cookieManager.removeAllCookies(null);
1704                                         }
1705                                 }
1706                             }
1707                         })
1708                         .show();
1709                 return true;
1710
1711             case R.id.clear_dom_storage:
1712                 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
1713                         .setAction(R.string.undo, v -> {
1714                             // Do nothing because everything will be handled by `onDismissed()` below.
1715                         })
1716                         .addCallback(new Snackbar.Callback() {
1717                             @Override
1718                             public void onDismissed(Snackbar snackbar, int event) {
1719                                 switch (event) {
1720                                     // The user pushed the `Undo` button.
1721                                     case Snackbar.Callback.DISMISS_EVENT_ACTION:
1722                                         // Do nothing.
1723                                         break;
1724
1725                                     // The `Snackbar` was dismissed without the `Undo` button being pushed.
1726                                     default:
1727                                         // Delete the DOM Storage.
1728                                         WebStorage webStorage = WebStorage.getInstance();
1729                                         webStorage.deleteAllData();
1730
1731                                         // Manually remove `IndexedDB` if it exists.
1732                                         try {
1733                                             privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
1734                                         } catch (IOException e) {
1735                                             // Do nothing if an error is thrown.
1736                                         }
1737                                 }
1738                             }
1739                         })
1740                         .show();
1741                 return true;
1742
1743             case R.id.clear_form_data:
1744                 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_deleted, Snackbar.LENGTH_LONG)
1745                         .setAction(R.string.undo, v -> {
1746                             // Do nothing because everything will be handled by `onDismissed()` below.
1747                         })
1748                         .addCallback(new Snackbar.Callback() {
1749                             @Override
1750                             public void onDismissed(Snackbar snackbar, int event) {
1751                                 switch (event) {
1752                                     // The user pushed the `Undo` button.
1753                                     case Snackbar.Callback.DISMISS_EVENT_ACTION:
1754                                         // Do nothing.
1755                                         break;
1756
1757                                     // The `Snackbar` was dismissed without the `Undo` button being pushed.
1758                                     default:
1759                                         // Delete the form data.
1760                                         WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(getApplicationContext());
1761                                         mainWebViewDatabase.clearFormData();
1762                                 }
1763                             }
1764                         })
1765                         .show();
1766                 return true;
1767
1768             case R.id.font_size_twenty_five_percent:
1769                 mainWebView.getSettings().setTextZoom(25);
1770                 return true;
1771
1772             case R.id.font_size_fifty_percent:
1773                 mainWebView.getSettings().setTextZoom(50);
1774                 return true;
1775
1776             case R.id.font_size_seventy_five_percent:
1777                 mainWebView.getSettings().setTextZoom(75);
1778                 return true;
1779
1780             case R.id.font_size_one_hundred_percent:
1781                 mainWebView.getSettings().setTextZoom(100);
1782                 return true;
1783
1784             case R.id.font_size_one_hundred_twenty_five_percent:
1785                 mainWebView.getSettings().setTextZoom(125);
1786                 return true;
1787
1788             case R.id.font_size_one_hundred_fifty_percent:
1789                 mainWebView.getSettings().setTextZoom(150);
1790                 return true;
1791
1792             case R.id.font_size_one_hundred_seventy_five_percent:
1793                 mainWebView.getSettings().setTextZoom(175);
1794                 return true;
1795
1796             case R.id.font_size_two_hundred_percent:
1797                 mainWebView.getSettings().setTextZoom(200);
1798                 return true;
1799
1800             case R.id.display_images:
1801                 if (mainWebView.getSettings().getLoadsImagesAutomatically()) {  // Images are currently loaded automatically.
1802                     mainWebView.getSettings().setLoadsImagesAutomatically(false);
1803                     mainWebView.reload();
1804                 } else {  // Images are not currently loaded automatically.
1805                     mainWebView.getSettings().setLoadsImagesAutomatically(true);
1806                 }
1807
1808                 // Set `onTheFlyDisplayImagesSet`.
1809                 onTheFlyDisplayImagesSet = true;
1810                 return true;
1811
1812             case R.id.share:
1813                 // Setup the share string.
1814                 String shareString = webViewTitle + " – " + urlTextBox.getText().toString();
1815
1816                 // Create the share intent.
1817                 Intent shareIntent = new Intent();
1818                 shareIntent.setAction(Intent.ACTION_SEND);
1819                 shareIntent.putExtra(Intent.EXTRA_TEXT, shareString);
1820                 shareIntent.setType("text/plain");
1821
1822                 // Make it so.
1823                 startActivity(Intent.createChooser(shareIntent, "Share URL"));
1824                 return true;
1825
1826             case R.id.find_on_page:
1827                 // Hide the URL app bar.
1828                 supportAppBar.setVisibility(View.GONE);
1829
1830                 // Show the Find on Page `RelativeLayout`.
1831                 findOnPageLinearLayout.setVisibility(View.VISIBLE);
1832
1833                 // Display the keyboard.  We have to wait 200 ms before running the command to work around a bug in Android.  http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
1834                 findOnPageEditText.postDelayed(() -> {
1835                     // Set the focus on `findOnPageEditText`.
1836                     findOnPageEditText.requestFocus();
1837
1838                     // Display the keyboard.  `0` sets no input flags.
1839                     inputMethodManager.showSoftInput(findOnPageEditText, 0);
1840                 }, 200);
1841                 return true;
1842
1843             case R.id.print:
1844                 // Get a `PrintManager` instance.
1845                 PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
1846
1847                 // Convert `mainWebView` to `printDocumentAdapter`.
1848                 PrintDocumentAdapter printDocumentAdapter = mainWebView.createPrintDocumentAdapter();
1849
1850                 // Remove the lint error below that `printManager` might be `null`.
1851                 assert printManager != null;
1852
1853                 // Print the document.  The print attributes are `null`.
1854                 printManager.print(getString(R.string.privacy_browser_web_page), printDocumentAdapter, null);
1855                 return true;
1856
1857             case R.id.add_to_homescreen:
1858                 // Show the `CreateHomeScreenShortcutDialog` `AlertDialog` and name this instance `R.string.create_shortcut`.
1859                 AppCompatDialogFragment createHomeScreenShortcutDialogFragment = new CreateHomeScreenShortcutDialog();
1860                 createHomeScreenShortcutDialogFragment.show(getSupportFragmentManager(), getString(R.string.create_shortcut));
1861
1862                 //Everything else will be handled by `CreateHomeScreenShortcutDialog` and the associated listener below.
1863                 return true;
1864
1865             case R.id.refresh:
1866                 mainWebView.reload();
1867                 return true;
1868
1869             default:
1870                 // Don't consume the event.
1871                 return super.onOptionsItemSelected(menuItem);
1872         }
1873     }
1874
1875     // removeAllCookies is deprecated, but it is required for API < 21.
1876     @SuppressWarnings("deprecation")
1877     @Override
1878     public boolean onNavigationItemSelected(@NonNull MenuItem menuItem) {
1879         int menuItemId = menuItem.getItemId();
1880
1881         switch (menuItemId) {
1882             case R.id.home:
1883                 loadUrl(homepage);
1884                 break;
1885
1886             case R.id.back:
1887                 if (mainWebView.canGoBack()) {
1888                     // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
1889                     navigatingHistory = true;
1890
1891                     // Load the previous website in the history.
1892                     mainWebView.goBack();
1893                 }
1894                 break;
1895
1896             case R.id.forward:
1897                 if (mainWebView.canGoForward()) {
1898                     // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
1899                     navigatingHistory = true;
1900
1901                     // Load the next website in the history.
1902                     mainWebView.goForward();
1903                 }
1904                 break;
1905
1906             case R.id.history:
1907                 // Get the `WebBackForwardList`.
1908                 WebBackForwardList webBackForwardList = mainWebView.copyBackForwardList();
1909
1910                 // Show the `UrlHistoryDialog` `AlertDialog` and name this instance `R.string.history`.  `this` is the `Context`.
1911                 AppCompatDialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(this, webBackForwardList);
1912                 urlHistoryDialogFragment.show(getSupportFragmentManager(), getString(R.string.history));
1913                 break;
1914
1915             case R.id.downloads:
1916                 // Launch the system Download Manager.
1917                 Intent downloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
1918
1919                 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
1920                 downloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1921
1922                 startActivity(downloadManagerIntent);
1923                 break;
1924
1925             case R.id.domains:
1926                 // Reset `currentDomainName` so that domain settings are reapplied after returning to `MainWebViewActivity`.
1927                 currentDomainName = "";
1928
1929                 // Launch `DomainsActivity`.
1930                 Intent domainsIntent = new Intent(this, DomainsActivity.class);
1931                 startActivity(domainsIntent);
1932                 break;
1933
1934             case R.id.settings:
1935                 // Reset `currentDomainName` so that domain settings are reapplied after returning to `MainWebViewActivity`.
1936                 currentDomainName = "";
1937
1938                 // Launch `SettingsActivity`.
1939                 Intent settingsIntent = new Intent(this, SettingsActivity.class);
1940                 startActivity(settingsIntent);
1941                 break;
1942
1943             case R.id.guide:
1944                 // Launch `GuideActivity`.
1945                 Intent guideIntent = new Intent(this, GuideActivity.class);
1946                 startActivity(guideIntent);
1947                 break;
1948
1949             case R.id.about:
1950                 // Launch `AboutActivity`.
1951                 Intent aboutIntent = new Intent(this, AboutActivity.class);
1952                 startActivity(aboutIntent);
1953                 break;
1954
1955             case R.id.clearAndExit:
1956                 // Get a handle for `sharedPreferences`.  `this` references the current context.
1957                 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
1958
1959                 boolean clearEverything = sharedPreferences.getBoolean("clear_everything", true);
1960
1961                 // Clear cookies.
1962                 if (clearEverything || sharedPreferences.getBoolean("clear_cookies", true)) {
1963                     // The command to remove cookies changed slightly in API 21.
1964                     if (Build.VERSION.SDK_INT >= 21) {
1965                         cookieManager.removeAllCookies(null);
1966                     } else {
1967                         cookieManager.removeAllCookie();
1968                     }
1969
1970                     // Manually delete the cookies database, as `CookieManager` sometimes will not flush its changes to disk before `System.exit(0)` is run.
1971                     try {
1972                         // We have to use two commands because `Runtime.exec()` does not like `*`.
1973                         privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies");
1974                         privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies-journal");
1975                     } catch (IOException e) {
1976                         // Do nothing if an error is thrown.
1977                     }
1978                 }
1979
1980                 // Clear DOM storage.
1981                 if (clearEverything || sharedPreferences.getBoolean("clear_dom_storage", true)) {
1982                     // Ask `WebStorage` to clear the DOM storage.
1983                     WebStorage webStorage = WebStorage.getInstance();
1984                     webStorage.deleteAllData();
1985
1986                     // Manually delete the DOM storage files and directories, as `WebStorage` sometimes will not flush its changes to disk before `System.exit(0)` is run.
1987                     try {
1988                         // We have to use a `String[]` because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
1989                         privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
1990
1991                         // We have to use multiple commands because `Runtime.exec()` does not like `*`.
1992                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
1993                         privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
1994                         privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
1995                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
1996                     } catch (IOException e) {
1997                         // Do nothing if an error is thrown.
1998                     }
1999                 }
2000
2001                 // Clear form data.
2002                 if (clearEverything || sharedPreferences.getBoolean("clear_form_data", true)) {
2003                     WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
2004                     webViewDatabase.clearFormData();
2005
2006                     // Manually delete the form data database, as `WebViewDatabase` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2007                     try {
2008                         // We have to use a `String[]` because the database contains a space and `Runtime.exec` will not escape the string correctly otherwise.
2009                         privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data"});
2010                         privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data-journal"});
2011                     } catch (IOException e) {
2012                         // Do nothing if an error is thrown.
2013                     }
2014                 }
2015
2016                 // Clear the cache.
2017                 if (clearEverything || sharedPreferences.getBoolean("clear_cache", true)) {
2018                     // `true` includes disk files.
2019                     mainWebView.clearCache(true);
2020
2021                     // Manually delete the cache directories.
2022                     try {
2023                         // Delete the main cache directory.
2024                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
2025
2026                         // Delete the secondary `Service Worker` cache directory.  We have to use a `String[]` because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
2027                         privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
2028                     } catch (IOException e) {
2029                         // Do nothing if an error is thrown.
2030                     }
2031                 }
2032
2033                 // Clear SSL certificate preferences.
2034                 mainWebView.clearSslPreferences();
2035
2036                 // Clear the back/forward history.
2037                 mainWebView.clearHistory();
2038
2039                 // Clear `formattedUrlString`.
2040                 formattedUrlString = null;
2041
2042                 // Clear `customHeaders`.
2043                 customHeaders.clear();
2044
2045                 // Detach all views from `mainWebViewRelativeLayout`.
2046                 mainWebViewRelativeLayout.removeAllViews();
2047
2048                 // Destroy the internal state of `mainWebView`.
2049                 mainWebView.destroy();
2050
2051                 // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
2052                 // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
2053                 if (clearEverything) {
2054                     try {
2055                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
2056                     } catch (IOException e) {
2057                         // Do nothing if an error is thrown.
2058                     }
2059                 }
2060
2061                 // Close Privacy Browser.  `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
2062                 if (Build.VERSION.SDK_INT >= 21) {
2063                     finishAndRemoveTask();
2064                 } else {
2065                     finish();
2066                 }
2067
2068                 // Remove the terminated program from RAM.  The status code is `0`.
2069                 System.exit(0);
2070                 break;
2071         }
2072
2073         // Close the navigation drawer.
2074         drawerLayout.closeDrawer(GravityCompat.START);
2075         return true;
2076     }
2077
2078     @Override
2079     public void onPostCreate(Bundle savedInstanceState) {
2080         super.onPostCreate(savedInstanceState);
2081
2082         // Sync the state of the DrawerToggle after onRestoreInstanceState has finished.
2083         drawerToggle.syncState();
2084     }
2085
2086     @Override
2087     public void onConfigurationChanged(Configuration newConfig) {
2088         super.onConfigurationChanged(newConfig);
2089
2090         // Reload the ad for the free flavor if we are not in full screen mode.
2091         if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
2092             // Reload the ad.
2093             BannerAd.reloadAfterRotate(adView, getApplicationContext(), getString(R.string.ad_id));
2094
2095             // Reinitialize the `adView` variable, as the `View` will have been removed and re-added by `BannerAd.reloadAfterRotate()`.
2096             adView = findViewById(R.id.adview);
2097         }
2098
2099         // `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
2100         // ActivityCompat.invalidateOptionsMenu(this);
2101     }
2102
2103     @Override
2104     public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
2105         // Store the `HitTestResult`.
2106         final WebView.HitTestResult hitTestResult = mainWebView.getHitTestResult();
2107
2108         // Create strings.
2109         final String imageUrl;
2110         final String linkUrl;
2111
2112         // Get a handle for the `ClipboardManager`.
2113         final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
2114
2115         // Remove the lint errors below that `clipboardManager` might be `null`.
2116         assert clipboardManager != null;
2117
2118         switch (hitTestResult.getType()) {
2119             // `SRC_ANCHOR_TYPE` is a link.
2120             case WebView.HitTestResult.SRC_ANCHOR_TYPE:
2121                 // Get the target URL.
2122                 linkUrl = hitTestResult.getExtra();
2123
2124                 // Set the target URL as the title of the `ContextMenu`.
2125                 menu.setHeaderTitle(linkUrl);
2126
2127                 // Add a `Load URL` entry.
2128                 menu.add(R.string.load_url).setOnMenuItemClickListener(item -> {
2129                     loadUrl(linkUrl);
2130                     return false;
2131                 });
2132
2133                 // Add a `Copy URL` entry.
2134                 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2135                     // Save the link URL in a `ClipData`.
2136                     ClipData srcAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
2137
2138                     // Set the `ClipData` as the clipboard's primary clip.
2139                     clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
2140                     return false;
2141                 });
2142
2143                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2144                 menu.add(R.string.cancel);
2145                 break;
2146
2147             case WebView.HitTestResult.EMAIL_TYPE:
2148                 // Get the target URL.
2149                 linkUrl = hitTestResult.getExtra();
2150
2151                 // Set the target URL as the title of the `ContextMenu`.
2152                 menu.setHeaderTitle(linkUrl);
2153
2154                 // Add a `Write Email` entry.
2155                 menu.add(R.string.write_email).setOnMenuItemClickListener(item -> {
2156                     // We use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
2157                     Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
2158
2159                     // Parse the url and set it as the data for the `Intent`.
2160                     emailIntent.setData(Uri.parse("mailto:" + linkUrl));
2161
2162                     // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
2163                     emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2164
2165                     // Make it so.
2166                     startActivity(emailIntent);
2167                     return false;
2168                 });
2169
2170                 // Add a `Copy Email Address` entry.
2171                 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(item -> {
2172                     // Save the email address in a `ClipData`.
2173                     ClipData srcEmailTypeClipData = ClipData.newPlainText(getString(R.string.email_address), linkUrl);
2174
2175                     // Set the `ClipData` as the clipboard's primary clip.
2176                     clipboardManager.setPrimaryClip(srcEmailTypeClipData);
2177                     return false;
2178                 });
2179
2180                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2181                 menu.add(R.string.cancel);
2182                 break;
2183
2184             // `IMAGE_TYPE` is an image.
2185             case WebView.HitTestResult.IMAGE_TYPE:
2186                 // Get the image URL.
2187                 imageUrl = hitTestResult.getExtra();
2188
2189                 // Set the image URL as the title of the `ContextMenu`.
2190                 menu.setHeaderTitle(imageUrl);
2191
2192                 // Add a `View Image` entry.
2193                 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2194                     loadUrl(imageUrl);
2195                     return false;
2196                 });
2197
2198                 // Add a `Download Image` entry.
2199                 menu.add(R.string.download_image).setOnMenuItemClickListener(item -> {
2200                     // Show the `DownloadImageDialog` `AlertDialog` and name this instance `@string/download`.
2201                     AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2202                     downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2203                     return false;
2204                 });
2205
2206                 // Add a `Copy URL` entry.
2207                 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2208                     // Save the image URL in a `ClipData`.
2209                     ClipData srcImageTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2210
2211                     // Set the `ClipData` as the clipboard's primary clip.
2212                     clipboardManager.setPrimaryClip(srcImageTypeClipData);
2213                     return false;
2214                 });
2215
2216                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2217                 menu.add(R.string.cancel);
2218                 break;
2219
2220
2221             // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
2222             case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
2223                 // Get the image URL.
2224                 imageUrl = hitTestResult.getExtra();
2225
2226                 // Set the image URL as the title of the `ContextMenu`.
2227                 menu.setHeaderTitle(imageUrl);
2228
2229                 // Add a `View Image` entry.
2230                 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2231                     loadUrl(imageUrl);
2232                     return false;
2233                 });
2234
2235                 // Add a `Download Image` entry.
2236                 menu.add(R.string.download_image).setOnMenuItemClickListener(item -> {
2237                     // Show the `DownloadImageDialog` `AlertDialog` and name this instance `@string/download`.
2238                     AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2239                     downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2240                     return false;
2241                 });
2242
2243                 // Add a `Copy URL` entry.
2244                 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2245                     // Save the image URL in a `ClipData`.
2246                     ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2247
2248                     // Set the `ClipData` as the clipboard's primary clip.
2249                     clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
2250                     return false;
2251                 });
2252
2253                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2254                 menu.add(R.string.cancel);
2255                 break;
2256         }
2257     }
2258
2259     @Override
2260     public void onCreateBookmark(AppCompatDialogFragment dialogFragment) {
2261         // Get the `EditTexts` from the `dialogFragment`.
2262         EditText createBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_name_edittext);
2263         EditText createBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_url_edittext);
2264
2265         // Extract the strings from the `EditTexts`.
2266         String bookmarkNameString = createBookmarkNameEditText.getText().toString();
2267         String bookmarkUrlString = createBookmarkUrlEditText.getText().toString();
2268
2269         // Convert the favoriteIcon Bitmap to a byte array.  `0` is for lossless compression (the only option for a PNG).
2270         ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2271         favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
2272         byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
2273
2274         // Display the new bookmark below the current items in the (0 indexed) list.
2275         int newBookmarkDisplayOrder = bookmarksListView.getCount();
2276
2277         // Create the bookmark.
2278         bookmarksDatabaseHelper.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray);
2279
2280         // Update `bookmarksCursor` with the current contents of this folder.
2281         bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2282
2283         // Update the `ListView`.
2284         bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2285
2286         // Scroll to the new bookmark.
2287         bookmarksListView.setSelection(newBookmarkDisplayOrder);
2288     }
2289
2290     @Override
2291     public void onCreateBookmarkFolder(AppCompatDialogFragment dialogFragment) {
2292         // Get handles for the views in `dialogFragment`.
2293         EditText createFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.create_folder_name_edittext);
2294         RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon_radiobutton);
2295         ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon);
2296
2297         // Get new folder name string.
2298         String folderNameString = createFolderNameEditText.getText().toString();
2299
2300         // Get the new folder icon `Bitmap`.
2301         Bitmap folderIconBitmap;
2302         if (defaultFolderIconRadioButton.isChecked()) {  // Use the default folder icon.
2303             // Get the default folder icon and convert it to a `Bitmap`.
2304             Drawable folderIconDrawable = folderIconImageView.getDrawable();
2305             BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2306             folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2307         } else {  // Use the `WebView` favorite icon.
2308             folderIconBitmap = favoriteIconBitmap;
2309         }
2310
2311         // Convert `folderIconBitmap` to a byte array.  `0` is for lossless compression (the only option for a PNG).
2312         ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2313         folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
2314         byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
2315
2316         // Move all the bookmarks down one in the display order.
2317         for (int i = 0; i < bookmarksListView.getCount(); i++) {
2318             int databaseId = (int) bookmarksListView.getItemIdAtPosition(i);
2319             bookmarksDatabaseHelper.updateDisplayOrder(databaseId, i + 1);
2320         }
2321
2322         // Create the folder, which will be placed at the top of the `ListView`.
2323         bookmarksDatabaseHelper.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray);
2324
2325         // Update `bookmarksCursor` with the current contents of this folder.
2326         bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2327
2328         // Update the `ListView`.
2329         bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2330
2331         // Scroll to the new folder.
2332         bookmarksListView.setSelection(0);
2333     }
2334
2335     @Override
2336     public void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment) {
2337         // Get shortcutNameEditText from the alert dialog.
2338         EditText shortcutNameEditText = dialogFragment.getDialog().findViewById(R.id.shortcut_name_edittext);
2339
2340         // Create the bookmark shortcut based on formattedUrlString.
2341         Intent bookmarkShortcut = new Intent();
2342         bookmarkShortcut.setAction(Intent.ACTION_VIEW);
2343         bookmarkShortcut.setData(Uri.parse(formattedUrlString));
2344
2345         // Place the bookmark shortcut on the home screen.
2346         Intent placeBookmarkShortcut = new Intent();
2347         placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.INTENT", bookmarkShortcut);
2348         placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.NAME", shortcutNameEditText.getText().toString());
2349         placeBookmarkShortcut.putExtra("android.intent.extra.shortcut.ICON", favoriteIconBitmap);
2350         placeBookmarkShortcut.setAction("com.android.launcher.action.INSTALL_SHORTCUT");
2351         sendBroadcast(placeBookmarkShortcut);
2352     }
2353
2354     @Override
2355     public void onDownloadImage(AppCompatDialogFragment dialogFragment, String imageUrl) {
2356         // Download the image if it has an HTTP or HTTPS URI.
2357         if (imageUrl.startsWith("http")) {
2358             // Get a handle for the system `DOWNLOAD_SERVICE`.
2359             DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
2360
2361             // Parse `imageUrl`.
2362             DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(imageUrl));
2363
2364             // Pass cookies to download manager if cookies are enabled.  This is required to download images from websites that require a login.
2365             // Code contributed 2017 Hendrik Knackstedt.  Copyright assigned to Soren Stoutner <soren@stoutner.com>.
2366             if (firstPartyCookiesEnabled) {
2367                 // Get the cookies for `imageUrl`.
2368                 String cookies = cookieManager.getCookie(imageUrl);
2369
2370                 // Add the cookies to `downloadRequest`.  In the HTTP request header, cookies are named `Cookie`.
2371                 downloadRequest.addRequestHeader("Cookie", cookies);
2372             }
2373
2374             // Get the file name from `dialogFragment`.
2375             EditText downloadImageNameEditText = dialogFragment.getDialog().findViewById(R.id.download_image_name);
2376             String imageName = downloadImageNameEditText.getText().toString();
2377
2378             // Once we have `WRITE_EXTERNAL_STORAGE` permissions we can use `setDestinationInExternalPublicDir`.
2379             if (Build.VERSION.SDK_INT >= 23) { // If API >= 23, set the download save in the the `DIRECTORY_DOWNLOADS` using `imageName`.
2380                 downloadRequest.setDestinationInExternalFilesDir(this, "/", imageName);
2381             } else { // Only set the title using `imageName`.
2382                 downloadRequest.setTitle(imageName);
2383             }
2384
2385             // Allow `MediaScanner` to index the download if it is a media file.
2386             downloadRequest.allowScanningByMediaScanner();
2387
2388             // Add the URL as the description for the download.
2389             downloadRequest.setDescription(imageUrl);
2390
2391             // Show the download notification after the download is completed.
2392             downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
2393
2394             // Remove the lint warning below that `downloadManager` might be `null`.
2395             assert downloadManager != null;
2396
2397             // Initiate the download.
2398             downloadManager.enqueue(downloadRequest);
2399         } else {  // The image is not an HTTP or HTTPS URI.
2400             Snackbar.make(mainWebView, R.string.cannot_download_image, Snackbar.LENGTH_INDEFINITE).show();
2401         }
2402     }
2403
2404     @Override
2405     public void onDownloadFile(AppCompatDialogFragment dialogFragment, String downloadUrl) {
2406         // Download the file if it has an HTTP or HTTPS URI.
2407         if (downloadUrl.startsWith("http")) {
2408
2409             // Get a handle for the system `DOWNLOAD_SERVICE`.
2410             DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
2411
2412             // Parse `downloadUrl`.
2413             DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(downloadUrl));
2414
2415             // Pass cookies to download manager if cookies are enabled.  This is required to download files from websites that require a login.
2416             // Code contributed 2017 Hendrik Knackstedt.  Copyright assigned to Soren Stoutner <soren@stoutner.com>.
2417             if (firstPartyCookiesEnabled) {
2418                 // Get the cookies for `downloadUrl`.
2419                 String cookies = cookieManager.getCookie(downloadUrl);
2420
2421                 // Add the cookies to `downloadRequest`.  In the HTTP request header, cookies are named `Cookie`.
2422                 downloadRequest.addRequestHeader("Cookie", cookies);
2423             }
2424
2425             // Get the file name from `dialogFragment`.
2426             EditText downloadFileNameEditText = dialogFragment.getDialog().findViewById(R.id.download_file_name);
2427             String fileName = downloadFileNameEditText.getText().toString();
2428
2429             // Once we have `WRITE_EXTERNAL_STORAGE` permissions we can use `setDestinationInExternalPublicDir`.
2430             if (Build.VERSION.SDK_INT >= 23) { // If API >= 23, set the download location to `/sdcard/Android/data/com.stoutner.privacybrowser.standard/files` named `fileName`.
2431                 downloadRequest.setDestinationInExternalFilesDir(this, "/", fileName);
2432             } else { // Only set the title using `fileName`.
2433                 downloadRequest.setTitle(fileName);
2434             }
2435
2436             // Allow `MediaScanner` to index the download if it is a media file.
2437             downloadRequest.allowScanningByMediaScanner();
2438
2439             // Add the URL as the description for the download.
2440             downloadRequest.setDescription(downloadUrl);
2441
2442             // Show the download notification after the download is completed.
2443             downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
2444
2445             // Remove the lint warning below that `downloadManager` might be `null`.
2446             assert downloadManager != null;
2447
2448             // Initiate the download.
2449             downloadManager.enqueue(downloadRequest);
2450         } else {  // The download is not an HTTP or HTTPS URI.
2451             Snackbar.make(mainWebView, R.string.cannot_download_file, Snackbar.LENGTH_INDEFINITE).show();
2452         }
2453     }
2454
2455     @Override
2456     public void onSaveBookmark(AppCompatDialogFragment dialogFragment, int selectedBookmarkDatabaseId) {
2457         // Get handles for the views from `dialogFragment`.
2458         EditText editBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_name_edittext);
2459         EditText editBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_url_edittext);
2460         RadioButton currentBookmarkIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_current_icon_radiobutton);
2461
2462         // Store the bookmark strings.
2463         String bookmarkNameString = editBookmarkNameEditText.getText().toString();
2464         String bookmarkUrlString = editBookmarkUrlEditText.getText().toString();
2465
2466         // Update the bookmark.
2467         if (currentBookmarkIconRadioButton.isChecked()) {  // Update the bookmark without changing the favorite icon.
2468             bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString);
2469         } else {  // Update the bookmark using the `WebView` favorite icon.
2470             // Convert the favorite icon to a byte array.  `0` is for lossless compression (the only option for a PNG).
2471             ByteArrayOutputStream newFavoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2472             favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFavoriteIconByteArrayOutputStream);
2473             byte[] newFavoriteIconByteArray = newFavoriteIconByteArrayOutputStream.toByteArray();
2474
2475             //  Update the bookmark and the favorite icon.
2476             bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString, newFavoriteIconByteArray);
2477         }
2478
2479         // Update `bookmarksCursor` with the current contents of this folder.
2480         bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2481
2482         // Update the `ListView`.
2483         bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2484     }
2485
2486     @Override
2487     public void onSaveBookmarkFolder(AppCompatDialogFragment dialogFragment, int selectedFolderDatabaseId) {
2488         // Get handles for the views from `dialogFragment`.
2489         EditText editFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_folder_name_edittext);
2490         RadioButton currentFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_current_icon_radiobutton);
2491         RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_radiobutton);
2492         ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_imageview);
2493
2494         // Get the new folder name.
2495         String newFolderNameString = editFolderNameEditText.getText().toString();
2496
2497         // Check if the favorite icon has changed.
2498         if (currentFolderIconRadioButton.isChecked()) {  // Only the name has changed.
2499             // Update the name in the database.
2500             bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString);
2501         } else if (!currentFolderIconRadioButton.isChecked() && newFolderNameString.equals(oldFolderNameString)) {  // Only the icon has changed.
2502             // Get the new folder icon `Bitmap`.
2503             Bitmap folderIconBitmap;
2504             if (defaultFolderIconRadioButton.isChecked()) {
2505                 // Get the default folder icon and convert it to a `Bitmap`.
2506                 Drawable folderIconDrawable = folderIconImageView.getDrawable();
2507                 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2508                 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2509             } else {  // Use the `WebView` favorite icon.
2510                 folderIconBitmap = favoriteIconBitmap;
2511             }
2512
2513             // Convert the folder `Bitmap` to a byte array.  `0` is for lossless compression (the only option for a PNG).
2514             ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2515             folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
2516             byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
2517
2518             // Update the folder icon in the database.
2519             bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, folderIconByteArray);
2520         } else {  // The folder icon and the name have changed.
2521             // Get the new folder icon `Bitmap`.
2522             Bitmap folderIconBitmap;
2523             if (defaultFolderIconRadioButton.isChecked()) {
2524                 // Get the default folder icon and convert it to a `Bitmap`.
2525                 Drawable folderIconDrawable = folderIconImageView.getDrawable();
2526                 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2527                 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2528             } else {  // Use the `WebView` favorite icon.
2529                 folderIconBitmap = MainWebViewActivity.favoriteIconBitmap;
2530             }
2531
2532             // Convert the folder `Bitmap` to a byte array.  `0` is for lossless compression (the only option for a PNG).
2533             ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2534             folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
2535             byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
2536
2537             // Update the folder name and icon in the database.
2538             bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString, folderIconByteArray);
2539         }
2540
2541         // Update `bookmarksCursor` with the current contents of this folder.
2542         bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2543
2544         // Update the `ListView`.
2545         bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2546     }
2547
2548     @Override
2549     public void onHttpAuthenticationCancel() {
2550         // Cancel the `HttpAuthHandler`.
2551         httpAuthHandler.cancel();
2552     }
2553
2554     @Override
2555     public void onHttpAuthenticationProceed(AppCompatDialogFragment dialogFragment) {
2556         // Get handles for the `EditTexts`.
2557         EditText usernameEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_username);
2558         EditText passwordEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_password);
2559
2560         // Proceed with the HTTP authentication.
2561         httpAuthHandler.proceed(usernameEditText.getText().toString(), passwordEditText.getText().toString());
2562     }
2563
2564     public void viewSslCertificate(View view) {
2565         // Show the `ViewSslCertificateDialog` `AlertDialog` and name this instance `@string/view_ssl_certificate`.
2566         DialogFragment viewSslCertificateDialogFragment = new ViewSslCertificateDialog();
2567         viewSslCertificateDialogFragment.show(getFragmentManager(), getString(R.string.view_ssl_certificate));
2568     }
2569
2570     @Override
2571     public void onSslErrorCancel() {
2572         sslErrorHandler.cancel();
2573     }
2574
2575     @Override
2576     public void onSslErrorProceed() {
2577         sslErrorHandler.proceed();
2578     }
2579
2580     @Override
2581     public void onSslMismatchBack() {
2582         if (mainWebView.canGoBack()) {  // There is a back page in the history.
2583             // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2584             navigatingHistory = true;
2585
2586             // Go back.
2587             mainWebView.goBack();
2588         } else {  // There are no pages to go back to.
2589             // Load a blank page
2590             loadUrl("");
2591         }
2592     }
2593
2594     @Override
2595     public void onSslMismatchProceed() {
2596         // Do not check the pinned SSL certificate for this domain again until the domain changes.
2597         ignorePinnedSslCertificate = true;
2598     }
2599
2600     @Override
2601     public void onUrlHistoryEntrySelected(int moveBackOrForwardSteps) {
2602         // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2603         navigatingHistory = true;
2604
2605         // Load the history entry.
2606         mainWebView.goBackOrForward(moveBackOrForwardSteps);
2607     }
2608
2609     @Override
2610     public void onClearHistory() {
2611         // Clear the history.
2612         mainWebView.clearHistory();
2613     }
2614
2615     // Override `onBackPressed` to handle the navigation drawer and `mainWebView`.
2616     @Override
2617     public void onBackPressed() {
2618         if (drawerLayout.isDrawerVisible(GravityCompat.START)) {  // The navigation drawer is open.
2619             // Close the navigation drawer.
2620             drawerLayout.closeDrawer(GravityCompat.START);
2621         } else if (drawerLayout.isDrawerVisible(GravityCompat.END)){  // The bookmarks drawer is open.
2622             if (currentBookmarksFolder.isEmpty()) {  // The home folder is displayed.
2623                 // close the bookmarks drawer.
2624                 drawerLayout.closeDrawer(GravityCompat.END);
2625             } else {  // A subfolder is displayed.
2626                 // Place the former parent folder in `currentFolder`.
2627                 currentBookmarksFolder = bookmarksDatabaseHelper.getParentFolder(currentBookmarksFolder);
2628
2629                 // Load the new folder.
2630                 loadBookmarksFolder();
2631             }
2632