2 * Copyright © 2015-2018 Soren Stoutner <soren@stoutner.com>.
4 * Download cookie code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
6 * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
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.
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.
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/>.
22 package com.stoutner.privacybrowser.activities;
24 import android.Manifest;
25 import android.annotation.SuppressLint;
26 import android.app.DialogFragment;
27 import android.app.DownloadManager;
28 import android.content.ActivityNotFoundException;
29 import android.content.BroadcastReceiver;
30 import android.content.ClipData;
31 import android.content.ClipboardManager;
32 import android.content.Context;
33 import android.content.Intent;
34 import android.content.IntentFilter;
35 import android.content.SharedPreferences;
36 import android.content.pm.PackageManager;
37 import android.content.res.Configuration;
38 import android.database.Cursor;
39 import android.graphics.Bitmap;
40 import android.graphics.BitmapFactory;
41 import android.graphics.Typeface;
42 import android.graphics.drawable.BitmapDrawable;
43 import android.graphics.drawable.Drawable;
44 import android.net.Uri;
45 import android.net.http.SslCertificate;
46 import android.net.http.SslError;
47 import android.os.Build;
48 import android.os.Bundle;
49 import android.os.Environment;
50 import android.os.Handler;
51 import android.preference.PreferenceManager;
52 import android.print.PrintDocumentAdapter;
53 import android.print.PrintManager;
54 import android.support.annotation.NonNull;
55 import android.support.design.widget.CoordinatorLayout;
56 import android.support.design.widget.FloatingActionButton;
57 import android.support.design.widget.NavigationView;
58 import android.support.design.widget.Snackbar;
59 import android.support.v4.app.ActivityCompat;
60 import android.support.v4.content.ContextCompat;
61 // `ShortcutInfoCompat`, `ShortcutManagerCompat`, and `IconCompat` can be switched to the non-compat version once API >= 26.
62 import android.support.v4.content.pm.ShortcutInfoCompat;
63 import android.support.v4.content.pm.ShortcutManagerCompat;
64 import android.support.v4.graphics.drawable.IconCompat;
65 import android.support.v4.view.GravityCompat;
66 import android.support.v4.widget.DrawerLayout;
67 import android.support.v4.widget.SwipeRefreshLayout;
68 import android.support.v7.app.ActionBar;
69 import android.support.v7.app.ActionBarDrawerToggle;
70 import android.support.v7.app.AppCompatActivity;
71 import android.support.v7.app.AppCompatDialogFragment;
72 import android.support.v7.widget.Toolbar;
73 import android.text.Editable;
74 import android.text.Spanned;
75 import android.text.TextWatcher;
76 import android.text.style.ForegroundColorSpan;
77 import android.util.Patterns;
78 import android.view.ContextMenu;
79 import android.view.GestureDetector;
80 import android.view.KeyEvent;
81 import android.view.Menu;
82 import android.view.MenuItem;
83 import android.view.MotionEvent;
84 import android.view.View;
85 import android.view.ViewGroup;
86 import android.view.WindowManager;
87 import android.view.inputmethod.InputMethodManager;
88 import android.webkit.CookieManager;
89 import android.webkit.HttpAuthHandler;
90 import android.webkit.SslErrorHandler;
91 import android.webkit.ValueCallback;
92 import android.webkit.WebBackForwardList;
93 import android.webkit.WebChromeClient;
94 import android.webkit.WebResourceResponse;
95 import android.webkit.WebStorage;
96 import android.webkit.WebView;
97 import android.webkit.WebViewClient;
98 import android.webkit.WebViewDatabase;
99 import android.widget.ArrayAdapter;
100 import android.widget.CursorAdapter;
101 import android.widget.EditText;
102 import android.widget.FrameLayout;
103 import android.widget.ImageView;
104 import android.widget.LinearLayout;
105 import android.widget.ListView;
106 import android.widget.ProgressBar;
107 import android.widget.RadioButton;
108 import android.widget.RelativeLayout;
109 import android.widget.TextView;
111 import com.stoutner.privacybrowser.BuildConfig;
112 import com.stoutner.privacybrowser.R;
113 import com.stoutner.privacybrowser.dialogs.AdConsentDialog;
114 import com.stoutner.privacybrowser.dialogs.CreateBookmarkDialog;
115 import com.stoutner.privacybrowser.dialogs.CreateBookmarkFolderDialog;
116 import com.stoutner.privacybrowser.dialogs.CreateHomeScreenShortcutDialog;
117 import com.stoutner.privacybrowser.dialogs.DownloadImageDialog;
118 import com.stoutner.privacybrowser.dialogs.DownloadLocationPermissionDialog;
119 import com.stoutner.privacybrowser.dialogs.EditBookmarkDialog;
120 import com.stoutner.privacybrowser.dialogs.EditBookmarkFolderDialog;
121 import com.stoutner.privacybrowser.dialogs.HttpAuthenticationDialog;
122 import com.stoutner.privacybrowser.dialogs.PinnedSslCertificateMismatchDialog;
123 import com.stoutner.privacybrowser.dialogs.UrlHistoryDialog;
124 import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog;
125 import com.stoutner.privacybrowser.helpers.AdHelper;
126 import com.stoutner.privacybrowser.helpers.BlockListHelper;
127 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
128 import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper;
129 import com.stoutner.privacybrowser.helpers.OrbotProxyHelper;
130 import com.stoutner.privacybrowser.dialogs.DownloadFileDialog;
131 import com.stoutner.privacybrowser.dialogs.SslCertificateErrorDialog;
133 import java.io.ByteArrayInputStream;
134 import java.io.ByteArrayOutputStream;
136 import java.io.IOException;
137 import java.io.UnsupportedEncodingException;
138 import java.net.MalformedURLException;
140 import java.net.URLDecoder;
141 import java.net.URLEncoder;
142 import java.util.ArrayList;
143 import java.util.Date;
144 import java.util.HashMap;
145 import java.util.HashSet;
146 import java.util.List;
147 import java.util.Map;
148 import java.util.Set;
150 // AppCompatActivity from android.support.v7.app.AppCompatActivity must be used to have access to the SupportActionBar until the minimum API is >= 21.
151 public class MainWebViewActivity extends AppCompatActivity implements CreateBookmarkDialog.CreateBookmarkListener, CreateBookmarkFolderDialog.CreateBookmarkFolderListener,
152 CreateHomeScreenShortcutDialog.CreateHomeScreenShortcutListener, DownloadFileDialog.DownloadFileListener, DownloadImageDialog.DownloadImageListener,
153 DownloadLocationPermissionDialog.DownloadLocationPermissionDialogListener, EditBookmarkDialog.EditBookmarkListener, EditBookmarkFolderDialog.EditBookmarkFolderListener,
154 HttpAuthenticationDialog.HttpAuthenticationListener, NavigationView.OnNavigationItemSelectedListener, PinnedSslCertificateMismatchDialog.PinnedSslCertificateMismatchListener,
155 SslCertificateErrorDialog.SslCertificateErrorListener, UrlHistoryDialog.UrlHistoryListener {
157 // `darkTheme` is public static so it can be accessed from everywhere.
158 public static boolean darkTheme;
160 // `allowScreenshots` is public static so it can be accessed from everywhere. It is also used in `onCreate()`.
161 public static boolean allowScreenshots;
163 // `favoriteIconBitmap` is public static so it can be accessed from `CreateHomeScreenShortcutDialog`, `BookmarksActivity`, `BookmarksDatabaseViewActivity`, `CreateBookmarkDialog`,
164 // `CreateBookmarkFolderDialog`, `EditBookmarkDialog`, `EditBookmarkFolderDialog`, `EditBookmarkDatabaseViewDialog`, and `ViewSslCertificateDialog`. It is also used in `onCreate()`,
165 // `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onCreateHomeScreenShortcutCreate()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `applyDomainSettings()`.
166 public static Bitmap favoriteIconBitmap;
168 // `formattedUrlString` is public static so it can be accessed from `BookmarksActivity`, `CreateBookmarkDialog`, and `AddDomainDialog`.
169 // It is also used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onCreateHomeScreenShortcutCreate()`, and `loadUrlFromTextBox()`.
170 public static String formattedUrlString;
172 // `sslCertificate` is public static so it can be accessed from `DomainsActivity`, `DomainsListFragment`, `DomainSettingsFragment`, `PinnedSslCertificateMismatchDialog`,
173 // and `ViewSslCertificateDialog`. It is also used in `onCreate()`.
174 public static SslCertificate sslCertificate;
176 // `orbotStatus` is public static so it can be accessed from `OrbotProxyHelper`. It is also used in `onCreate()` and `onResume()`.
177 public static String orbotStatus;
179 // `webViewTitle` is public static so it can be accessed from `CreateBookmarkDialog` and `CreateHomeScreenShortcutDialog`. It is also used in `onCreate()`.
180 public static String webViewTitle;
182 // `appliedUserAgentString` is public static so it can be accessed from `ViewSourceActivity`. It is also used in `applyDomainSettings()`.
183 public static String appliedUserAgentString;
185 // `reloadOnRestart` is public static so it can be accessed from `SettingsFragment`. It is also used in `onRestart()`
186 public static boolean reloadOnRestart;
188 // `reloadUrlOnRestart` is public static so it can be accessed from `SettingsFragment` and `BookmarksActivity`. It is also used in `onRestart()`.
189 public static boolean loadUrlOnRestart;
191 // `restartFromBookmarksActivity` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onRestart()`.
192 public static boolean restartFromBookmarksActivity;
194 // The block list versions are public static so they can be accessed from `AboutTabFragment`. They are also used in `onCreate()`.
195 public static String easyListVersion;
196 public static String easyPrivacyVersion;
197 public static String fanboysAnnoyanceVersion;
198 public static String fanboysSocialVersion;
199 public static String ultraPrivacyVersion;
201 // The request items are public static so they can be accessed by `BlockListHelper`, `RequestsArrayAdapter`, and `ViewRequestsDialog`. They are also used in `onCreate()`.
202 public static List<String[]> resourceRequests;
203 public static String[] whiteListResultStringArray;
204 public final static int REQUEST_DISPOSITION = 0;
205 public final static int REQUEST_URL = 1;
206 public final static int REQUEST_BLOCKLIST = 2;
207 public final static int REQUEST_SUBLIST = 3;
208 public final static int REQUEST_BLOCKLIST_ENTRIES = 4;
209 public final static int REQUEST_BLOCKLIST_ORIGINAL_ENTRY = 5;
211 public final static int REQUEST_DEFAULT = 0;
212 public final static int REQUEST_ALLOWED = 1;
213 public final static int REQUEST_THIRD_PARTY = 2;
214 public final static int REQUEST_BLOCKED = 3;
216 public final static int MAIN_WHITELIST = 1;
217 public final static int FINAL_WHITELIST = 2;
218 public final static int DOMAIN_WHITELIST = 3;
219 public final static int DOMAIN_INITIAL_WHITELIST = 4;
220 public final static int DOMAIN_FINAL_WHITELIST = 5;
221 public final static int THIRD_PARTY_WHITELIST = 6;
222 public final static int THIRD_PARTY_DOMAIN_WHITELIST = 7;
223 public final static int THIRD_PARTY_DOMAIN_INITIAL_WHITELIST = 8;
225 public final static int MAIN_BLACKLIST = 9;
226 public final static int INITIAL_BLACKLIST = 10;
227 public final static int FINAL_BLACKLIST = 11;
228 public final static int DOMAIN_BLACKLIST = 12;
229 public final static int DOMAIN_INITIAL_BLACKLIST = 13;
230 public final static int DOMAIN_FINAL_BLACKLIST = 14;
231 public final static int DOMAIN_REGULAR_EXPRESSION_BLACKLIST = 15;
232 public final static int THIRD_PARTY_BLACKLIST = 16;
233 public final static int THIRD_PARTY_INITIAL_BLACKLIST = 17;
234 public final static int THIRD_PARTY_DOMAIN_BLACKLIST = 18;
235 public final static int THIRD_PARTY_DOMAIN_INITIAL_BLACKLIST = 19;
236 public final static int THIRD_PARTY_REGULAR_EXPRESSION_BLACKLIST = 20;
237 public final static int THIRD_PARTY_DOMAIN_REGULAR_EXPRESSION_BLACKLIST = 21;
238 public final static int REGULAR_EXPRESSION_BLACKLIST = 22;
240 // `blockAllThirdPartyRequests` is public static so it can be accessed from `RequestsActivity`.
241 // It is also used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyAppSettings()`
242 public static boolean blockAllThirdPartyRequests;
244 // `currentBookmarksFolder` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onCreate()`, `onBackPressed()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`,
245 // `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
246 public static String currentBookmarksFolder;
248 // `domainSettingsDatabaseId` is public static so it can be accessed from `PinnedSslCertificateMismatchDialog`. It is also used in `onCreate()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
249 public static int domainSettingsDatabaseId;
251 // The pinned domain SSL Certificate variables are public static so they can be accessed from `PinnedSslCertificateMismatchDialog`. They are also used in `onCreate()` and `applyDomainSettings()`.
252 public static String pinnedDomainSslIssuedToCNameString;
253 public static String pinnedDomainSslIssuedToONameString;
254 public static String pinnedDomainSslIssuedToUNameString;
255 public static String pinnedDomainSslIssuedByCNameString;
256 public static String pinnedDomainSslIssuedByONameString;
257 public static String pinnedDomainSslIssuedByUNameString;
258 public static Date pinnedDomainSslStartDate;
259 public static Date pinnedDomainSslEndDate;
261 // The user agent constants are public static so they can be accessed from `SettingsFragment`, `DomainsActivity`, and `DomainSettingsFragment`.
262 public final static int UNRECOGNIZED_USER_AGENT = -1;
263 public final static int SETTINGS_WEBVIEW_DEFAULT_USER_AGENT = 1;
264 public final static int SETTINGS_CUSTOM_USER_AGENT = 12;
265 public final static int DOMAINS_SYSTEM_DEFAULT_USER_AGENT = 0;
266 public final static int DOMAINS_WEBVIEW_DEFAULT_USER_AGENT = 2;
267 public final static int DOMAINS_CUSTOM_USER_AGENT = 13;
270 // `appBar` is used in `onCreate()`, `onOptionsItemSelected()`, `closeFindOnPage()`, and `applyAppSettings()`.
271 private ActionBar appBar;
273 // `navigatingHistory` is used in `onCreate()`, `onNavigationItemSelected()`, `onSslMismatchBack()`, and `applyDomainSettings()`.
274 private boolean navigatingHistory;
276 // `favoriteIconDefaultBitmap` is used in `onCreate()` and `applyDomainSettings`.
277 private Bitmap favoriteIconDefaultBitmap;
279 // `drawerLayout` is used in `onCreate()`, `onNewIntent()`, `onBackPressed()`, and `onRestart()`.
280 private DrawerLayout drawerLayout;
282 // `rootCoordinatorLayout` is used in `onCreate()` and `applyAppSettings()`.
283 private CoordinatorLayout rootCoordinatorLayout;
285 // `mainWebView` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`,
286 // `findNextOnPage()`, `closeFindOnPage()`, `loadUrlFromTextBox()`, `onSslMismatchBack()`, and `setDisplayWebpageImages()`.
287 private WebView mainWebView;
289 // `fullScreenVideoFrameLayout` is used in `onCreate()` and `onConfigurationChanged()`.
290 private FrameLayout fullScreenVideoFrameLayout;
292 // `swipeRefreshLayout` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `onRestart()`.
293 private SwipeRefreshLayout swipeRefreshLayout;
295 // `urlAppBarRelativeLayout` is used in `onCreate()` and `applyDomainSettings()`.
296 private RelativeLayout urlAppBarRelativeLayout;
298 // `favoriteIconImageView` is used in `onCreate()` and `applyDomainSettings()`
299 private ImageView favoriteIconImageView;
301 // `cookieManager` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`, `loadUrlFromTextBox()`, `onDownloadImage()`, `onDownloadFile()`, and `onRestart()`.
302 private CookieManager cookieManager;
304 // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrl()`.
305 private final Map<String, String> customHeaders = new HashMap<>();
307 // `javaScriptEnabled` is also used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `applyDomainSettings()`, and `updatePrivacyIcons()`.
308 private boolean javaScriptEnabled;
310 // `firstPartyCookiesEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onDownloadImage()`, `onDownloadFile()`, and `applyDomainSettings()`.
311 private boolean firstPartyCookiesEnabled;
313 // `thirdPartyCookiesEnabled` used in `onCreate()`, `onPrepareOptionsMenu()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
314 private boolean thirdPartyCookiesEnabled;
316 // `domStorageEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
317 private boolean domStorageEnabled;
319 // `saveFormDataEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`. It can be removed once the minimum API >= 26.
320 private boolean saveFormDataEnabled;
322 // `nightMode` is used in `onCreate()` and `applyDomainSettings()`.
323 private boolean nightMode;
325 // `displayWebpageImagesBoolean` is used in `applyAppSettings()` and `applyDomainSettings()`.
326 private boolean displayWebpageImagesBoolean;
328 // 'homepage' is used in `onCreate()`, `onNavigationItemSelected()`, and `applyAppSettings()`.
329 private String homepage;
331 // `searchURL` is used in `loadURLFromTextBox()` and `applyAppSettings()`.
332 private String searchURL;
334 // The block list variables are used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
335 private boolean easyListEnabled;
336 private boolean easyPrivacyEnabled;
337 private boolean fanboysAnnoyanceListEnabled;
338 private boolean fanboysSocialBlockingListEnabled;
339 private boolean ultraPrivacyEnabled;
341 // `privacyBrowserRuntime` is used in `onCreate()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
342 private Runtime privacyBrowserRuntime;
344 // `proxyThroughOrbot` is used in `onRestart()` and `applyAppSettings()`.
345 private boolean proxyThroughOrbot;
347 // `incognitoModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
348 private boolean incognitoModeEnabled;
350 // `fullScreenBrowsingModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
351 private boolean fullScreenBrowsingModeEnabled;
353 // `inFullScreenBrowsingMode` is used in `onCreate()`, `onConfigurationChanged()`, and `applyAppSettings()`.
354 private boolean inFullScreenBrowsingMode;
356 // `hideSystemBarsOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
357 private boolean hideSystemBarsOnFullscreen;
359 // `translucentNavigationBarOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
360 private boolean translucentNavigationBarOnFullscreen;
362 // `reapplyDomainSettingsOnRestart` is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, and `onAddDomain()`, .
363 private boolean reapplyDomainSettingsOnRestart;
365 // `reapplyAppSettingsOnRestart` is used in `onNavigationItemSelected()` and `onRestart()`.
366 private boolean reapplyAppSettingsOnRestart;
368 // `displayingFullScreenVideo` is used in `onCreate()` and `onResume()`.
369 private boolean displayingFullScreenVideo;
371 // `currentDomainName` is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onAddDomain()`, and `applyDomainSettings()`.
372 private String currentDomainName;
374 // `ignorePinnedSslCertificateForDomain` is used in `onCreate()`, `onSslMismatchProceed()`, and `applyDomainSettings()`.
375 private boolean ignorePinnedSslCertificate;
377 // `waitingForOrbot` is used in `onCreate()`, `onResume()`, and `applyAppSettings()`.
378 private boolean waitingForOrbot;
380 // `domainSettingsApplied` is used in `prepareOptionsMenu()`, `applyDomainSettings()`, and `setDisplayWebpageImages()`.
381 private boolean domainSettingsApplied;
383 // `displayWebpageImagesInt` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
384 private int displayWebpageImagesInt;
386 // `onTheFlyDisplayImagesSet` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
387 private boolean onTheFlyDisplayImagesSet;
389 // `waitingForOrbotData` is used in `onCreate()` and `applyAppSettings()`.
390 private String waitingForOrbotHTMLString;
392 // `privateDataDirectoryString` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`.
393 private String privateDataDirectoryString;
395 // `findOnPageLinearLayout` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
396 private LinearLayout findOnPageLinearLayout;
398 // `findOnPageEditText` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
399 private EditText findOnPageEditText;
401 // `mainMenu` is used in `onCreateOptionsMenu()` and `updatePrivacyIcons()`.
402 private Menu mainMenu;
404 // `drawerToggle` is used in `onCreate()`, `onPostCreate()`, `onConfigurationChanged()`, `onNewIntent()`, and `onNavigationItemSelected()`.
405 private ActionBarDrawerToggle drawerToggle;
407 // `supportAppBar` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
408 private Toolbar supportAppBar;
410 // `urlTextBox` is used in `onCreate()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, `loadUrl()`, and `highlightUrlText()`.
411 private EditText urlTextBox;
413 // The color spans are used in `onCreate()` and `highlightUrlText()`.
414 private ForegroundColorSpan redColorSpan;
415 private ForegroundColorSpan initialGrayColorSpan;
416 private ForegroundColorSpan finalGrayColorSpan;
418 // `sslErrorHandler` is used in `onCreate()`, `onSslErrorCancel()`, and `onSslErrorProceed`.
419 private SslErrorHandler sslErrorHandler;
421 // `httpAuthHandler` is used in `onCreate()`, `onHttpAuthenticationCancel()`, and `onHttpAuthenticationProceed()`.
422 private static HttpAuthHandler httpAuthHandler;
424 // `inputMethodManager` is used in `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `closeFindOnPage()`.
425 private InputMethodManager inputMethodManager;
427 // `mainWebViewRelativeLayout` is used in `onCreate()` and `onNavigationItemSelected()`.
428 private RelativeLayout mainWebViewRelativeLayout;
430 // `urlIsLoading` is used in `onCreate()`, `loadUrl()`, and `applyDomainSettings()`.
431 private boolean urlIsLoading;
433 // `pinnedDomainSslCertificate` is used in `onCreate()` and `applyDomainSettings()`.
434 private boolean pinnedDomainSslCertificate;
436 // `bookmarksDatabaseHelper` is used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
437 private BookmarksDatabaseHelper bookmarksDatabaseHelper;
439 // `bookmarksListView` is used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, and `loadBookmarksFolder()`.
440 private ListView bookmarksListView;
442 // `bookmarksTitleTextView` is used in `onCreate()` and `loadBookmarksFolder()`.
443 private TextView bookmarksTitleTextView;
445 // `bookmarksCursor` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
446 private Cursor bookmarksCursor;
448 // `bookmarksCursorAdapter` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()` `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
449 private CursorAdapter bookmarksCursorAdapter;
451 // `oldFolderNameString` is used in `onCreate()` and `onSaveEditBookmarkFolder()`.
452 private String oldFolderNameString;
454 // `fileChooserCallback` is used in `onCreate()` and `onActivityResult()`.
455 private ValueCallback<Uri[]> fileChooserCallback;
457 // The download strings are used in `onCreate()` and `onRequestPermissionResult()`.
458 private String downloadUrl;
459 private String downloadContentDisposition;
460 private long downloadContentLength;
462 // `downloadImageUrl` is used in `onCreateContextMenu()` and `onRequestPermissionResult()`.
463 private String downloadImageUrl;
465 // The user agent variables are used in `onCreate()` and `applyDomainSettings()`.
466 private ArrayAdapter<CharSequence> userAgentNamesArray;
467 private String[] userAgentDataArray;
469 // The request codes are used in `onCreate()`, `onCreateContextMenu()`, `onCloseDownloadLocationPermissionDialog()`, and `onRequestPermissionResult()`.
470 private final int DOWNLOAD_FILE_REQUEST_CODE = 1;
471 private final int DOWNLOAD_IMAGE_REQUEST_CODE = 2;
474 // 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.
475 // Also, remove the warning about needing to override `performClick()` when using an `OnTouchListener` with `WebView`.
476 @SuppressLint({"SetJavaScriptEnabled", "ClickableViewAccessibility"})
477 // Remove Android Studio's warning about deprecations. We have to use the deprecated `getColor()` until API >= 23.
478 @SuppressWarnings("deprecation")
479 protected void onCreate(Bundle savedInstanceState) {
480 // Get a handle for the shared preferences.
481 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
483 // Get the theme and screenshot preferences.
484 darkTheme = sharedPreferences.getBoolean("dark_theme", false);
485 allowScreenshots = sharedPreferences.getBoolean("allow_screenshots", false);
487 // Disable screenshots if not allowed.
488 if (!allowScreenshots) {
489 getWindow().addFlags(WindowManager.LayoutParams.FLAG_SECURE);
492 // Set the activity theme.
494 setTheme(R.style.PrivacyBrowserDark);
496 setTheme(R.style.PrivacyBrowserLight);
499 // Run the default commands.
500 super.onCreate(savedInstanceState);
502 // Set the content view.
503 setContentView(R.layout.main_drawerlayout);
505 // Get a handle for `inputMethodManager`.
506 inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
508 // `SupportActionBar` from `android.support.v7.app.ActionBar` must be used until the minimum API is >= 21.
509 supportAppBar = findViewById(R.id.app_bar);
510 setSupportActionBar(supportAppBar);
511 appBar = getSupportActionBar();
513 // This is needed to get rid of the Android Studio warning that `appBar` might be null.
514 assert appBar != null;
516 // Add the custom `url_app_bar` layout, which shows the favorite icon and the URL text bar.
517 appBar.setCustomView(R.layout.url_app_bar);
518 appBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
520 // Initialize the foreground color spans for highlighting the URLs. We have to use the deprecated `getColor()` until API >= 23.
521 redColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.red_a700));
522 initialGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
523 finalGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
525 // Get a handle for `urlTextBox`.
526 urlTextBox = findViewById(R.id.url_edittext);
528 // Remove the formatting from `urlTextBar` when the user is editing the text.
529 urlTextBox.setOnFocusChangeListener((View v, boolean hasFocus) -> {
530 if (hasFocus) { // The user is editing `urlTextBox`.
531 // Remove the highlighting.
532 urlTextBox.getText().removeSpan(redColorSpan);
533 urlTextBox.getText().removeSpan(initialGrayColorSpan);
534 urlTextBox.getText().removeSpan(finalGrayColorSpan);
535 } else { // The user has stopped editing `urlTextBox`.
536 // Reapply the highlighting.
541 // Set the go button on the keyboard to load the URL in `urlTextBox`.
542 urlTextBox.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
543 // If the event is a key-down event on the `enter` button, load the URL.
544 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
545 // Load the URL into the mainWebView and consume the event.
547 loadUrlFromTextBox();
548 } catch (UnsupportedEncodingException e) {
551 // If the enter key was pressed, consume the event.
554 // If any other key was pressed, do not consume the event.
559 // Set `waitingForOrbotHTMLString`.
560 waitingForOrbotHTMLString = "<html><body><br/><center><h1>" + getString(R.string.waiting_for_orbot) + "</h1></center></body></html>";
562 // Initialize `currentDomainName`, `orbotStatus`, and `waitingForOrbot`.
563 currentDomainName = "";
564 orbotStatus = "unknown";
565 waitingForOrbot = false;
567 // Create an Orbot status `BroadcastReceiver`.
568 BroadcastReceiver orbotStatusBroadcastReceiver = new BroadcastReceiver() {
570 public void onReceive(Context context, Intent intent) {
571 // Store the content of the status message in `orbotStatus`.
572 orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS");
574 // If we are waiting on Orbot, load the website now that Orbot is connected.
575 if (orbotStatus.equals("ON") && waitingForOrbot) {
576 // Reset `waitingForOrbot`.
577 waitingForOrbot = false;
579 // Load `formattedUrlString
580 loadUrl(formattedUrlString);
585 // Register `orbotStatusBroadcastReceiver` on `this` context.
586 this.registerReceiver(orbotStatusBroadcastReceiver, new IntentFilter("org.torproject.android.intent.action.STATUS"));
588 // Get handles for views that need to be accessed.
589 drawerLayout = findViewById(R.id.drawerlayout);
590 rootCoordinatorLayout = findViewById(R.id.root_coordinatorlayout);
591 bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
592 bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview);
593 FloatingActionButton launchBookmarksActivityFab = findViewById(R.id.launch_bookmarks_activity_fab);
594 FloatingActionButton createBookmarkFolderFab = findViewById(R.id.create_bookmark_folder_fab);
595 FloatingActionButton createBookmarkFab = findViewById(R.id.create_bookmark_fab);
596 mainWebViewRelativeLayout = findViewById(R.id.main_webview_relativelayout);
597 mainWebView = findViewById(R.id.main_webview);
598 findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
599 findOnPageEditText = findViewById(R.id.find_on_page_edittext);
600 fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
601 urlAppBarRelativeLayout = findViewById(R.id.url_app_bar_relativelayout);
602 favoriteIconImageView = findViewById(R.id.favorite_icon);
604 // Set the bookmarks drawer resources according to the theme. This can't be done in the layout due to compatibility issues with the `DrawerLayout` support widget.
606 launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_dark));
607 createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_dark));
608 createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_dark));
609 bookmarksListView.setBackgroundColor(getResources().getColor(R.color.gray_850));
611 launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_light));
612 createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_light));
613 createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_light));
614 bookmarksListView.setBackgroundColor(getResources().getColor(R.color.white));
617 // Set the launch bookmarks activity FAB to launch the bookmarks activity.
618 launchBookmarksActivityFab.setOnClickListener(v -> {
619 // Create an intent to launch the bookmarks activity.
620 Intent bookmarksIntent = new Intent(getApplicationContext(), BookmarksActivity.class);
622 // Include the current folder with the `Intent`.
623 bookmarksIntent.putExtra("Current Folder", currentBookmarksFolder);
626 startActivity(bookmarksIntent);
629 // Set the create new bookmark folder FAB to display an alert dialog.
630 createBookmarkFolderFab.setOnClickListener(v -> {
631 // Show the `CreateBookmarkFolderDialog` `AlertDialog` and name the instance `@string/create_folder`.
632 AppCompatDialogFragment createBookmarkFolderDialog = new CreateBookmarkFolderDialog();
633 createBookmarkFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_folder));
636 // Set the create new bookmark FAB to display an alert dialog.
637 createBookmarkFab.setOnClickListener(view -> {
638 // Show the `CreateBookmarkDialog` `AlertDialog` and name the instance `@string/create_bookmark`.
639 AppCompatDialogFragment createBookmarkDialog = new CreateBookmarkDialog();
640 createBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_bookmark));
643 // Create a double-tap listener to toggle full-screen mode.
644 final GestureDetector gestureDetector = new GestureDetector(this, new GestureDetector.SimpleOnGestureListener() {
645 // Override `onDoubleTap()`. All other events are handled using the default settings.
647 public boolean onDoubleTap(MotionEvent event) {
648 if (fullScreenBrowsingModeEnabled) { // Only process the double-tap if full screen browsing mode is enabled.
649 // Toggle `inFullScreenBrowsingMode`.
650 inFullScreenBrowsingMode = !inFullScreenBrowsingMode;
652 if (inFullScreenBrowsingMode) { // Switch to full screen mode.
653 // Hide the `appBar`.
656 // Hide the banner ad in the free flavor.
657 if (BuildConfig.FLAVOR.contentEquals("free")) {
658 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
659 AdHelper.hideAd(findViewById(R.id.adview));
662 // Modify the system bars.
663 if (hideSystemBarsOnFullscreen) { // Hide everything.
664 // Remove the translucent overlays.
665 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
667 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
668 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
670 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
671 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
672 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
674 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
676 // Set `rootCoordinatorLayout` to fill the whole screen.
677 rootCoordinatorLayout.setFitsSystemWindows(false);
678 } else { // Hide everything except the status and navigation bars.
679 // Set `rootCoordinatorLayout` to fit under the status and navigation bars.
680 rootCoordinatorLayout.setFitsSystemWindows(false);
682 // 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.
683 if (translucentNavigationBarOnFullscreen) {
684 // Set the navigation bar to be translucent.
685 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
688 } else { // Switch to normal viewing mode.
689 // Show the `appBar`.
692 // Show the `BannerAd` in the free flavor.
693 if (BuildConfig.FLAVOR.contentEquals("free")) {
694 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
695 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_id));
698 // Remove the translucent navigation bar flag if it is set.
699 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
701 // Add the translucent status flag if it is unset. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
702 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
704 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
705 rootCoordinatorLayout.setSystemUiVisibility(0);
707 // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
708 rootCoordinatorLayout.setFitsSystemWindows(true);
711 // Consume the double-tap.
713 } else { // Do not consume the double-tap because full screen browsing mode is disabled.
719 // Pass all touch events on `mainWebView` through `gestureDetector` to check for double-taps.
720 mainWebView.setOnTouchListener((View v, MotionEvent event) -> {
721 // Call `performClick()` on the view, which is required for accessibility.
724 // Send the `event` to `gestureDetector`.
725 return gestureDetector.onTouchEvent(event);
728 // Update `findOnPageCountTextView`.
729 mainWebView.setFindListener(new WebView.FindListener() {
730 // Get a handle for `findOnPageCountTextView`.
731 final TextView findOnPageCountTextView = (TextView) findViewById(R.id.find_on_page_count_textview);
734 public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, boolean isDoneCounting) {
735 if ((isDoneCounting) && (numberOfMatches == 0)) { // There are no matches.
736 // Set `findOnPageCountTextView` to `0/0`.
737 findOnPageCountTextView.setText(R.string.zero_of_zero);
738 } else if (isDoneCounting) { // There are matches.
739 // `activeMatchOrdinal` is zero-based.
740 int activeMatch = activeMatchOrdinal + 1;
742 // Build the match string.
743 String matchString = activeMatch + "/" + numberOfMatches;
745 // Set `findOnPageCountTextView`.
746 findOnPageCountTextView.setText(matchString);
751 // Search for the string on the page whenever a character changes in the `findOnPageEditText`.
752 findOnPageEditText.addTextChangedListener(new TextWatcher() {
754 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
759 public void onTextChanged(CharSequence s, int start, int before, int count) {
764 public void afterTextChanged(Editable s) {
765 // Search for the text in `mainWebView`.
766 mainWebView.findAllAsync(findOnPageEditText.getText().toString());
770 // Set the `check mark` button for the `findOnPageEditText` keyboard to close the soft keyboard.
771 findOnPageEditText.setOnKeyListener((v, keyCode, event) -> {
772 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) { // The `enter` key was pressed.
773 // Hide the soft keyboard. `0` indicates no additional flags.
774 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
776 // Consume the event.
778 } else { // A different key was pressed.
779 // Do not consume the event.
784 // Implement swipe to refresh
785 swipeRefreshLayout = findViewById(R.id.swipe_refreshlayout);
786 swipeRefreshLayout.setColorSchemeResources(R.color.blue_700);
787 swipeRefreshLayout.setOnRefreshListener(() -> mainWebView.reload());
789 // `DrawerTitle` identifies the `DrawerLayouts` in accessibility mode.
790 drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer));
791 drawerLayout.setDrawerTitle(GravityCompat.END, getString(R.string.bookmarks));
793 // Listen for touches on the navigation menu.
794 final NavigationView navigationView = findViewById(R.id.navigationview);
795 navigationView.setNavigationItemSelectedListener(this);
797 // 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.
798 final Menu navigationMenu = navigationView.getMenu();
799 final MenuItem navigationBackMenuItem = navigationMenu.getItem(1);
800 final MenuItem navigationForwardMenuItem = navigationMenu.getItem(2);
801 final MenuItem navigationHistoryMenuItem = navigationMenu.getItem(3);
802 final MenuItem navigationRequestsMenuItem = navigationMenu.getItem(4);
804 // Initialize the bookmarks database helper. `this` specifies the context. The two `nulls` do not specify the database name or a `CursorFactory`.
805 // The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
806 bookmarksDatabaseHelper = new BookmarksDatabaseHelper(this, null, null, 0);
808 // Initialize `currentBookmarksFolder`. `""` is the home folder in the database.
809 currentBookmarksFolder = "";
811 // Load the home folder, which is `""` in the database.
812 loadBookmarksFolder();
814 bookmarksListView.setOnItemClickListener((parent, view, position, id) -> {
815 // Convert the id from long to int to match the format of the bookmarks database.
816 int databaseID = (int) id;
818 // Get the bookmark cursor for this ID and move it to the first row.
819 Cursor bookmarkCursor = bookmarksDatabaseHelper.getBookmarkCursor(databaseID);
820 bookmarkCursor.moveToFirst();
822 // Act upon the bookmark according to the type.
823 if (bookmarkCursor.getInt(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) { // The selected bookmark is a folder.
824 // Store the new folder name in `currentBookmarksFolder`.
825 currentBookmarksFolder = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
827 // Load the new folder.
828 loadBookmarksFolder();
829 } else { // The selected bookmark is not a folder.
830 // Load the bookmark URL.
831 loadUrl(bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_URL)));
833 // Close the bookmarks drawer.
834 drawerLayout.closeDrawer(GravityCompat.END);
837 // Close the `Cursor`.
838 bookmarkCursor.close();
841 bookmarksListView.setOnItemLongClickListener((parent, view, position, id) -> {
842 // Convert the database ID from `long` to `int`.
843 int databaseId = (int) id;
845 // Find out if the selected bookmark is a folder.
846 boolean isFolder = bookmarksDatabaseHelper.isFolder(databaseId);
849 // Save the current folder name, which is used in `onSaveEditBookmarkFolder()`.
850 oldFolderNameString = bookmarksCursor.getString(bookmarksCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
852 // Show the edit bookmark folder `AlertDialog` and name the instance `@string/edit_folder`.
853 AppCompatDialogFragment editFolderDialog = EditBookmarkFolderDialog.folderDatabaseId(databaseId);
854 editFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_folder));
856 // Show the edit bookmark `AlertDialog` and name the instance `@string/edit_bookmark`.
857 AppCompatDialogFragment editBookmarkDialog = EditBookmarkDialog.bookmarkDatabaseId(databaseId);
858 editBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_bookmark));
861 // Consume the event.
865 // The `DrawerListener` is used to update the Navigation Menu.
866 drawerLayout.addDrawerListener(new DrawerLayout.DrawerListener() {
868 public void onDrawerSlide(@NonNull View drawerView, float slideOffset) {
872 public void onDrawerOpened(@NonNull View drawerView) {
876 public void onDrawerClosed(@NonNull View drawerView) {
880 public void onDrawerStateChanged(int newState) {
881 if ((newState == DrawerLayout.STATE_SETTLING) || (newState == DrawerLayout.STATE_DRAGGING)) { // The drawer is opening or closing.
882 // Initialize a the blocked requests counter.
883 int blockedRequests = 0;
885 // Count the number of blocked requests.
886 for (int i = 0; i < resourceRequests.size(); i++) {
887 // Add the blocked requests.
888 if (Integer.valueOf(resourceRequests.get(i)[REQUEST_DISPOSITION]) == REQUEST_BLOCKED) {
892 // Add the third-party requests if they are blocked.
893 if (blockAllThirdPartyRequests && (Integer.valueOf(resourceRequests.get(i)[REQUEST_DISPOSITION]) == REQUEST_THIRD_PARTY)) {
898 // Update the back, forward, history, and requests menu items.
899 navigationBackMenuItem.setEnabled(mainWebView.canGoBack());
900 navigationForwardMenuItem.setEnabled(mainWebView.canGoForward());
901 navigationHistoryMenuItem.setEnabled((mainWebView.canGoBack() || mainWebView.canGoForward()));
902 navigationRequestsMenuItem.setTitle(getResources().getString(R.string.requests) + " - " + blockedRequests);
904 // Hide the keyboard (if displayed) so we can see the navigation menu. `0` indicates no additional flags.
905 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
907 // Clear the focus from `urlTextBox` if it has it.
908 urlTextBox.clearFocus();
913 // drawerToggle creates the hamburger icon at the start of the AppBar.
914 drawerToggle = new ActionBarDrawerToggle(this, drawerLayout, supportAppBar, R.string.open_navigation_drawer, R.string.close_navigation_drawer);
916 // Get a handle for the progress bar.
917 final ProgressBar progressBar = findViewById(R.id.progress_bar);
919 mainWebView.setWebChromeClient(new WebChromeClient() {
920 // Update the progress bar when a page is loading.
922 public void onProgressChanged(WebView view, int progress) {
923 // Inject the night mode CSS if night mode is enabled.
925 // `background-color: #212121` sets the background to be dark gray. `color: #BDBDBD` sets the text color to be light gray. `box-shadow: none` removes a lower underline on links
926 // used by WordPress. `text-decoration: none` removes all text underlines. `text-shadow: none` removes text shadows, which usually have a hard coded color.
927 // `border: none` removes all borders, which can also be used to underline text.
928 // `a {color: #1565C0}` sets links to be a dark blue. `!important` takes precedent over any existing sub-settings.
929 mainWebView.evaluateJavascript("(function() {var parent = document.getElementsByTagName('head').item(0); var style = document.createElement('style'); style.type = 'text/css'; " +
930 "style.innerHTML = '* {background-color: #212121 !important; color: #BDBDBD !important; box-shadow: none !important; text-decoration: none !important;" +
931 "text-shadow: none !important; border: none !important;} a {color: #1565C0 !important;}'; parent.appendChild(style)})()", value -> {
932 // Initialize a `Handler` to display `mainWebView`.
933 Handler displayWebViewHandler = new Handler();
935 // Setup a `Runnable` to display `mainWebView` after a delay to allow the CSS to be applied.
936 Runnable displayWebViewRunnable = () -> {
937 // Only display `mainWebView` if the progress bar is one. This prevents the display of the `WebView` while it is still loading.
938 if (progressBar.getVisibility() == View.GONE) {
939 mainWebView.setVisibility(View.VISIBLE);
943 // Use `displayWebViewHandler` to delay the displaying of `mainWebView` for 500 milliseconds.
944 displayWebViewHandler.postDelayed(displayWebViewRunnable, 500);
948 // Update the progress bar.
949 progressBar.setProgress(progress);
951 // Set the visibility of the progress bar.
952 if (progress < 100) {
953 // Show the progress bar.
954 progressBar.setVisibility(View.VISIBLE);
956 // Hide the progress bar.
957 progressBar.setVisibility(View.GONE);
959 // Display `mainWebView` if night mode is disabled.
960 // Because of a race condition between `applyDomainSettings` and `onPageStarted`, when night mode is set by domain settings the `WebView` may be hidden even if night mode is not
961 // currently enabled.
963 mainWebView.setVisibility(View.VISIBLE);
966 //Stop the swipe to refresh indicator if it is running
967 swipeRefreshLayout.setRefreshing(false);
971 // Set the favorite icon when it changes.
973 public void onReceivedIcon(WebView view, Bitmap icon) {
974 // Only update the favorite icon if the website has finished loading.
975 if (progressBar.getVisibility() == View.GONE) {
976 // Save a copy of the favorite icon.
977 favoriteIconBitmap = icon;
979 // Place the favorite icon in the appBar.
980 favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
984 // Save a copy of the title when it changes.
986 public void onReceivedTitle(WebView view, String title) {
987 // Save a copy of the title.
988 webViewTitle = title;
991 // Enter full screen video.
993 public void onShowCustomView(View view, CustomViewCallback callback) {
994 // Set the full screen video flag.
995 displayingFullScreenVideo = true;
997 // Pause the ad if this is the free flavor.
998 if (BuildConfig.FLAVOR.contentEquals("free")) {
999 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1000 AdHelper.pauseAd(findViewById(R.id.adview));
1003 // Remove the translucent overlays.
1004 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1006 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
1007 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
1009 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
1010 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
1011 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
1013 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
1015 // Set `rootCoordinatorLayout` to fill the entire screen.
1016 rootCoordinatorLayout.setFitsSystemWindows(false);
1018 // Disable the sliding drawers.
1019 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED);
1021 // Add `view` to `fullScreenVideoFrameLayout` and display it on the screen.
1022 fullScreenVideoFrameLayout.addView(view);
1023 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
1026 // Exit full screen video.
1028 public void onHideCustomView() {
1029 // Unset the full screen video flag.
1030 displayingFullScreenVideo = true;
1032 // Hide `fullScreenVideoFrameLayout`.
1033 fullScreenVideoFrameLayout.removeAllViews();
1034 fullScreenVideoFrameLayout.setVisibility(View.GONE);
1036 // Enable the sliding drawers.
1037 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED);
1039 // Apply the appropriate full screen mode the `SYSTEM_UI` flags.
1040 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
1041 if (hideSystemBarsOnFullscreen) { // Hide everything.
1042 // Remove the translucent navigation setting if it is currently flagged.
1043 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
1045 // Remove the translucent status bar overlay.
1046 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1048 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
1049 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
1051 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
1052 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
1053 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
1055 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
1056 } else { // Hide everything except the status and navigation bars.
1057 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
1058 rootCoordinatorLayout.setSystemUiVisibility(0);
1060 // Add the translucent status flag if it is unset.
1061 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1063 if (translucentNavigationBarOnFullscreen) {
1064 // Set the navigation bar to be translucent. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
1065 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
1067 // Set the navigation bar to be black.
1068 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
1071 } else { // Switch to normal viewing mode.
1072 // Show the `appBar` if `findOnPageLinearLayout` is not visible.
1073 if (findOnPageLinearLayout.getVisibility() == View.GONE) {
1077 // Show the `BannerAd` in the free flavor.
1078 if (BuildConfig.FLAVOR.contentEquals("free")) {
1079 // Initialize the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1080 AdHelper.initializeAds(findViewById(R.id.adview), getApplicationContext(), getFragmentManager(), getString(R.string.ad_id));
1083 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
1084 rootCoordinatorLayout.setSystemUiVisibility(0);
1086 // Remove the translucent navigation bar flag if it is set.
1087 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
1089 // Add the translucent status flag if it is unset. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
1090 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1092 // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
1093 rootCoordinatorLayout.setFitsSystemWindows(true);
1096 // Show the ad if this is the free flavor.
1097 if (BuildConfig.FLAVOR.contentEquals("free")) {
1098 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1099 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_id));
1105 public boolean onShowFileChooser(WebView webView, ValueCallback<Uri[]> filePathCallback, FileChooserParams fileChooserParams) {
1106 // Show the file chooser if the device is running API >= 21.
1107 if (Build.VERSION.SDK_INT >= 21) {
1108 // Store the file path callback.
1109 fileChooserCallback = filePathCallback;
1111 // Create an intent to open a chooser based ont the file chooser parameters.
1112 Intent fileChooserIntent = fileChooserParams.createIntent();
1114 // Open the file chooser. Currently only one `startActivityForResult` exists in this activity, so the request code, used to differentiate them, is simply `0`.
1115 startActivityForResult(fileChooserIntent, 0);
1121 // Register `mainWebView` for a context menu. This is used to see link targets and download images.
1122 registerForContextMenu(mainWebView);
1124 // Allow the downloading of files.
1125 mainWebView.setDownloadListener((String url, String userAgent, String contentDisposition, String mimetype, long contentLength) -> {
1126 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
1127 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
1128 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
1130 // Store the variables for future use by `onRequestPermissionsResult()`.
1132 downloadContentDisposition = contentDisposition;
1133 downloadContentLength = contentLength;
1135 // Show a dialog if the user has previously denied the permission.
1136 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
1137 // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
1138 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
1140 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
1141 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
1142 } else { // Show the permission request directly.
1143 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
1144 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
1146 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
1147 // Get a handle for the download file alert dialog.
1148 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(url, contentDisposition, contentLength);
1150 // Show the download file alert dialog.
1151 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
1155 // Allow pinch to zoom.
1156 mainWebView.getSettings().setBuiltInZoomControls(true);
1158 // Hide zoom controls.
1159 mainWebView.getSettings().setDisplayZoomControls(false);
1161 // Set `mainWebView` to use a wide viewport. Otherwise, some web pages will be scrunched and some content will render outside the screen.
1162 mainWebView.getSettings().setUseWideViewPort(true);
1164 // Set `mainWebView` to load in overview mode (zoomed out to the maximum width).
1165 mainWebView.getSettings().setLoadWithOverviewMode(true);
1167 // Explicitly disable geolocation.
1168 mainWebView.getSettings().setGeolocationEnabled(false);
1170 // Initialize cookieManager.
1171 cookieManager = CookieManager.getInstance();
1173 // 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).
1174 customHeaders.put("X-Requested-With", "");
1176 // 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.
1177 PreferenceManager.setDefaultValues(this, R.xml.preferences, false);
1179 // Get the intent that started the app.
1180 final Intent launchingIntent = getIntent();
1182 // Extract the launching intent data as `launchingIntentUriData`.
1183 final Uri launchingIntentUriData = launchingIntent.getData();
1185 // Convert the launching intent URI data (if it exists) to a string and store it in `formattedUrlString`.
1186 if (launchingIntentUriData != null) {
1187 formattedUrlString = launchingIntentUriData.toString();
1190 // Get a handle for the `Runtime`.
1191 privacyBrowserRuntime = Runtime.getRuntime();
1193 // Store the application's private data directory.
1194 privateDataDirectoryString = getApplicationInfo().dataDir;
1195 // `dataDir` will vary, but will be something like `/data/user/0/com.stoutner.privacybrowser.standard`, which links to `/data/data/com.stoutner.privacybrowser.standard`.
1197 // Initialize `inFullScreenBrowsingMode`, which is always false at this point because Privacy Browser never starts in full screen browsing mode.
1198 inFullScreenBrowsingMode = false;
1200 // Initialize the privacy settings variables.
1201 javaScriptEnabled = false;
1202 firstPartyCookiesEnabled = false;
1203 thirdPartyCookiesEnabled = false;
1204 domStorageEnabled = false;
1205 saveFormDataEnabled = false; // Form data can be removed once the minimum API >= 26.
1208 // Initialize the WebView title.
1209 webViewTitle = getString(R.string.no_title);
1211 // Initialize the favorite icon bitmap. `ContextCompat` must be used until API >= 21.
1212 Drawable favoriteIconDrawable = ContextCompat.getDrawable(getApplicationContext(), R.drawable.world);
1213 BitmapDrawable favoriteIconBitmapDrawable = (BitmapDrawable) favoriteIconDrawable;
1214 assert favoriteIconBitmapDrawable != null;
1215 favoriteIconDefaultBitmap = favoriteIconBitmapDrawable.getBitmap();
1217 // If the favorite icon is null, load the default.
1218 if (favoriteIconBitmap == null) {
1219 favoriteIconBitmap = favoriteIconDefaultBitmap;
1222 // Initialize the user agent array adapter and string array.
1223 userAgentNamesArray = ArrayAdapter.createFromResource(this, R.array.user_agent_names, R.layout.domain_settings_spinner_item);
1224 userAgentDataArray = getResources().getStringArray(R.array.user_agent_data);
1226 // Apply the app settings from the shared preferences.
1229 // Instantiate the block list helper.
1230 BlockListHelper blockListHelper = new BlockListHelper();
1232 // Initialize the list of resource requests.
1233 resourceRequests = new ArrayList<>();
1235 // Parse the block lists.
1236 final ArrayList<List<String[]>> easyList = blockListHelper.parseBlockList(getAssets(), "blocklists/easylist.txt");
1237 final ArrayList<List<String[]>> easyPrivacy = blockListHelper.parseBlockList(getAssets(), "blocklists/easyprivacy.txt");
1238 final ArrayList<List<String[]>> fanboysAnnoyanceList = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-annoyance.txt");
1239 final ArrayList<List<String[]>> fanboysSocialList = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-social.txt");
1240 final ArrayList<List<String[]>> ultraPrivacy = blockListHelper.parseBlockList(getAssets(), "blocklists/ultraprivacy.txt");
1242 // Store the list versions.
1243 easyListVersion = easyList.get(0).get(0)[0];
1244 easyPrivacyVersion = easyPrivacy.get(0).get(0)[0];
1245 fanboysAnnoyanceVersion = fanboysAnnoyanceList.get(0).get(0)[0];
1246 fanboysSocialVersion = fanboysSocialList.get(0).get(0)[0];
1247 ultraPrivacyVersion = ultraPrivacy.get(0).get(0)[0];
1249 mainWebView.setWebViewClient(new WebViewClient() {
1250 // `shouldOverrideUrlLoading` makes this `WebView` the default handler for URLs inside the app, so that links are not kicked out to other apps.
1251 // The deprecated `shouldOverrideUrlLoading` must be used until API >= 24.
1252 @SuppressWarnings("deprecation")
1254 public boolean shouldOverrideUrlLoading(WebView view, String url) {
1255 if (url.startsWith("http")) { // Load the URL in Privacy Browser.
1256 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
1257 formattedUrlString = "";
1259 // Apply the domain settings for the new URL. `applyDomainSettings` doesn't do anything if the domain has not changed.
1260 applyDomainSettings(url, true, false);
1262 // Returning false causes the current WebView to handle the URL and prevents it from adding redirects to the history list.
1264 } else if (url.startsWith("mailto:")) { // Load the email address in an external email program.
1265 // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
1266 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
1268 // Parse the url and set it as the data for the intent.
1269 emailIntent.setData(Uri.parse(url));
1271 // Open the email program in a new task instead of as part of Privacy Browser.
1272 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1275 startActivity(emailIntent);
1277 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1279 } else if (url.startsWith("tel:")) { // Load the phone number in the dialer.
1280 // Open the dialer and load the phone number, but wait for the user to place the call.
1281 Intent dialIntent = new Intent(Intent.ACTION_DIAL);
1283 // Add the phone number to the intent.
1284 dialIntent.setData(Uri.parse(url));
1286 // Open the dialer in a new task instead of as part of Privacy Browser.
1287 dialIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1290 startActivity(dialIntent);
1292 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1294 } else { // Load a system chooser to select an app that can handle the URL.
1295 // Open an app that can handle the URL.
1296 Intent genericIntent = new Intent(Intent.ACTION_VIEW);
1298 // Add the URL to the intent.
1299 genericIntent.setData(Uri.parse(url));
1301 // List all apps that can handle the URL instead of just opening the first one.
1302 genericIntent.addCategory(Intent.CATEGORY_BROWSABLE);
1304 // Open the app in a new task instead of as part of Privacy Browser.
1305 genericIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1307 // Start the app or display a snackbar if no app is available to handle the URL.
1309 startActivity(genericIntent);
1310 } catch (ActivityNotFoundException exception) {
1311 Snackbar.make(mainWebView, getString(R.string.unrecognized_url) + " " + url, Snackbar.LENGTH_SHORT).show();
1314 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1319 // Check requests against the block lists. The deprecated `shouldInterceptRequest()` must be used until minimum API >= 21.
1320 @SuppressWarnings("deprecation")
1322 public WebResourceResponse shouldInterceptRequest(WebView view, String url){
1323 // Create an empty web resource response to be used if the resource request is blocked.
1324 WebResourceResponse emptyWebResourceResponse = new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
1326 // Reset `whiteListResultStringArray`.
1327 whiteListResultStringArray = null;
1329 // Initialize the third party request tracker.
1330 boolean isThirdPartyRequest = false;
1332 // Initialize the current domain string.
1333 String currentDomain = "";
1335 // Nobody is happy when comparing null strings.
1336 if (!(formattedUrlString == null) && !(url == null)) {
1337 // Get the domain strings to URIs.
1338 Uri currentDomainUri = Uri.parse(formattedUrlString);
1339 Uri requestDomainUri = Uri.parse(url);
1341 // Get the domain host names.
1342 String currentBaseDomain = currentDomainUri.getHost();
1343 String requestBaseDomain = requestDomainUri.getHost();
1345 // Update the current domain variable.
1346 currentDomain = currentBaseDomain;
1348 // Only compare the current base domain and the request base domain if neither is null.
1349 if (!(currentBaseDomain == null) && !(requestBaseDomain == null)) {
1350 // Determine the current base domain.
1351 while (currentBaseDomain.indexOf(".", currentBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
1352 // Remove the first subdomain.
1353 currentBaseDomain = currentBaseDomain.substring(currentBaseDomain.indexOf(".") + 1);
1356 // Determine the request base domain.
1357 while (requestBaseDomain.indexOf(".", requestBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
1358 // Remove the first subdomain.
1359 requestBaseDomain = requestBaseDomain.substring(requestBaseDomain.indexOf(".") + 1);
1362 // Update the third party request tracker.
1363 isThirdPartyRequest = !currentBaseDomain.equals(requestBaseDomain);
1367 // Block third-party requests if enabled.
1368 if (isThirdPartyRequest && blockAllThirdPartyRequests) {
1369 // Add the request to the log.
1370 resourceRequests.add(new String[]{String.valueOf(REQUEST_THIRD_PARTY), url});
1372 // Return an empty web resource response.
1373 return emptyWebResourceResponse;
1376 // Check UltraPrivacy if it is enabled.
1377 if (ultraPrivacyEnabled) {
1378 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, ultraPrivacy)) {
1379 // The resource request was blocked. Return an empty web resource response.
1380 return emptyWebResourceResponse;
1383 // If the whitelist result is not null, the request has been allowed by UltraPrivacy.
1384 if (whiteListResultStringArray != null) {
1385 // Add a whitelist entry to the resource requests array.
1386 resourceRequests.add(whiteListResultStringArray);
1388 // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
1393 // Check EasyList if it is enabled.
1394 if (easyListEnabled) {
1395 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, easyList)) {
1396 // The resource request was blocked. Return an empty web resource response.
1397 return emptyWebResourceResponse;
1401 // Check EasyPrivacy if it is enabled.
1402 if (easyPrivacyEnabled) {
1403 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, easyPrivacy)) {
1404 // The resource request was blocked. Return an empty web resource response.
1405 return emptyWebResourceResponse;
1409 // Check Fanboy’s Annoyance List if it is enabled.
1410 if (fanboysAnnoyanceListEnabled) {
1411 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, fanboysAnnoyanceList)) {
1412 // The resource request was blocked. Return an empty web resource response.
1413 return emptyWebResourceResponse;
1415 } else if (fanboysSocialBlockingListEnabled){ // Only check Fanboy’s Social Blocking List if Fanboy’s Annoyance List is disabled.
1416 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, fanboysSocialList)) {
1417 // The resource request was blocked. Return an empty web resource response.
1418 return emptyWebResourceResponse;
1422 // Add the request to the log because it hasn't been processed by any of the previous checks.
1423 if (whiteListResultStringArray != null ) { // The request was processed by a whitelist.
1424 resourceRequests.add(whiteListResultStringArray);
1425 } else { // The request didn't match any blocklist entry. Log it as a defult request.
1426 resourceRequests.add(new String[]{String.valueOf(REQUEST_DEFAULT), url});
1429 // The resource request has not been blocked. `return null` loads the requested resource.
1433 // Handle HTTP authentication requests.
1435 public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) {
1436 // Store `handler` so it can be accessed from `onHttpAuthenticationCancel()` and `onHttpAuthenticationProceed()`.
1437 httpAuthHandler = handler;
1439 // Display the HTTP authentication dialog.
1440 AppCompatDialogFragment httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm);
1441 httpAuthenticationDialogFragment.show(getSupportFragmentManager(), getString(R.string.http_authentication));
1444 // Update the URL in urlTextBox when the page starts to load.
1446 public void onPageStarted(WebView view, String url, Bitmap favicon) {
1447 // Reset the list of resource requests.
1448 resourceRequests.clear();
1450 // If night mode is enabled, hide `mainWebView` until after the night mode CSS is applied.
1452 mainWebView.setVisibility(View.INVISIBLE);
1455 // Hide the keyboard. `0` indicates no additional flags.
1456 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
1458 // Check to see if Privacy Browser is waiting on Orbot.
1459 if (!waitingForOrbot) { // We are not waiting on Orbot, so we need to process the URL.
1460 // 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.
1461 formattedUrlString = url;
1463 // Display the formatted URL text.
1464 urlTextBox.setText(formattedUrlString);
1466 // Apply text highlighting to `urlTextBox`.
1469 // Apply any custom domain settings if the URL was loaded by navigating history.
1470 if (navigatingHistory) {
1471 // Reset `navigatingHistory`.
1472 navigatingHistory = false;
1474 // Apply the domain settings.
1475 applyDomainSettings(url, true, false);
1478 // Set `urlIsLoading` to `true`, so that redirects while loading do not trigger changes in the user agent, which forces another reload of the existing page.
1479 urlIsLoading = true;
1483 // It is necessary to update `formattedUrlString` and `urlTextBox` after the page finishes loading because the final URL can change during load.
1485 public void onPageFinished(WebView view, String url) {
1486 // Flush any cookies to persistent storage. `CookieManager` has become very lazy about flushing cookies in recent versions.
1487 if (firstPartyCookiesEnabled && Build.VERSION.SDK_INT >= 21) {
1488 cookieManager.flush();
1491 // Reset `urlIsLoading`, which is used to prevent reloads on redirect if the user agent changes.
1492 urlIsLoading = false;
1494 // Clear the cache and history if Incognito Mode is enabled.
1495 if (incognitoModeEnabled) {
1496 // Clear the cache. `true` includes disk files.
1497 mainWebView.clearCache(true);
1499 // Clear the back/forward history.
1500 mainWebView.clearHistory();
1502 // Manually delete cache folders.
1504 // Delete the main cache directory.
1505 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
1507 // Delete the secondary `Service Worker` cache directory.
1508 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
1509 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
1510 } catch (IOException e) {
1511 // Do nothing if an error is thrown.
1515 // Update `urlTextBox` and apply domain settings if not waiting on Orbot.
1516 if (!waitingForOrbot) {
1517 // Check to see if `WebView` has set `url` to be `about:blank`.
1518 if (url.equals("about:blank")) { // `WebView` is blank, so `formattedUrlString` should be `""` and `urlTextBox` should display a hint.
1519 // Set `formattedUrlString` to `""`.
1520 formattedUrlString = "";
1522 urlTextBox.setText(formattedUrlString);
1524 // Request focus for `urlTextBox`.
1525 urlTextBox.requestFocus();
1527 // Display the keyboard.
1528 inputMethodManager.showSoftInput(urlTextBox, 0);
1530 // Apply the domain settings. This clears any settings from the previous domain.
1531 applyDomainSettings(formattedUrlString, true, false);
1532 } else { // `WebView` has loaded a webpage.
1533 // Set `formattedUrlString`.
1534 formattedUrlString = url;
1536 // Only update `urlTextBox` if the user is not typing in it.
1537 if (!urlTextBox.hasFocus()) {
1538 // Display the formatted URL text.
1539 urlTextBox.setText(formattedUrlString);
1541 // Apply text highlighting to `urlTextBox`.
1546 // Store the SSL certificate so it can be accessed from `ViewSslCertificateDialog` and `PinnedSslCertificateMismatchDialog`.
1547 sslCertificate = mainWebView.getCertificate();
1549 // Check the current website SSL certificate against the pinned SSL certificate if there is a pinned SSL certificate the user has not chosen to ignore it for this session.
1550 if (pinnedDomainSslCertificate && !ignorePinnedSslCertificate) {
1551 // Initialize the current SSL certificate variables.
1552 String currentWebsiteIssuedToCName = "";
1553 String currentWebsiteIssuedToOName = "";
1554 String currentWebsiteIssuedToUName = "";
1555 String currentWebsiteIssuedByCName = "";
1556 String currentWebsiteIssuedByOName = "";
1557 String currentWebsiteIssuedByUName = "";
1558 Date currentWebsiteSslStartDate = null;
1559 Date currentWebsiteSslEndDate = null;
1562 // Extract the individual pieces of information from the current website SSL certificate if it is not null.
1563 if (sslCertificate != null) {
1564 currentWebsiteIssuedToCName = sslCertificate.getIssuedTo().getCName();
1565 currentWebsiteIssuedToOName = sslCertificate.getIssuedTo().getOName();
1566 currentWebsiteIssuedToUName = sslCertificate.getIssuedTo().getUName();
1567 currentWebsiteIssuedByCName = sslCertificate.getIssuedBy().getCName();
1568 currentWebsiteIssuedByOName = sslCertificate.getIssuedBy().getOName();
1569 currentWebsiteIssuedByUName = sslCertificate.getIssuedBy().getUName();
1570 currentWebsiteSslStartDate = sslCertificate.getValidNotBeforeDate();
1571 currentWebsiteSslEndDate = sslCertificate.getValidNotAfterDate();
1574 // Initialize `String` variables to store the SSL certificate dates. `Strings` are needed to compare the values below, which doesn't work with `Dates` if they are `null`.
1575 String currentWebsiteSslStartDateString = "";
1576 String currentWebsiteSslEndDateString = "";
1577 String pinnedDomainSslStartDateString = "";
1578 String pinnedDomainSslEndDateString = "";
1580 // Convert the `Dates` to `Strings` if they are not `null`.
1581 if (currentWebsiteSslStartDate != null) {
1582 currentWebsiteSslStartDateString = currentWebsiteSslStartDate.toString();
1585 if (currentWebsiteSslEndDate != null) {
1586 currentWebsiteSslEndDateString = currentWebsiteSslEndDate.toString();
1589 if (pinnedDomainSslStartDate != null) {
1590 pinnedDomainSslStartDateString = pinnedDomainSslStartDate.toString();
1593 if (pinnedDomainSslEndDate != null) {
1594 pinnedDomainSslEndDateString = pinnedDomainSslEndDate.toString();
1597 // Check to see if the pinned SSL certificate matches the current website certificate.
1598 if (!currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) || !currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) ||
1599 !currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) || !currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) ||
1600 !currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) || !currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) ||
1601 !currentWebsiteSslStartDateString.equals(pinnedDomainSslStartDateString) || !currentWebsiteSslEndDateString.equals(pinnedDomainSslEndDateString)) {
1602 // The pinned SSL certificate doesn't match the current domain certificate.
1603 //Display the pinned SSL certificate mismatch `AlertDialog`.
1604 AppCompatDialogFragment pinnedSslCertificateMismatchDialogFragment = new PinnedSslCertificateMismatchDialog();
1605 pinnedSslCertificateMismatchDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_mismatch));
1611 // Handle SSL Certificate errors.
1613 public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
1614 // Get the current website SSL certificate.
1615 SslCertificate currentWebsiteSslCertificate = error.getCertificate();
1617 // Extract the individual pieces of information from the current website SSL certificate.
1618 String currentWebsiteIssuedToCName = currentWebsiteSslCertificate.getIssuedTo().getCName();
1619 String currentWebsiteIssuedToOName = currentWebsiteSslCertificate.getIssuedTo().getOName();
1620 String currentWebsiteIssuedToUName = currentWebsiteSslCertificate.getIssuedTo().getUName();
1621 String currentWebsiteIssuedByCName = currentWebsiteSslCertificate.getIssuedBy().getCName();
1622 String currentWebsiteIssuedByOName = currentWebsiteSslCertificate.getIssuedBy().getOName();
1623 String currentWebsiteIssuedByUName = currentWebsiteSslCertificate.getIssuedBy().getUName();
1624 Date currentWebsiteSslStartDate = currentWebsiteSslCertificate.getValidNotBeforeDate();
1625 Date currentWebsiteSslEndDate = currentWebsiteSslCertificate.getValidNotAfterDate();
1627 // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
1628 if (pinnedDomainSslCertificate &&
1629 currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) && currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) &&
1630 currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) && currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) &&
1631 currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) && currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) &&
1632 currentWebsiteSslStartDate.equals(pinnedDomainSslStartDate) && currentWebsiteSslEndDate.equals(pinnedDomainSslEndDate)) {
1633 // An SSL certificate is pinned and matches the current domain certificate.
1634 // Proceed to the website without displaying an error.
1636 } else { // Either there isn't a pinned SSL certificate or it doesn't match the current website certificate.
1637 // Store `handler` so it can be accesses from `onSslErrorCancel()` and `onSslErrorProceed()`.
1638 sslErrorHandler = handler;
1640 // Display the SSL error `AlertDialog`.
1641 AppCompatDialogFragment sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error);
1642 sslCertificateErrorDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_error));
1647 // Load the website if not waiting for Orbot to connect.
1648 if (!waitingForOrbot) {
1649 loadUrl(formattedUrlString);
1654 protected void onNewIntent(Intent intent) {
1655 // Sets the new intent as the activity intent, so that any future `getIntent()`s pick up this one instead of creating a new activity.
1658 // Check to see if the intent contains a new URL.
1659 if (intent.getData() != null) {
1660 // Get the intent data.
1661 final Uri intentUriData = intent.getData();
1663 // Load the website.
1664 loadUrl(intentUriData.toString());
1666 // Close the navigation drawer if it is open.
1667 if (drawerLayout.isDrawerVisible(GravityCompat.START)) {
1668 drawerLayout.closeDrawer(GravityCompat.START);
1671 // Close the bookmarks drawer if it is open.
1672 if (drawerLayout.isDrawerVisible(GravityCompat.END)) {
1673 drawerLayout.closeDrawer(GravityCompat.END);
1676 // Clear the keyboard if displayed and remove the focus on the urlTextBar if it has it.
1677 mainWebView.requestFocus();
1682 public void onRestart() {
1683 // Run the default commands.
1686 // Make sure Orbot is running if Privacy Browser is proxying through Orbot.
1687 if (proxyThroughOrbot) {
1688 // Request Orbot to start. If Orbot is already running no hard will be caused by this request.
1689 Intent orbotIntent = new Intent("org.torproject.android.intent.action.START");
1691 // Send the intent to the Orbot package.
1692 orbotIntent.setPackage("org.torproject.android");
1695 sendBroadcast(orbotIntent);
1698 // Apply the app settings if returning from the Settings activity..
1699 if (reapplyAppSettingsOnRestart) {
1700 // Apply the app settings.
1703 // Reload the webpage if displaying of images has been disabled in the Settings activity.
1704 if (reloadOnRestart) {
1705 // Reload `mainWebView`.
1706 mainWebView.reload();
1708 // Reset `reloadOnRestartBoolean`.
1709 reloadOnRestart = false;
1712 // Reset the return from settings flag.
1713 reapplyAppSettingsOnRestart = false;
1716 // Apply the domain settings if returning from the Domains activity.
1717 if (reapplyDomainSettingsOnRestart) {
1718 // Reapply the domain settings.
1719 applyDomainSettings(formattedUrlString, false, true);
1721 // Reset `reapplyDomainSettingsOnRestart`.
1722 reapplyDomainSettingsOnRestart = false;
1725 // Load the URL on restart to apply changes to night mode.
1726 if (loadUrlOnRestart) {
1727 // Load the current `formattedUrlString`.
1728 loadUrl(formattedUrlString);
1730 // Reset `loadUrlOnRestart.
1731 loadUrlOnRestart = false;
1734 // Update the bookmarks drawer if returning from the Bookmarks activity.
1735 if (restartFromBookmarksActivity) {
1736 // Close the bookmarks drawer.
1737 drawerLayout.closeDrawer(GravityCompat.END);
1739 // Reload the bookmarks drawer.
1740 loadBookmarksFolder();
1742 // Reset `restartFromBookmarksActivity`.
1743 restartFromBookmarksActivity = false;
1746 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step. This can be important if the screen was rotated.
1747 updatePrivacyIcons(true);
1750 // `onResume()` runs after `onStart()`, which runs after `onCreate()` and `onRestart()`.
1752 public void onResume() {
1753 // Run the default commands.
1756 // Resume JavaScript (if enabled).
1757 mainWebView.resumeTimers();
1759 // Resume `mainWebView`.
1760 mainWebView.onResume();
1762 // Resume the adView for the free flavor.
1763 if (BuildConfig.FLAVOR.contentEquals("free")) {
1765 AdHelper.resumeAd(findViewById(R.id.adview));
1768 // Display a message to the user if waiting for Orbot.
1769 if (waitingForOrbot && !orbotStatus.equals("ON")) {
1770 // Load a waiting page. `null` specifies no encoding, which defaults to ASCII.
1771 mainWebView.loadData(waitingForOrbotHTMLString, "text/html", null);
1774 if (displayingFullScreenVideo) {
1775 // Remove the translucent overlays.
1776 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1778 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
1779 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
1781 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
1782 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
1783 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
1785 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
1790 public void onPause() {
1793 // Pause `mainWebView`.
1794 mainWebView.onPause();
1796 // Stop all JavaScript.
1797 mainWebView.pauseTimers();
1799 // Pause the ad or it will continue to consume resources in the background on the free flavor.
1800 if (BuildConfig.FLAVOR.contentEquals("free")) {
1802 AdHelper.pauseAd(findViewById(R.id.adview));
1807 public boolean onCreateOptionsMenu(Menu menu) {
1808 // Inflate the menu; this adds items to the action bar if it is present.
1809 getMenuInflater().inflate(R.menu.webview_options_menu, menu);
1811 // Set mainMenu so it can be used by `onOptionsItemSelected()` and `updatePrivacyIcons`.
1814 // Set the initial status of the privacy icons. `false` does not call `invalidateOptionsMenu` as the last step.
1815 updatePrivacyIcons(false);
1817 // Get handles for the menu items.
1818 MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1819 MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1820 MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1821 MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data); // Form data can be removed once the minimum API >= 26.
1822 MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data); // Form data can be removed once the minimum API >= 26.
1823 MenuItem refreshMenuItem = menu.findItem(R.id.refresh);
1824 MenuItem adConsentMenuItem = menu.findItem(R.id.ad_consent);
1826 // Only display third-party cookies if API >= 21
1827 toggleThirdPartyCookiesMenuItem.setVisible(Build.VERSION.SDK_INT >= 21);
1829 // Only display the form data menu items if the API < 26.
1830 toggleSaveFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
1831 clearFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
1833 // Only show Ad Consent if this is the free flavor.
1834 adConsentMenuItem.setVisible(BuildConfig.FLAVOR.contentEquals("free"));
1836 // Get the shared preference values. `this` references the current context.
1837 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
1839 // Set the status of the additional app bar icons. Setting the refresh menu item to `SHOW_AS_ACTION_ALWAYS` makes it appear even on small devices like phones.
1840 if (sharedPreferences.getBoolean("display_additional_app_bar_icons", false)) {
1841 toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1842 toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1843 refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_ALWAYS);
1844 } else { //Do not display the additional icons.
1845 toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1846 toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1847 refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1854 public boolean onPrepareOptionsMenu(Menu menu) {
1855 // Get handles for the menu items.
1856 MenuItem addOrEditDomain = menu.findItem(R.id.add_or_edit_domain);
1857 MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1858 MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1859 MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1860 MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data); // Form data can be removed once the minimum API >= 26.
1861 MenuItem clearDataMenuItem = menu.findItem(R.id.clear_data);
1862 MenuItem clearCookiesMenuItem = menu.findItem(R.id.clear_cookies);
1863 MenuItem clearDOMStorageMenuItem = menu.findItem(R.id.clear_dom_storage);
1864 MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data); // Form data can be removed once the minimum API >= 26.
1865 MenuItem easyListMenuItem = menu.findItem(R.id.easylist);
1866 MenuItem easyPrivacyMenuItem = menu.findItem(R.id.easyprivacy);
1867 MenuItem fanboysAnnoyanceListMenuItem = menu.findItem(R.id.fanboys_annoyance_list);
1868 MenuItem fanboysSocialBlockingListMenuItem = menu.findItem(R.id.fanboys_social_blocking_list);
1869 MenuItem ultraPrivacyMenuItem = menu.findItem(R.id.ultraprivacy);
1870 MenuItem blockAllThirdParyRequestsMenuItem = menu.findItem(R.id.block_all_third_party_requests);
1871 MenuItem fontSizeMenuItem = menu.findItem(R.id.font_size);
1872 MenuItem swipeToRefreshMenuItem = menu.findItem(R.id.swipe_to_refresh);
1873 MenuItem displayImagesMenuItem = menu.findItem(R.id.display_images);
1875 // Set the text for the domain menu item.
1876 if (domainSettingsApplied) {
1877 addOrEditDomain.setTitle(R.string.edit_domain_settings);
1879 addOrEditDomain.setTitle(R.string.add_domain_settings);
1882 // Set the status of the menu item checkboxes.
1883 toggleFirstPartyCookiesMenuItem.setChecked(firstPartyCookiesEnabled);
1884 toggleThirdPartyCookiesMenuItem.setChecked(thirdPartyCookiesEnabled);
1885 toggleDomStorageMenuItem.setChecked(domStorageEnabled);
1886 toggleSaveFormDataMenuItem.setChecked(saveFormDataEnabled); // Form data can be removed once the minimum API >= 26.
1887 easyListMenuItem.setChecked(easyListEnabled);
1888 easyPrivacyMenuItem.setChecked(easyPrivacyEnabled);
1889 fanboysAnnoyanceListMenuItem.setChecked(fanboysAnnoyanceListEnabled);
1890 fanboysSocialBlockingListMenuItem.setChecked(fanboysSocialBlockingListEnabled);
1891 ultraPrivacyMenuItem.setChecked(ultraPrivacyEnabled);
1892 blockAllThirdParyRequestsMenuItem.setChecked(blockAllThirdPartyRequests);
1893 swipeToRefreshMenuItem.setChecked(swipeRefreshLayout.isEnabled());
1894 displayImagesMenuItem.setChecked(mainWebView.getSettings().getLoadsImagesAutomatically());
1896 // Enable third-party cookies if first-party cookies are enabled.
1897 toggleThirdPartyCookiesMenuItem.setEnabled(firstPartyCookiesEnabled);
1899 // Enable DOM Storage if JavaScript is enabled.
1900 toggleDomStorageMenuItem.setEnabled(javaScriptEnabled);
1902 // Enable Clear Cookies if there are any.
1903 clearCookiesMenuItem.setEnabled(cookieManager.hasCookies());
1905 // Get a count of the number of files in the Local Storage directory.
1906 File localStorageDirectory = new File (privateDataDirectoryString + "/app_webview/Local Storage/");
1907 int localStorageDirectoryNumberOfFiles = 0;
1908 if (localStorageDirectory.exists()) {
1909 localStorageDirectoryNumberOfFiles = localStorageDirectory.list().length;
1912 // Get a count of the number of files in the IndexedDB directory.
1913 File indexedDBDirectory = new File (privateDataDirectoryString + "/app_webview/IndexedDB");
1914 int indexedDBDirectoryNumberOfFiles = 0;
1915 if (indexedDBDirectory.exists()) {
1916 indexedDBDirectoryNumberOfFiles = indexedDBDirectory.list().length;
1919 // Enable Clear DOM Storage if there is any.
1920 clearDOMStorageMenuItem.setEnabled(localStorageDirectoryNumberOfFiles > 0 || indexedDBDirectoryNumberOfFiles > 0);
1922 // Enable Clear Form Data is there is any. This can be removed once the minimum API >= 26.
1923 if (Build.VERSION.SDK_INT < 26) {
1924 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(this);
1925 clearFormDataMenuItem.setEnabled(mainWebViewDatabase.hasFormData());
1928 // Enable Clear Data if any of the submenu items are enabled.
1929 clearDataMenuItem.setEnabled(clearCookiesMenuItem.isEnabled() || clearDOMStorageMenuItem.isEnabled() || clearFormDataMenuItem.isEnabled());
1931 // Disable Fanboy's Social Blocking List if Fanboy's Annoyance List is checked.
1932 fanboysSocialBlockingListMenuItem.setEnabled(!fanboysAnnoyanceListEnabled);
1934 // Initialize font size variables.
1935 int fontSize = mainWebView.getSettings().getTextZoom();
1936 String fontSizeTitle;
1937 MenuItem selectedFontSizeMenuItem;
1939 // Prepare the font size title and current size menu item.
1942 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.twenty_five_percent);
1943 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_twenty_five_percent);
1947 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.fifty_percent);
1948 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_fifty_percent);
1952 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.seventy_five_percent);
1953 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_seventy_five_percent);
1957 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1958 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1962 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_twenty_five_percent);
1963 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_twenty_five_percent);
1967 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_fifty_percent);
1968 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_fifty_percent);
1972 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_seventy_five_percent);
1973 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_seventy_five_percent);
1977 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.two_hundred_percent);
1978 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_two_hundred_percent);
1982 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1983 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1987 // Set the font size title and select the current size menu item.
1988 fontSizeMenuItem.setTitle(fontSizeTitle);
1989 selectedFontSizeMenuItem.setChecked(true);
1991 // Run all the other default commands.
1992 super.onPrepareOptionsMenu(menu);
1994 // Display the menu.
1999 // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
2000 @SuppressLint("SetJavaScriptEnabled")
2001 // removeAllCookies is deprecated, but it is required for API < 21.
2002 @SuppressWarnings("deprecation")
2003 public boolean onOptionsItemSelected(MenuItem menuItem) {
2004 // Get the selected menu item ID.
2005 int menuItemId = menuItem.getItemId();
2007 // Set the commands that relate to the menu entries.
2008 switch (menuItemId) {
2009 case R.id.toggle_javascript:
2010 // Switch the status of javaScriptEnabled.
2011 javaScriptEnabled = !javaScriptEnabled;
2013 // Apply the new JavaScript status.
2014 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
2016 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2017 updatePrivacyIcons(true);
2019 // Display a `Snackbar`.
2020 if (javaScriptEnabled) { // JavaScrip is enabled.
2021 Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show();
2022 } else if (firstPartyCookiesEnabled) { // JavaScript is disabled, but first-party cookies are enabled.
2023 Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show();
2024 } else { // Privacy mode.
2025 Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
2028 // Reload the WebView.
2029 mainWebView.reload();
2032 case R.id.add_or_edit_domain:
2033 if (domainSettingsApplied) { // Edit the current domain settings.
2034 // Reapply the domain settings on returning to `MainWebViewActivity`.
2035 reapplyDomainSettingsOnRestart = true;
2036 currentDomainName = "";
2038 // Create an intent to launch the domains activity.
2039 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2041 // Put extra information instructing the domains activity to directly load the current domain and close on back instead of returning to the domains list.
2042 domainsIntent.putExtra("loadDomain", domainSettingsDatabaseId);
2043 domainsIntent.putExtra("closeOnBack", true);
2046 startActivity(domainsIntent);
2047 } else { // Add a new domain.
2048 // Apply the new domain settings on returning to `MainWebViewActivity`.
2049 reapplyDomainSettingsOnRestart = true;
2050 currentDomainName = "";
2052 // Get the current domain
2053 Uri currentUri = Uri.parse(formattedUrlString);
2054 String currentDomain = currentUri.getHost();
2056 // Initialize the database handler. The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
2057 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
2059 // Create the domain and store the database ID.
2060 int newDomainDatabaseId = domainsDatabaseHelper.addDomain(currentDomain);
2062 // Create an intent to launch the domains activity.
2063 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2065 // Put extra information instructing the domains activity to directly load the new domain and close on back instead of returning to the domains list.
2066 domainsIntent.putExtra("loadDomain", newDomainDatabaseId);
2067 domainsIntent.putExtra("closeOnBack", true);
2070 startActivity(domainsIntent);
2074 case R.id.toggle_first_party_cookies:
2075 // Switch the status of firstPartyCookiesEnabled.
2076 firstPartyCookiesEnabled = !firstPartyCookiesEnabled;
2078 // Update the menu checkbox.
2079 menuItem.setChecked(firstPartyCookiesEnabled);
2081 // Apply the new cookie status.
2082 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
2084 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2085 updatePrivacyIcons(true);
2087 // Display a `Snackbar`.
2088 if (firstPartyCookiesEnabled) { // First-party cookies are enabled.
2089 Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
2090 } else if (javaScriptEnabled) { // JavaScript is still enabled.
2091 Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
2092 } else { // Privacy mode.
2093 Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
2096 // Reload the WebView.
2097 mainWebView.reload();
2100 case R.id.toggle_third_party_cookies:
2101 if (Build.VERSION.SDK_INT >= 21) {
2102 // Switch the status of thirdPartyCookiesEnabled.
2103 thirdPartyCookiesEnabled = !thirdPartyCookiesEnabled;
2105 // Update the menu checkbox.
2106 menuItem.setChecked(thirdPartyCookiesEnabled);
2108 // Apply the new cookie status.
2109 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
2111 // Display a `Snackbar`.
2112 if (thirdPartyCookiesEnabled) {
2113 Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
2115 Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
2118 // Reload the WebView.
2119 mainWebView.reload();
2120 } // Else do nothing because SDK < 21.
2123 case R.id.toggle_dom_storage:
2124 // Switch the status of domStorageEnabled.
2125 domStorageEnabled = !domStorageEnabled;
2127 // Update the menu checkbox.
2128 menuItem.setChecked(domStorageEnabled);
2130 // Apply the new DOM Storage status.
2131 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
2133 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2134 updatePrivacyIcons(true);
2136 // Display a `Snackbar`.
2137 if (domStorageEnabled) {
2138 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show();
2140 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show();
2143 // Reload the WebView.
2144 mainWebView.reload();
2147 // Form data can be removed once the minimum API >= 26.
2148 case R.id.toggle_save_form_data:
2149 // Switch the status of saveFormDataEnabled.
2150 saveFormDataEnabled = !saveFormDataEnabled;
2152 // Update the menu checkbox.
2153 menuItem.setChecked(saveFormDataEnabled);
2155 // Apply the new form data status.
2156 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
2158 // Display a `Snackbar`.
2159 if (saveFormDataEnabled) {
2160 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show();
2162 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show();
2165 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2166 updatePrivacyIcons(true);
2168 // Reload the WebView.
2169 mainWebView.reload();
2172 case R.id.clear_cookies:
2173 Snackbar.make(findViewById(R.id.main_webview), R.string.cookies_deleted, Snackbar.LENGTH_LONG)
2174 .setAction(R.string.undo, v -> {
2175 // Do nothing because everything will be handled by `onDismissed()` below.
2177 .addCallback(new Snackbar.Callback() {
2179 public void onDismissed(Snackbar snackbar, int event) {
2181 // The user pushed the `Undo` button.
2182 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2186 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2188 // `cookieManager.removeAllCookie()` varies by SDK.
2189 if (Build.VERSION.SDK_INT < 21) {
2190 cookieManager.removeAllCookie();
2192 // `null` indicates no callback.
2193 cookieManager.removeAllCookies(null);
2201 case R.id.clear_dom_storage:
2202 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
2203 .setAction(R.string.undo, v -> {
2204 // Do nothing because everything will be handled by `onDismissed()` below.
2206 .addCallback(new Snackbar.Callback() {
2208 public void onDismissed(Snackbar snackbar, int event) {
2210 // The user pushed the `Undo` button.
2211 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2215 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2217 // Delete the DOM Storage.
2218 WebStorage webStorage = WebStorage.getInstance();
2219 webStorage.deleteAllData();
2221 // Manually delete the DOM storage files and directories.
2223 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2224 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2226 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2227 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2228 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2229 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2230 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2231 } catch (IOException e) {
2232 // Do nothing if an error is thrown.
2240 // Form data can be remove once the minimum API >= 26.
2241 case R.id.clear_form_data:
2242 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_deleted, Snackbar.LENGTH_LONG)
2243 .setAction(R.string.undo, v -> {
2244 // Do nothing because everything will be handled by `onDismissed()` below.
2246 .addCallback(new Snackbar.Callback() {
2248 public void onDismissed(Snackbar snackbar, int event) {
2250 // The user pushed the `Undo` button.
2251 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2255 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2257 // Delete the form data.
2258 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(getApplicationContext());
2259 mainWebViewDatabase.clearFormData();
2266 case R.id.font_size_twenty_five_percent:
2267 mainWebView.getSettings().setTextZoom(25);
2270 case R.id.font_size_fifty_percent:
2271 mainWebView.getSettings().setTextZoom(50);
2274 case R.id.font_size_seventy_five_percent:
2275 mainWebView.getSettings().setTextZoom(75);
2278 case R.id.font_size_one_hundred_percent:
2279 mainWebView.getSettings().setTextZoom(100);
2282 case R.id.font_size_one_hundred_twenty_five_percent:
2283 mainWebView.getSettings().setTextZoom(125);
2286 case R.id.font_size_one_hundred_fifty_percent:
2287 mainWebView.getSettings().setTextZoom(150);
2290 case R.id.font_size_one_hundred_seventy_five_percent:
2291 mainWebView.getSettings().setTextZoom(175);
2294 case R.id.font_size_two_hundred_percent:
2295 mainWebView.getSettings().setTextZoom(200);
2298 case R.id.swipe_to_refresh:
2299 // Toggle swipe to refresh.
2300 swipeRefreshLayout.setEnabled(!swipeRefreshLayout.isEnabled());
2303 case R.id.display_images:
2304 if (mainWebView.getSettings().getLoadsImagesAutomatically()) { // Images are currently loaded automatically.
2305 mainWebView.getSettings().setLoadsImagesAutomatically(false);
2306 mainWebView.reload();
2307 } else { // Images are not currently loaded automatically.
2308 mainWebView.getSettings().setLoadsImagesAutomatically(true);
2311 // Set `onTheFlyDisplayImagesSet`.
2312 onTheFlyDisplayImagesSet = true;
2315 case R.id.view_source:
2316 // Launch the View Source activity.
2317 Intent viewSourceIntent = new Intent(this, ViewSourceActivity.class);
2318 startActivity(viewSourceIntent);
2322 // Toggle the EasyList status.
2323 easyListEnabled = !easyListEnabled;
2325 // Update the menu checkbox.
2326 menuItem.setChecked(easyListEnabled);
2328 // Reload the main WebView.
2329 mainWebView.reload();
2332 case R.id.easyprivacy:
2333 // Toggle the EasyPrivacy status.
2334 easyPrivacyEnabled = !easyPrivacyEnabled;
2336 // Update the menu checkbox.
2337 menuItem.setChecked(easyPrivacyEnabled);
2339 // Reload the main WebView.
2340 mainWebView.reload();
2343 case R.id.fanboys_annoyance_list:
2344 // Toggle Fanboy's Annoyance List status.
2345 fanboysAnnoyanceListEnabled = !fanboysAnnoyanceListEnabled;
2347 // Update the menu checkbox.
2348 menuItem.setChecked(fanboysAnnoyanceListEnabled);
2350 // Update the staus of Fanboy's Social Blocking List.
2351 MenuItem fanboysSocialBlockingListMenuItem = mainMenu.findItem(R.id.fanboys_social_blocking_list);
2352 fanboysSocialBlockingListMenuItem.setEnabled(!fanboysAnnoyanceListEnabled);
2354 // Reload the main WebView.
2355 mainWebView.reload();
2358 case R.id.fanboys_social_blocking_list:
2359 // Toggle Fanboy's Social Blocking List status.
2360 fanboysSocialBlockingListEnabled = !fanboysSocialBlockingListEnabled;
2362 // Update the menu checkbox.
2363 menuItem.setChecked(fanboysSocialBlockingListEnabled);
2365 // Reload the main WebView.
2366 mainWebView.reload();
2369 case R.id.ultraprivacy:
2370 // Toggle the UltraPrivacy status.
2371 ultraPrivacyEnabled = !ultraPrivacyEnabled;
2373 // Update the menu checkbox.
2374 menuItem.setChecked(ultraPrivacyEnabled);
2376 // Reload the main WebView.
2377 mainWebView.reload();
2380 case R.id.block_all_third_party_requests:
2381 //Toggle the third-party requests blocker status.
2382 blockAllThirdPartyRequests = !blockAllThirdPartyRequests;
2384 // Update the menu checkbox.
2385 menuItem.setChecked(blockAllThirdPartyRequests);
2387 // Reload the main WebView.
2388 mainWebView.reload();
2392 // Setup the share string.
2393 String shareString = webViewTitle + " – " + urlTextBox.getText().toString();
2395 // Create the share intent.
2396 Intent shareIntent = new Intent();
2397 shareIntent.setAction(Intent.ACTION_SEND);
2398 shareIntent.putExtra(Intent.EXTRA_TEXT, shareString);
2399 shareIntent.setType("text/plain");
2402 startActivity(Intent.createChooser(shareIntent, "Share URL"));
2405 case R.id.find_on_page:
2406 // Hide the URL app bar.
2407 supportAppBar.setVisibility(View.GONE);
2409 // Show the Find on Page `RelativeLayout`.
2410 findOnPageLinearLayout.setVisibility(View.VISIBLE);
2412 // Display the keyboard. We have to wait 200 ms before running the command to work around a bug in Android.
2413 // http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
2414 findOnPageEditText.postDelayed(() -> {
2415 // Set the focus on `findOnPageEditText`.
2416 findOnPageEditText.requestFocus();
2418 // Display the keyboard. `0` sets no input flags.
2419 inputMethodManager.showSoftInput(findOnPageEditText, 0);
2424 // Get a `PrintManager` instance.
2425 PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
2427 // Convert `mainWebView` to `printDocumentAdapter`.
2428 PrintDocumentAdapter printDocumentAdapter = mainWebView.createPrintDocumentAdapter();
2430 // Remove the lint error below that `printManager` might be `null`.
2431 assert printManager != null;
2433 // Print the document. The print attributes are `null`.
2434 printManager.print(getString(R.string.privacy_browser_web_page), printDocumentAdapter, null);
2437 case R.id.add_to_homescreen:
2438 // Show the `CreateHomeScreenShortcutDialog` `AlertDialog` and name this instance `R.string.create_shortcut`.
2439 AppCompatDialogFragment createHomeScreenShortcutDialogFragment = new CreateHomeScreenShortcutDialog();
2440 createHomeScreenShortcutDialogFragment.show(getSupportFragmentManager(), getString(R.string.create_shortcut));
2442 //Everything else will be handled by `CreateHomeScreenShortcutDialog` and the associated listener below.
2446 mainWebView.reload();
2449 case R.id.ad_consent:
2450 // Display the ad consent dialog.
2451 DialogFragment adConsentDialogFragment = new AdConsentDialog();
2452 adConsentDialogFragment.show(getFragmentManager(), getString(R.string.ad_consent));
2456 // Don't consume the event.
2457 return super.onOptionsItemSelected(menuItem);
2461 // removeAllCookies is deprecated, but it is required for API < 21.
2462 @SuppressWarnings("deprecation")
2464 public boolean onNavigationItemSelected(@NonNull MenuItem menuItem) {
2465 int menuItemId = menuItem.getItemId();
2467 switch (menuItemId) {
2473 if (mainWebView.canGoBack()) {
2474 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
2475 formattedUrlString = "";
2477 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2478 navigatingHistory = true;
2480 // Load the previous website in the history.
2481 mainWebView.goBack();
2486 if (mainWebView.canGoForward()) {
2487 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
2488 formattedUrlString = "";
2490 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2491 navigatingHistory = true;
2493 // Load the next website in the history.
2494 mainWebView.goForward();
2499 // Get the `WebBackForwardList`.
2500 WebBackForwardList webBackForwardList = mainWebView.copyBackForwardList();
2502 // Show the `UrlHistoryDialog` `AlertDialog` and name this instance `R.string.history`. `this` is the `Context`.
2503 AppCompatDialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(this, webBackForwardList);
2504 urlHistoryDialogFragment.show(getSupportFragmentManager(), getString(R.string.history));
2508 // Launch the requests activity.
2509 Intent requestsIntent = new Intent(this, RequestsActivity.class);
2510 startActivity(requestsIntent);
2513 case R.id.downloads:
2514 // Launch the system Download Manager.
2515 Intent downloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
2517 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
2518 downloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2520 startActivity(downloadManagerIntent);
2524 // Set the flag to reapply the domain settings on restart when returning from Domain Settings.
2525 reapplyDomainSettingsOnRestart = true;
2526 currentDomainName = "";
2528 // Launch the domains activity.
2529 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2530 startActivity(domainsIntent);
2534 // Set the flag to reapply app settings on restart when returning from Settings.
2535 reapplyAppSettingsOnRestart = true;
2537 // Set the flag to reapply the domain settings on restart when returning from Settings.
2538 reapplyDomainSettingsOnRestart = true;
2539 currentDomainName = "";
2541 // Launch the settings activity.
2542 Intent settingsIntent = new Intent(this, SettingsActivity.class);
2543 startActivity(settingsIntent);
2547 // Launch `GuideActivity`.
2548 Intent guideIntent = new Intent(this, GuideActivity.class);
2549 startActivity(guideIntent);
2553 // Launch `AboutActivity`.
2554 Intent aboutIntent = new Intent(this, AboutActivity.class);
2555 startActivity(aboutIntent);
2558 case R.id.clearAndExit:
2559 // Get a handle for `sharedPreferences`. `this` references the current context.
2560 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2562 boolean clearEverything = sharedPreferences.getBoolean("clear_everything", true);
2565 if (clearEverything || sharedPreferences.getBoolean("clear_cookies", true)) {
2566 // The command to remove cookies changed slightly in API 21.
2567 if (Build.VERSION.SDK_INT >= 21) {
2568 cookieManager.removeAllCookies(null);
2570 cookieManager.removeAllCookie();
2573 // Manually delete the cookies database, as `CookieManager` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2575 // We have to use two commands because `Runtime.exec()` does not like `*`.
2576 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies");
2577 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies-journal");
2578 } catch (IOException e) {
2579 // Do nothing if an error is thrown.
2583 // Clear DOM storage.
2584 if (clearEverything || sharedPreferences.getBoolean("clear_dom_storage", true)) {
2585 // Ask `WebStorage` to clear the DOM storage.
2586 WebStorage webStorage = WebStorage.getInstance();
2587 webStorage.deleteAllData();
2589 // Manually delete the DOM storage files and directories, as `WebStorage` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2591 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2592 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2594 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2595 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2596 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2597 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2598 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2599 } catch (IOException e) {
2600 // Do nothing if an error is thrown.
2604 // Clear form data if the API < 26.
2605 if ((Build.VERSION.SDK_INT < 26) && (clearEverything || sharedPreferences.getBoolean("clear_form_data", true))) {
2606 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
2607 webViewDatabase.clearFormData();
2609 // Manually delete the form data database, as `WebViewDatabase` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2611 // We have to use a `String[]` because the database contains a space and `Runtime.exec` will not escape the string correctly otherwise.
2612 privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data"});
2613 privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data-journal"});
2614 } catch (IOException e) {
2615 // Do nothing if an error is thrown.
2620 if (clearEverything || sharedPreferences.getBoolean("clear_cache", true)) {
2621 // `true` includes disk files.
2622 mainWebView.clearCache(true);
2624 // Manually delete the cache directories.
2626 // Delete the main cache directory.
2627 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
2629 // Delete the secondary `Service Worker` cache directory.
2630 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
2631 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
2632 } catch (IOException e) {
2633 // Do nothing if an error is thrown.
2637 // Clear SSL certificate preferences.
2638 mainWebView.clearSslPreferences();
2640 // Clear the back/forward history.
2641 mainWebView.clearHistory();
2643 // Clear `formattedUrlString`.
2644 formattedUrlString = null;
2646 // Clear `customHeaders`.
2647 customHeaders.clear();
2649 // Detach all views from `mainWebViewRelativeLayout`.
2650 mainWebViewRelativeLayout.removeAllViews();
2652 // Destroy the internal state of `mainWebView`.
2653 mainWebView.destroy();
2655 // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
2656 // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
2657 if (clearEverything) {
2659 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
2660 } catch (IOException e) {
2661 // Do nothing if an error is thrown.
2665 // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
2666 if (Build.VERSION.SDK_INT >= 21) {
2667 finishAndRemoveTask();
2672 // Remove the terminated program from RAM. The status code is `0`.
2677 // Close the navigation drawer.
2678 drawerLayout.closeDrawer(GravityCompat.START);
2683 public void onPostCreate(Bundle savedInstanceState) {
2684 super.onPostCreate(savedInstanceState);
2686 // Sync the state of the DrawerToggle after onRestoreInstanceState has finished.
2687 drawerToggle.syncState();
2691 public void onConfigurationChanged(Configuration newConfig) {
2692 super.onConfigurationChanged(newConfig);
2694 // Reload the ad for the free flavor if we not in full screen mode.
2695 if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
2696 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
2697 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_id));
2700 // `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:
2701 // https://code.google.com/p/android/issues/detail?id=20493#c8
2702 // ActivityCompat.invalidateOptionsMenu(this);
2706 public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
2707 // Store the `HitTestResult`.
2708 final WebView.HitTestResult hitTestResult = mainWebView.getHitTestResult();
2711 final String imageUrl;
2712 final String linkUrl;
2714 // Get a handle for the `ClipboardManager`.
2715 final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
2717 // Remove the lint errors below that `clipboardManager` might be `null`.
2718 assert clipboardManager != null;
2720 switch (hitTestResult.getType()) {
2721 // `SRC_ANCHOR_TYPE` is a link.
2722 case WebView.HitTestResult.SRC_ANCHOR_TYPE:
2723 // Get the target URL.
2724 linkUrl = hitTestResult.getExtra();
2726 // Set the target URL as the title of the `ContextMenu`.
2727 menu.setHeaderTitle(linkUrl);
2729 // Add a Load URL entry.
2730 menu.add(R.string.load_url).setOnMenuItemClickListener((MenuItem item) -> {
2735 // Add a Copy URL entry.
2736 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
2737 // Save the link URL in a `ClipData`.
2738 ClipData srcAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
2740 // Set the `ClipData` as the clipboard's primary clip.
2741 clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
2745 // Add a Download URL entry.
2746 menu.add(R.string.download_url).setOnMenuItemClickListener((MenuItem item) -> {
2747 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
2748 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
2749 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
2751 // Store the variables for future use by `onRequestPermissionsResult()`.
2752 downloadUrl = linkUrl;
2753 downloadContentDisposition = "none";
2754 downloadContentLength = -1;
2756 // Show a dialog if the user has previously denied the permission.
2757 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2758 // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
2759 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
2761 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
2762 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
2763 } else { // Show the permission request directly.
2764 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
2765 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
2767 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
2768 // Get a handle for the download file alert dialog.
2769 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(linkUrl, "none", -1);
2771 // Show the download file alert dialog.
2772 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2777 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2778 menu.add(R.string.cancel);
2781 case WebView.HitTestResult.EMAIL_TYPE:
2782 // Get the target URL.
2783 linkUrl = hitTestResult.getExtra();
2785 // Set the target URL as the title of the `ContextMenu`.
2786 menu.setHeaderTitle(linkUrl);
2788 // Add a `Write Email` entry.
2789 menu.add(R.string.write_email).setOnMenuItemClickListener(item -> {
2790 // We use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
2791 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
2793 // Parse the url and set it as the data for the `Intent`.
2794 emailIntent.setData(Uri.parse("mailto:" + linkUrl));
2796 // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
2797 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2800 startActivity(emailIntent);
2804 // Add a `Copy Email Address` entry.
2805 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(item -> {
2806 // Save the email address in a `ClipData`.
2807 ClipData srcEmailTypeClipData = ClipData.newPlainText(getString(R.string.email_address), linkUrl);
2809 // Set the `ClipData` as the clipboard's primary clip.
2810 clipboardManager.setPrimaryClip(srcEmailTypeClipData);
2814 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2815 menu.add(R.string.cancel);
2818 // `IMAGE_TYPE` is an image.
2819 case WebView.HitTestResult.IMAGE_TYPE:
2820 // Get the image URL.
2821 imageUrl = hitTestResult.getExtra();
2823 // Set the image URL as the title of the `ContextMenu`.
2824 menu.setHeaderTitle(imageUrl);
2826 // Add a `View Image` entry.
2827 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2832 // Add a `Download Image` entry.
2833 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2834 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
2835 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
2836 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
2838 // Store the image URL for use by `onRequestPermissionResult()`.
2839 downloadImageUrl = imageUrl;
2841 // Show a dialog if the user has previously denied the permission.
2842 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2843 // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2844 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2846 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
2847 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
2848 } else { // Show the permission request directly.
2849 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
2850 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2852 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
2853 // Get a handle for the download image alert dialog.
2854 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2856 // Show the download image alert dialog.
2857 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2862 // Add a `Copy URL` entry.
2863 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2864 // Save the image URL in a `ClipData`.
2865 ClipData srcImageTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2867 // Set the `ClipData` as the clipboard's primary clip.
2868 clipboardManager.setPrimaryClip(srcImageTypeClipData);
2872 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2873 menu.add(R.string.cancel);
2877 // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
2878 case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
2879 // Get the image URL.
2880 imageUrl = hitTestResult.getExtra();
2882 // Set the image URL as the title of the `ContextMenu`.
2883 menu.setHeaderTitle(imageUrl);
2885 // Add a `View Image` entry.
2886 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2891 // Add a `Download Image` entry.
2892 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2893 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
2894 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
2895 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
2897 // Store the image URL for use by `onRequestPermissionResult()`.
2898 downloadImageUrl = imageUrl;
2900 // Show a dialog if the user has previously denied the permission.
2901 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2902 // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2903 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2905 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
2906 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
2907 } else { // Show the permission request directly.
2908 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
2909 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2911 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
2912 // Get a handle for the download image alert dialog.
2913 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2915 // Show the download image alert dialog.
2916 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2921 // Add a `Copy URL` entry.
2922 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2923 // Save the image URL in a `ClipData`.
2924 ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2926 // Set the `ClipData` as the clipboard's primary clip.
2927 clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
2931 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2932 menu.add(R.string.cancel);
2938 public void onCreateBookmark(AppCompatDialogFragment dialogFragment) {
2939 // Get the `EditTexts` from the `dialogFragment`.
2940 EditText createBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_name_edittext);
2941 EditText createBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_url_edittext);
2943 // Extract the strings from the `EditTexts`.
2944 String bookmarkNameString = createBookmarkNameEditText.getText().toString();
2945 String bookmarkUrlString = createBookmarkUrlEditText.getText().toString();
2947 // Convert the favoriteIcon Bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2948 ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2949 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
2950 byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
2952 // Display the new bookmark below the current items in the (0 indexed) list.
2953 int newBookmarkDisplayOrder = bookmarksListView.getCount();
2955 // Create the bookmark.
2956 bookmarksDatabaseHelper.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray);
2958 // Update `bookmarksCursor` with the current contents of this folder.
2959 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2961 // Update the `ListView`.
2962 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2964 // Scroll to the new bookmark.
2965 bookmarksListView.setSelection(newBookmarkDisplayOrder);
2969 public void onCreateBookmarkFolder(AppCompatDialogFragment dialogFragment) {
2970 // Get handles for the views in `dialogFragment`.
2971 EditText createFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.create_folder_name_edittext);
2972 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon_radiobutton);
2973 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon);
2975 // Get new folder name string.
2976 String folderNameString = createFolderNameEditText.getText().toString();
2978 // Get the new folder icon `Bitmap`.
2979 Bitmap folderIconBitmap;
2980 if (defaultFolderIconRadioButton.isChecked()) { // Use the default folder icon.
2981 // Get the default folder icon and convert it to a `Bitmap`.
2982 Drawable folderIconDrawable = folderIconImageView.getDrawable();
2983 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2984 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2985 } else { // Use the `WebView` favorite icon.
2986 folderIconBitmap = favoriteIconBitmap;
2989 // Convert `folderIconBitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
2990 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2991 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
2992 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
2994 // Move all the bookmarks down one in the display order.
2995 for (int i = 0; i < bookmarksListView.getCount(); i++) {
2996 int databaseId = (int) bookmarksListView.getItemIdAtPosition(i);
2997 bookmarksDatabaseHelper.updateDisplayOrder(databaseId, i + 1);
3000 // Create the folder, which will be placed at the top of the `ListView`.
3001 bookmarksDatabaseHelper.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray);
3003 // Update `bookmarksCursor` with the current contents of this folder.
3004 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3006 // Update the `ListView`.
3007 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3009 // Scroll to the new folder.
3010 bookmarksListView.setSelection(0);
3014 public void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment) {
3015 // Get the shortcut name.
3016 EditText shortcutNameEditText = dialogFragment.getDialog().findViewById(R.id.shortcut_name_edittext);
3017 String shortcutNameString = shortcutNameEditText.getText().toString();
3019 // Convert the favorite icon bitmap to an `Icon`. `IconCompat` is required until API >= 26.
3020 IconCompat favoriteIcon = IconCompat.createWithBitmap(favoriteIconBitmap);
3022 // Setup the shortcut intent.
3023 Intent shortcutIntent = new Intent();
3024 shortcutIntent.setAction(Intent.ACTION_VIEW);
3025 shortcutIntent.setData(Uri.parse(formattedUrlString));
3027 // Create a shortcut info builder. The shortcut name becomes the shortcut ID.
3028 ShortcutInfoCompat.Builder shortcutInfoBuilder = new ShortcutInfoCompat.Builder(this, shortcutNameString);
3030 // Add the required fields to the shortcut info builder.
3031 shortcutInfoBuilder.setIcon(favoriteIcon);
3032 shortcutInfoBuilder.setIntent(shortcutIntent);
3033 shortcutInfoBuilder.setShortLabel(shortcutNameString);
3035 // Request the pin. `ShortcutManagerCompat` can be switched to `ShortcutManager` once API >= 26.
3036 ShortcutManagerCompat.requestPinShortcut(this, shortcutInfoBuilder.build(), null);
3040 public void onCloseDownloadLocationPermissionDialog(int downloadType) {
3041 switch (downloadType) {
3042 case DownloadLocationPermissionDialog.DOWNLOAD_FILE:
3043 // Request the WRITE_EXTERNAL_STORAGE permission with a file request code.
3044 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
3047 case DownloadLocationPermissionDialog.DOWNLOAD_IMAGE:
3048 // Request the WRITE_EXTERNAL_STORAGE permission with an image request code.
3049 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
3055 public void onRequestPermissionsResult(int requestCode, @NonNull String permissions[], @NonNull int[] grantResults) {
3056 switch (requestCode) {
3057 case DOWNLOAD_FILE_REQUEST_CODE:
3058 // Show the download file alert dialog. When the dialog closes, the correct command will be used based on the permission status.
3059 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(downloadUrl, downloadContentDisposition, downloadContentLength);
3061 // On API 23, displaying the fragment must be delayed or the app will crash.
3062 if (Build.VERSION.SDK_INT == 23) {
3063 new Handler().postDelayed(() -> downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
3065 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3068 // Reset the download variables.
3070 downloadContentDisposition = "";
3071 downloadContentLength = 0;
3074 case DOWNLOAD_IMAGE_REQUEST_CODE:
3075 // Show the download image alert dialog. When the dialog closes, the correct command will be used based on the permission status.
3076 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(downloadImageUrl);
3078 // On API 23, displaying the fragment must be delayed or the app will crash.
3079 if (Build.VERSION.SDK_INT == 23) {
3080 new Handler().postDelayed(() -> downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
3082 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3085 // Reset the image URL variable.
3086 downloadImageUrl = "";
3092 public void onDownloadImage(AppCompatDialogFragment dialogFragment, String imageUrl) {
3093 // Download the image if it has an HTTP or HTTPS URI.
3094 if (imageUrl.startsWith("http")) {
3095 // Get a handle for the system `DOWNLOAD_SERVICE`.
3096 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3098 // Parse `imageUrl`.
3099 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(imageUrl));
3101 // Pass cookies to download manager if cookies are enabled. This is required to download images from websites that require a login.
3102 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3103 if (firstPartyCookiesEnabled) {
3104 // Get the cookies for `imageUrl`.
3105 String cookies = cookieManager.getCookie(imageUrl);
3107 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3108 downloadRequest.addRequestHeader("Cookie", cookies);
3111 // Get the file name from the dialog fragment.
3112 EditText downloadImageNameEditText = dialogFragment.getDialog().findViewById(R.id.download_image_name);
3113 String imageName = downloadImageNameEditText.getText().toString();
3115 // Specify the download location.
3116 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3117 // Download to the public download directory.
3118 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, imageName);
3119 } else { // External write permission denied.
3120 // Download to the app's external download directory.
3121 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, imageName);
3124 // Allow `MediaScanner` to index the download if it is a media file.
3125 downloadRequest.allowScanningByMediaScanner();
3127 // Add the URL as the description for the download.
3128 downloadRequest.setDescription(imageUrl);
3130 // Show the download notification after the download is completed.
3131 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3133 // Remove the lint warning below that `downloadManager` might be `null`.
3134 assert downloadManager != null;
3136 // Initiate the download.
3137 downloadManager.enqueue(downloadRequest);
3138 } else { // The image is not an HTTP or HTTPS URI.
3139 Snackbar.make(mainWebView, R.string.cannot_download_image, Snackbar.LENGTH_INDEFINITE).show();
3144 public void onDownloadFile(AppCompatDialogFragment dialogFragment, String downloadUrl) {
3145 // Download the file if it has an HTTP or HTTPS URI.
3146 if (downloadUrl.startsWith("http")) {
3147 // Get a handle for the system `DOWNLOAD_SERVICE`.
3148 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3150 // Parse `downloadUrl`.
3151 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(downloadUrl));
3153 // Pass cookies to download manager if cookies are enabled. This is required to download files from websites that require a login.
3154 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3155 if (firstPartyCookiesEnabled) {
3156 // Get the cookies for `downloadUrl`.
3157 String cookies = cookieManager.getCookie(downloadUrl);
3159 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3160 downloadRequest.addRequestHeader("Cookie", cookies);
3163 // Get the file name from the dialog fragment.
3164 EditText downloadFileNameEditText = dialogFragment.getDialog().findViewById(R.id.download_file_name);
3165 String fileName = downloadFileNameEditText.getText().toString();
3167 // Specify the download location.
3168 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3169 // Download to the public download directory.
3170 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, fileName);
3171 } else { // External write permission denied.
3172 // Download to the app's external download directory.
3173 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, fileName);
3176 // Allow `MediaScanner` to index the download if it is a media file.
3177 downloadRequest.allowScanningByMediaScanner();
3179 // Add the URL as the description for the download.
3180 downloadRequest.setDescription(downloadUrl);
3182 // Show the download notification after the download is completed.
3183 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3185 // Remove the lint warning below that `downloadManager` might be `null`.
3186 assert downloadManager != null;
3188 // Initiate the download.
3189 downloadManager.enqueue(downloadRequest);
3190 } else { // The download is not an HTTP or HTTPS URI.
3191 Snackbar.make(mainWebView, R.string.cannot_download_file, Snackbar.LENGTH_INDEFINITE).show();
3196 public void onSaveBookmark(AppCompatDialogFragment dialogFragment, int selectedBookmarkDatabaseId) {
3197 // Get handles for the views from `dialogFragment`.
3198 EditText editBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_name_edittext);
3199 EditText editBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_url_edittext);
3200 RadioButton currentBookmarkIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_current_icon_radiobutton);
3202 // Store the bookmark strings.
3203 String bookmarkNameString = editBookmarkNameEditText.getText().toString();
3204 String bookmarkUrlString = editBookmarkUrlEditText.getText().toString();
3206 // Update the bookmark.
3207 if (currentBookmarkIconRadioButton.isChecked()) { // Update the bookmark without changing the favorite icon.
3208 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString);
3209 } else { // Update the bookmark using the `WebView` favorite icon.
3210 // Convert the favorite icon to a byte array. `0` is for lossless compression (the only option for a PNG).
3211 ByteArrayOutputStream newFavoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
3212 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFavoriteIconByteArrayOutputStream);
3213 byte[] newFavoriteIconByteArray = newFavoriteIconByteArrayOutputStream.toByteArray();
3215 // Update the bookmark and the favorite icon.
3216 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString, newFavoriteIconByteArray);
3219 // Update `bookmarksCursor` with the current contents of this folder.
3220 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3222 // Update the `ListView`.
3223 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3227 public void onSaveBookmarkFolder(AppCompatDialogFragment dialogFragment, int selectedFolderDatabaseId) {
3228 // Get handles for the views from `dialogFragment`.
3229 EditText editFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_folder_name_edittext);
3230 RadioButton currentFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_current_icon_radiobutton);
3231 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_radiobutton);
3232 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_imageview);
3234 // Get the new folder name.
3235 String newFolderNameString = editFolderNameEditText.getText().toString();
3237 // Check if the favorite icon has changed.
3238 if (currentFolderIconRadioButton.isChecked()) { // Only the name has changed.
3239 // Update the name in the database.
3240 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString);
3241 } else if (!currentFolderIconRadioButton.isChecked() && newFolderNameString.equals(oldFolderNameString)) { // Only the icon has changed.
3242 // Get the new folder icon `Bitmap`.
3243 Bitmap folderIconBitmap;
3244 if (defaultFolderIconRadioButton.isChecked()) {
3245 // Get the default folder icon and convert it to a `Bitmap`.
3246 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3247 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3248 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3249 } else { // Use the `WebView` favorite icon.
3250 folderIconBitmap = favoriteIconBitmap;
3253 // Convert the folder `Bitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
3254 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3255 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3256 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3258 // Update the folder icon in the database.
3259 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, folderIconByteArray);
3260 } else { // The folder icon and the name have changed.
3261 // Get the new folder icon `Bitmap`.
3262 Bitmap folderIconBitmap;
3263 if (defaultFolderIconRadioButton.isChecked()) {
3264 // Get the default folder icon and convert it to a `Bitmap`.
3265 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3266 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3267 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3268 } else { // Use the `WebView` favorite icon.
3269 folderIconBitmap = MainWebViewActivity.favoriteIconBitmap;
3272 // Convert the folder `Bitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
3273 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3274 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3275 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3277 // Update the folder name and icon in the database.
3278 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString, folderIconByteArray);
3281 // Update `bookmarksCursor` with the current contents of this folder.
3282 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3284 // Update the `ListView`.
3285 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3289 public void onHttpAuthenticationCancel() {
3290 // Cancel the `HttpAuthHandler`.
3291 httpAuthHandler.cancel();
3295 public void onHttpAuthenticationProceed(AppCompatDialogFragment dialogFragment) {
3296 // Get handles for the `EditTexts`.
3297 EditText usernameEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_username);
3298 EditText passwordEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_password);
3300 // Proceed with the HTTP authentication.
3301 httpAuthHandler.proceed(usernameEditText.getText().toString(), passwordEditText.getText().toString());
3304 public void viewSslCertificate(View view) {
3305 // Show the `ViewSslCertificateDialog` `AlertDialog` and name this instance `@string/view_ssl_certificate`.
3306 DialogFragment viewSslCertificateDialogFragment = new ViewSslCertificateDialog();
3307 viewSslCertificateDialogFragment.show(getFragmentManager(), getString(R.string.view_ssl_certificate));
3311 public void onSslErrorCancel() {
3312 sslErrorHandler.cancel();
3316 public void onSslErrorProceed() {
3317 sslErrorHandler.proceed();
3321 public void onSslMismatchBack() {
3322 if (mainWebView.canGoBack()) { // There is a back page in the history.
3323 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
3324 formattedUrlString = "";
3326 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3327 navigatingHistory = true;
3330 mainWebView.goBack();
3331 } else { // There are no pages to go back to.
3332 // Load a blank page
3338 public void onSslMismatchProceed() {
3339 // Do not check the pinned SSL certificate for this domain again until the domain changes.
3340 ignorePinnedSslCertificate = true;
3344 public void onUrlHistoryEntrySelected(int moveBackOrForwardSteps) {
3345 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
3346 formattedUrlString = "";
3348 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3349 navigatingHistory = true;
3351 // Load the history entry.
3352 mainWebView.goBackOrForward(moveBackOrForwardSteps);
3356 public void onClearHistory() {
3357 // Clear the history.
3358 mainWebView.clearHistory();
3361 // Override `onBackPressed` to handle the navigation drawer and `mainWebView`.
3363 public void onBackPressed() {
3364 if (drawerLayout.isDrawerVisible(GravityCompat.START)) { // The navigation drawer is open.
3365 // Close the navigation drawer.
3366 drawerLayout.closeDrawer(GravityCompat.START);
3367 } else if (drawerLayout.isDrawerVisible(GravityCompat.END)){ // The bookmarks drawer is open.
3368 if (currentBookmarksFolder.isEmpty()) { // The home folder is displayed.
3369 // close the bookmarks drawer.
3370 drawerLayout.closeDrawer(GravityCompat.END);
3371 } else { // A subfolder is displayed.
3372 // Place the former parent folder in `currentFolder`.
3373 currentBookmarksFolder = bookmarksDatabaseHelper.getParentFolder(currentBookmarksFolder);
3375 // Load the new folder.
3376 loadBookmarksFolder();
3379 } else if (mainWebView.canGoBack()) { // There is at least one item in the `WebView` history.
3380 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
3381 formattedUrlString = "";
3383 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3384 navigatingHistory = true;
3387 mainWebView.goBack();
3388 } else { // There isn't anything to do in Privacy Browser.
3389 // Pass `onBackPressed()` to the system.
3390 super.onBackPressed();
3394 // Process the results of an upload file chooser. Currently there is only one `startActivityForResult` in this activity, so the request code, used to differentiate them, is ignored.
3396 public void onActivityResult(int requestCode, int resultCode, Intent data) {
3397 // File uploads only work on API >= 21.
3398 if (Build.VERSION.SDK_INT >= 21) {
3399 // Pass the file to the WebView.
3400 fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(resultCode, data));
3404 private void loadUrlFromTextBox() throws UnsupportedEncodingException {
3405 // Get the text from urlTextBox and convert it to a string. trim() removes white spaces from the beginning and end of the string.
3406 String unformattedUrlString = urlTextBox.getText().toString().trim();
3408 // Check to see if `unformattedUrlString` is a valid URL. Otherwise, convert it into a search.
3409 if ((Patterns.WEB_URL.matcher(unformattedUrlString).matches()) || (unformattedUrlString.startsWith("http://")) || (unformattedUrlString.startsWith("https://"))) {
3410 // Add `http://` at the beginning if it is missing. Otherwise the app will segfault.
3411 if (!unformattedUrlString.startsWith("http")) {
3412 unformattedUrlString = "http://" + unformattedUrlString;
3415 // Initialize `unformattedUrl`.
3416 URL unformattedUrl = null;
3418 // 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.
3420 unformattedUrl = new URL(unformattedUrlString);
3421 } catch (MalformedURLException e) {
3422 e.printStackTrace();
3425 // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if `.get` was called on a `null` value.
3426 final String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
3427 final String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
3428 final String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
3429 final String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
3430 final String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
3433 Uri.Builder formattedUri = new Uri.Builder();
3434 formattedUri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
3436 // Decode `formattedUri` as a `String` in `UTF-8`.
3437 formattedUrlString = URLDecoder.decode(formattedUri.build().toString(), "UTF-8");
3438 } else if (unformattedUrlString.isEmpty()){ // Load a blank web site.
3439 // Load a blank string.
3440 formattedUrlString = "";
3441 } else { // Search for the contents of the URL box.
3442 // Sanitize the search input and convert it to a search.
3443 final String encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
3445 // Add the base search URL.
3446 formattedUrlString = searchURL + encodedUrlString;
3449 // Clear the focus from the URL text box. Otherwise, proximate typing in the box will retain the colorized formatting instead of being reset during refocus.
3450 urlTextBox.clearFocus();
3453 loadUrl(formattedUrlString);
3456 private void loadUrl(String url) {// Apply any custom domain settings.
3457 // Set the URL as the formatted URL string so that checking third-party requests works correctly.
3458 formattedUrlString = url;
3460 // Apply the domain settings.
3461 applyDomainSettings(url, true, false);
3463 // Set `urlIsLoading` to prevent changes in the user agent on websites with redirects from reloading the current website.
3464 urlIsLoading = true;
3467 mainWebView.loadUrl(url, customHeaders);
3470 public void findPreviousOnPage(View view) {
3471 // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards.
3472 mainWebView.findNext(false);
3475 public void findNextOnPage(View view) {
3476 // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
3477 mainWebView.findNext(true);
3480 public void closeFindOnPage(View view) {
3481 // Delete the contents of `find_on_page_edittext`.
3482 findOnPageEditText.setText(null);
3484 // Clear the highlighted phrases.
3485 mainWebView.clearMatches();
3487 // Hide the Find on Page `RelativeLayout`.
3488 findOnPageLinearLayout.setVisibility(View.GONE);
3490 // Show the URL app bar.
3491 supportAppBar.setVisibility(View.VISIBLE);
3493 // Hide the keyboard so we can see the webpage. `0` indicates no additional flags.
3494 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
3497 private void applyAppSettings() {
3498 // Get a handle for the shared preferences.
3499 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3501 // Store the values from the shared preferences in variables.
3502 String homepageString = sharedPreferences.getString("homepage", "https://start.duckduckgo.com");
3503 String torHomepageString = sharedPreferences.getString("tor_homepage", "https://3g2upl4pq6kufc4m.onion");
3504 String torSearchString = sharedPreferences.getString("tor_search", "https://3g2upl4pq6kufc4m.onion/html/?q=");
3505 String torSearchCustomURLString = sharedPreferences.getString("tor_search_custom_url", "");
3506 String searchString = sharedPreferences.getString("search", "https://duckduckgo.com/html/?q=");
3507 String searchCustomURLString = sharedPreferences.getString("search_custom_url", "");
3508 incognitoModeEnabled = sharedPreferences.getBoolean("incognito_mode", false);
3509 boolean doNotTrackEnabled = sharedPreferences.getBoolean("do_not_track", false);
3510 proxyThroughOrbot = sharedPreferences.getBoolean("proxy_through_orbot", false);
3511 fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean("full_screen_browsing_mode", false);
3512 hideSystemBarsOnFullscreen = sharedPreferences.getBoolean("hide_system_bars", false);
3513 translucentNavigationBarOnFullscreen = sharedPreferences.getBoolean("translucent_navigation_bar", true);
3514 displayWebpageImagesBoolean = sharedPreferences.getBoolean("display_webpage_images", true);
3516 // Set the homepage, search, and proxy options.
3517 if (proxyThroughOrbot) { // Set the Tor options.
3518 // Set `torHomepageString` as `homepage`.
3519 homepage = torHomepageString;
3521 // If formattedUrlString is null assign the homepage to it.
3522 if (formattedUrlString == null) {
3523 formattedUrlString = homepage;
3526 // Set the search URL.
3527 if (torSearchString.equals("Custom URL")) { // Get the custom URL string.
3528 searchURL = torSearchCustomURLString;
3529 } else { // Use the string from the pre-built list.
3530 searchURL = torSearchString;
3533 // Set the proxy. `this` refers to the current activity where an `AlertDialog` might be displayed.
3534 OrbotProxyHelper.setProxy(getApplicationContext(), this, "localhost", "8118");
3536 // Set the `appBar` background to indicate proxying through Orbot is enabled. `this` refers to the context.
3538 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.dark_blue_30));
3540 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.blue_50));
3543 // Display a message to the user if waiting for Orbot.
3544 if (!orbotStatus.equals("ON")) {
3545 // Set `waitingForOrbot`.
3546 waitingForOrbot = true;
3548 // Load a waiting page. `null` specifies no encoding, which defaults to ASCII.
3549 mainWebView.loadData(waitingForOrbotHTMLString, "text/html", null);
3551 } else { // Set the non-Tor options.
3552 // Set `homepageString` as `homepage`.
3553 homepage = homepageString;
3555 // If formattedUrlString is null assign the homepage to it.
3556 if (formattedUrlString == null) {
3557 formattedUrlString = homepage;
3560 // Set the search URL.
3561 if (searchString.equals("Custom URL")) { // Get the custom URL string.
3562 searchURL = searchCustomURLString;
3563 } else { // Use the string from the pre-built list.
3564 searchURL = searchString;
3567 // Reset the proxy to default. The host is `""` and the port is `"0"`.
3568 OrbotProxyHelper.setProxy(getApplicationContext(), this, "", "0");
3570 // Set the default `appBar` background. `this` refers to the context.
3572 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_900));
3574 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_100));
3577 // Reset `waitingForOrbot.
3578 waitingForOrbot = false;
3581 // Set Do Not Track status.
3582 if (doNotTrackEnabled) {
3583 customHeaders.put("DNT", "1");
3585 customHeaders.remove("DNT");
3588 // Apply the appropriate full screen mode the `SYSTEM_UI` flags.
3589 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
3590 if (hideSystemBarsOnFullscreen) { // Hide everything.
3591 // Remove the translucent navigation setting if it is currently flagged.
3592 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3594 // Remove the translucent status bar overlay.
3595 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3597 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
3598 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
3600 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
3601 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
3602 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
3604 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
3605 } else { // Hide everything except the status and navigation bars.
3606 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
3607 rootCoordinatorLayout.setSystemUiVisibility(0);
3609 // Add the translucent status flag if it is unset.
3610 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3612 if (translucentNavigationBarOnFullscreen) {
3613 // Set the navigation bar to be translucent.
3614 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3616 // Set the navigation bar to be black.
3617 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3620 } else { // Privacy Browser is not in full screen browsing mode.
3621 // Reset the full screen tracker, which could be true if Privacy Browser was in full screen mode before entering settings and full screen browsing was disabled.
3622 inFullScreenBrowsingMode = false;
3624 // Show the `appBar` if `findOnPageLinearLayout` is not visible.
3625 if (findOnPageLinearLayout.getVisibility() == View.GONE) {
3629 // Show the `BannerAd` in the free flavor.
3630 if (BuildConfig.FLAVOR.contentEquals("free")) {
3631 // Initialize the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
3632 AdHelper.initializeAds(findViewById(R.id.adview), getApplicationContext(), getFragmentManager(), getString(R.string.ad_id));
3635 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
3636 rootCoordinatorLayout.setSystemUiVisibility(0);
3638 // Remove the translucent navigation bar flag if it is set.
3639 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3641 // Add the translucent status flag if it is unset. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
3642 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3644 // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
3645 rootCoordinatorLayout.setFitsSystemWindows(true);
3649 // `reloadWebsite` is used if returning from the Domains activity. Otherwise JavaScript might not function correctly if it is newly enabled.
3650 // The deprecated `.getDrawable()` must be used until the minimum API >= 21.
3651 @SuppressWarnings("deprecation")
3652 private void applyDomainSettings(String url, boolean resetFavoriteIcon, boolean reloadWebsite) {
3653 // Parse the URL into a URI.
3654 Uri uri = Uri.parse(url);
3656 // Extract the domain from `uri`.
3657 String hostName = uri.getHost();
3659 // Initialize `loadingNewDomainName`.
3660 boolean loadingNewDomainName;
3662 // If either `hostName` or `currentDomainName` are `null`, run the options for loading a new domain name.
3663 // The lint suggestion to simplify the `if` statement is incorrect, because `hostName.equals(currentDomainName)` can produce a `null object reference.`
3664 //noinspection SimplifiableIfStatement
3665 if ((hostName == null) || (currentDomainName == null)) {
3666 loadingNewDomainName = true;
3667 } else { // Determine if `hostName` equals `currentDomainName`.
3668 loadingNewDomainName = !hostName.equals(currentDomainName);
3671 // Strings don't like to be null.
3672 if (hostName == null) {
3676 // Only apply the domain settings if a new domain is being loaded. This allows the user to set temporary settings for JavaScript, cookies, DOM storage, etc.
3677 if (loadingNewDomainName) {
3678 // Set the new `hostname` as the `currentDomainName`.
3679 currentDomainName = hostName;
3681 // Reset `ignorePinnedSslCertificate`.
3682 ignorePinnedSslCertificate = false;
3684 // Reset the favorite icon if specified.
3685 if (resetFavoriteIcon) {
3686 favoriteIconBitmap = favoriteIconDefaultBitmap;
3687 favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(favoriteIconBitmap, 64, 64, true));
3690 // Initialize the database handler. `this` specifies the context. The two `nulls` do not specify the database name or a `CursorFactory`.
3691 // The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
3692 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
3694 // Get a full cursor from `domainsDatabaseHelper`.
3695 Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain();
3697 // Initialize `domainSettingsSet`.
3698 Set<String> domainSettingsSet = new HashSet<>();
3700 // Get the domain name column index.
3701 int domainNameColumnIndex = domainNameCursor.getColumnIndex(DomainsDatabaseHelper.DOMAIN_NAME);
3703 // Populate `domainSettingsSet`.
3704 for (int i = 0; i < domainNameCursor.getCount(); i++) {
3705 // Move `domainsCursor` to the current row.
3706 domainNameCursor.moveToPosition(i);
3708 // Store the domain name in `domainSettingsSet`.
3709 domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex));
3712 // Close `domainNameCursor.
3713 domainNameCursor.close();
3715 // Initialize variables to track if domain settings will be applied and, if so, under which name.
3716 domainSettingsApplied = false;
3717 String domainNameInDatabase = null;
3719 // Check the hostname.
3720 if (domainSettingsSet.contains(hostName)) {
3721 domainSettingsApplied = true;
3722 domainNameInDatabase = hostName;
3725 // Check all the subdomains of the host name against wildcard domains in the domain cursor.
3726 while (!domainSettingsApplied && hostName.contains(".")) { // Stop checking if domain settings are already applied or there are no more `.` in the host name.
3727 if (domainSettingsSet.contains("*." + hostName)) { // Check the host name prepended by `*.`.
3728 // Apply the domain settings.
3729 domainSettingsApplied = true;
3731 // Store the applied domain names as it appears in the database.
3732 domainNameInDatabase = "*." + hostName;
3735 // Strip out the lowest subdomain of of the host name.
3736 hostName = hostName.substring(hostName.indexOf(".") + 1);
3740 // Get a handle for the shared preference.
3741 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3743 // Store the general preference information.
3744 String defaultFontSizeString = sharedPreferences.getString("default_font_size", "100");
3745 String defaultUserAgentName = sharedPreferences.getString("user_agent", "Privacy Browser");
3746 String defaultCustomUserAgentString = sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0");
3747 boolean defaultSwipeToRefresh = sharedPreferences.getBoolean("swipe_to_refresh", true);
3748 nightMode = sharedPreferences.getBoolean("night_mode", false);
3750 if (domainSettingsApplied) { // The url we are loading has custom domain settings.
3751 // Get a cursor for the current host and move it to the first position.
3752 Cursor currentHostDomainSettingsCursor = domainsDatabaseHelper.getCursorForDomainName(domainNameInDatabase);
3753 currentHostDomainSettingsCursor.moveToFirst();
3755 // Get the settings from the cursor.
3756 domainSettingsDatabaseId = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper._ID)));
3757 javaScriptEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1);
3758 firstPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FIRST_PARTY_COOKIES)) == 1);
3759 thirdPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_THIRD_PARTY_COOKIES)) == 1);
3760 domStorageEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1);
3761 // Form data can be removed once the minimum API >= 26.
3762 saveFormDataEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1);
3763 easyListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYLIST)) == 1);
3764 easyPrivacyEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYPRIVACY)) == 1);
3765 fanboysAnnoyanceListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_ANNOYANCE_LIST)) == 1);
3766 fanboysSocialBlockingListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST)) == 1);
3767 ultraPrivacyEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_ULTRAPRIVACY)) == 1);
3768 blockAllThirdPartyRequests = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.BLOCK_ALL_THIRD_PARTY_REQUESTS)) == 1);
3769 String userAgentName = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.USER_AGENT));
3770 int fontSize = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.FONT_SIZE));
3771 int swipeToRefreshInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SWIPE_TO_REFRESH));
3772 int nightModeInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.NIGHT_MODE));
3773 displayWebpageImagesInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.DISPLAY_IMAGES));
3774 pinnedDomainSslCertificate = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.PINNED_SSL_CERTIFICATE)) == 1);
3775 pinnedDomainSslIssuedToCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_COMMON_NAME));
3776 pinnedDomainSslIssuedToONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATION));
3777 pinnedDomainSslIssuedToUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT));
3778 pinnedDomainSslIssuedByCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_COMMON_NAME));
3779 pinnedDomainSslIssuedByONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATION));
3780 pinnedDomainSslIssuedByUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT));
3782 // Set `nightMode` according to `nightModeInt`. If `nightModeInt` is `DomainsDatabaseHelper.NIGHT_MODE_SYSTEM_DEFAULT` the current setting from `sharedPreferences` will be used.
3783 switch (nightModeInt) {
3784 case DomainsDatabaseHelper.NIGHT_MODE_ENABLED:
3788 case DomainsDatabaseHelper.NIGHT_MODE_DISABLED:
3793 // Set `javaScriptEnabled` to be `true` if `night_mode` is `true`.
3795 javaScriptEnabled = true;
3798 // Set the pinned SSL certificate start date to `null` if the saved date `long` is 0.
3799 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)) == 0) {
3800 pinnedDomainSslStartDate = null;
3802 pinnedDomainSslStartDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)));
3805 // Set the pinned SSL certificate end date to `null` if the saved date `long` is 0.
3806 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)) == 0) {
3807 pinnedDomainSslEndDate = null;
3809 pinnedDomainSslEndDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)));
3812 // Close `currentHostDomainSettingsCursor`.
3813 currentHostDomainSettingsCursor.close();
3815 // Apply the domain settings.
3816 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
3817 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
3818 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
3820 // Apply the form data setting if the API < 26.
3821 if (Build.VERSION.SDK_INT < 26) {
3822 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
3825 // Apply the font size.
3826 if (fontSize == 0) { // Apply the default font size.
3827 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3828 } else { // Apply the specified font size.
3829 mainWebView.getSettings().setTextZoom(fontSize);
3832 // Set third-party cookies status if API >= 21.
3833 if (Build.VERSION.SDK_INT >= 21) {
3834 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
3837 // Only set the user agent if the webpage is not currently loading. Otherwise, changing the user agent on redirects can cause the original website to reload.
3838 // <https://redmine.stoutner.com/issues/160>
3839 if (!urlIsLoading) {
3840 // Set the user agent.
3841 if (userAgentName.equals(getString(R.string.system_default_user_agent))) { // Use the system default user agent.
3842 // Get the array position of the default user agent name.
3843 int defaultUserAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3845 // Set the user agent according to the system default.
3846 switch (defaultUserAgentArrayPosition) {
3847 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
3848 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3849 mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
3852 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3853 // Set the user agent to `""`, which uses the default value.
3854 mainWebView.getSettings().setUserAgentString("");
3857 case SETTINGS_CUSTOM_USER_AGENT:
3858 // Set the custom user agent.
3859 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
3863 // Get the user agent string from the user agent data array
3864 mainWebView.getSettings().setUserAgentString(userAgentDataArray[defaultUserAgentArrayPosition]);
3866 } else { // Set the user agent according to the stored name.
3867 // Get the array position of the user agent name.
3868 int userAgentArrayPosition = userAgentNamesArray.getPosition(userAgentName);
3870 switch (userAgentArrayPosition) {
3871 case UNRECOGNIZED_USER_AGENT: // The user agent name contains a custom user agent.
3872 mainWebView.getSettings().setUserAgentString(userAgentName);
3875 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3876 // Set the user agent to `""`, which uses the default value.
3877 mainWebView.getSettings().setUserAgentString("");
3881 // Get the user agent string from the user agent data array.
3882 mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3886 // Set swipe to refresh.
3887 switch (swipeToRefreshInt) {
3888 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_SYSTEM_DEFAULT:
3889 // Set swipe to refresh according to the default.
3890 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3893 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_ENABLED:
3894 // Enable swipe to refresh.
3895 swipeRefreshLayout.setEnabled(true);
3898 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_DISABLED:
3899 // Disable swipe to refresh.
3900 swipeRefreshLayout.setEnabled(false);
3903 // Store the applied user agent string, which is used in the View Source activity.
3904 appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
3907 // 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.
3909 urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_dark_blue));
3911 urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_light_green));
3913 } else { // The new URL does not have custom domain settings. Load the defaults.
3914 // Store the values from `sharedPreferences` in variables.
3915 javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
3916 firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
3917 thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
3918 domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
3919 saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false); // Form data can be removed once the minimum API >= 26.
3920 easyListEnabled = sharedPreferences.getBoolean("easylist", true);
3921 easyPrivacyEnabled = sharedPreferences.getBoolean("easyprivacy", true);
3922 fanboysAnnoyanceListEnabled = sharedPreferences.getBoolean("fanboy_annoyance_list", true);
3923 fanboysSocialBlockingListEnabled = sharedPreferences.getBoolean("fanboy_social_blocking_list", true);
3924 ultraPrivacyEnabled = sharedPreferences.getBoolean("ultraprivacy", true);
3925 blockAllThirdPartyRequests = sharedPreferences.getBoolean("block_all_third_party_requests", false);
3927 // Set `javaScriptEnabled` to be `true` if `night_mode` is `true`.
3929 javaScriptEnabled = true;
3932 // Apply the default settings.
3933 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
3934 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
3935 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
3936 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3937 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3939 // Apply the form data setting if the API < 26.
3940 if (Build.VERSION.SDK_INT < 26) {
3941 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
3944 // Reset the pinned SSL certificate information.
3945 domainSettingsDatabaseId = -1;
3946 pinnedDomainSslCertificate = false;
3947 pinnedDomainSslIssuedToCNameString = "";
3948 pinnedDomainSslIssuedToONameString = "";
3949 pinnedDomainSslIssuedToUNameString = "";
3950 pinnedDomainSslIssuedByCNameString = "";
3951 pinnedDomainSslIssuedByONameString = "";
3952 pinnedDomainSslIssuedByUNameString = "";
3953 pinnedDomainSslStartDate = null;
3954 pinnedDomainSslEndDate = null;
3956 // Set third-party cookies status if API >= 21.
3957 if (Build.VERSION.SDK_INT >= 21) {
3958 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
3961 // Only set the user agent if the webpage is not currently loading. Otherwise, changing the user agent on redirects can cause the original website to reload.
3962 // <https://redmine.stoutner.com/issues/160>
3963 if (!urlIsLoading) {
3964 // Get the array position of the user agent name.
3965 int userAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3967 // Set the user agent.
3968 switch (userAgentArrayPosition) {
3969 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
3970 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3971 mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
3974 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3975 // Set the user agent to `""`, which uses the default value.
3976 mainWebView.getSettings().setUserAgentString("");
3979 case SETTINGS_CUSTOM_USER_AGENT:
3980 // Set the custom user agent.
3981 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
3985 // Get the user agent string from the user agent data array
3986 mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3989 // Store the applied user agent string, which is used in the View Source activity.
3990 appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
3993 // Set a transparent background on `urlTextBox`. We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
3994 urlAppBarRelativeLayout.setBackgroundDrawable(getResources().getDrawable(R.color.transparent));
3997 // Close `domainsDatabaseHelper`.
3998 domainsDatabaseHelper.close();
4000 // Remove the `onTheFlyDisplayImagesSet` flag and set the display webpage images mode. `true` indicates that custom domain settings are applied.
4001 onTheFlyDisplayImagesSet = false;
4002 setDisplayWebpageImages();
4004 // Update the privacy icons, but only if `mainMenu` has already been populated.
4005 if (mainMenu != null) {
4006 updatePrivacyIcons(true);
4010 // Reload the website if returning from the Domains activity.
4011 if (reloadWebsite) {
4012 mainWebView.reload();
4016 private void setDisplayWebpageImages() {
4017 if (!onTheFlyDisplayImagesSet) {
4018 if (domainSettingsApplied) { // Custom domain settings are applied.
4019 switch (displayWebpageImagesInt) {
4020 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_SYSTEM_DEFAULT:
4021 mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
4024 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_ENABLED:
4025 mainWebView.getSettings().setLoadsImagesAutomatically(true);
4028 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_DISABLED:
4029 mainWebView.getSettings().setLoadsImagesAutomatically(false);
4032 } else { // Default settings are applied.
4033 mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
4038 private void updatePrivacyIcons(boolean runInvalidateOptionsMenu) {
4039 // Get handles for the menu items.
4040 MenuItem privacyMenuItem = mainMenu.findItem(R.id.toggle_javascript);
4041 MenuItem firstPartyCookiesMenuItem = mainMenu.findItem(R.id.toggle_first_party_cookies);
4042 MenuItem domStorageMenuItem = mainMenu.findItem(R.id.toggle_dom_storage);
4043 MenuItem refreshMenuItem = mainMenu.findItem(R.id.refresh);
4045 // Update the privacy icon.
4046 if (javaScriptEnabled) { // JavaScript is enabled.
4047 privacyMenuItem.setIcon(R.drawable.javascript_enabled);
4048 } else if (firstPartyCookiesEnabled) { // JavaScript is disabled but cookies are enabled.
4049 privacyMenuItem.setIcon(R.drawable.warning);
4050 } else { // All the dangerous features are disabled.
4051 privacyMenuItem.setIcon(R.drawable.privacy_mode);
4054 // Update the first-party cookies icon.
4055 if (firstPartyCookiesEnabled) { // First-party cookies are enabled.
4056 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_enabled);
4057 } else { // First-party cookies are disabled.
4059 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_dark);
4061 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_light);
4065 // Update the DOM storage icon.
4066 if (javaScriptEnabled && domStorageEnabled) { // Both JavaScript and DOM storage are enabled.
4067 domStorageMenuItem.setIcon(R.drawable.dom_storage_enabled);
4068 } else if (javaScriptEnabled) { // JavaScript is enabled but DOM storage is disabled.
4070 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_dark);
4072 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_light);
4074 } else { // JavaScript is disabled, so DOM storage is ghosted.
4076 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_dark);
4078 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_light);
4082 // Update the refresh icon.
4084 refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
4086 refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
4089 // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`.
4090 if (runInvalidateOptionsMenu) {
4091 invalidateOptionsMenu();
4095 private void highlightUrlText() {
4096 String urlString = urlTextBox.getText().toString();
4098 if (urlString.startsWith("http://")) { // Highlight the protocol of connections that are not encrypted.
4099 urlTextBox.getText().setSpan(redColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4100 } else if (urlString.startsWith("https://")) { // De-emphasize the protocol of connections that are encrypted.
4101 urlTextBox.getText().setSpan(initialGrayColorSpan, 0, 8, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4104 // Get the index of the `/` immediately after the domain name.
4105 int endOfDomainName = urlString.indexOf("/", (urlString.indexOf("//") + 2));
4107 // De-emphasize the text after the domain name.
4108 if (endOfDomainName > 0) {
4109 urlTextBox.getText().setSpan(finalGrayColorSpan, endOfDomainName, urlString.length(), Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4113 private void loadBookmarksFolder() {
4114 // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
4115 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
4117 // Populate the bookmarks cursor adapter. `this` specifies the `Context`. `false` disables `autoRequery`.
4118 bookmarksCursorAdapter = new CursorAdapter(this, bookmarksCursor, false) {
4120 public View newView(Context context, Cursor cursor, ViewGroup parent) {
4121 // Inflate the individual item layout. `false` does not attach it to the root.
4122 return getLayoutInflater().inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false);
4126 public void bindView(View view, Context context, Cursor cursor) {
4127 // Get handles for the views.
4128 ImageView bookmarkFavoriteIcon = view.findViewById(R.id.bookmark_favorite_icon);
4129 TextView bookmarkNameTextView = view.findViewById(R.id.bookmark_name);
4131 // Get the favorite icon byte array from the cursor.
4132 byte[] favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
4134 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
4135 Bitmap favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.length);
4137 // Display the bitmap in `bookmarkFavoriteIcon`.
4138 bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap);
4140 // Get the bookmark name from the cursor and display it in `bookmarkNameTextView`.
4141 String bookmarkNameString = cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
4142 bookmarkNameTextView.setText(bookmarkNameString);
4144 // Make the font bold for folders.
4145 if (cursor.getInt(cursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {
4146 bookmarkNameTextView.setTypeface(Typeface.DEFAULT_BOLD);
4147 } else { // Reset the font to default for normal bookmarks.
4148 bookmarkNameTextView.setTypeface(Typeface.DEFAULT);
4153 // Populate the `ListView` with the adapter.
4154 bookmarksListView.setAdapter(bookmarksCursorAdapter);
4156 // Set the bookmarks drawer title.
4157 if (currentBookmarksFolder.isEmpty()) {
4158 bookmarksTitleTextView.setText(R.string.bookmarks);
4160 bookmarksTitleTextView.setText(currentBookmarksFolder);