]> gitweb.stoutner.com Git - PrivacyBrowserAndroid.git/blob - app/src/main/java/com/stoutner/privacybrowser/activities/MainWebViewActivity.java
26a6a403a68256af7eb0bdfac55acc56edb545ca
[PrivacyBrowserAndroid.git] / app / src / main / java / com / stoutner / privacybrowser / activities / MainWebViewActivity.java
1 /*
2  * Copyright © 2015-2018 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.Manifest;
25 import android.annotation.SuppressLint;
26 import android.app.DialogFragment;
27 import android.app.DownloadManager;
28 import android.content.ActivityNotFoundException;
29 import android.content.BroadcastReceiver;
30 import android.content.ClipData;
31 import android.content.ClipboardManager;
32 import android.content.Context;
33 import android.content.Intent;
34 import android.content.IntentFilter;
35 import android.content.SharedPreferences;
36 import android.content.pm.PackageManager;
37 import android.content.res.Configuration;
38 import android.database.Cursor;
39 import android.graphics.Bitmap;
40 import android.graphics.BitmapFactory;
41 import android.graphics.Typeface;
42 import android.graphics.drawable.BitmapDrawable;
43 import android.graphics.drawable.Drawable;
44 import android.net.Uri;
45 import android.net.http.SslCertificate;
46 import android.net.http.SslError;
47 import android.os.Build;
48 import android.os.Bundle;
49 import android.os.Environment;
50 import android.os.Handler;
51 import android.preference.PreferenceManager;
52 import android.print.PrintDocumentAdapter;
53 import android.print.PrintManager;
54 import android.support.annotation.NonNull;
55 import android.support.design.widget.CoordinatorLayout;
56 import android.support.design.widget.FloatingActionButton;
57 import android.support.design.widget.NavigationView;
58 import android.support.design.widget.Snackbar;
59 import android.support.v4.app.ActivityCompat;
60 import android.support.v4.content.ContextCompat;
61 // `ShortcutInfoCompat`, `ShortcutManagerCompat`, and `IconCompat` can be switched to the non-compat version once API >= 26.
62 import android.support.v4.content.pm.ShortcutInfoCompat;
63 import android.support.v4.content.pm.ShortcutManagerCompat;
64 import android.support.v4.graphics.drawable.IconCompat;
65 import android.support.v4.view.GravityCompat;
66 import android.support.v4.widget.DrawerLayout;
67 import android.support.v4.widget.SwipeRefreshLayout;
68 import android.support.v7.app.ActionBar;
69 import android.support.v7.app.ActionBarDrawerToggle;
70 import android.support.v7.app.AppCompatActivity;
71 import android.support.v7.app.AppCompatDialogFragment;
72 import android.support.v7.widget.Toolbar;
73 import android.text.Editable;
74 import android.text.Spanned;
75 import android.text.TextWatcher;
76 import android.text.style.ForegroundColorSpan;
77 import android.util.Patterns;
78 import android.view.ContextMenu;
79 import android.view.GestureDetector;
80 import android.view.KeyEvent;
81 import android.view.Menu;
82 import android.view.MenuItem;
83 import android.view.MotionEvent;
84 import android.view.View;
85 import android.view.ViewGroup;
86 import android.view.WindowManager;
87 import android.view.inputmethod.InputMethodManager;
88 import android.webkit.CookieManager;
89 import android.webkit.HttpAuthHandler;
90 import android.webkit.SslErrorHandler;
91 import android.webkit.ValueCallback;
92 import android.webkit.WebBackForwardList;
93 import android.webkit.WebChromeClient;
94 import android.webkit.WebResourceResponse;
95 import android.webkit.WebStorage;
96 import android.webkit.WebView;
97 import android.webkit.WebViewClient;
98 import android.webkit.WebViewDatabase;
99 import android.widget.ArrayAdapter;
100 import android.widget.CursorAdapter;
101 import android.widget.EditText;
102 import android.widget.FrameLayout;
103 import android.widget.ImageView;
104 import android.widget.LinearLayout;
105 import android.widget.ListView;
106 import android.widget.ProgressBar;
107 import android.widget.RadioButton;
108 import android.widget.RelativeLayout;
109 import android.widget.TextView;
110
111 import com.stoutner.privacybrowser.BuildConfig;
112 import com.stoutner.privacybrowser.R;
113 import com.stoutner.privacybrowser.dialogs.AdConsentDialog;
114 import com.stoutner.privacybrowser.dialogs.CreateBookmarkDialog;
115 import com.stoutner.privacybrowser.dialogs.CreateBookmarkFolderDialog;
116 import com.stoutner.privacybrowser.dialogs.CreateHomeScreenShortcutDialog;
117 import com.stoutner.privacybrowser.dialogs.DownloadImageDialog;
118 import com.stoutner.privacybrowser.dialogs.DownloadLocationPermissionDialog;
119 import com.stoutner.privacybrowser.dialogs.EditBookmarkDialog;
120 import com.stoutner.privacybrowser.dialogs.EditBookmarkFolderDialog;
121 import com.stoutner.privacybrowser.dialogs.HttpAuthenticationDialog;
122 import com.stoutner.privacybrowser.dialogs.PinnedSslCertificateMismatchDialog;
123 import com.stoutner.privacybrowser.dialogs.UrlHistoryDialog;
124 import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog;
125 import com.stoutner.privacybrowser.helpers.AdHelper;
126 import com.stoutner.privacybrowser.helpers.BlockListHelper;
127 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
128 import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper;
129 import com.stoutner.privacybrowser.helpers.OrbotProxyHelper;
130 import com.stoutner.privacybrowser.dialogs.DownloadFileDialog;
131 import com.stoutner.privacybrowser.dialogs.SslCertificateErrorDialog;
132
133 import java.io.ByteArrayInputStream;
134 import java.io.ByteArrayOutputStream;
135 import java.io.File;
136 import java.io.IOException;
137 import java.io.UnsupportedEncodingException;
138 import java.net.MalformedURLException;
139 import java.net.URL;
140 import java.net.URLDecoder;
141 import java.net.URLEncoder;
142 import java.util.ArrayList;
143 import java.util.Date;
144 import java.util.HashMap;
145 import java.util.HashSet;
146 import java.util.List;
147 import java.util.Map;
148 import java.util.Set;
149
150 // AppCompatActivity from android.support.v7.app.AppCompatActivity must be used to have access to the SupportActionBar until the minimum API is >= 21.
151 public class MainWebViewActivity extends AppCompatActivity implements CreateBookmarkDialog.CreateBookmarkListener, CreateBookmarkFolderDialog.CreateBookmarkFolderListener,
152         CreateHomeScreenShortcutDialog.CreateHomeScreenShortcutListener, DownloadFileDialog.DownloadFileListener, DownloadImageDialog.DownloadImageListener,
153         DownloadLocationPermissionDialog.DownloadLocationPermissionDialogListener, EditBookmarkDialog.EditBookmarkListener, EditBookmarkFolderDialog.EditBookmarkFolderListener,
154         HttpAuthenticationDialog.HttpAuthenticationListener, NavigationView.OnNavigationItemSelectedListener, PinnedSslCertificateMismatchDialog.PinnedSslCertificateMismatchListener,
155         SslCertificateErrorDialog.SslCertificateErrorListener, UrlHistoryDialog.UrlHistoryListener {
156
157     // `darkTheme` is public static so it can be accessed from everywhere.
158     public static boolean darkTheme;
159
160     // `allowScreenshots` is public static so it can be accessed from everywhere.  It is also used in `onCreate()`.
161     public static boolean allowScreenshots;
162
163     // `favoriteIconBitmap` is public static so it can be accessed from `CreateHomeScreenShortcutDialog`, `BookmarksActivity`, `BookmarksDatabaseViewActivity`, `CreateBookmarkDialog`,
164     // `CreateBookmarkFolderDialog`, `EditBookmarkDialog`, `EditBookmarkFolderDialog`, `EditBookmarkDatabaseViewDialog`, and `ViewSslCertificateDialog`.  It is also used in `onCreate()`,
165     // `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onCreateHomeScreenShortcutCreate()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `applyDomainSettings()`.
166     public static Bitmap favoriteIconBitmap;
167
168     // `formattedUrlString` is public static so it can be accessed from `BookmarksActivity`, `CreateBookmarkDialog`, and `AddDomainDialog`.
169     // It is also used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onCreateHomeScreenShortcutCreate()`, and `loadUrlFromTextBox()`.
170     public static String formattedUrlString;
171
172     // `sslCertificate` is public static so it can be accessed from `DomainsActivity`, `DomainsListFragment`, `DomainSettingsFragment`, `PinnedSslCertificateMismatchDialog`,
173     // and `ViewSslCertificateDialog`.  It is also used in `onCreate()`.
174     public static SslCertificate sslCertificate;
175
176     // `orbotStatus` is public static so it can be accessed from `OrbotProxyHelper`.  It is also used in `onCreate()`.
177     public static String orbotStatus;
178
179     // `webViewTitle` is public static so it can be accessed from `CreateBookmarkDialog` and `CreateHomeScreenShortcutDialog`.  It is also used in `onCreate()`.
180     public static String webViewTitle;
181
182     // `appliedUserAgentString` is public static so it can be accessed from `ViewSourceActivity`.  It is also used in `applyDomainSettings()`.
183     public static String appliedUserAgentString;
184
185     // `reloadOnRestart` is public static so it can be accessed from `SettingsFragment`.  It is also used in `onRestart()`
186     public static boolean reloadOnRestart;
187
188     // `reloadUrlOnRestart` is public static so it can be accessed from `SettingsFragment` and `BookmarksActivity`.  It is also used in `onRestart()`.
189     public static boolean loadUrlOnRestart;
190
191     // `restartFromBookmarksActivity` is public static so it can be accessed from `BookmarksActivity`.  It is also used in `onRestart()`.
192     public static boolean restartFromBookmarksActivity;
193
194     // The block list versions are public static so they can be accessed from `AboutTabFragment`.  They are also used in `onCreate()`.
195     public static String easyListVersion;
196     public static String easyPrivacyVersion;
197     public static String fanboyAnnoyanceVersion;
198     public static String fanboySocialVersion;
199
200     // The request items are public static so they can be accessed by `BlockListHelper`, `RequestsArrayAdapter`, and `ViewRequestsDialog`.  They are also used in `onCreate()`.
201     public static List<String[]> resourceRequests;
202     public static String[] whiteListResultStringArray;
203     public final static int REQUEST_DISPOSITION = 0;
204     public final static int REQUEST_URL = 1;
205     public final static int REQUEST_BLOCKLIST = 2;
206     public final static int REQUEST_SUBLIST = 3;
207     public final static int REQUEST_BLOCKLIST_ENTRIES = 4;
208     public final static int REQUEST_BLOCKLIST_ORIGINAL_ENTRY = 5;
209
210     public final static int REQUEST_DEFAULT = 0;
211     public final static int REQUEST_ALLOWED = 1;
212     public final static int REQUEST_BLOCKED = 2;
213
214     public final static int MAIN_WHITELIST = 1;
215     public final static int FINAL_WHITELIST = 2;
216     public final static int DOMAIN_WHITELIST = 3;
217     public final static int DOMAIN_INITIAL_WHITELIST = 4;
218     public final static int DOMAIN_FINAL_WHITELIST = 5;
219     public final static int THIRD_PARTY_WHITELIST = 6;
220     public final static int THIRD_PARTY_DOMAIN_WHITELIST = 7;
221     public final static int THIRD_PARTY_DOMAIN_INITIAL_WHITELIST = 8;
222
223     public final static int MAIN_BLACKLIST = 9;
224     public final static int INITIAL_BLACKLIST = 10;
225     public final static int FINAL_BLACKLIST = 11;
226     public final static int DOMAIN_BLACKLIST = 12;
227     public final static int DOMAIN_INITIAL_BLACKLIST = 13;
228     public final static int DOMAIN_FINAL_BLACKLIST = 14;
229     public final static int DOMAIN_REGULAR_EXPRESSION_BLACKLIST = 15;
230     public final static int THIRD_PARTY_BLACKLIST = 16;
231     public final static int THIRD_PARTY_INITIAL_BLACKLIST = 17;
232     public final static int THIRD_PARTY_DOMAIN_BLACKLIST = 18;
233     public final static int THIRD_PARTY_DOMAIN_INITIAL_BLACKLIST = 19;
234     public final static int THIRD_PARTY_REGULAR_EXPRESSION_BLACKLIST = 20;
235     public final static int THIRD_PARTY_DOMAIN_REGULAR_EXPRESSION_BLACKLIST = 21;
236     public final static int REGULAR_EXPRESSION_BLACKLIST = 22;
237
238     // `currentBookmarksFolder` is public static so it can be accessed from `BookmarksActivity`.  It is also used in `onCreate()`, `onBackPressed()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`,
239     // `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
240     public static String currentBookmarksFolder;
241
242     // `domainSettingsDatabaseId` is public static so it can be accessed from `PinnedSslCertificateMismatchDialog`.  It is also used in `onCreate()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
243     public static int domainSettingsDatabaseId;
244
245     // The pinned domain SSL Certificate variables are public static so they can be accessed from `PinnedSslCertificateMismatchDialog`.  They are also used in `onCreate()` and `applyDomainSettings()`.
246     public static String pinnedDomainSslIssuedToCNameString;
247     public static String pinnedDomainSslIssuedToONameString;
248     public static String pinnedDomainSslIssuedToUNameString;
249     public static String pinnedDomainSslIssuedByCNameString;
250     public static String pinnedDomainSslIssuedByONameString;
251     public static String pinnedDomainSslIssuedByUNameString;
252     public static Date pinnedDomainSslStartDate;
253     public static Date pinnedDomainSslEndDate;
254
255     // The user agent constants are public static so they can be accessed from `SettingsFragment`, `DomainsActivity`, and `DomainSettingsFragment`.
256     public final static int UNRECOGNIZED_USER_AGENT = -1;
257     public final static int SETTINGS_WEBVIEW_DEFAULT_USER_AGENT = 1;
258     public final static int SETTINGS_CUSTOM_USER_AGENT = 12;
259     public final static int DOMAINS_SYSTEM_DEFAULT_USER_AGENT = 0;
260     public final static int DOMAINS_WEBVIEW_DEFAULT_USER_AGENT = 2;
261     public final static int DOMAINS_CUSTOM_USER_AGENT = 13;
262
263
264     // `appBar` is used in `onCreate()`, `onOptionsItemSelected()`, `closeFindOnPage()`, and `applyAppSettings()`.
265     private ActionBar appBar;
266
267     // `navigatingHistory` is used in `onCreate()`, `onNavigationItemSelected()`, `onSslMismatchBack()`, and `applyDomainSettings()`.
268     private boolean navigatingHistory;
269
270     // `favoriteIconDefaultBitmap` is used in `onCreate()` and `applyDomainSettings`.
271     private Bitmap favoriteIconDefaultBitmap;
272
273     // `drawerLayout` is used in `onCreate()`, `onNewIntent()`, `onBackPressed()`, and `onRestart()`.
274     private DrawerLayout drawerLayout;
275
276     // `rootCoordinatorLayout` is used in `onCreate()` and `applyAppSettings()`.
277     private CoordinatorLayout rootCoordinatorLayout;
278
279     // `mainWebView` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`,
280     // `findNextOnPage()`, `closeFindOnPage()`, `loadUrlFromTextBox()`, `onSslMismatchBack()`, and `setDisplayWebpageImages()`.
281     private WebView mainWebView;
282
283     // `fullScreenVideoFrameLayout` is used in `onCreate()` and `onConfigurationChanged()`.
284     private FrameLayout fullScreenVideoFrameLayout;
285
286     // `swipeRefreshLayout` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `onRestart()`.
287     private SwipeRefreshLayout swipeRefreshLayout;
288
289     // `urlAppBarRelativeLayout` is used in `onCreate()` and `applyDomainSettings()`.
290     private RelativeLayout urlAppBarRelativeLayout;
291
292     // `favoriteIconImageView` is used in `onCreate()` and `applyDomainSettings()`
293     private ImageView favoriteIconImageView;
294
295     // `cookieManager` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`, `loadUrlFromTextBox()`, `onDownloadImage()`, `onDownloadFile()`, and `onRestart()`.
296     private CookieManager cookieManager;
297
298     // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrl()`.
299     private final Map<String, String> customHeaders = new HashMap<>();
300
301     // `javaScriptEnabled` is also used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `applyDomainSettings()`, and `updatePrivacyIcons()`.
302     private boolean javaScriptEnabled;
303
304     // `firstPartyCookiesEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onDownloadImage()`, `onDownloadFile()`, and `applyDomainSettings()`.
305     private boolean firstPartyCookiesEnabled;
306
307     // `thirdPartyCookiesEnabled` used in `onCreate()`, `onPrepareOptionsMenu()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
308     private boolean thirdPartyCookiesEnabled;
309
310     // `domStorageEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
311     private boolean domStorageEnabled;
312
313     // `saveFormDataEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.  It can be removed once the minimum API >= 26.
314     private boolean saveFormDataEnabled;
315
316     // `nightMode` is used in `onCreate()` and  `applyDomainSettings()`.
317     private boolean nightMode;
318
319     // `displayWebpageImagesBoolean` is used in `applyAppSettings()` and `applyDomainSettings()`.
320     private boolean displayWebpageImagesBoolean;
321
322     // 'homepage' is used in `onCreate()`, `onNavigationItemSelected()`, and `applyAppSettings()`.
323     private String homepage;
324
325     // `searchURL` is used in `loadURLFromTextBox()` and `applyAppSettings()`.
326     private String searchURL;
327
328     // The block list variables are used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
329     private boolean easyListEnabled;
330     private boolean easyPrivacyEnabled;
331     private boolean fanboysAnnoyanceListEnabled;
332     private boolean fanboysSocialBlockingListEnabled;
333
334     // `privacyBrowserRuntime` is used in `onCreate()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
335     private Runtime privacyBrowserRuntime;
336
337     // `proxyThroughOrbot` is used in `onRestart()` and `applyAppSettings()`.
338     private boolean proxyThroughOrbot;
339
340     // `incognitoModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
341     private boolean incognitoModeEnabled;
342
343     // `fullScreenBrowsingModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
344     private boolean fullScreenBrowsingModeEnabled;
345
346     // `inFullScreenBrowsingMode` is used in `onCreate()`, `onConfigurationChanged()`, and `applyAppSettings()`.
347     private boolean inFullScreenBrowsingMode;
348
349     // `hideSystemBarsOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
350     private boolean hideSystemBarsOnFullscreen;
351
352     // `translucentNavigationBarOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
353     private boolean translucentNavigationBarOnFullscreen;
354
355     // `reapplyDomainSettingsOnRestart` is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, and `onAddDomain()`, .
356     private boolean reapplyDomainSettingsOnRestart;
357
358     // `reapplyAppSettingsOnRestart` is used in `onNavigationItemSelected()` and `onRestart()`.
359     private boolean reapplyAppSettingsOnRestart;
360
361     // `currentDomainName` is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onAddDomain()`, and `applyDomainSettings()`.
362     private String currentDomainName;
363
364     // `ignorePinnedSslCertificateForDomain` is used in `onCreate()`, `onSslMismatchProceed()`, and `applyDomainSettings()`.
365     private boolean ignorePinnedSslCertificate;
366
367     // `waitingForOrbot` is used in `onCreate()` and `applyAppSettings()`.
368     private boolean waitingForOrbot;
369
370     // `domainSettingsApplied` is used in `prepareOptionsMenu()`, `applyDomainSettings()`, and `setDisplayWebpageImages()`.
371     private boolean domainSettingsApplied;
372
373     // `displayWebpageImagesInt` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
374     private int displayWebpageImagesInt;
375
376     // `onTheFlyDisplayImagesSet` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
377     private boolean onTheFlyDisplayImagesSet;
378
379     // `waitingForOrbotData` is used in `onCreate()` and `applyAppSettings()`.
380     private String waitingForOrbotHTMLString;
381
382     // `privateDataDirectoryString` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`.
383     private String privateDataDirectoryString;
384
385     // `findOnPageLinearLayout` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
386     private LinearLayout findOnPageLinearLayout;
387
388     // `findOnPageEditText` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
389     private EditText findOnPageEditText;
390
391     // `mainMenu` is used in `onCreateOptionsMenu()` and `updatePrivacyIcons()`.
392     private Menu mainMenu;
393
394     // `drawerToggle` is used in `onCreate()`, `onPostCreate()`, `onConfigurationChanged()`, `onNewIntent()`, and `onNavigationItemSelected()`.
395     private ActionBarDrawerToggle drawerToggle;
396
397     // `supportAppBar` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
398     private Toolbar supportAppBar;
399
400     // `urlTextBox` is used in `onCreate()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, `loadUrl()`, and `highlightUrlText()`.
401     private EditText urlTextBox;
402
403     // The color spans are used in `onCreate()` and `highlightUrlText()`.
404     private ForegroundColorSpan redColorSpan;
405     private ForegroundColorSpan initialGrayColorSpan;
406     private ForegroundColorSpan finalGrayColorSpan;
407
408     // `sslErrorHandler` is used in `onCreate()`, `onSslErrorCancel()`, and `onSslErrorProceed`.
409     private SslErrorHandler sslErrorHandler;
410
411     // `httpAuthHandler` is used in `onCreate()`, `onHttpAuthenticationCancel()`, and `onHttpAuthenticationProceed()`.
412     private static HttpAuthHandler httpAuthHandler;
413
414     // `inputMethodManager` is used in `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `closeFindOnPage()`.
415     private InputMethodManager inputMethodManager;
416
417     // `mainWebViewRelativeLayout` is used in `onCreate()` and `onNavigationItemSelected()`.
418     private RelativeLayout mainWebViewRelativeLayout;
419
420     // `urlIsLoading` is used in `onCreate()`, `loadUrl()`, and `applyDomainSettings()`.
421     private boolean urlIsLoading;
422
423     // `pinnedDomainSslCertificate` is used in `onCreate()` and `applyDomainSettings()`.
424     private boolean pinnedDomainSslCertificate;
425
426     // `bookmarksDatabaseHelper` is used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
427     private BookmarksDatabaseHelper bookmarksDatabaseHelper;
428
429     // `bookmarksListView` is used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, and `loadBookmarksFolder()`.
430     private ListView bookmarksListView;
431
432     // `bookmarksTitleTextView` is used in `onCreate()` and `loadBookmarksFolder()`.
433     private TextView bookmarksTitleTextView;
434
435     // `bookmarksCursor` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
436     private Cursor bookmarksCursor;
437
438     // `bookmarksCursorAdapter` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()` `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
439     private CursorAdapter bookmarksCursorAdapter;
440
441     // `oldFolderNameString` is used in `onCreate()` and `onSaveEditBookmarkFolder()`.
442     private String oldFolderNameString;
443
444     // `fileChooserCallback` is used in `onCreate()` and `onActivityResult()`.
445     private ValueCallback<Uri[]> fileChooserCallback;
446
447     // The download strings are used in `onCreate()` and `onRequestPermissionResult()`.
448     private String downloadUrl;
449     private String downloadContentDisposition;
450     private long downloadContentLength;
451
452     // `downloadImageUrl` is used in `onCreateContextMenu()` and `onRequestPermissionResult()`.
453     private String downloadImageUrl;
454
455     // The user agent variables are used in `onCreate()` and `applyDomainSettings()`.
456     private ArrayAdapter<CharSequence> userAgentNamesArray;
457     private String[] userAgentDataArray;
458
459     // The request codes are used in `onCreate()`, `onCreateContextMenu()`, `onCloseDownloadLocationPermissionDialog()`, and `onRequestPermissionResult()`.
460     private final int DOWNLOAD_FILE_REQUEST_CODE = 1;
461     private final int DOWNLOAD_IMAGE_REQUEST_CODE = 2;
462
463     @Override
464     // 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.
465     // Also, remove the warning about needing to override `performClick()` when using an `OnTouchListener` with `WebView`.
466     @SuppressLint({"SetJavaScriptEnabled", "ClickableViewAccessibility"})
467     // Remove Android Studio's warning about deprecations.  We have to use the deprecated `getColor()` until API >= 23.
468     @SuppressWarnings("deprecation")
469     protected void onCreate(Bundle savedInstanceState) {
470         // Get a handle for the shared preferences.
471         SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
472
473         // Get the theme and screenshot preferences.
474         darkTheme = sharedPreferences.getBoolean("dark_theme", false);
475         allowScreenshots = sharedPreferences.getBoolean("allow_screenshots", false);
476
477         // Disable screenshots if not allowed.
478         if (!allowScreenshots) {
479             getWindow().addFlags(WindowManager.LayoutParams.FLAG_SECURE);
480         }
481
482         // Set the activity theme.
483         if (darkTheme) {
484             setTheme(R.style.PrivacyBrowserDark);
485         } else {
486             setTheme(R.style.PrivacyBrowserLight);
487         }
488
489         // Run the default commands.
490         super.onCreate(savedInstanceState);
491
492         // Set the content view.
493         setContentView(R.layout.main_drawerlayout);
494
495         // Get a handle for `inputMethodManager`.
496         inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
497
498         // `SupportActionBar` from `android.support.v7.app.ActionBar` must be used until the minimum API is >= 21.
499         supportAppBar = findViewById(R.id.app_bar);
500         setSupportActionBar(supportAppBar);
501         appBar = getSupportActionBar();
502
503         // This is needed to get rid of the Android Studio warning that `appBar` might be null.
504         assert appBar != null;
505
506         // Add the custom `url_app_bar` layout, which shows the favorite icon and the URL text bar.
507         appBar.setCustomView(R.layout.url_app_bar);
508         appBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
509
510         // Initialize the foreground color spans for highlighting the URLs.  We have to use the deprecated `getColor()` until API >= 23.
511         redColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.red_a700));
512         initialGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
513         finalGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
514
515         // Get a handle for `urlTextBox`.
516         urlTextBox = findViewById(R.id.url_edittext);
517
518         // Remove the formatting from `urlTextBar` when the user is editing the text.
519         urlTextBox.setOnFocusChangeListener((View v, boolean hasFocus) -> {
520             if (hasFocus) {  // The user is editing `urlTextBox`.
521                 // Remove the highlighting.
522                 urlTextBox.getText().removeSpan(redColorSpan);
523                 urlTextBox.getText().removeSpan(initialGrayColorSpan);
524                 urlTextBox.getText().removeSpan(finalGrayColorSpan);
525             } else {  // The user has stopped editing `urlTextBox`.
526                 // Reapply the highlighting.
527                 highlightUrlText();
528             }
529         });
530
531         // Set the go button on the keyboard to load the URL in `urlTextBox`.
532         urlTextBox.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
533             // If the event is a key-down event on the `enter` button, load the URL.
534             if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
535                 // Load the URL into the mainWebView and consume the event.
536                 try {
537                     loadUrlFromTextBox();
538                 } catch (UnsupportedEncodingException e) {
539                     e.printStackTrace();
540                 }
541                 // If the enter key was pressed, consume the event.
542                 return true;
543             } else {
544                 // If any other key was pressed, do not consume the event.
545                 return false;
546             }
547         });
548
549         // Set `waitingForOrbotHTMLString`.
550         waitingForOrbotHTMLString = "<html><body><br/><center><h1>" + getString(R.string.waiting_for_orbot) + "</h1></center></body></html>";
551
552         // Initialize `currentDomainName`, `orbotStatus`, and `waitingForOrbot`.
553         currentDomainName = "";
554         orbotStatus = "unknown";
555         waitingForOrbot = false;
556
557         // Create an Orbot status `BroadcastReceiver`.
558         BroadcastReceiver orbotStatusBroadcastReceiver = new BroadcastReceiver() {
559             @Override
560             public void onReceive(Context context, Intent intent) {
561                 // Store the content of the status message in `orbotStatus`.
562                 orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS");
563
564                 // If we are waiting on Orbot, load the website now that Orbot is connected.
565                 if (orbotStatus.equals("ON") && waitingForOrbot) {
566                     // Reset `waitingForOrbot`.
567                     waitingForOrbot = false;
568
569                     // Load `formattedUrlString
570                     loadUrl(formattedUrlString);
571                 }
572             }
573         };
574
575         // Register `orbotStatusBroadcastReceiver` on `this` context.
576         this.registerReceiver(orbotStatusBroadcastReceiver, new IntentFilter("org.torproject.android.intent.action.STATUS"));
577
578         // Get handles for views that need to be accessed.
579         drawerLayout = findViewById(R.id.drawerlayout);
580         rootCoordinatorLayout = findViewById(R.id.root_coordinatorlayout);
581         bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
582         bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview);
583         FloatingActionButton launchBookmarksActivityFab = findViewById(R.id.launch_bookmarks_activity_fab);
584         FloatingActionButton createBookmarkFolderFab = findViewById(R.id.create_bookmark_folder_fab);
585         FloatingActionButton createBookmarkFab = findViewById(R.id.create_bookmark_fab);
586         mainWebViewRelativeLayout = findViewById(R.id.main_webview_relativelayout);
587         mainWebView = findViewById(R.id.main_webview);
588         findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
589         findOnPageEditText = findViewById(R.id.find_on_page_edittext);
590         fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
591         urlAppBarRelativeLayout = findViewById(R.id.url_app_bar_relativelayout);
592         favoriteIconImageView = findViewById(R.id.favorite_icon);
593
594         // 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.
595         if (darkTheme) {
596             launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_dark));
597             createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_dark));
598             createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_dark));
599             bookmarksListView.setBackgroundColor(getResources().getColor(R.color.gray_850));
600         } else {
601             launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_light));
602             createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_light));
603             createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_light));
604             bookmarksListView.setBackgroundColor(getResources().getColor(R.color.white));
605         }
606
607         // Set the launch bookmarks activity FAB to launch the bookmarks activity.
608         launchBookmarksActivityFab.setOnClickListener(v -> {
609             // Create an intent to launch the bookmarks activity.
610             Intent bookmarksIntent = new Intent(getApplicationContext(), BookmarksActivity.class);
611
612             // Include the current folder with the `Intent`.
613             bookmarksIntent.putExtra("Current Folder", currentBookmarksFolder);
614
615             // Make it so.
616             startActivity(bookmarksIntent);
617         });
618
619         // Set the create new bookmark folder FAB to display an alert dialog.
620         createBookmarkFolderFab.setOnClickListener(v -> {
621             // Show the `CreateBookmarkFolderDialog` `AlertDialog` and name the instance `@string/create_folder`.
622             AppCompatDialogFragment createBookmarkFolderDialog = new CreateBookmarkFolderDialog();
623             createBookmarkFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_folder));
624         });
625
626         // Set the create new bookmark FAB to display an alert dialog.
627         createBookmarkFab.setOnClickListener(view -> {
628             // Show the `CreateBookmarkDialog` `AlertDialog` and name the instance `@string/create_bookmark`.
629             AppCompatDialogFragment createBookmarkDialog = new CreateBookmarkDialog();
630             createBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_bookmark));
631         });
632
633         // Create a double-tap listener to toggle full-screen mode.
634         final GestureDetector gestureDetector = new GestureDetector(this, new GestureDetector.SimpleOnGestureListener() {
635             // Override `onDoubleTap()`.  All other events are handled using the default settings.
636             @Override
637             public boolean onDoubleTap(MotionEvent event) {
638                 if (fullScreenBrowsingModeEnabled) {  // Only process the double-tap if full screen browsing mode is enabled.
639                     // Toggle `inFullScreenBrowsingMode`.
640                     inFullScreenBrowsingMode = !inFullScreenBrowsingMode;
641
642                     if (inFullScreenBrowsingMode) {  // Switch to full screen mode.
643                         // Hide the `appBar`.
644                         appBar.hide();
645
646                         // Hide the banner ad in the free flavor.
647                         if (BuildConfig.FLAVOR.contentEquals("free")) {
648                             // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
649                             AdHelper.hideAd(findViewById(R.id.adview));
650                         }
651
652                         // Modify the system bars.
653                         if (hideSystemBarsOnFullscreen) {  // Hide everything.
654                             // Remove the translucent overlays.
655                             getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
656
657                             // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
658                             drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
659
660                             /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
661                              * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
662                              * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
663                              */
664                             rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
665
666                             // Set `rootCoordinatorLayout` to fill the whole screen.
667                             rootCoordinatorLayout.setFitsSystemWindows(false);
668                         } else {  // Hide everything except the status and navigation bars.
669                             // Set `rootCoordinatorLayout` to fit under the status and navigation bars.
670                             rootCoordinatorLayout.setFitsSystemWindows(false);
671
672                             // 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.
673                             if (translucentNavigationBarOnFullscreen) {
674                                 // Set the navigation bar to be translucent.
675                                 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
676                             }
677                         }
678                     } else {  // Switch to normal viewing mode.
679                         // Show the `appBar`.
680                         appBar.show();
681
682                         // Show the `BannerAd` in the free flavor.
683                         if (BuildConfig.FLAVOR.contentEquals("free")) {
684                             // Reload the ad.  The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
685                             AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_id));
686                         }
687
688                         // Remove the translucent navigation bar flag if it is set.
689                         getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
690
691                         // Add the translucent status flag if it is unset.  This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
692                         getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
693
694                         // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
695                         rootCoordinatorLayout.setSystemUiVisibility(0);
696
697                         // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
698                         rootCoordinatorLayout.setFitsSystemWindows(true);
699                     }
700
701                     // Consume the double-tap.
702                     return true;
703                 } else { // Do not consume the double-tap because full screen browsing mode is disabled.
704                     return false;
705                 }
706             }
707         });
708
709         // Pass all touch events on `mainWebView` through `gestureDetector` to check for double-taps.
710         mainWebView.setOnTouchListener((View v, MotionEvent event) -> {
711             // Call `performClick()` on the view, which is required for accessibility.
712             v.performClick();
713
714             // Send the `event` to `gestureDetector`.
715             return gestureDetector.onTouchEvent(event);
716         });
717
718         // Update `findOnPageCountTextView`.
719         mainWebView.setFindListener(new WebView.FindListener() {
720             // Get a handle for `findOnPageCountTextView`.
721             final TextView findOnPageCountTextView = (TextView) findViewById(R.id.find_on_page_count_textview);
722
723             @Override
724             public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, boolean isDoneCounting) {
725                 if ((isDoneCounting) && (numberOfMatches == 0)) {  // There are no matches.
726                     // Set `findOnPageCountTextView` to `0/0`.
727                     findOnPageCountTextView.setText(R.string.zero_of_zero);
728                 } else if (isDoneCounting) {  // There are matches.
729                     // `activeMatchOrdinal` is zero-based.
730                     int activeMatch = activeMatchOrdinal + 1;
731
732                     // Build the match string.
733                     String matchString = activeMatch + "/" + numberOfMatches;
734
735                     // Set `findOnPageCountTextView`.
736                     findOnPageCountTextView.setText(matchString);
737                 }
738             }
739         });
740
741         // Search for the string on the page whenever a character changes in the `findOnPageEditText`.
742         findOnPageEditText.addTextChangedListener(new TextWatcher() {
743             @Override
744             public void beforeTextChanged(CharSequence s, int start, int count, int after) {
745                 // Do nothing.
746             }
747
748             @Override
749             public void onTextChanged(CharSequence s, int start, int before, int count) {
750                 // Do nothing.
751             }
752
753             @Override
754             public void afterTextChanged(Editable s) {
755                 // Search for the text in `mainWebView`.
756                 mainWebView.findAllAsync(findOnPageEditText.getText().toString());
757             }
758         });
759
760         // Set the `check mark` button for the `findOnPageEditText` keyboard to close the soft keyboard.
761         findOnPageEditText.setOnKeyListener((v, keyCode, event) -> {
762             if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {  // The `enter` key was pressed.
763                 // Hide the soft keyboard.  `0` indicates no additional flags.
764                 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
765
766                 // Consume the event.
767                 return true;
768             } else {  // A different key was pressed.
769                 // Do not consume the event.
770                 return false;
771             }
772         });
773
774         // Implement swipe to refresh
775         swipeRefreshLayout = findViewById(R.id.swipe_refreshlayout);
776         swipeRefreshLayout.setColorSchemeResources(R.color.blue_700);
777         swipeRefreshLayout.setOnRefreshListener(() -> mainWebView.reload());
778
779         // `DrawerTitle` identifies the `DrawerLayouts` in accessibility mode.
780         drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer));
781         drawerLayout.setDrawerTitle(GravityCompat.END, getString(R.string.bookmarks));
782
783         // Listen for touches on the navigation menu.
784         final NavigationView navigationView = findViewById(R.id.navigationview);
785         navigationView.setNavigationItemSelectedListener(this);
786
787         // 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.
788         final Menu navigationMenu = navigationView.getMenu();
789         final MenuItem navigationBackMenuItem = navigationMenu.getItem(1);
790         final MenuItem navigationForwardMenuItem = navigationMenu.getItem(2);
791         final MenuItem navigationHistoryMenuItem = navigationMenu.getItem(3);
792         final MenuItem navigationRequestsMenuItem = navigationMenu.getItem(4);
793
794         // Initialize the bookmarks database helper.  `this` specifies the context.  The two `nulls` do not specify the database name or a `CursorFactory`.
795         // The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
796         bookmarksDatabaseHelper = new BookmarksDatabaseHelper(this, null, null, 0);
797
798         // Initialize `currentBookmarksFolder`.  `""` is the home folder in the database.
799         currentBookmarksFolder = "";
800
801         // Load the home folder, which is `""` in the database.
802         loadBookmarksFolder();
803
804         bookmarksListView.setOnItemClickListener((parent, view, position, id) -> {
805             // Convert the id from long to int to match the format of the bookmarks database.
806             int databaseID = (int) id;
807
808             // Get the bookmark cursor for this ID and move it to the first row.
809             Cursor bookmarkCursor = bookmarksDatabaseHelper.getBookmarkCursor(databaseID);
810             bookmarkCursor.moveToFirst();
811
812             // Act upon the bookmark according to the type.
813             if (bookmarkCursor.getInt(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {  // The selected bookmark is a folder.
814                 // Store the new folder name in `currentBookmarksFolder`.
815                 currentBookmarksFolder = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
816
817                 // Load the new folder.
818                 loadBookmarksFolder();
819             } else {  // The selected bookmark is not a folder.
820                 // Load the bookmark URL.
821                 loadUrl(bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_URL)));
822
823                 // Close the bookmarks drawer.
824                 drawerLayout.closeDrawer(GravityCompat.END);
825             }
826
827             // Close the `Cursor`.
828             bookmarkCursor.close();
829         });
830
831         bookmarksListView.setOnItemLongClickListener((parent, view, position, id) -> {
832             // Convert the database ID from `long` to `int`.
833             int databaseId = (int) id;
834
835             // Find out if the selected bookmark is a folder.
836             boolean isFolder = bookmarksDatabaseHelper.isFolder(databaseId);
837
838             if (isFolder) {
839                 // Save the current folder name, which is used in `onSaveEditBookmarkFolder()`.
840                 oldFolderNameString = bookmarksCursor.getString(bookmarksCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
841
842                 // Show the edit bookmark folder `AlertDialog` and name the instance `@string/edit_folder`.
843                 AppCompatDialogFragment editFolderDialog = EditBookmarkFolderDialog.folderDatabaseId(databaseId);
844                 editFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_folder));
845             } else {
846                 // Show the edit bookmark `AlertDialog` and name the instance `@string/edit_bookmark`.
847                 AppCompatDialogFragment editBookmarkDialog = EditBookmarkDialog.bookmarkDatabaseId(databaseId);
848                 editBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_bookmark));
849             }
850
851             // Consume the event.
852             return true;
853         });
854
855         // The `DrawerListener` is used to update the Navigation Menu.
856         drawerLayout.addDrawerListener(new DrawerLayout.DrawerListener() {
857             @Override
858             public void onDrawerSlide(@NonNull View drawerView, float slideOffset) {
859             }
860
861             @Override
862             public void onDrawerOpened(@NonNull View drawerView) {
863             }
864
865             @Override
866             public void onDrawerClosed(@NonNull View drawerView) {
867             }
868
869             @Override
870             public void onDrawerStateChanged(int newState) {
871                 if ((newState == DrawerLayout.STATE_SETTLING) || (newState == DrawerLayout.STATE_DRAGGING)) {  // The drawer is opening or closing.
872                     // Initialize a the blocked requests counter.
873                     int blockedRequests = 0;
874
875                     // Count the number of blocked requests.
876                     for (int i = 0; i < resourceRequests.size(); i++) {
877                         if (Integer.valueOf(resourceRequests.get(i)[REQUEST_DISPOSITION]) == REQUEST_BLOCKED) {
878                             blockedRequests++;
879                         }
880                     }
881
882                     // Update the back, forward, history, and requests menu items.
883                     navigationBackMenuItem.setEnabled(mainWebView.canGoBack());
884                     navigationForwardMenuItem.setEnabled(mainWebView.canGoForward());
885                     navigationHistoryMenuItem.setEnabled((mainWebView.canGoBack() || mainWebView.canGoForward()));
886                     navigationRequestsMenuItem.setTitle(getResources().getString(R.string.requests) + " - " + blockedRequests);
887
888                     // Hide the keyboard (if displayed) so we can see the navigation menu.  `0` indicates no additional flags.
889                     inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
890
891                     // Clear the focus from `urlTextBox` if it has it.
892                     urlTextBox.clearFocus();
893                 }
894             }
895         });
896
897         // drawerToggle creates the hamburger icon at the start of the AppBar.
898         drawerToggle = new ActionBarDrawerToggle(this, drawerLayout, supportAppBar, R.string.open_navigation_drawer, R.string.close_navigation_drawer);
899
900         // Get a handle for the progress bar.
901         final ProgressBar progressBar = findViewById(R.id.progress_bar);
902
903         mainWebView.setWebChromeClient(new WebChromeClient() {
904             // Update the progress bar when a page is loading.
905             @Override
906             public void onProgressChanged(WebView view, int progress) {
907                 // Inject the night mode CSS if night mode is enabled.
908                 if (nightMode) {
909                     // `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
910                     // used by WordPress.  `text-decoration: none` removes all text underlines.  `text-shadow: none` removes text shadows, which usually have a hard coded color.
911                     // `border: none` removes all borders, which can also be used to underline text.
912                     // `a {color: #1565C0}` sets links to be a dark blue.  `!important` takes precedent over any existing sub-settings.
913                     mainWebView.evaluateJavascript("(function() {var parent = document.getElementsByTagName('head').item(0); var style = document.createElement('style'); style.type = 'text/css'; " +
914                             "style.innerHTML = '* {background-color: #212121 !important; color: #BDBDBD !important; box-shadow: none !important; text-decoration: none !important;" +
915                             "text-shadow: none !important; border: none !important;} a {color: #1565C0 !important;}'; parent.appendChild(style)})()", value -> {
916                                 // Initialize a `Handler` to display `mainWebView`.
917                                 Handler displayWebViewHandler = new Handler();
918
919                                 // Setup a `Runnable` to display `mainWebView` after a delay to allow the CSS to be applied.
920                                 Runnable displayWebViewRunnable = () -> {
921                                     // Only display `mainWebView` if the progress bar is one.  This prevents the display of the `WebView` while it is still loading.
922                                     if (progressBar.getVisibility() == View.GONE) {
923                                         mainWebView.setVisibility(View.VISIBLE);
924                                     }
925                                 };
926
927                                 // Use `displayWebViewHandler` to delay the displaying of `mainWebView` for 500 milliseconds.
928                                 displayWebViewHandler.postDelayed(displayWebViewRunnable, 500);
929                             });
930                 }
931
932                 // Update the progress bar.
933                 progressBar.setProgress(progress);
934
935                 // Set the visibility of the progress bar.
936                 if (progress < 100) {
937                     // Show the progress bar.
938                     progressBar.setVisibility(View.VISIBLE);
939                 } else {
940                     // Hide the progress bar.
941                     progressBar.setVisibility(View.GONE);
942
943                     // Display `mainWebView` if night mode is disabled.
944                     // 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
945                     // currently enabled.
946                     if (!nightMode) {
947                         mainWebView.setVisibility(View.VISIBLE);
948                     }
949
950                     //Stop the swipe to refresh indicator if it is running
951                     swipeRefreshLayout.setRefreshing(false);
952                 }
953             }
954
955             // Set the favorite icon when it changes.
956             @Override
957             public void onReceivedIcon(WebView view, Bitmap icon) {
958                 // Only update the favorite icon if the website has finished loading.
959                 if (progressBar.getVisibility() == View.GONE) {
960                     // Save a copy of the favorite icon.
961                     favoriteIconBitmap = icon;
962
963                     // Place the favorite icon in the appBar.
964                     favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
965                 }
966             }
967
968             // Save a copy of the title when it changes.
969             @Override
970             public void onReceivedTitle(WebView view, String title) {
971                 // Save a copy of the title.
972                 webViewTitle = title;
973             }
974
975             // Enter full screen video.
976             @Override
977             public void onShowCustomView(View view, CustomViewCallback callback) {
978                 // Pause the ad if this is the free flavor.
979                 if (BuildConfig.FLAVOR.contentEquals("free")) {
980                     // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
981                     AdHelper.pauseAd(findViewById(R.id.adview));
982                 }
983
984                 // Remove the translucent overlays.
985                 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
986
987                 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
988                 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
989
990                 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
991                  * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
992                  * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
993                  */
994                 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
995
996                 // Set `rootCoordinatorLayout` to fill the entire screen.
997                 rootCoordinatorLayout.setFitsSystemWindows(false);
998
999                 // Add `view` to `fullScreenVideoFrameLayout` and display it on the screen.
1000                 fullScreenVideoFrameLayout.addView(view);
1001                 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
1002             }
1003
1004             // Exit full screen video.
1005             @Override
1006             public void onHideCustomView() {
1007                 // Hide `fullScreenVideoFrameLayout`.
1008                 fullScreenVideoFrameLayout.removeAllViews();
1009                 fullScreenVideoFrameLayout.setVisibility(View.GONE);
1010
1011                 // Add the translucent status flag.  This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
1012                 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1013
1014                 // Set `rootCoordinatorLayout` to fit inside the status and navigation bars.  This also clears the `SYSTEM_UI` flags.
1015                 rootCoordinatorLayout.setFitsSystemWindows(true);
1016
1017                 // Show the ad if this is the free flavor.
1018                 if (BuildConfig.FLAVOR.contentEquals("free")) {
1019                     // Reload the ad.  The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1020                     AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_id));
1021                 }
1022             }
1023
1024             // Upload files.
1025             @Override
1026             public boolean onShowFileChooser(WebView webView, ValueCallback<Uri[]> filePathCallback, FileChooserParams fileChooserParams) {
1027                 // Show the file chooser if the device is running API >= 21.
1028                 if (Build.VERSION.SDK_INT >= 21) {
1029                     // Store the file path callback.
1030                     fileChooserCallback = filePathCallback;
1031
1032                     // Create an intent to open a chooser based ont the file chooser parameters.
1033                     Intent fileChooserIntent = fileChooserParams.createIntent();
1034
1035                     // Open the file chooser.  Currently only one `startActivityForResult` exists in this activity, so the request code, used to differentiate them, is simply `0`.
1036                     startActivityForResult(fileChooserIntent, 0);
1037                 }
1038                 return true;
1039             }
1040         });
1041
1042         // Register `mainWebView` for a context menu.  This is used to see link targets and download images.
1043         registerForContextMenu(mainWebView);
1044
1045         // Allow the downloading of files.
1046         mainWebView.setDownloadListener((String url, String userAgent, String contentDisposition, String mimetype, long contentLength) -> {
1047             // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
1048             if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
1049                 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
1050
1051                 // Store the variables for future use by `onRequestPermissionsResult()`.
1052                 downloadUrl = url;
1053                 downloadContentDisposition = contentDisposition;
1054                 downloadContentLength = contentLength;
1055
1056                 // Show a dialog if the user has previously denied the permission.
1057                 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) {  // Show a dialog explaining the request first.
1058                     // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
1059                     DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
1060
1061                     // Show the download location permission alert dialog.  The permission will be requested when the the dialog is closed.
1062                     downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
1063                 } else {  // Show the permission request directly.
1064                     // Request the permission.  The download dialog will be launched by `onRequestPermissionResult()`.
1065                     ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
1066                 }
1067             } else {  // The WRITE_EXTERNAL_STORAGE permission has already been granted.
1068                 // Get a handle for the download file alert dialog.
1069                 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(url, contentDisposition, contentLength);
1070
1071                 // Show the download file alert dialog.
1072                 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
1073             }
1074         });
1075
1076         // Allow pinch to zoom.
1077         mainWebView.getSettings().setBuiltInZoomControls(true);
1078
1079         // Hide zoom controls.
1080         mainWebView.getSettings().setDisplayZoomControls(false);
1081
1082         // Set `mainWebView` to use a wide viewport.  Otherwise, some web pages will be scrunched and some content will render outside the screen.
1083         mainWebView.getSettings().setUseWideViewPort(true);
1084
1085         // Set `mainWebView` to load in overview mode (zoomed out to the maximum width).
1086         mainWebView.getSettings().setLoadWithOverviewMode(true);
1087
1088         // Explicitly disable geolocation.
1089         mainWebView.getSettings().setGeolocationEnabled(false);
1090
1091         // Initialize cookieManager.
1092         cookieManager = CookieManager.getInstance();
1093
1094         // 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).
1095         customHeaders.put("X-Requested-With", "");
1096
1097         // 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.
1098         PreferenceManager.setDefaultValues(this, R.xml.preferences, false);
1099
1100         // Get the intent that started the app.
1101         final Intent launchingIntent = getIntent();
1102
1103         // Extract the launching intent data as `launchingIntentUriData`.
1104         final Uri launchingIntentUriData = launchingIntent.getData();
1105
1106         // Convert the launching intent URI data (if it exists) to a string and store it in `formattedUrlString`.
1107         if (launchingIntentUriData != null) {
1108             formattedUrlString = launchingIntentUriData.toString();
1109         }
1110
1111         // Get a handle for the `Runtime`.
1112         privacyBrowserRuntime = Runtime.getRuntime();
1113
1114         // Store the application's private data directory.
1115         privateDataDirectoryString = getApplicationInfo().dataDir;
1116         // `dataDir` will vary, but will be something like `/data/user/0/com.stoutner.privacybrowser.standard`, which links to `/data/data/com.stoutner.privacybrowser.standard`.
1117
1118         // Initialize `inFullScreenBrowsingMode`, which is always false at this point because Privacy Browser never starts in full screen browsing mode.
1119         inFullScreenBrowsingMode = false;
1120
1121         // Initialize the privacy settings variables.
1122         javaScriptEnabled = false;
1123         firstPartyCookiesEnabled = false;
1124         thirdPartyCookiesEnabled = false;
1125         domStorageEnabled = false;
1126         saveFormDataEnabled = false;  // Form data can be removed once the minimum API >= 26.
1127         nightMode = false;
1128
1129         // Initialize the WebView title.
1130         webViewTitle = getString(R.string.no_title);
1131
1132         // Initialize the favorite icon bitmap.  `ContextCompat` must be used until API >= 21.
1133         Drawable favoriteIconDrawable = ContextCompat.getDrawable(getApplicationContext(), R.drawable.world);
1134         BitmapDrawable favoriteIconBitmapDrawable = (BitmapDrawable) favoriteIconDrawable;
1135         assert favoriteIconBitmapDrawable != null;
1136         favoriteIconDefaultBitmap = favoriteIconBitmapDrawable.getBitmap();
1137
1138         // If the favorite icon is null, load the default.
1139         if (favoriteIconBitmap == null) {
1140             favoriteIconBitmap = favoriteIconDefaultBitmap;
1141         }
1142
1143         // Initialize the user agent array adapter and string array.
1144         userAgentNamesArray = ArrayAdapter.createFromResource(this, R.array.user_agent_names, R.layout.domain_settings_spinner_item);
1145         userAgentDataArray = getResources().getStringArray(R.array.user_agent_data);
1146
1147         // Apply the app settings from the shared preferences.
1148         applyAppSettings();
1149
1150         // Instantiate the block list helper.
1151         BlockListHelper blockListHelper = new BlockListHelper();
1152
1153         // Initialize the list of resource requests.
1154         resourceRequests = new ArrayList<>();
1155
1156         // Parse the block lists.
1157         final ArrayList<List<String[]>> easyList = blockListHelper.parseBlockList(getAssets(), "blocklists/easylist.txt");
1158         final ArrayList<List<String[]>> easyPrivacy = blockListHelper.parseBlockList(getAssets(), "blocklists/easyprivacy.txt");
1159         final ArrayList<List<String[]>> fanboyAnnoyance = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-annoyance.txt");
1160         final ArrayList<List<String[]>> fanboySocial = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-social.txt");
1161
1162         // Store the list versions.
1163         easyListVersion = easyList.get(0).get(0)[0];
1164         easyPrivacyVersion = easyPrivacy.get(0).get(0)[0];
1165         fanboyAnnoyanceVersion = fanboyAnnoyance.get(0).get(0)[0];
1166         fanboySocialVersion = fanboySocial.get(0).get(0)[0];
1167
1168         mainWebView.setWebViewClient(new WebViewClient() {
1169             // `shouldOverrideUrlLoading` makes this `WebView` the default handler for URLs inside the app, so that links are not kicked out to other apps.
1170             // The deprecated `shouldOverrideUrlLoading` must be used until API >= 24.
1171             @SuppressWarnings("deprecation")
1172             @Override
1173             public boolean shouldOverrideUrlLoading(WebView view, String url) {
1174                 if (url.startsWith("http")) {  // Load the URL in Privacy Browser.
1175                     // Apply the domain settings for the new URL.  `applyDomainSettings` doesn't do anything if the domain has not changed.
1176                     applyDomainSettings(url, true, false);
1177
1178                     // Returning false causes the current WebView to handle the URL and prevents it from adding redirects to the history list.
1179                     return false;
1180                 } else if (url.startsWith("mailto:")) {  // Load the email address in an external email program.
1181                     // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
1182                     Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
1183
1184                     // Parse the url and set it as the data for the intent.
1185                     emailIntent.setData(Uri.parse(url));
1186
1187                     // Open the email program in a new task instead of as part of Privacy Browser.
1188                     emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1189
1190                     // Make it so.
1191                     startActivity(emailIntent);
1192
1193                     // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1194                     return true;
1195                 } else if (url.startsWith("tel:")) {  // Load the phone number in the dialer.
1196                     // Open the dialer and load the phone number, but wait for the user to place the call.
1197                     Intent dialIntent = new Intent(Intent.ACTION_DIAL);
1198
1199                     // Add the phone number to the intent.
1200                     dialIntent.setData(Uri.parse(url));
1201
1202                     // Open the dialer in a new task instead of as part of Privacy Browser.
1203                     dialIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1204
1205                     // Make it so.
1206                     startActivity(dialIntent);
1207
1208                     // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1209                     return true;
1210                 } else {  // Load a system chooser to select an app that can handle the URL.
1211                     // Open an app that can handle the URL.
1212                     Intent genericIntent = new Intent(Intent.ACTION_VIEW);
1213
1214                     // Add the URL to the intent.
1215                     genericIntent.setData(Uri.parse(url));
1216
1217                     // List all apps that can handle the URL instead of just opening the first one.
1218                     genericIntent.addCategory(Intent.CATEGORY_BROWSABLE);
1219
1220                     // Open the app in a new task instead of as part of Privacy Browser.
1221                     genericIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1222
1223                     // Start the app or display a snackbar if no app is available to handle the URL.
1224                     try {
1225                         startActivity(genericIntent);
1226                     } catch (ActivityNotFoundException exception) {
1227                         Snackbar.make(mainWebView, getString(R.string.unrecognized_url) + "  " + url, Snackbar.LENGTH_SHORT).show();
1228                     }
1229
1230                     // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1231                     return true;
1232                 }
1233             }
1234
1235             // Check requests against the block lists.  The deprecated `shouldInterceptRequest()` must be used until minimum API >= 21.
1236             @SuppressWarnings("deprecation")
1237             @Override
1238             public WebResourceResponse shouldInterceptRequest(WebView view, String url){
1239                 // Create an empty web resource response to be used if the resource request is blocked.
1240                 WebResourceResponse emptyWebResourceResponse = new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
1241
1242                 // Reset `whiteListResultStringArray`.
1243                 whiteListResultStringArray = null;
1244
1245                 // Check EasyList if it is enabled.
1246                 if (easyListEnabled) {
1247                     if (blockListHelper.isBlocked(formattedUrlString, url, easyList)) {
1248                         // The resource request was blocked.  Return an empty web resource response.
1249                         return emptyWebResourceResponse;
1250                     }
1251                 }
1252
1253                 // Check EasyPrivacy if it is enabled.
1254                 if (easyPrivacyEnabled) {
1255                     if (blockListHelper.isBlocked(formattedUrlString, url, easyPrivacy)) {
1256                         // The resource request was blocked.  Return an empty web resource response.
1257                         return emptyWebResourceResponse;
1258                     }
1259                 }
1260
1261                 // Check Fanboy’s Annoyance List if it is enabled.
1262                 if (fanboysAnnoyanceListEnabled) {
1263                     if (blockListHelper.isBlocked(formattedUrlString, url, fanboyAnnoyance)) {
1264                         // The resource request was blocked.  Return an empty web resource response.
1265                         return emptyWebResourceResponse;
1266                     }
1267                 } else if (fanboysSocialBlockingListEnabled){  // Only check Fanboy’s Social Blocking List if Fanboy’s Annoyance List is disabled.
1268                     if (blockListHelper.isBlocked(formattedUrlString, url, fanboySocial)) {
1269                         // The resource request was blocked.  Return an empty web resource response.
1270                         return emptyWebResourceResponse;
1271                     }
1272                 }
1273
1274                 // Add the request to the log.
1275                 if (whiteListResultStringArray != null ) {  // The request was processed by a whitelist.
1276                     resourceRequests.add(whiteListResultStringArray);
1277                 } else {  // The request didn't match any blocklist entry.  Log it as a defult request.
1278                     resourceRequests.add(new String[]{String.valueOf(REQUEST_DEFAULT), url});
1279                 }
1280
1281                 // The resource request has not been blocked.  `return null` loads the requested resource.
1282                 return null;
1283             }
1284
1285             // Handle HTTP authentication requests.
1286             @Override
1287             public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) {
1288                 // Store `handler` so it can be accessed from `onHttpAuthenticationCancel()` and `onHttpAuthenticationProceed()`.
1289                 httpAuthHandler = handler;
1290
1291                 // Display the HTTP authentication dialog.
1292                 AppCompatDialogFragment httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm);
1293                 httpAuthenticationDialogFragment.show(getSupportFragmentManager(), getString(R.string.http_authentication));
1294             }
1295
1296             // Update the URL in urlTextBox when the page starts to load.
1297             @Override
1298             public void onPageStarted(WebView view, String url, Bitmap favicon) {
1299                 // Reset the list of resource requests.
1300                 resourceRequests.clear();
1301
1302                 // If night mode is enabled, hide `mainWebView` until after the night mode CSS is applied.
1303                 if (nightMode) {
1304                     mainWebView.setVisibility(View.INVISIBLE);
1305                 }
1306
1307                 // Hide the keyboard.  `0` indicates no additional flags.
1308                 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
1309
1310                 // Check to see if Privacy Browser is waiting on Orbot.
1311                 if (!waitingForOrbot) {  // We are not waiting on Orbot, so we need to process the URL.
1312                     // 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.
1313                     formattedUrlString = url;
1314
1315                     // Display the formatted URL text.
1316                     urlTextBox.setText(formattedUrlString);
1317
1318                     // Apply text highlighting to `urlTextBox`.
1319                     highlightUrlText();
1320
1321                     // Apply any custom domain settings if the URL was loaded by navigating history.
1322                     if (navigatingHistory) {
1323                         applyDomainSettings(url, true, false);
1324                     }
1325
1326                     // 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.
1327                     urlIsLoading = true;
1328                 }
1329             }
1330
1331             // It is necessary to update `formattedUrlString` and `urlTextBox` after the page finishes loading because the final URL can change during load.
1332             @Override
1333             public void onPageFinished(WebView view, String url) {
1334                 // Flush any cookies to persistent storage.  `CookieManager` has become very lazy about flushing cookies in recent versions.
1335                 if (firstPartyCookiesEnabled && Build.VERSION.SDK_INT >= 21) {
1336                     cookieManager.flush();
1337                 }
1338
1339                 // Reset `urlIsLoading`, which is used to prevent reloads on redirect if the user agent changes.
1340                 urlIsLoading = false;
1341
1342                 // Clear the cache and history if Incognito Mode is enabled.
1343                 if (incognitoModeEnabled) {
1344                     // Clear the cache.  `true` includes disk files.
1345                     mainWebView.clearCache(true);
1346
1347                     // Clear the back/forward history.
1348                     mainWebView.clearHistory();
1349
1350                     // Manually delete cache folders.
1351                     try {
1352                         // Delete the main cache directory.
1353                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
1354
1355                         // Delete the secondary `Service Worker` cache directory.
1356                         // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
1357                         privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
1358                     } catch (IOException e) {
1359                         // Do nothing if an error is thrown.
1360                     }
1361                 }
1362
1363                 // Update `urlTextBox` and apply domain settings if not waiting on Orbot.
1364                 if (!waitingForOrbot) {
1365                     // Check to see if `WebView` has set `url` to be `about:blank`.
1366                     if (url.equals("about:blank")) {  // `WebView` is blank, so `formattedUrlString` should be `""` and `urlTextBox` should display a hint.
1367                         // Set `formattedUrlString` to `""`.
1368                         formattedUrlString = "";
1369
1370                         urlTextBox.setText(formattedUrlString);
1371
1372                         // Request focus for `urlTextBox`.
1373                         urlTextBox.requestFocus();
1374
1375                         // Display the keyboard.
1376                         inputMethodManager.showSoftInput(urlTextBox, 0);
1377
1378                         // Apply the domain settings.  This clears any settings from the previous domain.
1379                         applyDomainSettings(formattedUrlString, true, false);
1380                     } else {  // `WebView` has loaded a webpage.
1381                         // Set `formattedUrlString`.
1382                         formattedUrlString = url;
1383
1384                         // Only update `urlTextBox` if the user is not typing in it.
1385                         if (!urlTextBox.hasFocus()) {
1386                             // Display the formatted URL text.
1387                             urlTextBox.setText(formattedUrlString);
1388
1389                             // Apply text highlighting to `urlTextBox`.
1390                             highlightUrlText();
1391                         }
1392                     }
1393
1394                     // Store the SSL certificate so it can be accessed from `ViewSslCertificateDialog` and `PinnedSslCertificateMismatchDialog`.
1395                     sslCertificate = mainWebView.getCertificate();
1396
1397                     // 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.
1398                     if (pinnedDomainSslCertificate && !ignorePinnedSslCertificate) {
1399                         // Initialize the current SSL certificate variables.
1400                         String currentWebsiteIssuedToCName = "";
1401                         String currentWebsiteIssuedToOName = "";
1402                         String currentWebsiteIssuedToUName = "";
1403                         String currentWebsiteIssuedByCName = "";
1404                         String currentWebsiteIssuedByOName = "";
1405                         String currentWebsiteIssuedByUName = "";
1406                         Date currentWebsiteSslStartDate = null;
1407                         Date currentWebsiteSslEndDate = null;
1408
1409
1410                         // Extract the individual pieces of information from the current website SSL certificate if it is not null.
1411                         if (sslCertificate != null) {
1412                             currentWebsiteIssuedToCName = sslCertificate.getIssuedTo().getCName();
1413                             currentWebsiteIssuedToOName = sslCertificate.getIssuedTo().getOName();
1414                             currentWebsiteIssuedToUName = sslCertificate.getIssuedTo().getUName();
1415                             currentWebsiteIssuedByCName = sslCertificate.getIssuedBy().getCName();
1416                             currentWebsiteIssuedByOName = sslCertificate.getIssuedBy().getOName();
1417                             currentWebsiteIssuedByUName = sslCertificate.getIssuedBy().getUName();
1418                             currentWebsiteSslStartDate = sslCertificate.getValidNotBeforeDate();
1419                             currentWebsiteSslEndDate = sslCertificate.getValidNotAfterDate();
1420                         }
1421
1422                         // 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`.
1423                         String currentWebsiteSslStartDateString = "";
1424                         String currentWebsiteSslEndDateString = "";
1425                         String pinnedDomainSslStartDateString = "";
1426                         String pinnedDomainSslEndDateString = "";
1427
1428                         // Convert the `Dates` to `Strings` if they are not `null`.
1429                         if (currentWebsiteSslStartDate != null) {
1430                             currentWebsiteSslStartDateString = currentWebsiteSslStartDate.toString();
1431                         }
1432
1433                         if (currentWebsiteSslEndDate != null) {
1434                             currentWebsiteSslEndDateString = currentWebsiteSslEndDate.toString();
1435                         }
1436
1437                         if (pinnedDomainSslStartDate != null) {
1438                             pinnedDomainSslStartDateString = pinnedDomainSslStartDate.toString();
1439                         }
1440
1441                         if (pinnedDomainSslEndDate != null) {
1442                             pinnedDomainSslEndDateString = pinnedDomainSslEndDate.toString();
1443                         }
1444
1445                         // Check to see if the pinned SSL certificate matches the current website certificate.
1446                         if (!currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) || !currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) ||
1447                                 !currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) || !currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) ||
1448                                 !currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) || !currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) ||
1449                                 !currentWebsiteSslStartDateString.equals(pinnedDomainSslStartDateString) || !currentWebsiteSslEndDateString.equals(pinnedDomainSslEndDateString)) {
1450                             // The pinned SSL certificate doesn't match the current domain certificate.
1451                             //Display the pinned SSL certificate mismatch `AlertDialog`.
1452                             AppCompatDialogFragment pinnedSslCertificateMismatchDialogFragment = new PinnedSslCertificateMismatchDialog();
1453                             pinnedSslCertificateMismatchDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_mismatch));
1454                         }
1455                     }
1456                 }
1457             }
1458
1459             // Handle SSL Certificate errors.
1460             @Override
1461             public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
1462                 // Get the current website SSL certificate.
1463                 SslCertificate currentWebsiteSslCertificate = error.getCertificate();
1464
1465                 // Extract the individual pieces of information from the current website SSL certificate.
1466                 String currentWebsiteIssuedToCName = currentWebsiteSslCertificate.getIssuedTo().getCName();
1467                 String currentWebsiteIssuedToOName = currentWebsiteSslCertificate.getIssuedTo().getOName();
1468                 String currentWebsiteIssuedToUName = currentWebsiteSslCertificate.getIssuedTo().getUName();
1469                 String currentWebsiteIssuedByCName = currentWebsiteSslCertificate.getIssuedBy().getCName();
1470                 String currentWebsiteIssuedByOName = currentWebsiteSslCertificate.getIssuedBy().getOName();
1471                 String currentWebsiteIssuedByUName = currentWebsiteSslCertificate.getIssuedBy().getUName();
1472                 Date currentWebsiteSslStartDate = currentWebsiteSslCertificate.getValidNotBeforeDate();
1473                 Date currentWebsiteSslEndDate = currentWebsiteSslCertificate.getValidNotAfterDate();
1474
1475                 // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
1476                 if (pinnedDomainSslCertificate &&
1477                         currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) && currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) &&
1478                         currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) && currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) &&
1479                         currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) && currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) &&
1480                         currentWebsiteSslStartDate.equals(pinnedDomainSslStartDate) && currentWebsiteSslEndDate.equals(pinnedDomainSslEndDate)) {
1481                     // An SSL certificate is pinned and matches the current domain certificate.
1482                     // Proceed to the website without displaying an error.
1483                     handler.proceed();
1484                 } else {  // Either there isn't a pinned SSL certificate or it doesn't match the current website certificate.
1485                     // Store `handler` so it can be accesses from `onSslErrorCancel()` and `onSslErrorProceed()`.
1486                     sslErrorHandler = handler;
1487
1488                     // Display the SSL error `AlertDialog`.
1489                     AppCompatDialogFragment sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error);
1490                     sslCertificateErrorDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_error));
1491                 }
1492             }
1493         });
1494
1495         // Load the website if not waiting for Orbot to connect.
1496         if (!waitingForOrbot) {
1497             loadUrl(formattedUrlString);
1498         }
1499     }
1500
1501     @Override
1502     protected void onNewIntent(Intent intent) {
1503         // Sets the new intent as the activity intent, so that any future `getIntent()`s pick up this one instead of creating a new activity.
1504         setIntent(intent);
1505
1506         // Check to see if the intent contains a new URL.
1507         if (intent.getData() != null) {
1508             // Get the intent data and convert it to a string.
1509             final Uri intentUriData = intent.getData();
1510             formattedUrlString = intentUriData.toString();
1511
1512             // Load the website.
1513             loadUrl(formattedUrlString);
1514
1515             // Close the navigation drawer if it is open.
1516             if (drawerLayout.isDrawerVisible(GravityCompat.START)) {
1517                 drawerLayout.closeDrawer(GravityCompat.START);
1518             }
1519
1520             // Close the bookmarks drawer if it is open.
1521             if (drawerLayout.isDrawerVisible(GravityCompat.END)) {
1522                 drawerLayout.closeDrawer(GravityCompat.END);
1523             }
1524
1525             // Clear the keyboard if displayed and remove the focus on the urlTextBar if it has it.
1526             mainWebView.requestFocus();
1527         }
1528     }
1529
1530     @Override
1531     public void onRestart() {
1532         // Run the default commands.
1533         super.onRestart();
1534
1535         // Make sure Orbot is running if Privacy Browser is proxying through Orbot.
1536         if (proxyThroughOrbot) {
1537             // Request Orbot to start.  If Orbot is already running no hard will be caused by this request.
1538             Intent orbotIntent = new Intent("org.torproject.android.intent.action.START");
1539
1540             // Send the intent to the Orbot package.
1541             orbotIntent.setPackage("org.torproject.android");
1542
1543             // Make it so.
1544             sendBroadcast(orbotIntent);
1545         }
1546
1547         // Apply the app settings if returning from the Settings activity..
1548         if (reapplyAppSettingsOnRestart) {
1549             // Apply the app settings.
1550             applyAppSettings();
1551
1552             // Reload the webpage if displaying of images has been disabled in the Settings activity.
1553             if (reloadOnRestart) {
1554                 // Reload `mainWebView`.
1555                 mainWebView.reload();
1556
1557                 // Reset `reloadOnRestartBoolean`.
1558                 reloadOnRestart = false;
1559             }
1560
1561             // Reset the return from settings flag.
1562             reapplyAppSettingsOnRestart = false;
1563         }
1564
1565         // Apply the domain settings if returning from the Domains activity.
1566         if (reapplyDomainSettingsOnRestart) {
1567             // Reapply the domain settings.
1568             applyDomainSettings(formattedUrlString, false, true);
1569
1570             // Reset `reapplyDomainSettingsOnRestart`.
1571             reapplyDomainSettingsOnRestart = false;
1572         }
1573
1574         // Load the URL on restart to apply changes to night mode.
1575         if (loadUrlOnRestart) {
1576             // Load the current `formattedUrlString`.
1577             loadUrl(formattedUrlString);
1578
1579             // Reset `loadUrlOnRestart.
1580             loadUrlOnRestart = false;
1581         }
1582
1583         // Update the bookmarks drawer if returning from the Bookmarks activity.
1584         if (restartFromBookmarksActivity) {
1585             // Close the bookmarks drawer.
1586             drawerLayout.closeDrawer(GravityCompat.END);
1587
1588             // Reload the bookmarks drawer.
1589             loadBookmarksFolder();
1590
1591             // Reset `restartFromBookmarksActivity`.
1592             restartFromBookmarksActivity = false;
1593         }
1594
1595         // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.  This can be important if the screen was rotated.
1596         updatePrivacyIcons(true);
1597     }
1598
1599     // `onResume()` runs after `onStart()`, which runs after `onCreate()` and `onRestart()`.
1600     @Override
1601     public void onResume() {
1602         // Run the default commands.
1603         super.onResume();
1604
1605         // Resume JavaScript (if enabled).
1606         mainWebView.resumeTimers();
1607
1608         // Resume `mainWebView`.
1609         mainWebView.onResume();
1610
1611         // Resume the adView for the free flavor.
1612         if (BuildConfig.FLAVOR.contentEquals("free")) {
1613             // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1614             AdHelper.resumeAd(findViewById(R.id.adview));
1615         }
1616     }
1617
1618     @Override
1619     public void onPause() {
1620         // Pause `mainWebView`.
1621         mainWebView.onPause();
1622
1623         // Stop all JavaScript.
1624         mainWebView.pauseTimers();
1625
1626         // Pause the adView or it will continue to consume resources in the background on the free flavor.
1627         if (BuildConfig.FLAVOR.contentEquals("free")) {
1628             // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1629             AdHelper.pauseAd(findViewById(R.id.adview));
1630         }
1631
1632         super.onPause();
1633     }
1634
1635     @Override
1636     public boolean onCreateOptionsMenu(Menu menu) {
1637         // Inflate the menu; this adds items to the action bar if it is present.
1638         getMenuInflater().inflate(R.menu.webview_options_menu, menu);
1639
1640         // Set mainMenu so it can be used by `onOptionsItemSelected()` and `updatePrivacyIcons`.
1641         mainMenu = menu;
1642
1643         // Set the initial status of the privacy icons.  `false` does not call `invalidateOptionsMenu` as the last step.
1644         updatePrivacyIcons(false);
1645
1646         // Get handles for the menu items.
1647         MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1648         MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1649         MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1650         MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data);  // Form data can be removed once the minimum API >= 26.
1651         MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data);  // Form data can be removed once the minimum API >= 26.
1652         MenuItem refreshMenuItem = menu.findItem(R.id.refresh);
1653         MenuItem adConsentMenuItem = menu.findItem(R.id.ad_consent);
1654
1655         // Only display third-party cookies if API >= 21
1656         toggleThirdPartyCookiesMenuItem.setVisible(Build.VERSION.SDK_INT >= 21);
1657
1658         // Only display the form data menu items if the API < 26.
1659         toggleSaveFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
1660         clearFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
1661
1662         // Only show Ad Consent if this is the free flavor.
1663         adConsentMenuItem.setVisible(BuildConfig.FLAVOR.contentEquals("free"));
1664
1665         // Get the shared preference values.  `this` references the current context.
1666         SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
1667
1668         // Set the status of the additional app bar icons.  Setting the refresh menu item to `SHOW_AS_ACTION_ALWAYS` makes it appear even on small devices like phones.
1669         if (sharedPreferences.getBoolean("display_additional_app_bar_icons", false)) {
1670             toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1671             toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1672             refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_ALWAYS);
1673         } else { //Do not display the additional icons.
1674             toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1675             toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1676             refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1677         }
1678
1679         return true;
1680     }
1681
1682     @Override
1683     public boolean onPrepareOptionsMenu(Menu menu) {
1684         // Get handles for the menu items.
1685         MenuItem addOrEditDomain = menu.findItem(R.id.add_or_edit_domain);
1686         MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1687         MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1688         MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1689         MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data);  // Form data can be removed once the minimum API >= 26.
1690         MenuItem clearDataMenuItem = menu.findItem(R.id.clear_data);
1691         MenuItem clearCookiesMenuItem = menu.findItem(R.id.clear_cookies);
1692         MenuItem clearDOMStorageMenuItem = menu.findItem(R.id.clear_dom_storage);
1693         MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data);  // Form data can be removed once the minimum API >= 26.
1694         MenuItem easyListMenuItem = menu.findItem(R.id.easylist);
1695         MenuItem easyPrivacyMenuItem = menu.findItem(R.id.easyprivacy);
1696         MenuItem fanboysAnnoyanceListMenuItem = menu.findItem(R.id.fanboys_annoyance_list);
1697         MenuItem fanboysSocialBlockingListMenuItem = menu.findItem(R.id.fanboys_social_blocking_list);
1698         MenuItem fontSizeMenuItem = menu.findItem(R.id.font_size);
1699         MenuItem swipeToRefreshMenuItem = menu.findItem(R.id.swipe_to_refresh);
1700         MenuItem displayImagesMenuItem = menu.findItem(R.id.display_images);
1701
1702         // Set the text for the domain menu item.
1703         if (domainSettingsApplied) {
1704             addOrEditDomain.setTitle(R.string.edit_domain_settings);
1705         } else {
1706             addOrEditDomain.setTitle(R.string.add_domain_settings);
1707         }
1708
1709         // Set the status of the menu item checkboxes.
1710         toggleFirstPartyCookiesMenuItem.setChecked(firstPartyCookiesEnabled);
1711         toggleThirdPartyCookiesMenuItem.setChecked(thirdPartyCookiesEnabled);
1712         toggleDomStorageMenuItem.setChecked(domStorageEnabled);
1713         toggleSaveFormDataMenuItem.setChecked(saveFormDataEnabled);  // Form data can be removed once the minimum API >= 26.
1714         easyListMenuItem.setChecked(easyListEnabled);
1715         easyPrivacyMenuItem.setChecked(easyPrivacyEnabled);
1716         fanboysAnnoyanceListMenuItem.setChecked(fanboysAnnoyanceListEnabled);
1717         fanboysSocialBlockingListMenuItem.setChecked(fanboysSocialBlockingListEnabled);
1718         swipeToRefreshMenuItem.setChecked(swipeRefreshLayout.isEnabled());
1719         displayImagesMenuItem.setChecked(mainWebView.getSettings().getLoadsImagesAutomatically());
1720
1721         // Enable third-party cookies if first-party cookies are enabled.
1722         toggleThirdPartyCookiesMenuItem.setEnabled(firstPartyCookiesEnabled);
1723
1724         // Enable DOM Storage if JavaScript is enabled.
1725         toggleDomStorageMenuItem.setEnabled(javaScriptEnabled);
1726
1727         // Enable Clear Cookies if there are any.
1728         clearCookiesMenuItem.setEnabled(cookieManager.hasCookies());
1729
1730         // Get a count of the number of files in the Local Storage directory.
1731         File localStorageDirectory = new File (privateDataDirectoryString + "/app_webview/Local Storage/");
1732         int localStorageDirectoryNumberOfFiles = 0;
1733         if (localStorageDirectory.exists()) {
1734             localStorageDirectoryNumberOfFiles = localStorageDirectory.list().length;
1735         }
1736
1737         // Get a count of the number of files in the IndexedDB directory.
1738         File indexedDBDirectory = new File (privateDataDirectoryString + "/app_webview/IndexedDB");
1739         int indexedDBDirectoryNumberOfFiles = 0;
1740         if (indexedDBDirectory.exists()) {
1741             indexedDBDirectoryNumberOfFiles = indexedDBDirectory.list().length;
1742         }
1743
1744         // Enable Clear DOM Storage if there is any.
1745         clearDOMStorageMenuItem.setEnabled(localStorageDirectoryNumberOfFiles > 0 || indexedDBDirectoryNumberOfFiles > 0);
1746
1747         // Enable Clear Form Data is there is any.  This can be removed once the minimum API >= 26.
1748         if (Build.VERSION.SDK_INT < 26) {
1749             WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(this);
1750             clearFormDataMenuItem.setEnabled(mainWebViewDatabase.hasFormData());
1751         }
1752
1753         // Enable Clear Data if any of the submenu items are enabled.
1754         clearDataMenuItem.setEnabled(clearCookiesMenuItem.isEnabled() || clearDOMStorageMenuItem.isEnabled() || clearFormDataMenuItem.isEnabled());
1755
1756         // Disable Fanboy's Social Blocking List if Fanboy's Annoyance List is checked.
1757         fanboysSocialBlockingListMenuItem.setEnabled(!fanboysAnnoyanceListEnabled);
1758
1759         // Initialize font size variables.
1760         int fontSize = mainWebView.getSettings().getTextZoom();
1761         String fontSizeTitle;
1762         MenuItem selectedFontSizeMenuItem;
1763
1764         // Prepare the font size title and current size menu item.
1765         switch (fontSize) {
1766             case 25:
1767                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.twenty_five_percent);
1768                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_twenty_five_percent);
1769                 break;
1770
1771             case 50:
1772                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.fifty_percent);
1773                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_fifty_percent);
1774                 break;
1775
1776             case 75:
1777                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.seventy_five_percent);
1778                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_seventy_five_percent);
1779                 break;
1780
1781             case 100:
1782                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1783                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1784                 break;
1785
1786             case 125:
1787                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_twenty_five_percent);
1788                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_twenty_five_percent);
1789                 break;
1790
1791             case 150:
1792                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_fifty_percent);
1793                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_fifty_percent);
1794                 break;
1795
1796             case 175:
1797                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_seventy_five_percent);
1798                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_seventy_five_percent);
1799                 break;
1800
1801             case 200:
1802                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.two_hundred_percent);
1803                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_two_hundred_percent);
1804                 break;
1805
1806             default:
1807                 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1808                 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1809                 break;
1810         }
1811
1812         // Set the font size title and select the current size menu item.
1813         fontSizeMenuItem.setTitle(fontSizeTitle);
1814         selectedFontSizeMenuItem.setChecked(true);
1815
1816         // Run all the other default commands.
1817         super.onPrepareOptionsMenu(menu);
1818
1819         // Display the menu.
1820         return true;
1821     }
1822
1823     @Override
1824     // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
1825     @SuppressLint("SetJavaScriptEnabled")
1826     // removeAllCookies is deprecated, but it is required for API < 21.
1827     @SuppressWarnings("deprecation")
1828     public boolean onOptionsItemSelected(MenuItem menuItem) {
1829         // Get the selected menu item ID.
1830         int menuItemId = menuItem.getItemId();
1831
1832         // Set the commands that relate to the menu entries.
1833         switch (menuItemId) {
1834             case R.id.toggle_javascript:
1835                 // Switch the status of javaScriptEnabled.
1836                 javaScriptEnabled = !javaScriptEnabled;
1837
1838                 // Apply the new JavaScript status.
1839                 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
1840
1841                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1842                 updatePrivacyIcons(true);
1843
1844                 // Display a `Snackbar`.
1845                 if (javaScriptEnabled) {  // JavaScrip is enabled.
1846                     Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show();
1847                 } else if (firstPartyCookiesEnabled) {  // JavaScript is disabled, but first-party cookies are enabled.
1848                     Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show();
1849                 } else {  // Privacy mode.
1850                     Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1851                 }
1852
1853                 // Reload the WebView.
1854                 mainWebView.reload();
1855                 return true;
1856
1857             case R.id.add_or_edit_domain:
1858                 if (domainSettingsApplied) {  // Edit the current domain settings.
1859                     // Reapply the domain settings on returning to `MainWebViewActivity`.
1860                     reapplyDomainSettingsOnRestart = true;
1861                     currentDomainName = "";
1862
1863                     // Create an intent to launch the domains activity.
1864                     Intent domainsIntent = new Intent(this, DomainsActivity.class);
1865
1866                     // Put extra information instructing the domains activity to directly load the current domain and close on back instead of returning to the domains list.
1867                     domainsIntent.putExtra("loadDomain", domainSettingsDatabaseId);
1868                     domainsIntent.putExtra("closeOnBack", true);
1869
1870                     // Make it so.
1871                     startActivity(domainsIntent);
1872                 } else {  // Add a new domain.
1873                     // Apply the new domain settings on returning to `MainWebViewActivity`.
1874                     reapplyDomainSettingsOnRestart = true;
1875                     currentDomainName = "";
1876
1877                     // Get the current domain
1878                     Uri currentUri = Uri.parse(formattedUrlString);
1879                     String currentDomain = currentUri.getHost();
1880
1881                     // Initialize the database handler.  The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
1882                     DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
1883
1884                     // Create the domain and store the database ID.
1885                     int newDomainDatabaseId = domainsDatabaseHelper.addDomain(currentDomain);
1886
1887                     // Create an intent to launch the domains activity.
1888                     Intent domainsIntent = new Intent(this, DomainsActivity.class);
1889
1890                     // Put extra information instructing the domains activity to directly load the new domain and close on back instead of returning to the domains list.
1891                     domainsIntent.putExtra("loadDomain", newDomainDatabaseId);
1892                     domainsIntent.putExtra("closeOnBack", true);
1893
1894                     // Make it so.
1895                     startActivity(domainsIntent);
1896                 }
1897                 return true;
1898
1899             case R.id.toggle_first_party_cookies:
1900                 // Switch the status of firstPartyCookiesEnabled.
1901                 firstPartyCookiesEnabled = !firstPartyCookiesEnabled;
1902
1903                 // Update the menu checkbox.
1904                 menuItem.setChecked(firstPartyCookiesEnabled);
1905
1906                 // Apply the new cookie status.
1907                 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
1908
1909                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1910                 updatePrivacyIcons(true);
1911
1912                 // Display a `Snackbar`.
1913                 if (firstPartyCookiesEnabled) {  // First-party cookies are enabled.
1914                     Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1915                 } else if (javaScriptEnabled) {  // JavaScript is still enabled.
1916                     Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1917                 } else {  // Privacy mode.
1918                     Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1919                 }
1920
1921                 // Reload the WebView.
1922                 mainWebView.reload();
1923                 return true;
1924
1925             case R.id.toggle_third_party_cookies:
1926                 if (Build.VERSION.SDK_INT >= 21) {
1927                     // Switch the status of thirdPartyCookiesEnabled.
1928                     thirdPartyCookiesEnabled = !thirdPartyCookiesEnabled;
1929
1930                     // Update the menu checkbox.
1931                     menuItem.setChecked(thirdPartyCookiesEnabled);
1932
1933                     // Apply the new cookie status.
1934                     cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
1935
1936                     // Display a `Snackbar`.
1937                     if (thirdPartyCookiesEnabled) {
1938                         Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1939                     } else {
1940                         Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1941                     }
1942
1943                     // Reload the WebView.
1944                     mainWebView.reload();
1945                 } // Else do nothing because SDK < 21.
1946                 return true;
1947
1948             case R.id.toggle_dom_storage:
1949                 // Switch the status of domStorageEnabled.
1950                 domStorageEnabled = !domStorageEnabled;
1951
1952                 // Update the menu checkbox.
1953                 menuItem.setChecked(domStorageEnabled);
1954
1955                 // Apply the new DOM Storage status.
1956                 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
1957
1958                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1959                 updatePrivacyIcons(true);
1960
1961                 // Display a `Snackbar`.
1962                 if (domStorageEnabled) {
1963                     Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show();
1964                 } else {
1965                     Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show();
1966                 }
1967
1968                 // Reload the WebView.
1969                 mainWebView.reload();
1970                 return true;
1971
1972             // Form data can be removed once the minimum API >= 26.
1973             case R.id.toggle_save_form_data:
1974                 // Switch the status of saveFormDataEnabled.
1975                 saveFormDataEnabled = !saveFormDataEnabled;
1976
1977                 // Update the menu checkbox.
1978                 menuItem.setChecked(saveFormDataEnabled);
1979
1980                 // Apply the new form data status.
1981                 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
1982
1983                 // Display a `Snackbar`.
1984                 if (saveFormDataEnabled) {
1985                     Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show();
1986                 } else {
1987                     Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show();
1988                 }
1989
1990                 // Update the privacy icon.  `true` runs `invalidateOptionsMenu` as the last step.
1991                 updatePrivacyIcons(true);
1992
1993                 // Reload the WebView.
1994                 mainWebView.reload();
1995                 return true;
1996
1997             case R.id.clear_cookies:
1998                 Snackbar.make(findViewById(R.id.main_webview), R.string.cookies_deleted, Snackbar.LENGTH_LONG)
1999                         .setAction(R.string.undo, v -> {
2000                             // Do nothing because everything will be handled by `onDismissed()` below.
2001                         })
2002                         .addCallback(new Snackbar.Callback() {
2003                             @Override
2004                             public void onDismissed(Snackbar snackbar, int event) {
2005                                 switch (event) {
2006                                     // The user pushed the `Undo` button.
2007                                     case Snackbar.Callback.DISMISS_EVENT_ACTION:
2008                                         // Do nothing.
2009                                         break;
2010
2011                                     // The `Snackbar` was dismissed without the `Undo` button being pushed.
2012                                     default:
2013                                         // `cookieManager.removeAllCookie()` varies by SDK.
2014                                         if (Build.VERSION.SDK_INT < 21) {
2015                                             cookieManager.removeAllCookie();
2016                                         } else {
2017                                             // `null` indicates no callback.
2018                                             cookieManager.removeAllCookies(null);
2019                                         }
2020                                 }
2021                             }
2022                         })
2023                         .show();
2024                 return true;
2025
2026             case R.id.clear_dom_storage:
2027                 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
2028                         .setAction(R.string.undo, v -> {
2029                             // Do nothing because everything will be handled by `onDismissed()` below.
2030                         })
2031                         .addCallback(new Snackbar.Callback() {
2032                             @Override
2033                             public void onDismissed(Snackbar snackbar, int event) {
2034                                 switch (event) {
2035                                     // The user pushed the `Undo` button.
2036                                     case Snackbar.Callback.DISMISS_EVENT_ACTION:
2037                                         // Do nothing.
2038                                         break;
2039
2040                                     // The `Snackbar` was dismissed without the `Undo` button being pushed.
2041                                     default:
2042                                         // Delete the DOM Storage.
2043                                         WebStorage webStorage = WebStorage.getInstance();
2044                                         webStorage.deleteAllData();
2045
2046                                         // Manually delete the DOM storage files and directories.
2047                                         try {
2048                                             // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2049                                             privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2050
2051                                             // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2052                                             privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2053                                             privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2054                                             privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2055                                             privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2056                                         } catch (IOException e) {
2057                                             // Do nothing if an error is thrown.
2058                                         }
2059                                 }
2060                             }
2061                         })
2062                         .show();
2063                 return true;
2064
2065             // Form data can be remove once the minimum API >= 26.
2066             case R.id.clear_form_data:
2067                 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_deleted, Snackbar.LENGTH_LONG)
2068                         .setAction(R.string.undo, v -> {
2069                             // Do nothing because everything will be handled by `onDismissed()` below.
2070                         })
2071                         .addCallback(new Snackbar.Callback() {
2072                             @Override
2073                             public void onDismissed(Snackbar snackbar, int event) {
2074                                 switch (event) {
2075                                     // The user pushed the `Undo` button.
2076                                     case Snackbar.Callback.DISMISS_EVENT_ACTION:
2077                                         // Do nothing.
2078                                         break;
2079
2080                                     // The `Snackbar` was dismissed without the `Undo` button being pushed.
2081                                     default:
2082                                         // Delete the form data.
2083                                         WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(getApplicationContext());
2084                                         mainWebViewDatabase.clearFormData();
2085                                 }
2086                             }
2087                         })
2088                         .show();
2089                 return true;
2090
2091             case R.id.font_size_twenty_five_percent:
2092                 mainWebView.getSettings().setTextZoom(25);
2093                 return true;
2094
2095             case R.id.font_size_fifty_percent:
2096                 mainWebView.getSettings().setTextZoom(50);
2097                 return true;
2098
2099             case R.id.font_size_seventy_five_percent:
2100                 mainWebView.getSettings().setTextZoom(75);
2101                 return true;
2102
2103             case R.id.font_size_one_hundred_percent:
2104                 mainWebView.getSettings().setTextZoom(100);
2105                 return true;
2106
2107             case R.id.font_size_one_hundred_twenty_five_percent:
2108                 mainWebView.getSettings().setTextZoom(125);
2109                 return true;
2110
2111             case R.id.font_size_one_hundred_fifty_percent:
2112                 mainWebView.getSettings().setTextZoom(150);
2113                 return true;
2114
2115             case R.id.font_size_one_hundred_seventy_five_percent:
2116                 mainWebView.getSettings().setTextZoom(175);
2117                 return true;
2118
2119             case R.id.font_size_two_hundred_percent:
2120                 mainWebView.getSettings().setTextZoom(200);
2121                 return true;
2122
2123             case R.id.swipe_to_refresh:
2124                 // Toggle swipe to refresh.
2125                 swipeRefreshLayout.setEnabled(!swipeRefreshLayout.isEnabled());
2126                 return true;
2127
2128             case R.id.display_images:
2129                 if (mainWebView.getSettings().getLoadsImagesAutomatically()) {  // Images are currently loaded automatically.
2130                     mainWebView.getSettings().setLoadsImagesAutomatically(false);
2131                     mainWebView.reload();
2132                 } else {  // Images are not currently loaded automatically.
2133                     mainWebView.getSettings().setLoadsImagesAutomatically(true);
2134                 }
2135
2136                 // Set `onTheFlyDisplayImagesSet`.
2137                 onTheFlyDisplayImagesSet = true;
2138                 return true;
2139
2140             case R.id.view_source:
2141                 // Launch the View Source activity.
2142                 Intent viewSourceIntent = new Intent(this, ViewSourceActivity.class);
2143                 startActivity(viewSourceIntent);
2144                 return true;
2145
2146             case R.id.easylist:
2147                 // Toggle the EasyList status.
2148                 easyListEnabled = !easyListEnabled;
2149
2150                 // Update the menu checkbox.
2151                 menuItem.setChecked(easyListEnabled);
2152
2153                 // Reload the main WebView.
2154                 mainWebView.reload();
2155                 return true;
2156
2157             case R.id.easyprivacy:
2158                 // Toggle the EasyPrivacy status.
2159                 easyPrivacyEnabled = !easyPrivacyEnabled;
2160
2161                 // Update the menu checkbox.
2162                 menuItem.setChecked(easyPrivacyEnabled);
2163
2164                 // Reload the main WebView.
2165                 mainWebView.reload();
2166                 return true;
2167
2168             case R.id.fanboys_annoyance_list:
2169                 // Toggle Fanboy's Annoyance List status.
2170                 fanboysAnnoyanceListEnabled = !fanboysAnnoyanceListEnabled;
2171
2172                 // Update the menu checkbox.
2173                 menuItem.setChecked(fanboysAnnoyanceListEnabled);
2174
2175                 // Update the staus of Fanboy's Social Blocking List.
2176                 MenuItem fanboysSocialBlockingListMenuItem = mainMenu.findItem(R.id.fanboys_social_blocking_list);
2177                 fanboysSocialBlockingListMenuItem.setEnabled(!fanboysAnnoyanceListEnabled);
2178
2179                 // Reload the main WebView.
2180                 mainWebView.reload();
2181                 return true;
2182
2183             case R.id.fanboys_social_blocking_list:
2184                 // Toggle Fanboy's Social Blocking List status.
2185                 fanboysSocialBlockingListEnabled = !fanboysSocialBlockingListEnabled;
2186
2187                 // Update teh menu checkbox.
2188                 menuItem.setChecked(fanboysSocialBlockingListEnabled);
2189
2190                 // Reload the main WebView.
2191                 mainWebView.reload();
2192                 return true;
2193
2194             case R.id.share:
2195                 // Setup the share string.
2196                 String shareString = webViewTitle + " – " + urlTextBox.getText().toString();
2197
2198                 // Create the share intent.
2199                 Intent shareIntent = new Intent();
2200                 shareIntent.setAction(Intent.ACTION_SEND);
2201                 shareIntent.putExtra(Intent.EXTRA_TEXT, shareString);
2202                 shareIntent.setType("text/plain");
2203
2204                 // Make it so.
2205                 startActivity(Intent.createChooser(shareIntent, "Share URL"));
2206                 return true;
2207
2208             case R.id.find_on_page:
2209                 // Hide the URL app bar.
2210                 supportAppBar.setVisibility(View.GONE);
2211
2212                 // Show the Find on Page `RelativeLayout`.
2213                 findOnPageLinearLayout.setVisibility(View.VISIBLE);
2214
2215                 // Display the keyboard.  We have to wait 200 ms before running the command to work around a bug in Android.
2216                 // http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
2217                 findOnPageEditText.postDelayed(() -> {
2218                     // Set the focus on `findOnPageEditText`.
2219                     findOnPageEditText.requestFocus();
2220
2221                     // Display the keyboard.  `0` sets no input flags.
2222                     inputMethodManager.showSoftInput(findOnPageEditText, 0);
2223                 }, 200);
2224                 return true;
2225
2226             case R.id.print:
2227                 // Get a `PrintManager` instance.
2228                 PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
2229
2230                 // Convert `mainWebView` to `printDocumentAdapter`.
2231                 PrintDocumentAdapter printDocumentAdapter = mainWebView.createPrintDocumentAdapter();
2232
2233                 // Remove the lint error below that `printManager` might be `null`.
2234                 assert printManager != null;
2235
2236                 // Print the document.  The print attributes are `null`.
2237                 printManager.print(getString(R.string.privacy_browser_web_page), printDocumentAdapter, null);
2238                 return true;
2239
2240             case R.id.add_to_homescreen:
2241                 // Show the `CreateHomeScreenShortcutDialog` `AlertDialog` and name this instance `R.string.create_shortcut`.
2242                 AppCompatDialogFragment createHomeScreenShortcutDialogFragment = new CreateHomeScreenShortcutDialog();
2243                 createHomeScreenShortcutDialogFragment.show(getSupportFragmentManager(), getString(R.string.create_shortcut));
2244
2245                 //Everything else will be handled by `CreateHomeScreenShortcutDialog` and the associated listener below.
2246                 return true;
2247
2248             case R.id.refresh:
2249                 mainWebView.reload();
2250                 return true;
2251
2252             case R.id.ad_consent:
2253                 // Display the ad consent dialog.
2254                 DialogFragment adConsentDialogFragment = new AdConsentDialog();
2255                 adConsentDialogFragment.show(getFragmentManager(), getString(R.string.ad_consent));
2256                 return true;
2257
2258             default:
2259                 // Don't consume the event.
2260                 return super.onOptionsItemSelected(menuItem);
2261         }
2262     }
2263
2264     // removeAllCookies is deprecated, but it is required for API < 21.
2265     @SuppressWarnings("deprecation")
2266     @Override
2267     public boolean onNavigationItemSelected(@NonNull MenuItem menuItem) {
2268         int menuItemId = menuItem.getItemId();
2269
2270         switch (menuItemId) {
2271             case R.id.home:
2272                 loadUrl(homepage);
2273                 break;
2274
2275             case R.id.back:
2276                 if (mainWebView.canGoBack()) {
2277                     // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2278                     navigatingHistory = true;
2279
2280                     // Load the previous website in the history.
2281                     mainWebView.goBack();
2282                 }
2283                 break;
2284
2285             case R.id.forward:
2286                 if (mainWebView.canGoForward()) {
2287                     // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2288                     navigatingHistory = true;
2289
2290                     // Load the next website in the history.
2291                     mainWebView.goForward();
2292                 }
2293                 break;
2294
2295             case R.id.history:
2296                 // Get the `WebBackForwardList`.
2297                 WebBackForwardList webBackForwardList = mainWebView.copyBackForwardList();
2298
2299                 // Show the `UrlHistoryDialog` `AlertDialog` and name this instance `R.string.history`.  `this` is the `Context`.
2300                 AppCompatDialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(this, webBackForwardList);
2301                 urlHistoryDialogFragment.show(getSupportFragmentManager(), getString(R.string.history));
2302                 break;
2303
2304             case R.id.requests:
2305                 // Launch the requests activity.
2306                 Intent requestsIntent = new Intent(this, RequestsActivity.class);
2307                 startActivity(requestsIntent);
2308                 break;
2309
2310             case R.id.downloads:
2311                 // Launch the system Download Manager.
2312                 Intent downloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
2313
2314                 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
2315                 downloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2316
2317                 startActivity(downloadManagerIntent);
2318                 break;
2319
2320             case R.id.domains:
2321                 // Set the flag to reapply the domain settings on restart when returning from Domain Settings.
2322                 reapplyDomainSettingsOnRestart = true;
2323                 currentDomainName = "";
2324
2325                 // Launch the domains activity.
2326                 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2327                 startActivity(domainsIntent);
2328                 break;
2329
2330             case R.id.settings:
2331                 // Set the flag to reapply app settings on restart when returning from Settings.
2332                 reapplyAppSettingsOnRestart = true;
2333
2334                 // Set the flag to reapply the domain settings on restart when returning from Settings.
2335                 reapplyDomainSettingsOnRestart = true;
2336                 currentDomainName = "";
2337
2338                 // Launch the settings activity.
2339                 Intent settingsIntent = new Intent(this, SettingsActivity.class);
2340                 startActivity(settingsIntent);
2341                 break;
2342
2343             case R.id.guide:
2344                 // Launch `GuideActivity`.
2345                 Intent guideIntent = new Intent(this, GuideActivity.class);
2346                 startActivity(guideIntent);
2347                 break;
2348
2349             case R.id.about:
2350                 // Launch `AboutActivity`.
2351                 Intent aboutIntent = new Intent(this, AboutActivity.class);
2352                 startActivity(aboutIntent);
2353                 break;
2354
2355             case R.id.clearAndExit:
2356                 // Get a handle for `sharedPreferences`.  `this` references the current context.
2357                 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2358
2359                 boolean clearEverything = sharedPreferences.getBoolean("clear_everything", true);
2360
2361                 // Clear cookies.
2362                 if (clearEverything || sharedPreferences.getBoolean("clear_cookies", true)) {
2363                     // The command to remove cookies changed slightly in API 21.
2364                     if (Build.VERSION.SDK_INT >= 21) {
2365                         cookieManager.removeAllCookies(null);
2366                     } else {
2367                         cookieManager.removeAllCookie();
2368                     }
2369
2370                     // Manually delete the cookies database, as `CookieManager` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2371                     try {
2372                         // We have to use two commands because `Runtime.exec()` does not like `*`.
2373                         privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies");
2374                         privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies-journal");
2375                     } catch (IOException e) {
2376                         // Do nothing if an error is thrown.
2377                     }
2378                 }
2379
2380                 // Clear DOM storage.
2381                 if (clearEverything || sharedPreferences.getBoolean("clear_dom_storage", true)) {
2382                     // Ask `WebStorage` to clear the DOM storage.
2383                     WebStorage webStorage = WebStorage.getInstance();
2384                     webStorage.deleteAllData();
2385
2386                     // Manually delete the DOM storage files and directories, as `WebStorage` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2387                     try {
2388                         // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2389                         privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2390
2391                         // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2392                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2393                         privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2394                         privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2395                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2396                     } catch (IOException e) {
2397                         // Do nothing if an error is thrown.
2398                     }
2399                 }
2400
2401                 // Clear form data if the API < 26.
2402                 if ((Build.VERSION.SDK_INT < 26) && (clearEverything || sharedPreferences.getBoolean("clear_form_data", true))) {
2403                     WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
2404                     webViewDatabase.clearFormData();
2405
2406                     // Manually delete the form data database, as `WebViewDatabase` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2407                     try {
2408                         // We have to use a `String[]` because the database contains a space and `Runtime.exec` will not escape the string correctly otherwise.
2409                         privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data"});
2410                         privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data-journal"});
2411                     } catch (IOException e) {
2412                         // Do nothing if an error is thrown.
2413                     }
2414                 }
2415
2416                 // Clear the cache.
2417                 if (clearEverything || sharedPreferences.getBoolean("clear_cache", true)) {
2418                     // `true` includes disk files.
2419                     mainWebView.clearCache(true);
2420
2421                     // Manually delete the cache directories.
2422                     try {
2423                         // Delete the main cache directory.
2424                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
2425
2426                         // Delete the secondary `Service Worker` cache directory.
2427                         // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
2428                         privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
2429                     } catch (IOException e) {
2430                         // Do nothing if an error is thrown.
2431                     }
2432                 }
2433
2434                 // Clear SSL certificate preferences.
2435                 mainWebView.clearSslPreferences();
2436
2437                 // Clear the back/forward history.
2438                 mainWebView.clearHistory();
2439
2440                 // Clear `formattedUrlString`.
2441                 formattedUrlString = null;
2442
2443                 // Clear `customHeaders`.
2444                 customHeaders.clear();
2445
2446                 // Detach all views from `mainWebViewRelativeLayout`.
2447                 mainWebViewRelativeLayout.removeAllViews();
2448
2449                 // Destroy the internal state of `mainWebView`.
2450                 mainWebView.destroy();
2451
2452                 // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
2453                 // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
2454                 if (clearEverything) {
2455                     try {
2456                         privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
2457                     } catch (IOException e) {
2458                         // Do nothing if an error is thrown.
2459                     }
2460                 }
2461
2462                 // Close Privacy Browser.  `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
2463                 if (Build.VERSION.SDK_INT >= 21) {
2464                     finishAndRemoveTask();
2465                 } else {
2466                     finish();
2467                 }
2468
2469                 // Remove the terminated program from RAM.  The status code is `0`.
2470                 System.exit(0);
2471                 break;
2472         }
2473
2474         // Close the navigation drawer.
2475         drawerLayout.closeDrawer(GravityCompat.START);
2476         return true;
2477     }
2478
2479     @Override
2480     public void onPostCreate(Bundle savedInstanceState) {
2481         super.onPostCreate(savedInstanceState);
2482
2483         // Sync the state of the DrawerToggle after onRestoreInstanceState has finished.
2484         drawerToggle.syncState();
2485     }
2486
2487     @Override
2488     public void onConfigurationChanged(Configuration newConfig) {
2489         super.onConfigurationChanged(newConfig);
2490
2491         // Reload the ad for the free flavor if we are not in full screen mode.
2492         if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
2493             // Reload the ad.  The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
2494             AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_id));
2495         }
2496
2497         // `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:
2498         // https://code.google.com/p/android/issues/detail?id=20493#c8
2499         // ActivityCompat.invalidateOptionsMenu(this);
2500     }
2501
2502     @Override
2503     public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
2504         // Store the `HitTestResult`.
2505         final WebView.HitTestResult hitTestResult = mainWebView.getHitTestResult();
2506
2507         // Create strings.
2508         final String imageUrl;
2509         final String linkUrl;
2510
2511         // Get a handle for the `ClipboardManager`.
2512         final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
2513
2514         // Remove the lint errors below that `clipboardManager` might be `null`.
2515         assert clipboardManager != null;
2516
2517         switch (hitTestResult.getType()) {
2518             // `SRC_ANCHOR_TYPE` is a link.
2519             case WebView.HitTestResult.SRC_ANCHOR_TYPE:
2520                 // Get the target URL.
2521                 linkUrl = hitTestResult.getExtra();
2522
2523                 // Set the target URL as the title of the `ContextMenu`.
2524                 menu.setHeaderTitle(linkUrl);
2525
2526                 // Add a Load URL entry.
2527                 menu.add(R.string.load_url).setOnMenuItemClickListener((MenuItem item) -> {
2528                     loadUrl(linkUrl);
2529                     return false;
2530                 });
2531
2532                 // Add a Copy URL entry.
2533                 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
2534                     // Save the link URL in a `ClipData`.
2535                     ClipData srcAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
2536
2537                     // Set the `ClipData` as the clipboard's primary clip.
2538                     clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
2539                     return false;
2540                 });
2541
2542                 // Add a Download URL entry.
2543                 menu.add(R.string.download_url).setOnMenuItemClickListener((MenuItem item) -> {
2544                     // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
2545                     if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
2546                         // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
2547
2548                         // Store the variables for future use by `onRequestPermissionsResult()`.
2549                         downloadUrl = linkUrl;
2550                         downloadContentDisposition = "none";
2551                         downloadContentLength = -1;
2552
2553                         // Show a dialog if the user has previously denied the permission.
2554                         if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) {  // Show a dialog explaining the request first.
2555                             // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
2556                             DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
2557
2558                             // Show the download location permission alert dialog.  The permission will be requested when the the dialog is closed.
2559                             downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
2560                         } else {  // Show the permission request directly.
2561                             // Request the permission.  The download dialog will be launched by `onRequestPermissionResult()`.
2562                             ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
2563                         }
2564                     } else {  // The WRITE_EXTERNAL_STORAGE permission has already been granted.
2565                         // Get a handle for the download file alert dialog.
2566                         AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(linkUrl, "none", -1);
2567
2568                         // Show the download file alert dialog.
2569                         downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2570                     }
2571                     return false;
2572                 });
2573
2574                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2575                 menu.add(R.string.cancel);
2576                 break;
2577
2578             case WebView.HitTestResult.EMAIL_TYPE:
2579                 // Get the target URL.
2580                 linkUrl = hitTestResult.getExtra();
2581
2582                 // Set the target URL as the title of the `ContextMenu`.
2583                 menu.setHeaderTitle(linkUrl);
2584
2585                 // Add a `Write Email` entry.
2586                 menu.add(R.string.write_email).setOnMenuItemClickListener(item -> {
2587                     // We use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
2588                     Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
2589
2590                     // Parse the url and set it as the data for the `Intent`.
2591                     emailIntent.setData(Uri.parse("mailto:" + linkUrl));
2592
2593                     // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
2594                     emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2595
2596                     // Make it so.
2597                     startActivity(emailIntent);
2598                     return false;
2599                 });
2600
2601                 // Add a `Copy Email Address` entry.
2602                 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(item -> {
2603                     // Save the email address in a `ClipData`.
2604                     ClipData srcEmailTypeClipData = ClipData.newPlainText(getString(R.string.email_address), linkUrl);
2605
2606                     // Set the `ClipData` as the clipboard's primary clip.
2607                     clipboardManager.setPrimaryClip(srcEmailTypeClipData);
2608                     return false;
2609                 });
2610
2611                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2612                 menu.add(R.string.cancel);
2613                 break;
2614
2615             // `IMAGE_TYPE` is an image.
2616             case WebView.HitTestResult.IMAGE_TYPE:
2617                 // Get the image URL.
2618                 imageUrl = hitTestResult.getExtra();
2619
2620                 // Set the image URL as the title of the `ContextMenu`.
2621                 menu.setHeaderTitle(imageUrl);
2622
2623                 // Add a `View Image` entry.
2624                 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2625                     loadUrl(imageUrl);
2626                     return false;
2627                 });
2628
2629                 // Add a `Download Image` entry.
2630                 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2631                     // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
2632                     if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
2633                         // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
2634
2635                         // Store the image URL for use by `onRequestPermissionResult()`.
2636                         downloadImageUrl = imageUrl;
2637
2638                         // Show a dialog if the user has previously denied the permission.
2639                         if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) {  // Show a dialog explaining the request first.
2640                             // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2641                             DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2642
2643                             // Show the download location permission alert dialog.  The permission will be requested when the dialog is closed.
2644                             downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
2645                         } else {  // Show the permission request directly.
2646                             // Request the permission.  The download dialog will be launched by `onRequestPermissionResult().
2647                             ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2648                         }
2649                     } else {  // The WRITE_EXTERNAL_STORAGE permission has already been granted.
2650                         // Get a handle for the download image alert dialog.
2651                         AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2652
2653                         // Show the download image alert dialog.
2654                         downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2655                     }
2656                     return false;
2657                 });
2658
2659                 // Add a `Copy URL` entry.
2660                 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2661                     // Save the image URL in a `ClipData`.
2662                     ClipData srcImageTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2663
2664                     // Set the `ClipData` as the clipboard's primary clip.
2665                     clipboardManager.setPrimaryClip(srcImageTypeClipData);
2666                     return false;
2667                 });
2668
2669                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2670                 menu.add(R.string.cancel);
2671                 break;
2672
2673
2674             // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
2675             case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
2676                 // Get the image URL.
2677                 imageUrl = hitTestResult.getExtra();
2678
2679                 // Set the image URL as the title of the `ContextMenu`.
2680                 menu.setHeaderTitle(imageUrl);
2681
2682                 // Add a `View Image` entry.
2683                 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2684                     loadUrl(imageUrl);
2685                     return false;
2686                 });
2687
2688                 // Add a `Download Image` entry.
2689                 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2690                     // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
2691                     if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
2692                         // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
2693
2694                         // Store the image URL for use by `onRequestPermissionResult()`.
2695                         downloadImageUrl = imageUrl;
2696
2697                         // Show a dialog if the user has previously denied the permission.
2698                         if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) {  // Show a dialog explaining the request first.
2699                             // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2700                             DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2701
2702                             // Show the download location permission alert dialog.  The permission will be requested when the dialog is closed.
2703                             downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
2704                         } else {  // Show the permission request directly.
2705                             // Request the permission.  The download dialog will be launched by `onRequestPermissionResult().
2706                             ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2707                         }
2708                     } else {  // The WRITE_EXTERNAL_STORAGE permission has already been granted.
2709                         // Get a handle for the download image alert dialog.
2710                         AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2711
2712                         // Show the download image alert dialog.
2713                         downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2714                     }
2715                     return false;
2716                 });
2717
2718                 // Add a `Copy URL` entry.
2719                 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2720                     // Save the image URL in a `ClipData`.
2721                     ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2722
2723                     // Set the `ClipData` as the clipboard's primary clip.
2724                     clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
2725                     return false;
2726                 });
2727
2728                 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2729                 menu.add(R.string.cancel);
2730                 break;
2731         }
2732     }
2733
2734     @Override
2735     public void onCreateBookmark(AppCompatDialogFragment dialogFragment) {
2736         // Get the `EditTexts` from the `dialogFragment`.
2737         EditText createBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_name_edittext);
2738         EditText createBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_url_edittext);
2739
2740         // Extract the strings from the `EditTexts`.
2741         String bookmarkNameString = createBookmarkNameEditText.getText().toString();
2742         String bookmarkUrlString = createBookmarkUrlEditText.getText().toString();
2743
2744         // Convert the favoriteIcon Bitmap to a byte array.  `0` is for lossless compression (the only option for a PNG).
2745         ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2746         favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
2747         byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
2748
2749         // Display the new bookmark below the current items in the (0 indexed) list.
2750         int newBookmarkDisplayOrder = bookmarksListView.getCount();
2751
2752         // Create the bookmark.
2753         bookmarksDatabaseHelper.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray);
2754
2755         // Update `bookmarksCursor` with the current contents of this folder.
2756         bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2757
2758         // Update the `ListView`.
2759         bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2760
2761         // Scroll to the new bookmark.
2762         bookmarksListView.setSelection(newBookmarkDisplayOrder);
2763     }
2764
2765     @Override
2766     public void onCreateBookmarkFolder(AppCompatDialogFragment dialogFragment) {
2767         // Get handles for the views in `dialogFragment`.
2768         EditText createFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.create_folder_name_edittext);
2769         RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon_radiobutton);
2770         ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon);
2771
2772         // Get new folder name string.
2773         String folderNameString = createFolderNameEditText.getText().toString();
2774
2775         // Get the new folder icon `Bitmap`.
2776         Bitmap folderIconBitmap;
2777         if (defaultFolderIconRadioButton.isChecked()) {  // Use the default folder icon.
2778             // Get the default folder icon and convert it to a `Bitmap`.
2779             Drawable folderIconDrawable = folderIconImageView.getDrawable();
2780             BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2781             folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2782         } else {  // Use the `WebView` favorite icon.
2783             folderIconBitmap = favoriteIconBitmap;
2784         }
2785
2786         // Convert `folderIconBitmap` to a byte array.  `0` is for lossless compression (the only option for a PNG).
2787         ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2788         folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
2789         byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
2790
2791         // Move all the bookmarks down one in the display order.
2792         for (int i = 0; i < bookmarksListView.getCount(); i++) {
2793             int databaseId = (int) bookmarksListView.getItemIdAtPosition(i);
2794             bookmarksDatabaseHelper.updateDisplayOrder(databaseId, i + 1);
2795         }
2796
2797         // Create the folder, which will be placed at the top of the `ListView`.
2798         bookmarksDatabaseHelper.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray);
2799
2800         // Update `bookmarksCursor` with the current contents of this folder.
2801         bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2802
2803         // Update the `ListView`.
2804         bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2805
2806         // Scroll to the new folder.
2807         bookmarksListView.setSelection(0);
2808     }
2809
2810     @Override
2811     public void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment) {
2812         // Get the shortcut name.
2813         EditText shortcutNameEditText = dialogFragment.getDialog().findViewById(R.id.shortcut_name_edittext);
2814         String shortcutNameString = shortcutNameEditText.getText().toString();
2815
2816         // Convert the favorite icon bitmap to an `Icon`.  `IconCompat` is required until API >= 26.
2817         IconCompat favoriteIcon = IconCompat.createWithBitmap(favoriteIconBitmap);
2818
2819         // Setup the shortcut intent.
2820         Intent shortcutIntent = new Intent();
2821         shortcutIntent.setAction(Intent.ACTION_VIEW);
2822         shortcutIntent.setData(Uri.parse(formattedUrlString));
2823
2824         // Create a shortcut info builder.  The shortcut name becomes the shortcut ID.
2825         ShortcutInfoCompat.Builder shortcutInfoBuilder = new ShortcutInfoCompat.Builder(this, shortcutNameString);
2826
2827         // Add the required fields to the shortcut info builder.
2828         shortcutInfoBuilder.setIcon(favoriteIcon);
2829         shortcutInfoBuilder.setIntent(shortcutIntent);
2830         shortcutInfoBuilder.setShortLabel(shortcutNameString);
2831
2832         // Request the pin.  `ShortcutManagerCompat` can be switched to `ShortcutManager` once API >= 26.
2833         ShortcutManagerCompat.requestPinShortcut(this, shortcutInfoBuilder.build(), null);
2834     }
2835
2836     @Override
2837     public void onCloseDownloadLocationPermissionDialog(int downloadType) {
2838         switch (downloadType) {
2839             case DownloadLocationPermissionDialog.DOWNLOAD_FILE:
2840                 // Request the WRITE_EXTERNAL_STORAGE permission with a file request code.
2841                 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
2842                 break;
2843
2844             case DownloadLocationPermissionDialog.DOWNLOAD_IMAGE:
2845                 // Request the WRITE_EXTERNAL_STORAGE permission with an image request code.
2846                 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2847                 break;
2848         }
2849     }
2850
2851     @Override
2852     public void onRequestPermissionsResult(int requestCode, @NonNull String permissions[], @NonNull int[] grantResults) {
2853         switch (requestCode) {
2854             case DOWNLOAD_FILE_REQUEST_CODE:
2855                 // Show the download file alert dialog.  When the dialog closes, the correct command will be used based on the permission status.
2856                 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(downloadUrl, downloadContentDisposition, downloadContentLength);
2857
2858                 // On API 23, displaying the fragment must be delayed or the app will crash.
2859                 if (Build.VERSION.SDK_INT == 23) {
2860                     new Handler().postDelayed(() -> downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
2861                 } else {
2862                     downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2863                 }
2864
2865                 // Reset the download variables.
2866                 downloadUrl = "";
2867                 downloadContentDisposition = "";
2868                 downloadContentLength = 0;
2869                 break;
2870
2871             case DOWNLOAD_IMAGE_REQUEST_CODE:
2872                 // Show the download image alert dialog.  When the dialog closes, the correct command will be used based on the permission status.
2873                 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(downloadImageUrl);
2874
2875                 // On API 23, displaying the fragment must be delayed or the app will crash.
2876                 if (Build.VERSION.SDK_INT == 23) {
2877                     new Handler().postDelayed(() -> downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
2878                 } else {
2879                     downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2880                 }
2881
2882                 // Reset the image URL variable.
2883                 downloadImageUrl = "";
2884                 break;
2885         }
2886     }
2887
2888     @Override
2889     public void onDownloadImage(AppCompatDialogFragment dialogFragment, String imageUrl) {
2890         // Download the image if it has an HTTP or HTTPS URI.
2891         if (imageUrl.startsWith("http")) {
2892             // Get a handle for the system `DOWNLOAD_SERVICE`.
2893             DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
2894
2895             // Parse `imageUrl`.
2896             DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(imageUrl));
2897
2898             // Pass cookies to download manager if cookies are enabled.  This is required to download images from websites that require a login.
2899             // Code contributed 2017 Hendrik Knackstedt.  Copyright assigned to Soren Stoutner <soren@stoutner.com>.
2900             if (firstPartyCookiesEnabled) {
2901                 // Get the cookies for `imageUrl`.
2902                 String cookies = cookieManager.getCookie(imageUrl);
2903
2904                 // Add the cookies to `downloadRequest`.  In the HTTP request header, cookies are named `Cookie`.
2905                 downloadRequest.addRequestHeader("Cookie", cookies);
2906             }
2907
2908             // Get the file name from the dialog fragment.
2909             EditText downloadImageNameEditText = dialogFragment.getDialog().findViewById(R.id.download_image_name);
2910             String imageName = downloadImageNameEditText.getText().toString();
2911
2912             // Specify the download location.
2913             if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) {  // External write permission granted.
2914                 // Download to the public download directory.
2915                 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, imageName);
2916             } else {  // External write permission denied.
2917                 // Download to the app's external download directory.
2918                 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, imageName);
2919             }
2920
2921             // Allow `MediaScanner` to index the download if it is a media file.
2922             downloadRequest.allowScanningByMediaScanner();
2923
2924             // Add the URL as the description for the download.
2925             downloadRequest.setDescription(imageUrl);
2926
2927             // Show the download notification after the download is completed.
2928             downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
2929
2930             // Remove the lint warning below that `downloadManager` might be `null`.
2931             assert downloadManager != null;
2932
2933             // Initiate the download.
2934             downloadManager.enqueue(downloadRequest);
2935         } else {  // The image is not an HTTP or HTTPS URI.
2936             Snackbar.make(mainWebView, R.string.cannot_download_image, Snackbar.LENGTH_INDEFINITE).show();
2937         }
2938     }
2939
2940     @Override
2941     public void onDownloadFile(AppCompatDialogFragment dialogFragment, String downloadUrl) {
2942         // Download the file if it has an HTTP or HTTPS URI.
2943         if (downloadUrl.startsWith("http")) {
2944             // Get a handle for the system `DOWNLOAD_SERVICE`.
2945             DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
2946
2947             // Parse `downloadUrl`.
2948             DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(downloadUrl));
2949
2950             // Pass cookies to download manager if cookies are enabled.  This is required to download files from websites that require a login.
2951             // Code contributed 2017 Hendrik Knackstedt.  Copyright assigned to Soren Stoutner <soren@stoutner.com>.
2952             if (firstPartyCookiesEnabled) {
2953                 // Get the cookies for `downloadUrl`.
2954                 String cookies = cookieManager.getCookie(downloadUrl);
2955
2956                 // Add the cookies to `downloadRequest`.  In the HTTP request header, cookies are named `Cookie`.
2957                 downloadRequest.addRequestHeader("Cookie", cookies);
2958             }
2959
2960             // Get the file name from the dialog fragment.
2961             EditText downloadFileNameEditText = dialogFragment.getDialog().findViewById(R.id.download_file_name);
2962             String fileName = downloadFileNameEditText.getText().toString();
2963
2964             // Specify the download location.
2965             if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) {  // External write permission granted.
2966                 // Download to the public download directory.
2967                 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, fileName);
2968             } else {  // External write permission denied.
2969                 // Download to the app's external download directory.
2970                 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, fileName);
2971             }
2972
2973             // Allow `MediaScanner` to index the download if it is a media file.
2974             downloadRequest.allowScanningByMediaScanner();
2975
2976             // Add the URL as the description for the download.
2977             downloadRequest.setDescription(downloadUrl);
2978
2979             // Show the download notification after the download is completed.
2980             downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
2981
2982             // Remove the lint warning below that `downloadManager` might be `null`.
2983             assert downloadManager != null;
2984
2985             // Initiate the download.
2986             downloadManager.enqueue(downloadRequest);
2987         } else {  // The download is not an HTTP or HTTPS URI.
2988             Snackbar.make(mainWebView, R.string.cannot_download_file, Snackbar.LENGTH_INDEFINITE).show();
2989         }
2990     }
2991
2992     @Override
2993     public void onSaveBookmark(AppCompatDialogFragment dialogFragment, int selectedBookmarkDatabaseId) {
2994         // Get handles for the views from `dialogFragment`.
2995         EditText editBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_name_edittext);
2996         EditText editBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_url_edittext);
2997         RadioButton currentBookmarkIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_current_icon_radiobutton);
2998
2999         // Store the bookmark strings.
3000         String bookmarkNameString = editBookmarkNameEditText.getText().toString();
3001         String bookmarkUrlString = editBookmarkUrlEditText.getText().toString();
3002
3003         // Update the bookmark.
3004         if (currentBookmarkIconRadioButton.isChecked()) {  // Update the bookmark without changing the favorite icon.
3005             bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString);
3006         } else {  // Update the bookmark using the `WebView` favorite icon.
3007             // Convert the favorite icon to a byte array.  `0` is for lossless compression (the only option for a PNG).
3008             ByteArrayOutputStream newFavoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
3009             favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFavoriteIconByteArrayOutputStream);
3010             byte[] newFavoriteIconByteArray = newFavoriteIconByteArrayOutputStream.toByteArray();
3011
3012             //  Update the bookmark and the favorite icon.
3013             bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString, newFavoriteIconByteArray);
3014         }
3015
3016         // Update `bookmarksCursor` with the current contents of this folder.
3017         bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3018
3019         // Update the `ListView`.
3020         bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3021     }
3022
3023     @Override
3024     public void onSaveBookmarkFolder(AppCompatDialogFragment dialogFragment, int selectedFolderDatabaseId) {
3025         // Get handles for the views from `dialogFragment`.
3026         EditText editFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_folder_name_edittext);
3027         RadioButton currentFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_current_icon_radiobutton);
3028         RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_radiobutton);
3029         ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_imageview);
3030
3031         // Get the new folder name.
3032         String newFolderNameString = editFolderNameEditText.getText().toString();
3033
3034         // Check if the favorite icon has changed.
3035         if (currentFolderIconRadioButton.isChecked()) {  // Only the name has changed.
3036             // Update the name in the database.
3037             bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString);
3038         } else if (!currentFolderIconRadioButton.isChecked() && newFolderNameString.equals(oldFolderNameString)) {  // Only the icon has changed.
3039             // Get the new folder icon `Bitmap`.
3040             Bitmap folderIconBitmap;
3041             if (defaultFolderIconRadioButton.isChecked()) {
3042                 // Get the default folder icon and convert it to a `Bitmap`.
3043                 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3044                 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3045                 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3046             } else {  // Use the `WebView` favorite icon.
3047                 folderIconBitmap = favoriteIconBitmap;
3048             }
3049
3050             // Convert the folder `Bitmap` to a byte array.  `0` is for lossless compression (the only option for a PNG).
3051             ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3052             folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3053             byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3054
3055             // Update the folder icon in the database.
3056             bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, folderIconByteArray);
3057         } else {  // The folder icon and the name have changed.
3058             // Get the new folder icon `Bitmap`.
3059             Bitmap folderIconBitmap;
3060             if (defaultFolderIconRadioButton.isChecked()) {
3061                 // Get the default folder icon and convert it to a `Bitmap`.
3062                 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3063                 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3064                 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3065             } else {  // Use the `WebView` favorite icon.
3066                 folderIconBitmap = MainWebViewActivity.favoriteIconBitmap;
3067             }
3068
3069             // Convert the folder `Bitmap` to a byte array.  `0` is for lossless compression (the only option for a PNG).
3070             ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3071             folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3072             byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3073
3074             // Update the folder name and icon in the database.
3075             bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString, folderIconByteArray);
3076         }
3077
3078         // Update `bookmarksCursor` with the current contents of this folder.
3079         bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3080
3081         // Update the `ListView`.
3082         bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3083     }
3084
3085     @Override
3086     public void onHttpAuthenticationCancel() {
3087         // Cancel the `HttpAuthHandler`.
3088         httpAuthHandler.cancel();
3089     }
3090
3091     @Override
3092     public void onHttpAuthenticationProceed(AppCompatDialogFragment dialogFragment) {
3093         // Get handles for the `EditTexts`.
3094         EditText usernameEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_username);
3095         EditText passwordEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_password);
3096
3097         // Proceed with the HTTP authentication.
3098         httpAuthHandler.proceed(usernameEditText.getText().toString(), passwordEditText.getText().toString());
3099     }
3100
3101     public void viewSslCertificate(View view) {
3102         // Show the `ViewSslCertificateDialog` `AlertDialog` and name this instance `@string/view_ssl_certificate`.
3103         DialogFragment viewSslCertificateDialogFragment = new ViewSslCertificateDialog();
3104         viewSslCertificateDialogFragment.show(getFragmentManager(), getString(R.string.view_ssl_certificate));
3105     }
3106
3107     @Override
3108     public void onSslErrorCancel() {
3109         sslErrorHandler.cancel();
3110     }
3111
3112     @Override
3113     public void onSslErrorProceed() {
3114         sslErrorHandler.proceed();
3115     }
3116
3117     @Override
3118     public void onSslMismatchBack() {
3119         if (mainWebView.canGoBack()) {  // There is a back page in the history.
3120             // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3121             navigatingHistory = true;
3122
3123             // Go back.
3124             mainWebView.goBack();
3125         } else {  // There are no pages to go back to.
3126             // Load a blank page
3127             loadUrl("");
3128         }
3129     }
3130
3131     @Override
3132     public void onSslMismatchProceed() {
3133         // Do not check the pinned SSL certificate for this domain again until the domain changes.
3134         ignorePinnedSslCertificate = true;
3135     }
3136
3137     @Override
3138     public void onUrlHistoryEntrySelected(int moveBackOrForwardSteps) {
3139         // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3140         navigatingHistory = true;
3141
3142         // Load the history entry.
3143         mainWebView.goBackOrForward(moveBackOrForwardSteps);
3144     }
3145
3146     @Override
3147     public void onClearHistory() {
3148         // Clear the history.
3149         mainWebView.clearHistory();
3150     }
3151
3152     // Override `onBackPressed` to handle the navigation drawer and `mainWebView`.
3153     @Override
3154     public void onBackPressed() {
3155         if (drawerLayout.isDrawerVisible(GravityCompat.START)) {  // The navigation drawer is open.
3156             // Close the navigation drawer.
3157             drawerLayout.closeDrawer(GravityCompat.START);
3158         } else if (drawerLayout.isDrawerVisible(GravityCompat.END)){  // The bookmarks drawer is open.
3159             if (currentBookmarksFolder.isEmpty()) {  // The home folder is displayed.
3160                 // close the bookmarks drawer.
3161                 drawerLayout.closeDrawer(GravityCompat.END);
3162             } else {  // A subfolder is displayed.
3163                 // Place the former parent folder in `currentFolder`.
3164                 currentBookmarksFolder = bookmarksDatabaseHelper.getParentFolder(currentBookmarksFolder);
3165
3166                 // Load the new folder.
3167                 loadBookmarksFolder();
3168             }
3169
3170         } else if (mainWebView.canGoBack()) {  // There is at least one item in the `WebView` history.
3171             // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3172             navigatingHistory = true;
3173
3174             // Go back.
3175             mainWebView.goBack();
3176         } else {  // There isn't anything to do in Privacy Browser.
3177             // Pass `onBackPressed()` to the system.
3178             super.onBackPressed();
3179         }
3180     }
3181
3182     // Process the results of an upload file chooser.  Currently there is only one `startActivityForResult` in this activity, so the request code, used to differentiate them, is ignored.
3183     @Override
3184     public void onActivityResult(int requestCode, int resultCode, Intent data) {
3185         // File uploads only work on API >= 21.
3186         if (Build.VERSION.SDK_INT >= 21) {
3187             // Pass the file to the WebView.
3188             fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(resultCode, data));
3189         }
3190     }
3191
3192     private void loadUrlFromTextBox() throws UnsupportedEncodingException {
3193         // Get the text from urlTextBox and convert it to a string.  trim() removes white spaces from the beginning and end of the string.
3194         String unformattedUrlString = urlTextBox.getText().toString().trim();
3195
3196         // Check to see if `unformattedUrlString` is a valid URL.  Otherwise, convert it into a search.
3197         if ((Patterns.WEB_URL.matcher(unformattedUrlString).matches()) || (unformattedUrlString.startsWith("http://")) || (unformattedUrlString.startsWith("https://"))) {
3198             // Add `http://` at the beginning if it is missing.  Otherwise the app will segfault.
3199             if (!unformattedUrlString.startsWith("http")) {
3200                 unformattedUrlString = "http://" + unformattedUrlString;
3201             }
3202
3203             // Initialize `unformattedUrl`.
3204             URL unformattedUrl = null;
3205
3206             // Convert `unformattedUrlString` to a `URL`, then to a `URI`, and then back to a `String`, which sanitizes the input and adds in any missing components.
3207             try {
3208                 unformattedUrl = new URL(unformattedUrlString);
3209             } catch (MalformedURLException e) {
3210                 e.printStackTrace();
3211             }
3212
3213             // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if `.get` was called on a `null` value.
3214             final String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
3215             final String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
3216             final String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
3217             final String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
3218             final String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
3219
3220             // Build the URI.
3221             Uri.Builder formattedUri = new Uri.Builder();
3222             formattedUri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
3223
3224             // Decode `formattedUri` as a `String` in `UTF-8`.
3225             formattedUrlString = URLDecoder.decode(formattedUri.build().toString(), "UTF-8");
3226         } else if (unformattedUrlString.isEmpty()){  // Load a blank web site.
3227             // Load a blank string.
3228             formattedUrlString = "";
3229         } else {  // Search for the contents of the URL box.
3230             // Sanitize the search input and convert it to a search.
3231             final String encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
3232
3233             // Add the base search URL.
3234             formattedUrlString = searchURL + encodedUrlString;
3235         }
3236
3237         // Clear the focus from the URL text box.  Otherwise, proximate typing in the box will retain the colorized formatting instead of being reset during refocus.
3238         urlTextBox.clearFocus();
3239
3240         // Make it so.
3241         loadUrl(formattedUrlString);
3242     }
3243
3244     private void loadUrl(String url) {// Apply any custom domain settings.
3245         applyDomainSettings(url, true, false);
3246
3247         // Set `urlIsLoading` to prevent changes in the user agent on websites with redirects from reloading the current website.
3248         urlIsLoading = true;
3249
3250         // Load the URL.
3251         mainWebView.loadUrl(url, customHeaders);
3252     }
3253
3254     public void findPreviousOnPage(View view) {
3255         // Go to the previous highlighted phrase on the page.  `false` goes backwards instead of forwards.
3256         mainWebView.findNext(false);
3257     }
3258
3259     public void findNextOnPage(View view) {
3260         // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
3261         mainWebView.findNext(true);
3262     }
3263
3264     public void closeFindOnPage(View view) {
3265         // Delete the contents of `find_on_page_edittext`.
3266         findOnPageEditText.setText(null);
3267
3268         // Clear the highlighted phrases.
3269         mainWebView.clearMatches();
3270
3271         // Hide the Find on Page `RelativeLayout`.
3272         findOnPageLinearLayout.setVisibility(View.GONE);
3273
3274         // Show the URL app bar.
3275         supportAppBar.setVisibility(View.VISIBLE);
3276
3277         // Hide the keyboard so we can see the webpage.  `0` indicates no additional flags.
3278         inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
3279     }
3280
3281     private void applyAppSettings() {
3282         // Get a handle for the shared preferences.
3283         SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3284
3285         // Store the values from the shared preferences in variables.
3286         String homepageString = sharedPreferences.getString("homepage", "https://start.duckduckgo.com");
3287         String torHomepageString = sharedPreferences.getString("tor_homepage", "https://3g2upl4pq6kufc4m.onion");
3288         String torSearchString = sharedPreferences.getString("tor_search", "https://3g2upl4pq6kufc4m.onion/html/?q=");
3289         String torSearchCustomURLString = sharedPreferences.getString("tor_search_custom_url", "");
3290         String searchString = sharedPreferences.getString("search", "https://duckduckgo.com/html/?q=");
3291         String searchCustomURLString = sharedPreferences.getString("search_custom_url", "");
3292         incognitoModeEnabled = sharedPreferences.getBoolean("incognito_mode", false);
3293         boolean doNotTrackEnabled = sharedPreferences.getBoolean("do_not_track", false);
3294         proxyThroughOrbot = sharedPreferences.getBoolean("proxy_through_orbot", false);
3295         fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean("full_screen_browsing_mode", false);
3296         hideSystemBarsOnFullscreen = sharedPreferences.getBoolean("hide_system_bars", false);
3297         translucentNavigationBarOnFullscreen = sharedPreferences.getBoolean("translucent_navigation_bar", true);
3298         displayWebpageImagesBoolean = sharedPreferences.getBoolean("display_webpage_images", true);
3299
3300         // Set the homepage, search, and proxy options.
3301         if (proxyThroughOrbot) {  // Set the Tor options.
3302             // Set `torHomepageString` as `homepage`.
3303             homepage = torHomepageString;
3304
3305             // If formattedUrlString is null assign the homepage to it.
3306             if (formattedUrlString == null) {
3307                 formattedUrlString = homepage;
3308             }
3309
3310             // Set the search URL.
3311             if (torSearchString.equals("Custom URL")) {  // Get the custom URL string.
3312                 searchURL = torSearchCustomURLString;
3313             } else {  // Use the string from the pre-built list.
3314                 searchURL = torSearchString;
3315             }
3316
3317             // Set the proxy.  `this` refers to the current activity where an `AlertDialog` might be displayed.
3318             OrbotProxyHelper.setProxy(getApplicationContext(), this, "localhost", "8118");
3319
3320             // Set the `appBar` background to indicate proxying through Orbot is enabled.  `this` refers to the context.
3321             if (darkTheme) {
3322                 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.dark_blue_30));
3323             } else {
3324                 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.blue_50));
3325             }
3326
3327             // Display a message to the user if we are waiting on Orbot.
3328             if (!orbotStatus.equals("ON")) {
3329                 // Set `waitingForOrbot`.
3330                 waitingForOrbot = true;
3331
3332                 // Load a waiting page.  `null` specifies no encoding, which defaults to ASCII.
3333                 mainWebView.loadData(waitingForOrbotHTMLString, "text/html", null);
3334             }
3335         } else {  // Set the non-Tor options.
3336             // Set `homepageString` as `homepage`.
3337             homepage = homepageString;
3338
3339             // If formattedUrlString is null assign the homepage to it.
3340             if (formattedUrlString == null) {
3341                 formattedUrlString = homepage;
3342             }
3343
3344             // Set the search URL.
3345             if (searchString.equals("Custom URL")) {  // Get the custom URL string.
3346                 searchURL = searchCustomURLString;
3347             } else {  // Use the string from the pre-built list.
3348                 searchURL = searchString;
3349             }
3350
3351             // Reset the proxy to default.  The host is `""` and the port is `"0"`.
3352             OrbotProxyHelper.setProxy(getApplicationContext(), this, "", "0");
3353
3354             // Set the default `appBar` background.  `this` refers to the context.
3355             if (darkTheme) {
3356                 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_900));
3357             } else {
3358                 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_100));
3359             }
3360
3361             // Reset `waitingForOrbot.
3362             waitingForOrbot = false;
3363         }
3364
3365         // Set Do Not Track status.
3366         if (doNotTrackEnabled) {
3367             customHeaders.put("DNT", "1");
3368         } else {
3369             customHeaders.remove("DNT");
3370         }
3371
3372         // Apply the appropriate full screen mode the `SYSTEM_UI` flags.
3373         if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) {
3374             if (hideSystemBarsOnFullscreen) {  // Hide everything.
3375                 // Remove the translucent navigation setting if it is currently flagged.
3376                 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3377
3378                 // Remove the translucent status bar overlay.
3379                 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3380
3381                 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
3382                 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
3383
3384                 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
3385                  * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
3386                  * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
3387                  */
3388                 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
3389             } else {  // Hide everything except the status and navigation bars.
3390                 // Add the translucent status flag if it is unset.
3391                 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3392
3393                 if (translucentNavigationBarOnFullscreen) {
3394                     // Set the navigation bar to be translucent.
3395                     getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3396                 } else {
3397                     // Set the navigation bar to be black.
3398                     getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3399                 }
3400             }
3401         } else {  // Switch to normal viewing mode.
3402             // Reset `inFullScreenBrowsingMode` to `false`.
3403             inFullScreenBrowsingMode = false;
3404
3405             // Show the `appBar` if `findOnPageLinearLayout` is not visible.
3406             if (findOnPageLinearLayout.getVisibility() == View.GONE) {
3407                 appBar.show();
3408             }
3409
3410             // Show the `BannerAd` in the free flavor.
3411             if (BuildConfig.FLAVOR.contentEquals("free")) {
3412                 // Initialize the ad.  The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
3413                 AdHelper.initializeAds(findViewById(R.id.adview), getApplicationContext(), getFragmentManager(), getString(R.string.ad_id));
3414             }
3415
3416             // Remove the translucent navigation bar flag if it is set.
3417             getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3418
3419             // Add the translucent status flag if it is unset.  This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
3420             getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3421
3422             // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
3423             rootCoordinatorLayout.setSystemUiVisibility(0);
3424
3425             // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
3426             rootCoordinatorLayout.setFitsSystemWindows(true);
3427         }
3428     }
3429
3430     // `reloadWebsite` is used if returning from the Domains activity.  Otherwise JavaScript might not function correctly if it is newly enabled.
3431     // The deprecated `.getDrawable()` must be used until the minimum API >= 21.
3432     @SuppressWarnings("deprecation")
3433     private void applyDomainSettings(String url, boolean resetFavoriteIcon, boolean reloadWebsite) {
3434         // Reset `navigatingHistory`.
3435         navigatingHistory = false;
3436
3437         // Parse the URL into a URI.
3438         Uri uri = Uri.parse(url);
3439
3440         // Extract the domain from `uri`.
3441         String hostName = uri.getHost();
3442
3443         // Initialize `loadingNewDomainName`.
3444         boolean loadingNewDomainName;
3445
3446         // If either `hostName` or `currentDomainName` are `null`, run the options for loading a new domain name.
3447         // The lint suggestion to simplify the `if` statement is incorrect, because `hostName.equals(currentDomainName)` can produce a `null object reference.`
3448         //noinspection SimplifiableIfStatement
3449         if ((hostName == null) || (currentDomainName == null)) {
3450             loadingNewDomainName = true;
3451         } else {  // Determine if `hostName` equals `currentDomainName`.
3452             loadingNewDomainName = !hostName.equals(currentDomainName);
3453         }
3454
3455         // Strings don't like to be null.
3456         if (hostName == null) {
3457             hostName = "";
3458         }
3459
3460         // Only apply the domain settings if a new domain is being loaded.  This allows the user to set temporary settings for JavaScript, cookies, DOM storage, etc.
3461         if (loadingNewDomainName) {
3462             // Set the new `hostname` as the `currentDomainName`.
3463             currentDomainName = hostName;
3464
3465             // Reset `ignorePinnedSslCertificate`.
3466             ignorePinnedSslCertificate = false;
3467
3468             // Reset the favorite icon if specified.
3469             if (resetFavoriteIcon) {
3470                 favoriteIconBitmap = favoriteIconDefaultBitmap;
3471                 favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(favoriteIconBitmap, 64, 64, true));
3472             }
3473
3474             // Initialize the database handler.  `this` specifies the context.  The two `nulls` do not specify the database name or a `CursorFactory`.
3475             // The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
3476             DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
3477
3478             // Get a full cursor from `domainsDatabaseHelper`.
3479             Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain();
3480
3481             // Initialize `domainSettingsSet`.
3482             Set<String> domainSettingsSet = new HashSet<>();
3483
3484             // Get the domain name column index.
3485             int domainNameColumnIndex = domainNameCursor.getColumnIndex(DomainsDatabaseHelper.DOMAIN_NAME);
3486
3487             // Populate `domainSettingsSet`.
3488             for (int i = 0; i < domainNameCursor.getCount(); i++) {
3489                 // Move `domainsCursor` to the current row.
3490                 domainNameCursor.moveToPosition(i);
3491
3492                 // Store the domain name in `domainSettingsSet`.
3493                 domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex));
3494             }
3495
3496             // Close `domainNameCursor.
3497             domainNameCursor.close();
3498
3499             // Initialize variables to track if domain settings will be applied and, if so, under which name.
3500             domainSettingsApplied = false;
3501             String domainNameInDatabase = null;
3502
3503             // Check the hostname.
3504             if (domainSettingsSet.contains(hostName)) {
3505                 domainSettingsApplied = true;
3506                 domainNameInDatabase = hostName;
3507             }
3508
3509             // Check all the subdomains of the host name against wildcard domains in the domain cursor.
3510             while (!domainSettingsApplied && hostName.contains(".")) {  // Stop checking if domain settings are already applied or there are no more `.` in the host name.
3511                 if (domainSettingsSet.contains("*." + hostName)) {  // Check the host name prepended by `*.`.
3512                     // Apply the domain settings.
3513                     domainSettingsApplied = true;
3514
3515                     // Store the applied domain names as it appears in the database.
3516                     domainNameInDatabase = "*." + hostName;
3517                 }
3518
3519                 // Strip out the lowest subdomain of of the host name.
3520                 hostName = hostName.substring(hostName.indexOf(".") + 1);
3521             }
3522
3523
3524             // Get a handle for the shared preference.
3525             SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3526
3527             // Store the general preference information.
3528             String defaultFontSizeString = sharedPreferences.getString("default_font_size", "100");
3529             String defaultUserAgentName = sharedPreferences.getString("user_agent", "Privacy Browser");
3530             String defaultCustomUserAgentString = sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0");
3531             boolean defaultSwipeToRefresh = sharedPreferences.getBoolean("swipe_to_refresh", true);
3532             nightMode = sharedPreferences.getBoolean("night_mode", false);
3533
3534             if (domainSettingsApplied) {  // The url we are loading has custom domain settings.
3535                 // Get a cursor for the current host and move it to the first position.
3536                 Cursor currentHostDomainSettingsCursor = domainsDatabaseHelper.getCursorForDomainName(domainNameInDatabase);
3537                 currentHostDomainSettingsCursor.moveToFirst();
3538
3539                 // Get the settings from the cursor.
3540                 domainSettingsDatabaseId = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper._ID)));
3541                 javaScriptEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1);
3542                 firstPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FIRST_PARTY_COOKIES)) == 1);
3543                 thirdPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_THIRD_PARTY_COOKIES)) == 1);
3544                 domStorageEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1);
3545                 // Form data can be removed once the minimum API >= 26.
3546                 saveFormDataEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1);
3547                 easyListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYLIST)) == 1);
3548                 easyPrivacyEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYPRIVACY)) == 1);
3549                 fanboysAnnoyanceListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_ANNOYANCE_LIST)) == 1);
3550                 fanboysSocialBlockingListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST)) == 1);
3551                 String userAgentName = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.USER_AGENT));
3552                 int fontSize = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.FONT_SIZE));
3553                 int swipeToRefreshInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SWIPE_TO_REFRESH));
3554                 int nightModeInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.NIGHT_MODE));
3555                 displayWebpageImagesInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.DISPLAY_IMAGES));
3556                 pinnedDomainSslCertificate = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.PINNED_SSL_CERTIFICATE)) == 1);
3557                 pinnedDomainSslIssuedToCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_COMMON_NAME));
3558                 pinnedDomainSslIssuedToONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATION));
3559                 pinnedDomainSslIssuedToUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT));
3560                 pinnedDomainSslIssuedByCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_COMMON_NAME));
3561                 pinnedDomainSslIssuedByONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATION));
3562                 pinnedDomainSslIssuedByUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT));
3563
3564                 // Set `nightMode` according to `nightModeInt`.  If `nightModeInt` is `DomainsDatabaseHelper.NIGHT_MODE_SYSTEM_DEFAULT` the current setting from `sharedPreferences` will be used.
3565                 switch (nightModeInt) {
3566                     case DomainsDatabaseHelper.NIGHT_MODE_ENABLED:
3567                         nightMode = true;
3568                         break;
3569
3570                     case DomainsDatabaseHelper.NIGHT_MODE_DISABLED:
3571                         nightMode = false;
3572                         break;
3573                 }
3574
3575                 // Set `javaScriptEnabled` to be `true` if `night_mode` is `true`.
3576                 if (nightMode) {
3577                     javaScriptEnabled = true;
3578                 }
3579
3580                 // Set the pinned SSL certificate start date to `null` if the saved date `long` is 0.
3581                 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)) == 0) {
3582                     pinnedDomainSslStartDate = null;
3583                 } else {
3584                     pinnedDomainSslStartDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)));
3585                 }
3586
3587                 // Set the pinned SSL certificate end date to `null` if the saved date `long` is 0.
3588                 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)) == 0) {
3589                     pinnedDomainSslEndDate = null;
3590                 } else {
3591                     pinnedDomainSslEndDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)));
3592                 }
3593
3594                 // Close `currentHostDomainSettingsCursor`.
3595                 currentHostDomainSettingsCursor.close();
3596
3597                 // Apply the domain settings.
3598                 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
3599                 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
3600                 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
3601
3602                 // Apply the form data setting if the API < 26.
3603                 if (Build.VERSION.SDK_INT < 26) {
3604                     mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
3605                 }
3606
3607                 // Apply the font size.
3608                 if (fontSize == 0) {  // Apply the default font size.
3609                     mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3610                 } else {  // Apply the specified font size.
3611                     mainWebView.getSettings().setTextZoom(fontSize);
3612                 }
3613
3614                 // Set third-party cookies status if API >= 21.
3615                 if (Build.VERSION.SDK_INT >= 21) {
3616                     cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
3617                 }
3618
3619                 // Only set the user agent if the webpage is not currently loading.  Otherwise, changing the user agent on redirects can cause the original website to reload.
3620                 // <https://redmine.stoutner.com/issues/160>
3621                 if (!urlIsLoading) {
3622                     // Set the user agent.
3623                     if (userAgentName.equals(getString(R.string.system_default_user_agent))) {  // Use the system default user agent.
3624                         // Get the array position of the default user agent name.
3625                         int defaultUserAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3626
3627                         // Set the user agent according to the system default.
3628                         switch (defaultUserAgentArrayPosition) {
3629                             case UNRECOGNIZED_USER_AGENT:  // The default user agent name is not on the canonical list.
3630                                 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3631                                 mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
3632                                 break;
3633
3634                             case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3635                                 // Set the user agent to `""`, which uses the default value.
3636                                 mainWebView.getSettings().setUserAgentString("");
3637                                 break;
3638
3639                             case SETTINGS_CUSTOM_USER_AGENT:
3640                                 // Set the custom user agent.
3641                                 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
3642                                 break;
3643
3644                             default:
3645                                 // Get the user agent string from the user agent data array
3646                                 mainWebView.getSettings().setUserAgentString(userAgentDataArray[defaultUserAgentArrayPosition]);
3647                         }
3648                     } else {  // Set the user agent according to the stored name.
3649                         // Get the array position of the user agent name.
3650                         int userAgentArrayPosition = userAgentNamesArray.getPosition(userAgentName);
3651
3652                         switch (userAgentArrayPosition) {
3653                             case UNRECOGNIZED_USER_AGENT:  // The user agent name contains a custom user agent.
3654                                 mainWebView.getSettings().setUserAgentString(userAgentName);
3655                                 break;
3656
3657                             case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3658                                 // Set the user agent to `""`, which uses the default value.
3659                                 mainWebView.getSettings().setUserAgentString("");
3660                                 break;
3661
3662                             default:
3663                                 // Get the user agent string from the user agent data array.
3664                                 mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3665                         }
3666                     }
3667
3668                     // Set swipe to refresh.
3669                     switch (swipeToRefreshInt) {
3670                         case DomainsDatabaseHelper.SWIPE_TO_REFRESH_SYSTEM_DEFAULT:
3671                             // Set swipe to refresh according to the default.
3672                             swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3673                             break;
3674
3675                         case DomainsDatabaseHelper.SWIPE_TO_REFRESH_ENABLED:
3676                             // Enable swipe to refresh.
3677                             swipeRefreshLayout.setEnabled(true);
3678                             break;
3679
3680                         case DomainsDatabaseHelper.SWIPE_TO_REFRESH_DISABLED:
3681                             // Disable swipe to refresh.
3682                             swipeRefreshLayout.setEnabled(false);
3683                     }
3684
3685                     // Store the applied user agent string, which is used in the View Source activity.
3686                     appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
3687                 }
3688
3689                 // Set a green background on `urlTextBox` to indicate that custom domain settings are being used.  We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
3690                 if (darkTheme) {
3691                     urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_dark_blue));
3692                 } else {
3693                     urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_light_green));
3694                 }
3695             } else {  // The new URL does not have custom domain settings.  Load the defaults.
3696                 // Store the values from `sharedPreferences` in variables.
3697                 javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
3698                 firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
3699                 thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
3700                 domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
3701                 saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false);  // Form data can be removed once the minimum API >= 26.
3702                 easyListEnabled = sharedPreferences.getBoolean("easylist", true);
3703                 easyPrivacyEnabled = sharedPreferences.getBoolean("easyprivacy", true);
3704                 fanboysAnnoyanceListEnabled = sharedPreferences.getBoolean("fanboy_annoyance_list", true);
3705                 fanboysSocialBlockingListEnabled = sharedPreferences.getBoolean("fanboy_social_blocking_list", true);
3706
3707                 // Set `javaScriptEnabled` to be `true` if `night_mode` is `true`.
3708                 if (nightMode) {
3709                     javaScriptEnabled = true;
3710                 }
3711
3712                 // Apply the default settings.
3713                 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
3714                 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
3715                 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
3716                 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3717                 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3718
3719                 // Apply the form data setting if the API < 26.
3720                 if (Build.VERSION.SDK_INT < 26) {
3721                     mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
3722                 }
3723
3724                 // Reset the pinned SSL certificate information.
3725                 domainSettingsDatabaseId = -1;
3726                 pinnedDomainSslCertificate = false;
3727                 pinnedDomainSslIssuedToCNameString = "";
3728                 pinnedDomainSslIssuedToONameString = "";
3729                 pinnedDomainSslIssuedToUNameString = "";
3730                 pinnedDomainSslIssuedByCNameString = "";
3731                 pinnedDomainSslIssuedByONameString = "";
3732                 pinnedDomainSslIssuedByUNameString = "";
3733                 pinnedDomainSslStartDate = null;
3734                 pinnedDomainSslEndDate = null;
3735
3736                 // Set third-party cookies status if API >= 21.
3737                 if (Build.VERSION.SDK_INT >= 21) {
3738                     cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
3739                 }
3740
3741                 // Only set the user agent if the webpage is not currently loading.  Otherwise, changing the user agent on redirects can cause the original website to reload.
3742                 // <https://redmine.stoutner.com/issues/160>
3743                 if (!urlIsLoading) {
3744                     // Get the array position of the user agent name.
3745                     int userAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3746
3747                     // Set the user agent.
3748                     switch (userAgentArrayPosition) {
3749                         case UNRECOGNIZED_USER_AGENT:  // The default user agent name is not on the canonical list.
3750                             // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3751                             mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
3752                             break;
3753
3754                         case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3755                             // Set the user agent to `""`, which uses the default value.
3756                             mainWebView.getSettings().setUserAgentString("");
3757                             break;
3758
3759                         case SETTINGS_CUSTOM_USER_AGENT:
3760                             // Set the custom user agent.
3761                             mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
3762                             break;
3763
3764                         default:
3765                             // Get the user agent string from the user agent data array
3766                             mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3767                     }
3768
3769                     // Store the applied user agent string, which is used in the View Source activity.
3770                     appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
3771                 }
3772
3773                 // Set a transparent background on `urlTextBox`.  We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
3774                 urlAppBarRelativeLayout.setBackgroundDrawable(getResources().getDrawable(R.color.transparent));
3775             }
3776
3777             // Close `domainsDatabaseHelper`.
3778             domainsDatabaseHelper.close();
3779
3780             // Remove the `onTheFlyDisplayImagesSet` flag and set the display webpage images mode.  `true` indicates that custom domain settings are applied.
3781             onTheFlyDisplayImagesSet = false;
3782             setDisplayWebpageImages();
3783
3784             // Update the privacy icons, but only if `mainMenu` has already been populated.
3785             if (mainMenu != null) {
3786                 updatePrivacyIcons(true);
3787             }
3788         }
3789
3790         // Reload the website if returning from the Domains activity.
3791         if (reloadWebsite) {
3792             mainWebView.reload();
3793         }
3794     }
3795
3796     private void setDisplayWebpageImages() {
3797         if (!onTheFlyDisplayImagesSet) {
3798             if (domainSettingsApplied) {  // Custom domain settings are applied.
3799                 switch (displayWebpageImagesInt) {
3800                     case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_SYSTEM_DEFAULT:
3801                         mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
3802                         break;
3803
3804                     case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_ENABLED:
3805                         mainWebView.getSettings().setLoadsImagesAutomatically(true);
3806                         break;
3807
3808                     case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_DISABLED:
3809                         mainWebView.getSettings().setLoadsImagesAutomatically(false);
3810                         break;
3811                 }
3812             } else {  // Default settings are applied.
3813                 mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
3814             }
3815         }
3816     }
3817
3818     private void updatePrivacyIcons(boolean runInvalidateOptionsMenu) {
3819         // Get handles for the menu items.
3820         MenuItem privacyMenuItem = mainMenu.findItem(R.id.toggle_javascript);
3821         MenuItem firstPartyCookiesMenuItem = mainMenu.findItem(R.id.toggle_first_party_cookies);
3822         MenuItem domStorageMenuItem = mainMenu.findItem(R.id.toggle_dom_storage);
3823         MenuItem refreshMenuItem = mainMenu.findItem(R.id.refresh);
3824
3825         // Update the privacy icon.
3826         if (javaScriptEnabled) {  // JavaScript is enabled.
3827             privacyMenuItem.setIcon(R.drawable.javascript_enabled);
3828         } else if (firstPartyCookiesEnabled) {  // JavaScript is disabled but cookies are enabled.
3829             privacyMenuItem.setIcon(R.drawable.warning);
3830         } else {  // All the dangerous features are disabled.
3831             privacyMenuItem.setIcon(R.drawable.privacy_mode);
3832         }
3833
3834         // Update the first-party cookies icon.
3835         if (firstPartyCookiesEnabled) {  // First-party cookies are enabled.
3836             firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_enabled);
3837         } else {  // First-party cookies are disabled.
3838             if (darkTheme) {
3839                 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_dark);
3840             } else {
3841                 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_light);
3842             }
3843         }
3844
3845         // Update the DOM storage icon.
3846         if (javaScriptEnabled && domStorageEnabled) {  // Both JavaScript and DOM storage are enabled.
3847             domStorageMenuItem.setIcon(R.drawable.dom_storage_enabled);
3848         } else if (javaScriptEnabled) {  // JavaScript is enabled but DOM storage is disabled.
3849             if (darkTheme) {
3850                 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_dark);
3851             } else {
3852                 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_light);
3853             }
3854         } else {  // JavaScript is disabled, so DOM storage is ghosted.
3855             if (darkTheme) {
3856                 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_dark);
3857             } else {
3858                 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_light);
3859             }
3860         }
3861
3862         // Update the refresh icon.
3863         if (darkTheme) {
3864             refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
3865         } else {
3866             refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
3867         }
3868
3869         // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`.
3870         if (runInvalidateOptionsMenu) {
3871             invalidateOptionsMenu();
3872         }
3873     }
3874
3875     private void highlightUrlText() {
3876         String urlString = urlTextBox.getText().toString();
3877
3878         if (urlString.startsWith("http://")) {  // Highlight the protocol of connections that are not encrypted.
3879             urlTextBox.getText().setSpan(redColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
3880         } else if (urlString.startsWith("https://")) {  // De-emphasize the protocol of connections that are encrypted.
3881             urlTextBox.getText().setSpan(initialGrayColorSpan, 0, 8, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
3882         }
3883
3884         // Get the index of the `/` immediately after the domain name.
3885         int endOfDomainName = urlString.indexOf("/", (urlString.indexOf("//") + 2));
3886
3887         // De-emphasize the text after the domain name.
3888         if (endOfDomainName > 0) {
3889             urlTextBox.getText().setSpan(finalGrayColorSpan, endOfDomainName, urlString.length(), Spanned.SPAN_INCLUSIVE_INCLUSIVE);
3890         }
3891     }
3892
3893     private void loadBookmarksFolder() {
3894         // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
3895         bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3896
3897         // Populate the bookmarks cursor adapter.  `this` specifies the `Context`.  `false` disables `autoRequery`.
3898         bookmarksCursorAdapter = new CursorAdapter(this, bookmarksCursor, false) {
3899             @Override
3900             public View newView(Context context, Cursor cursor, ViewGroup parent) {
3901                 // Inflate the individual item layout.  `false` does not attach it to the root.
3902                 return getLayoutInflater().inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false);
3903             }
3904
3905             @Override
3906             public void bindView(View view, Context context, Cursor cursor) {
3907                 // Get handles for the views.
3908                 ImageView bookmarkFavoriteIcon = view.findViewById(R.id.bookmark_favorite_icon);
3909                 TextView bookmarkNameTextView = view.findViewById(R.id.bookmark_name);
3910
3911                 // Get the favorite icon byte array from the cursor.
3912                 byte[] favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
3913
3914                 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
3915                 Bitmap favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.length);
3916
3917                 // Display the bitmap in `bookmarkFavoriteIcon`.
3918                 bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap);
3919
3920                 // Get the bookmark name from the cursor and display it in `bookmarkNameTextView`.
3921                 String bookmarkNameString = cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
3922                 bookmarkNameTextView.setText(bookmarkNameString);
3923
3924                 // Make the font bold for folders.
3925                 if (cursor.getInt(cursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {
3926                     bookmarkNameTextView.setTypeface(Typeface.DEFAULT_BOLD);
3927                 } else {  // Reset the font to default for normal bookmarks.
3928                     bookmarkNameTextView.setTypeface(Typeface.DEFAULT);
3929                 }
3930             }
3931         };
3932
3933         // Populate the `ListView` with the adapter.
3934         bookmarksListView.setAdapter(bookmarksCursorAdapter);
3935
3936         // Set the bookmarks drawer title.
3937         if (currentBookmarksFolder.isEmpty()) {
3938             bookmarksTitleTextView.setText(R.string.bookmarks);
3939         } else {
3940             bookmarksTitleTextView.setText(currentBookmarksFolder);
3941         }
3942     }
3943 }