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