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.Activity;
27 import android.app.DialogFragment;
28 import android.app.DownloadManager;
29 import android.content.ActivityNotFoundException;
30 import android.content.BroadcastReceiver;
31 import android.content.ClipData;
32 import android.content.ClipboardManager;
33 import android.content.Context;
34 import android.content.Intent;
35 import android.content.IntentFilter;
36 import android.content.SharedPreferences;
37 import android.content.pm.PackageManager;
38 import android.content.res.Configuration;
39 import android.database.Cursor;
40 import android.graphics.Bitmap;
41 import android.graphics.BitmapFactory;
42 import android.graphics.Typeface;
43 import android.graphics.drawable.BitmapDrawable;
44 import android.graphics.drawable.Drawable;
45 import android.net.Uri;
46 import android.net.http.SslCertificate;
47 import android.net.http.SslError;
48 import android.os.Build;
49 import android.os.Bundle;
50 import android.os.Environment;
51 import android.os.Handler;
52 import android.preference.PreferenceManager;
53 import android.print.PrintDocumentAdapter;
54 import android.print.PrintManager;
55 import android.support.annotation.NonNull;
56 import android.support.design.widget.CoordinatorLayout;
57 import android.support.design.widget.FloatingActionButton;
58 import android.support.design.widget.NavigationView;
59 import android.support.design.widget.Snackbar;
60 import android.support.v4.app.ActivityCompat;
61 import android.support.v4.content.ContextCompat;
62 // `ShortcutInfoCompat`, `ShortcutManagerCompat`, and `IconCompat` can be switched to the non-compat version once API >= 26.
63 import android.support.v4.content.pm.ShortcutInfoCompat;
64 import android.support.v4.content.pm.ShortcutManagerCompat;
65 import android.support.v4.graphics.drawable.IconCompat;
66 import android.support.v4.view.GravityCompat;
67 import android.support.v4.widget.DrawerLayout;
68 import android.support.v4.widget.SwipeRefreshLayout;
69 import android.support.v7.app.ActionBar;
70 import android.support.v7.app.ActionBarDrawerToggle;
71 import android.support.v7.app.AppCompatActivity;
72 import android.support.v7.app.AppCompatDialogFragment;
73 import android.support.v7.widget.Toolbar;
74 import android.text.Editable;
75 import android.text.Spanned;
76 import android.text.TextWatcher;
77 import android.text.style.ForegroundColorSpan;
78 import android.util.Patterns;
79 import android.view.ContextMenu;
80 import android.view.GestureDetector;
81 import android.view.KeyEvent;
82 import android.view.Menu;
83 import android.view.MenuItem;
84 import android.view.MotionEvent;
85 import android.view.View;
86 import android.view.ViewGroup;
87 import android.view.WindowManager;
88 import android.view.inputmethod.InputMethodManager;
89 import android.webkit.CookieManager;
90 import android.webkit.HttpAuthHandler;
91 import android.webkit.SslErrorHandler;
92 import android.webkit.ValueCallback;
93 import android.webkit.WebBackForwardList;
94 import android.webkit.WebChromeClient;
95 import android.webkit.WebResourceResponse;
96 import android.webkit.WebStorage;
97 import android.webkit.WebView;
98 import android.webkit.WebViewClient;
99 import android.webkit.WebViewDatabase;
100 import android.widget.ArrayAdapter;
101 import android.widget.CursorAdapter;
102 import android.widget.EditText;
103 import android.widget.FrameLayout;
104 import android.widget.ImageView;
105 import android.widget.LinearLayout;
106 import android.widget.ListView;
107 import android.widget.ProgressBar;
108 import android.widget.RadioButton;
109 import android.widget.RelativeLayout;
110 import android.widget.TextView;
112 import com.stoutner.privacybrowser.BuildConfig;
113 import com.stoutner.privacybrowser.R;
114 import com.stoutner.privacybrowser.dialogs.AdConsentDialog;
115 import com.stoutner.privacybrowser.dialogs.CreateBookmarkDialog;
116 import com.stoutner.privacybrowser.dialogs.CreateBookmarkFolderDialog;
117 import com.stoutner.privacybrowser.dialogs.CreateHomeScreenShortcutDialog;
118 import com.stoutner.privacybrowser.dialogs.DownloadImageDialog;
119 import com.stoutner.privacybrowser.dialogs.DownloadLocationPermissionDialog;
120 import com.stoutner.privacybrowser.dialogs.EditBookmarkDialog;
121 import com.stoutner.privacybrowser.dialogs.EditBookmarkFolderDialog;
122 import com.stoutner.privacybrowser.dialogs.HttpAuthenticationDialog;
123 import com.stoutner.privacybrowser.dialogs.PinnedSslCertificateMismatchDialog;
124 import com.stoutner.privacybrowser.dialogs.UrlHistoryDialog;
125 import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog;
126 import com.stoutner.privacybrowser.helpers.AdHelper;
127 import com.stoutner.privacybrowser.helpers.BlockListHelper;
128 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
129 import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper;
130 import com.stoutner.privacybrowser.helpers.OrbotProxyHelper;
131 import com.stoutner.privacybrowser.dialogs.DownloadFileDialog;
132 import com.stoutner.privacybrowser.dialogs.SslCertificateErrorDialog;
134 import java.io.ByteArrayInputStream;
135 import java.io.ByteArrayOutputStream;
137 import java.io.IOException;
138 import java.io.UnsupportedEncodingException;
139 import java.net.MalformedURLException;
141 import java.net.URLDecoder;
142 import java.net.URLEncoder;
143 import java.util.ArrayList;
144 import java.util.Date;
145 import java.util.HashMap;
146 import java.util.HashSet;
147 import java.util.List;
148 import java.util.Map;
149 import java.util.Set;
151 // AppCompatActivity from android.support.v7.app.AppCompatActivity must be used to have access to the SupportActionBar until the minimum API is >= 21.
152 public class MainWebViewActivity extends AppCompatActivity implements CreateBookmarkDialog.CreateBookmarkListener, CreateBookmarkFolderDialog.CreateBookmarkFolderListener,
153 CreateHomeScreenShortcutDialog.CreateHomeScreenShortcutListener, DownloadFileDialog.DownloadFileListener, DownloadImageDialog.DownloadImageListener,
154 DownloadLocationPermissionDialog.DownloadLocationPermissionDialogListener, EditBookmarkDialog.EditBookmarkListener, EditBookmarkFolderDialog.EditBookmarkFolderListener,
155 HttpAuthenticationDialog.HttpAuthenticationListener, NavigationView.OnNavigationItemSelectedListener, PinnedSslCertificateMismatchDialog.PinnedSslCertificateMismatchListener,
156 SslCertificateErrorDialog.SslCertificateErrorListener, UrlHistoryDialog.UrlHistoryListener {
158 // `darkTheme` is public static so it can be accessed from everywhere.
159 public static boolean darkTheme;
161 // `allowScreenshots` is public static so it can be accessed from everywhere. It is also used in `onCreate()`.
162 public static boolean allowScreenshots;
164 // `favoriteIconBitmap` is public static so it can be accessed from `CreateHomeScreenShortcutDialog`, `BookmarksActivity`, `BookmarksDatabaseViewActivity`, `CreateBookmarkDialog`,
165 // `CreateBookmarkFolderDialog`, `EditBookmarkDialog`, `EditBookmarkFolderDialog`, `EditBookmarkDatabaseViewDialog`, and `ViewSslCertificateDialog`. It is also used in `onCreate()`,
166 // `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onCreateHomeScreenShortcutCreate()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `applyDomainSettings()`.
167 public static Bitmap favoriteIconBitmap;
169 // `formattedUrlString` is public static so it can be accessed from `BookmarksActivity`, `CreateBookmarkDialog`, and `AddDomainDialog`.
170 // It is also used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onCreateHomeScreenShortcutCreate()`, `loadUrlFromTextBox()`, and `applyProxyThroughOrbot()`.
171 public static String formattedUrlString;
173 // `sslCertificate` is public static so it can be accessed from `DomainsActivity`, `DomainsListFragment`, `DomainSettingsFragment`, `PinnedSslCertificateMismatchDialog`,
174 // and `ViewSslCertificateDialog`. It is also used in `onCreate()`.
175 public static SslCertificate sslCertificate;
177 // `orbotStatus` is public static so it can be accessed from `OrbotProxyHelper`. It is also used in `onCreate()`, `onResume()`, and `applyProxyThroughOrbot()`.
178 public static String orbotStatus;
180 // `webViewTitle` is public static so it can be accessed from `CreateBookmarkDialog` and `CreateHomeScreenShortcutDialog`. It is also used in `onCreate()`.
181 public static String webViewTitle;
183 // `appliedUserAgentString` is public static so it can be accessed from `ViewSourceActivity`. It is also used in `applyDomainSettings()`.
184 public static String appliedUserAgentString;
186 // `reloadOnRestart` is public static so it can be accessed from `SettingsFragment`. It is also used in `onRestart()`
187 public static boolean reloadOnRestart;
189 // `reloadUrlOnRestart` is public static so it can be accessed from `SettingsFragment` and `BookmarksActivity`. It is also used in `onRestart()`.
190 public static boolean loadUrlOnRestart;
192 // `restartFromBookmarksActivity` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onRestart()`.
193 public static boolean restartFromBookmarksActivity;
195 // The block list versions are public static so they can be accessed from `AboutTabFragment`. They are also used in `onCreate()`.
196 public static String easyListVersion;
197 public static String easyPrivacyVersion;
198 public static String fanboysAnnoyanceVersion;
199 public static String fanboysSocialVersion;
200 public static String ultraPrivacyVersion;
202 // The request items are public static so they can be accessed by `BlockListHelper`, `RequestsArrayAdapter`, and `ViewRequestsDialog`. They are also used in `onCreate()` and `onPrepareOptionsMenu()`.
203 public static List<String[]> resourceRequests;
204 public static String[] whiteListResultStringArray;
205 private int blockedRequests;
206 private int easyListBlockedRequests;
207 private int easyPrivacyBlockedRequests;
208 private int fanboysAnnoyanceListBlockedRequests;
209 private int fanboysSocialBlockingListBlockedRequests;
210 private int ultraPrivacyBlockedRequests;
211 private int thirdPartyBlockedRequests;
213 public final static int REQUEST_DISPOSITION = 0;
214 public final static int REQUEST_URL = 1;
215 public final static int REQUEST_BLOCKLIST = 2;
216 public final static int REQUEST_SUBLIST = 3;
217 public final static int REQUEST_BLOCKLIST_ENTRIES = 4;
218 public final static int REQUEST_BLOCKLIST_ORIGINAL_ENTRY = 5;
220 public final static int REQUEST_DEFAULT = 0;
221 public final static int REQUEST_ALLOWED = 1;
222 public final static int REQUEST_THIRD_PARTY = 2;
223 public final static int REQUEST_BLOCKED = 3;
225 public final static int MAIN_WHITELIST = 1;
226 public final static int FINAL_WHITELIST = 2;
227 public final static int DOMAIN_WHITELIST = 3;
228 public final static int DOMAIN_INITIAL_WHITELIST = 4;
229 public final static int DOMAIN_FINAL_WHITELIST = 5;
230 public final static int THIRD_PARTY_WHITELIST = 6;
231 public final static int THIRD_PARTY_DOMAIN_WHITELIST = 7;
232 public final static int THIRD_PARTY_DOMAIN_INITIAL_WHITELIST = 8;
234 public final static int MAIN_BLACKLIST = 9;
235 public final static int INITIAL_BLACKLIST = 10;
236 public final static int FINAL_BLACKLIST = 11;
237 public final static int DOMAIN_BLACKLIST = 12;
238 public final static int DOMAIN_INITIAL_BLACKLIST = 13;
239 public final static int DOMAIN_FINAL_BLACKLIST = 14;
240 public final static int DOMAIN_REGULAR_EXPRESSION_BLACKLIST = 15;
241 public final static int THIRD_PARTY_BLACKLIST = 16;
242 public final static int THIRD_PARTY_INITIAL_BLACKLIST = 17;
243 public final static int THIRD_PARTY_DOMAIN_BLACKLIST = 18;
244 public final static int THIRD_PARTY_DOMAIN_INITIAL_BLACKLIST = 19;
245 public final static int THIRD_PARTY_REGULAR_EXPRESSION_BLACKLIST = 20;
246 public final static int THIRD_PARTY_DOMAIN_REGULAR_EXPRESSION_BLACKLIST = 21;
247 public final static int REGULAR_EXPRESSION_BLACKLIST = 22;
249 // `blockAllThirdPartyRequests` is public static so it can be accessed from `RequestsActivity`.
250 // It is also used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyAppSettings()`
251 public static boolean blockAllThirdPartyRequests;
253 // `currentBookmarksFolder` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onCreate()`, `onBackPressed()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`,
254 // `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
255 public static String currentBookmarksFolder;
257 // `domainSettingsDatabaseId` is public static so it can be accessed from `PinnedSslCertificateMismatchDialog`. It is also used in `onCreate()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
258 public static int domainSettingsDatabaseId;
260 // The pinned domain SSL Certificate variables are public static so they can be accessed from `PinnedSslCertificateMismatchDialog`. They are also used in `onCreate()` and `applyDomainSettings()`.
261 public static String pinnedDomainSslIssuedToCNameString;
262 public static String pinnedDomainSslIssuedToONameString;
263 public static String pinnedDomainSslIssuedToUNameString;
264 public static String pinnedDomainSslIssuedByCNameString;
265 public static String pinnedDomainSslIssuedByONameString;
266 public static String pinnedDomainSslIssuedByUNameString;
267 public static Date pinnedDomainSslStartDate;
268 public static Date pinnedDomainSslEndDate;
270 // The user agent constants are public static so they can be accessed from `SettingsFragment`, `DomainsActivity`, and `DomainSettingsFragment`.
271 public final static int UNRECOGNIZED_USER_AGENT = -1;
272 public final static int SETTINGS_WEBVIEW_DEFAULT_USER_AGENT = 1;
273 public final static int SETTINGS_CUSTOM_USER_AGENT = 12;
274 public final static int DOMAINS_SYSTEM_DEFAULT_USER_AGENT = 0;
275 public final static int DOMAINS_WEBVIEW_DEFAULT_USER_AGENT = 2;
276 public final static int DOMAINS_CUSTOM_USER_AGENT = 13;
279 // `appBar` is used in `onCreate()`, `onOptionsItemSelected()`, `closeFindOnPage()`, `applyAppSettings()`, and `applyProxyThroughOrbot()`.
280 private ActionBar appBar;
282 // `navigatingHistory` is used in `onCreate()`, `onNavigationItemSelected()`, `onSslMismatchBack()`, and `applyDomainSettings()`.
283 private boolean navigatingHistory;
285 // `favoriteIconDefaultBitmap` is used in `onCreate()` and `applyDomainSettings`.
286 private Bitmap favoriteIconDefaultBitmap;
288 // `drawerLayout` is used in `onCreate()`, `onNewIntent()`, `onBackPressed()`, and `onRestart()`.
289 private DrawerLayout drawerLayout;
291 // `rootCoordinatorLayout` is used in `onCreate()` and `applyAppSettings()`.
292 private CoordinatorLayout rootCoordinatorLayout;
294 // `mainWebView` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`,
295 // `findNextOnPage()`, `closeFindOnPage()`, `loadUrlFromTextBox()`, `onSslMismatchBack()`, `setDisplayWebpageImages()`, and `applyProxyThroughOrbot()`.
296 private WebView mainWebView;
298 // `fullScreenVideoFrameLayout` is used in `onCreate()` and `onConfigurationChanged()`.
299 private FrameLayout fullScreenVideoFrameLayout;
301 // `swipeRefreshLayout` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `onRestart()`.
302 private SwipeRefreshLayout swipeRefreshLayout;
304 // `urlAppBarRelativeLayout` is used in `onCreate()` and `applyDomainSettings()`.
305 private RelativeLayout urlAppBarRelativeLayout;
307 // `favoriteIconImageView` is used in `onCreate()` and `applyDomainSettings()`
308 private ImageView favoriteIconImageView;
310 // `cookieManager` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`, `loadUrlFromTextBox()`, `onDownloadImage()`, `onDownloadFile()`, and `onRestart()`.
311 private CookieManager cookieManager;
313 // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrl()`.
314 private final Map<String, String> customHeaders = new HashMap<>();
316 // `javaScriptEnabled` is also used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `applyDomainSettings()`, and `updatePrivacyIcons()`.
317 private boolean javaScriptEnabled;
319 // `firstPartyCookiesEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onDownloadImage()`, `onDownloadFile()`, and `applyDomainSettings()`.
320 private boolean firstPartyCookiesEnabled;
322 // `thirdPartyCookiesEnabled` used in `onCreate()`, `onPrepareOptionsMenu()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
323 private boolean thirdPartyCookiesEnabled;
325 // `domStorageEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
326 private boolean domStorageEnabled;
328 // `saveFormDataEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`. It can be removed once the minimum API >= 26.
329 private boolean saveFormDataEnabled;
331 // `nightMode` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
332 private boolean nightMode;
334 // `displayWebpageImagesBoolean` is used in `applyAppSettings()` and `applyDomainSettings()`.
335 private boolean displayWebpageImagesBoolean;
337 // 'homepage' is used in `onCreate()`, `onNavigationItemSelected()`, and `applyProxyThroughOrbot()`.
338 private String homepage;
340 // `searchURL` is used in `loadURLFromTextBox()` and `applyProxyThroughOrbot()`.
341 private String searchURL;
343 // `mainMenu` is used in `onCreateOptionsMenu()` and `updatePrivacyIcons()`.
344 private Menu mainMenu;
346 // `refreshMenuItem` is used in `onCreate()` and `onCreateOptionsMenu()`.
347 private MenuItem refreshMenuItem;
349 // The blocklist menu items are used in `onCreate()`, `onCreateOptionsMenu()`, and `onPrepareOptionsMenu()`.
350 private MenuItem blocklistsMenuItem;
351 private MenuItem easyListMenuItem;
352 private MenuItem easyPrivacyMenuItem;
353 private MenuItem fanboysAnnoyanceListMenuItem;
354 private MenuItem fanboysSocialBlockingListMenuItem;
355 private MenuItem ultraPrivacyMenuItem;
356 private MenuItem blockAllThirdPartyRequestsMenuItem;
358 // The blocklist variables are used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
359 private boolean easyListEnabled;
360 private boolean easyPrivacyEnabled;
361 private boolean fanboysAnnoyanceListEnabled;
362 private boolean fanboysSocialBlockingListEnabled;
363 private boolean ultraPrivacyEnabled;
365 // `webViewDefaultUserAgent` is used in `onCreate()` and `onPrepareOptionsMenu()`.
366 private String webViewDefaultUserAgent;
368 // `defaultCustomUserAgentString` is used in `onPrepareOptionsMenu()` and `applyDomainSettings()`.
369 private String defaultCustomUserAgentString;
371 // `privacyBrowserRuntime` is used in `onCreate()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
372 private Runtime privacyBrowserRuntime;
374 // `proxyThroughOrbot` is used in `onRestart()`, `onOptionsItemSelected()`, `applyAppSettings()`, and `applyProxyThroughOrbot()`.
375 private boolean proxyThroughOrbot;
377 // `incognitoModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
378 private boolean incognitoModeEnabled;
380 // `fullScreenBrowsingModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
381 private boolean fullScreenBrowsingModeEnabled;
383 // `inFullScreenBrowsingMode` is used in `onCreate()`, `onConfigurationChanged()`, and `applyAppSettings()`.
384 private boolean inFullScreenBrowsingMode;
386 // `hideSystemBarsOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
387 private boolean hideSystemBarsOnFullscreen;
389 // `translucentNavigationBarOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
390 private boolean translucentNavigationBarOnFullscreen;
392 // `reapplyDomainSettingsOnRestart` is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, and `onAddDomain()`, .
393 private boolean reapplyDomainSettingsOnRestart;
395 // `reapplyAppSettingsOnRestart` is used in `onNavigationItemSelected()` and `onRestart()`.
396 private boolean reapplyAppSettingsOnRestart;
398 // `displayingFullScreenVideo` is used in `onCreate()` and `onResume()`.
399 private boolean displayingFullScreenVideo;
401 // `currentDomainName` is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onAddDomain()`, and `applyDomainSettings()`.
402 private String currentDomainName;
404 // `ignorePinnedSslCertificateForDomain` is used in `onCreate()`, `onSslMismatchProceed()`, and `applyDomainSettings()`.
405 private boolean ignorePinnedSslCertificate;
407 // `orbotStatusBroadcastReceiver` is used in `onCreate()` and `onDestroy()`.
408 private BroadcastReceiver orbotStatusBroadcastReceiver;
410 // `waitingForOrbot` is used in `onCreate()`, `onResume()`, and `applyProxyThroughOrbot()`.
411 private boolean waitingForOrbot;
413 // `domainSettingsApplied` is used in `prepareOptionsMenu()`, `applyDomainSettings()`, and `setDisplayWebpageImages()`.
414 private boolean domainSettingsApplied;
416 // `domainSettingsJavaScriptEnabled` is used in `onOptionsItemSelected()` and `applyDomainSettings()`.
417 private Boolean domainSettingsJavaScriptEnabled;
419 // `displayWebpageImagesInt` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
420 private int displayWebpageImagesInt;
422 // `onTheFlyDisplayImagesSet` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
423 private boolean onTheFlyDisplayImagesSet;
425 // `waitingForOrbotHtmlString` is used in `onCreate()` and `applyProxyThroughOrbot()`.
426 private String waitingForOrbotHtmlString;
428 // `privateDataDirectoryString` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`.
429 private String privateDataDirectoryString;
431 // `findOnPageLinearLayout` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
432 private LinearLayout findOnPageLinearLayout;
434 // `findOnPageEditText` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
435 private EditText findOnPageEditText;
437 // `displayAdditionalAppBarIcons` is used in `onCreate()` and `onCreateOptionsMenu()`.
438 private boolean displayAdditionalAppBarIcons;
440 // `drawerToggle` is used in `onCreate()`, `onPostCreate()`, `onConfigurationChanged()`, `onNewIntent()`, and `onNavigationItemSelected()`.
441 private ActionBarDrawerToggle drawerToggle;
443 // `supportAppBar` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
444 private Toolbar supportAppBar;
446 // `urlTextBox` is used in `onCreate()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, `loadUrl()`, and `highlightUrlText()`.
447 private EditText urlTextBox;
449 // The color spans are used in `onCreate()` and `highlightUrlText()`.
450 private ForegroundColorSpan redColorSpan;
451 private ForegroundColorSpan initialGrayColorSpan;
452 private ForegroundColorSpan finalGrayColorSpan;
454 // `sslErrorHandler` is used in `onCreate()`, `onSslErrorCancel()`, and `onSslErrorProceed`.
455 private SslErrorHandler sslErrorHandler;
457 // `httpAuthHandler` is used in `onCreate()`, `onHttpAuthenticationCancel()`, and `onHttpAuthenticationProceed()`.
458 private static HttpAuthHandler httpAuthHandler;
460 // `inputMethodManager` is used in `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `closeFindOnPage()`.
461 private InputMethodManager inputMethodManager;
463 // `mainWebViewRelativeLayout` is used in `onCreate()` and `onNavigationItemSelected()`.
464 private RelativeLayout mainWebViewRelativeLayout;
466 // `urlIsLoading` is used in `onCreate()`, `onCreateOptionsMenu()`, `loadUrl()`, and `applyDomainSettings()`.
467 private boolean urlIsLoading;
469 // `pinnedDomainSslCertificate` is used in `onCreate()` and `applyDomainSettings()`.
470 private boolean pinnedDomainSslCertificate;
472 // `bookmarksDatabaseHelper` is used in `onCreate()`, `onDestroy`, `onOptionsItemSelected()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`,
473 // and `loadBookmarksFolder()`.
474 private BookmarksDatabaseHelper bookmarksDatabaseHelper;
476 // `bookmarksListView` is used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, and `loadBookmarksFolder()`.
477 private ListView bookmarksListView;
479 // `bookmarksTitleTextView` is used in `onCreate()` and `loadBookmarksFolder()`.
480 private TextView bookmarksTitleTextView;
482 // `bookmarksCursor` is used in `onDestroy()`, `onOptionsItemSelected()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
483 private Cursor bookmarksCursor;
485 // `bookmarksCursorAdapter` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()` `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
486 private CursorAdapter bookmarksCursorAdapter;
488 // `oldFolderNameString` is used in `onCreate()` and `onSaveEditBookmarkFolder()`.
489 private String oldFolderNameString;
491 // `fileChooserCallback` is used in `onCreate()` and `onActivityResult()`.
492 private ValueCallback<Uri[]> fileChooserCallback;
494 // The download strings are used in `onCreate()` and `onRequestPermissionResult()`.
495 private String downloadUrl;
496 private String downloadContentDisposition;
497 private long downloadContentLength;
499 // `downloadImageUrl` is used in `onCreateContextMenu()` and `onRequestPermissionResult()`.
500 private String downloadImageUrl;
502 // The user agent variables are used in `onCreate()` and `applyDomainSettings()`.
503 private ArrayAdapter<CharSequence> userAgentNamesArray;
504 private String[] userAgentDataArray;
506 // The request codes are used in `onCreate()`, `onCreateContextMenu()`, `onCloseDownloadLocationPermissionDialog()`, and `onRequestPermissionResult()`.
507 private final int DOWNLOAD_FILE_REQUEST_CODE = 1;
508 private final int DOWNLOAD_IMAGE_REQUEST_CODE = 2;
511 // 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.
512 // Also, remove the warning about needing to override `performClick()` when using an `OnTouchListener` with `WebView`.
513 @SuppressLint({"SetJavaScriptEnabled", "ClickableViewAccessibility"})
514 // Remove Android Studio's warning about deprecations. We have to use the deprecated `getColor()` until API >= 23.
515 @SuppressWarnings("deprecation")
516 protected void onCreate(Bundle savedInstanceState) {
517 // Get a handle for the shared preferences.
518 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
520 // Get the theme and screenshot preferences.
521 darkTheme = sharedPreferences.getBoolean("dark_theme", false);
522 allowScreenshots = sharedPreferences.getBoolean("allow_screenshots", false);
524 // Disable screenshots if not allowed.
525 if (!allowScreenshots) {
526 getWindow().addFlags(WindowManager.LayoutParams.FLAG_SECURE);
529 // Set the activity theme.
531 setTheme(R.style.PrivacyBrowserDark);
533 setTheme(R.style.PrivacyBrowserLight);
536 // Run the default commands.
537 super.onCreate(savedInstanceState);
539 // Set the content view.
540 setContentView(R.layout.main_drawerlayout);
542 // Get a handle for `inputMethodManager`.
543 inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
545 // `SupportActionBar` from `android.support.v7.app.ActionBar` must be used until the minimum API is >= 21.
546 supportAppBar = findViewById(R.id.app_bar);
547 setSupportActionBar(supportAppBar);
548 appBar = getSupportActionBar();
550 // This is needed to get rid of the Android Studio warning that `appBar` might be null.
551 assert appBar != null;
553 // Add the custom `url_app_bar` layout, which shows the favorite icon and the URL text bar.
554 appBar.setCustomView(R.layout.url_app_bar);
555 appBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
557 // Initialize the foreground color spans for highlighting the URLs. We have to use the deprecated `getColor()` until API >= 23.
558 redColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.red_a700));
559 initialGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
560 finalGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
562 // Get a handle for `urlTextBox`.
563 urlTextBox = findViewById(R.id.url_edittext);
565 // Remove the formatting from `urlTextBar` when the user is editing the text.
566 urlTextBox.setOnFocusChangeListener((View v, boolean hasFocus) -> {
567 if (hasFocus) { // The user is editing the URL text box.
568 // Remove the highlighting.
569 urlTextBox.getText().removeSpan(redColorSpan);
570 urlTextBox.getText().removeSpan(initialGrayColorSpan);
571 urlTextBox.getText().removeSpan(finalGrayColorSpan);
572 } else { // The user has stopped editing the URL text box.
573 // Move to the beginning of the string.
574 urlTextBox.setSelection(0);
576 // Reapply the highlighting.
581 // Set the go button on the keyboard to load the URL in `urlTextBox`.
582 urlTextBox.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
583 // If the event is a key-down event on the `enter` button, load the URL.
584 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
585 // Load the URL into the mainWebView and consume the event.
587 loadUrlFromTextBox();
588 } catch (UnsupportedEncodingException e) {
591 // If the enter key was pressed, consume the event.
594 // If any other key was pressed, do not consume the event.
599 // Set `waitingForOrbotHTMLString`.
600 waitingForOrbotHtmlString = "<html><body><br/><center><h1>" + getString(R.string.waiting_for_orbot) + "</h1></center></body></html>";
602 // Initialize `currentDomainName`, `orbotStatus`, and `waitingForOrbot`.
603 currentDomainName = "";
604 orbotStatus = "unknown";
605 waitingForOrbot = false;
607 // Create an Orbot status `BroadcastReceiver`.
608 orbotStatusBroadcastReceiver = new BroadcastReceiver() {
610 public void onReceive(Context context, Intent intent) {
611 // Store the content of the status message in `orbotStatus`.
612 orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS");
614 // If Privacy Browser is waiting on Orbot, load the website now that Orbot is connected.
615 if (orbotStatus.equals("ON") && waitingForOrbot) {
616 // Reset `waitingForOrbot`.
617 waitingForOrbot = false;
619 // Load `formattedUrlString
620 loadUrl(formattedUrlString);
625 // Register `orbotStatusBroadcastReceiver` on `this` context.
626 this.registerReceiver(orbotStatusBroadcastReceiver, new IntentFilter("org.torproject.android.intent.action.STATUS"));
628 // Get handles for views that need to be accessed.
629 drawerLayout = findViewById(R.id.drawerlayout);
630 rootCoordinatorLayout = findViewById(R.id.root_coordinatorlayout);
631 bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
632 bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview);
633 FloatingActionButton launchBookmarksActivityFab = findViewById(R.id.launch_bookmarks_activity_fab);
634 FloatingActionButton createBookmarkFolderFab = findViewById(R.id.create_bookmark_folder_fab);
635 FloatingActionButton createBookmarkFab = findViewById(R.id.create_bookmark_fab);
636 mainWebViewRelativeLayout = findViewById(R.id.main_webview_relativelayout);
637 mainWebView = findViewById(R.id.main_webview);
638 findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
639 findOnPageEditText = findViewById(R.id.find_on_page_edittext);
640 fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
641 urlAppBarRelativeLayout = findViewById(R.id.url_app_bar_relativelayout);
642 favoriteIconImageView = findViewById(R.id.favorite_icon);
644 // 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.
646 launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_dark));
647 createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_dark));
648 createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_dark));
649 bookmarksListView.setBackgroundColor(getResources().getColor(R.color.gray_850));
651 launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_light));
652 createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_light));
653 createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_light));
654 bookmarksListView.setBackgroundColor(getResources().getColor(R.color.white));
657 // Set the launch bookmarks activity FAB to launch the bookmarks activity.
658 launchBookmarksActivityFab.setOnClickListener(v -> {
659 // Create an intent to launch the bookmarks activity.
660 Intent bookmarksIntent = new Intent(getApplicationContext(), BookmarksActivity.class);
662 // Include the current folder with the `Intent`.
663 bookmarksIntent.putExtra("Current Folder", currentBookmarksFolder);
666 startActivity(bookmarksIntent);
669 // Set the create new bookmark folder FAB to display an alert dialog.
670 createBookmarkFolderFab.setOnClickListener(v -> {
671 // Show the `CreateBookmarkFolderDialog` `AlertDialog` and name the instance `@string/create_folder`.
672 AppCompatDialogFragment createBookmarkFolderDialog = new CreateBookmarkFolderDialog();
673 createBookmarkFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_folder));
676 // Set the create new bookmark FAB to display an alert dialog.
677 createBookmarkFab.setOnClickListener(view -> {
678 // Show the `CreateBookmarkDialog` `AlertDialog` and name the instance `@string/create_bookmark`.
679 AppCompatDialogFragment createBookmarkDialog = new CreateBookmarkDialog();
680 createBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_bookmark));
683 // Create a double-tap listener to toggle full-screen mode.
684 final GestureDetector gestureDetector = new GestureDetector(this, new GestureDetector.SimpleOnGestureListener() {
685 // Override `onDoubleTap()`. All other events are handled using the default settings.
687 public boolean onDoubleTap(MotionEvent event) {
688 if (fullScreenBrowsingModeEnabled) { // Only process the double-tap if full screen browsing mode is enabled.
689 // Toggle `inFullScreenBrowsingMode`.
690 inFullScreenBrowsingMode = !inFullScreenBrowsingMode;
692 if (inFullScreenBrowsingMode) { // Switch to full screen mode.
693 // Hide the `appBar`.
696 // Hide the banner ad in the free flavor.
697 if (BuildConfig.FLAVOR.contentEquals("free")) {
698 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
699 AdHelper.hideAd(findViewById(R.id.adview));
702 // Modify the system bars.
703 if (hideSystemBarsOnFullscreen) { // Hide everything.
704 // Remove the translucent overlays.
705 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
707 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
708 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
710 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
711 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
712 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
714 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
716 // Set `rootCoordinatorLayout` to fill the whole screen.
717 rootCoordinatorLayout.setFitsSystemWindows(false);
718 } else { // Hide everything except the status and navigation bars.
719 // Set `rootCoordinatorLayout` to fit under the status and navigation bars.
720 rootCoordinatorLayout.setFitsSystemWindows(false);
722 // 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.
723 if (translucentNavigationBarOnFullscreen) {
724 // Set the navigation bar to be translucent.
725 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
728 } else { // Switch to normal viewing mode.
729 // Show the `appBar`.
732 // Show the `BannerAd` in the free flavor.
733 if (BuildConfig.FLAVOR.contentEquals("free")) {
734 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
735 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
738 // Remove the translucent navigation bar flag if it is set.
739 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
741 // Add the translucent status flag if it is unset. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
742 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
744 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
745 rootCoordinatorLayout.setSystemUiVisibility(0);
747 // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
748 rootCoordinatorLayout.setFitsSystemWindows(true);
751 // Consume the double-tap.
753 } else { // Do not consume the double-tap because full screen browsing mode is disabled.
759 // Pass all touch events on `mainWebView` through `gestureDetector` to check for double-taps.
760 mainWebView.setOnTouchListener((View v, MotionEvent event) -> {
761 // Call `performClick()` on the view, which is required for accessibility.
764 // Send the `event` to `gestureDetector`.
765 return gestureDetector.onTouchEvent(event);
768 // Update `findOnPageCountTextView`.
769 mainWebView.setFindListener(new WebView.FindListener() {
770 // Get a handle for `findOnPageCountTextView`.
771 final TextView findOnPageCountTextView = (TextView) findViewById(R.id.find_on_page_count_textview);
774 public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, boolean isDoneCounting) {
775 if ((isDoneCounting) && (numberOfMatches == 0)) { // There are no matches.
776 // Set `findOnPageCountTextView` to `0/0`.
777 findOnPageCountTextView.setText(R.string.zero_of_zero);
778 } else if (isDoneCounting) { // There are matches.
779 // `activeMatchOrdinal` is zero-based.
780 int activeMatch = activeMatchOrdinal + 1;
782 // Build the match string.
783 String matchString = activeMatch + "/" + numberOfMatches;
785 // Set `findOnPageCountTextView`.
786 findOnPageCountTextView.setText(matchString);
791 // Search for the string on the page whenever a character changes in the `findOnPageEditText`.
792 findOnPageEditText.addTextChangedListener(new TextWatcher() {
794 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
799 public void onTextChanged(CharSequence s, int start, int before, int count) {
804 public void afterTextChanged(Editable s) {
805 // Search for the text in `mainWebView`.
806 mainWebView.findAllAsync(findOnPageEditText.getText().toString());
810 // Set the `check mark` button for the `findOnPageEditText` keyboard to close the soft keyboard.
811 findOnPageEditText.setOnKeyListener((v, keyCode, event) -> {
812 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) { // The `enter` key was pressed.
813 // Hide the soft keyboard. `0` indicates no additional flags.
814 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
816 // Consume the event.
818 } else { // A different key was pressed.
819 // Do not consume the event.
824 // Implement swipe to refresh
825 swipeRefreshLayout = findViewById(R.id.swipe_refreshlayout);
826 swipeRefreshLayout.setColorSchemeResources(R.color.blue_700);
827 swipeRefreshLayout.setOnRefreshListener(() -> mainWebView.reload());
829 // `DrawerTitle` identifies the `DrawerLayouts` in accessibility mode.
830 drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer));
831 drawerLayout.setDrawerTitle(GravityCompat.END, getString(R.string.bookmarks));
833 // Listen for touches on the navigation menu.
834 final NavigationView navigationView = findViewById(R.id.navigationview);
835 navigationView.setNavigationItemSelectedListener(this);
837 // 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.
838 final Menu navigationMenu = navigationView.getMenu();
839 final MenuItem navigationBackMenuItem = navigationMenu.getItem(1);
840 final MenuItem navigationForwardMenuItem = navigationMenu.getItem(2);
841 final MenuItem navigationHistoryMenuItem = navigationMenu.getItem(3);
842 final MenuItem navigationRequestsMenuItem = navigationMenu.getItem(4);
844 // Initialize the bookmarks database helper. `this` specifies the context. The two `nulls` do not specify the database name or a `CursorFactory`.
845 // The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
846 bookmarksDatabaseHelper = new BookmarksDatabaseHelper(this, null, null, 0);
848 // Initialize `currentBookmarksFolder`. `""` is the home folder in the database.
849 currentBookmarksFolder = "";
851 // Load the home folder, which is `""` in the database.
852 loadBookmarksFolder();
854 bookmarksListView.setOnItemClickListener((parent, view, position, id) -> {
855 // Convert the id from long to int to match the format of the bookmarks database.
856 int databaseID = (int) id;
858 // Get the bookmark cursor for this ID and move it to the first row.
859 Cursor bookmarkCursor = bookmarksDatabaseHelper.getBookmarkCursor(databaseID);
860 bookmarkCursor.moveToFirst();
862 // Act upon the bookmark according to the type.
863 if (bookmarkCursor.getInt(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) { // The selected bookmark is a folder.
864 // Store the new folder name in `currentBookmarksFolder`.
865 currentBookmarksFolder = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
867 // Load the new folder.
868 loadBookmarksFolder();
869 } else { // The selected bookmark is not a folder.
870 // Load the bookmark URL.
871 loadUrl(bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_URL)));
873 // Close the bookmarks drawer.
874 drawerLayout.closeDrawer(GravityCompat.END);
877 // Close the `Cursor`.
878 bookmarkCursor.close();
881 bookmarksListView.setOnItemLongClickListener((parent, view, position, id) -> {
882 // Convert the database ID from `long` to `int`.
883 int databaseId = (int) id;
885 // Find out if the selected bookmark is a folder.
886 boolean isFolder = bookmarksDatabaseHelper.isFolder(databaseId);
889 // Save the current folder name, which is used in `onSaveEditBookmarkFolder()`.
890 oldFolderNameString = bookmarksCursor.getString(bookmarksCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
892 // Show the edit bookmark folder `AlertDialog` and name the instance `@string/edit_folder`.
893 AppCompatDialogFragment editFolderDialog = EditBookmarkFolderDialog.folderDatabaseId(databaseId);
894 editFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_folder));
896 // Show the edit bookmark `AlertDialog` and name the instance `@string/edit_bookmark`.
897 AppCompatDialogFragment editBookmarkDialog = EditBookmarkDialog.bookmarkDatabaseId(databaseId);
898 editBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_bookmark));
901 // Consume the event.
905 // The drawer listener is used to update the navigation menu.
906 drawerLayout.addDrawerListener(new DrawerLayout.DrawerListener() {
908 public void onDrawerSlide(@NonNull View drawerView, float slideOffset) {
912 public void onDrawerOpened(@NonNull View drawerView) {
916 public void onDrawerClosed(@NonNull View drawerView) {
920 public void onDrawerStateChanged(int newState) {
921 if ((newState == DrawerLayout.STATE_SETTLING) || (newState == DrawerLayout.STATE_DRAGGING)) { // A drawer is opening or closing.
922 // Update the back, forward, history, and requests menu items.
923 navigationBackMenuItem.setEnabled(mainWebView.canGoBack());
924 navigationForwardMenuItem.setEnabled(mainWebView.canGoForward());
925 navigationHistoryMenuItem.setEnabled((mainWebView.canGoBack() || mainWebView.canGoForward()));
926 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
928 // Hide the keyboard (if displayed).
929 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
931 // Clear the focus from from the URL text box.
932 urlTextBox.clearFocus();
937 // drawerToggle creates the hamburger icon at the start of the AppBar.
938 drawerToggle = new ActionBarDrawerToggle(this, drawerLayout, supportAppBar, R.string.open_navigation_drawer, R.string.close_navigation_drawer);
940 // Get a handle for the progress bar.
941 final ProgressBar progressBar = findViewById(R.id.progress_bar);
943 mainWebView.setWebChromeClient(new WebChromeClient() {
944 // Update the progress bar when a page is loading.
946 public void onProgressChanged(WebView view, int progress) {
947 // Inject the night mode CSS if night mode is enabled.
949 // `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
950 // used by WordPress. `text-decoration: none` removes all text underlines. `text-shadow: none` removes text shadows, which usually have a hard coded color.
951 // `border: none` removes all borders, which can also be used to underline text.
952 // `a {color: #1565C0}` sets links to be a dark blue. `!important` takes precedent over any existing sub-settings.
953 mainWebView.evaluateJavascript("(function() {var parent = document.getElementsByTagName('head').item(0); var style = document.createElement('style'); style.type = 'text/css'; " +
954 "style.innerHTML = '* {background-color: #212121 !important; color: #BDBDBD !important; box-shadow: none !important; text-decoration: none !important;" +
955 "text-shadow: none !important; border: none !important;} a {color: #1565C0 !important;}'; parent.appendChild(style)})()", value -> {
956 // Initialize a handler to display `mainWebView`.
957 Handler displayWebViewHandler = new Handler();
959 // Setup a runnable to display `mainWebView` after a delay to allow the CSS to be applied.
960 Runnable displayWebViewRunnable = () -> {
961 // Only display `mainWebView` if the progress bar is one. This prevents the display of the `WebView` while it is still loading.
962 if (progressBar.getVisibility() == View.GONE) {
963 mainWebView.setVisibility(View.VISIBLE);
967 // Displaying of `mainWebView` after 500 milliseconds.
968 displayWebViewHandler.postDelayed(displayWebViewRunnable, 500);
972 // Update the progress bar.
973 progressBar.setProgress(progress);
975 // Set the visibility of the progress bar.
976 if (progress < 100) {
977 // Show the progress bar.
978 progressBar.setVisibility(View.VISIBLE);
980 // Hide the progress bar.
981 progressBar.setVisibility(View.GONE);
983 // Display `mainWebView` if night mode is disabled.
984 // 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
985 // currently enabled.
987 mainWebView.setVisibility(View.VISIBLE);
990 //Stop the swipe to refresh indicator if it is running
991 swipeRefreshLayout.setRefreshing(false);
995 // Set the favorite icon when it changes.
997 public void onReceivedIcon(WebView view, Bitmap icon) {
998 // Only update the favorite icon if the website has finished loading.
999 if (progressBar.getVisibility() == View.GONE) {
1000 // Save a copy of the favorite icon.
1001 favoriteIconBitmap = icon;
1003 // Place the favorite icon in the appBar.
1004 favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
1008 // Save a copy of the title when it changes.
1010 public void onReceivedTitle(WebView view, String title) {
1011 // Save a copy of the title.
1012 webViewTitle = title;
1015 // Enter full screen video.
1017 public void onShowCustomView(View view, CustomViewCallback callback) {
1018 // Set the full screen video flag.
1019 displayingFullScreenVideo = true;
1021 // Pause the ad if this is the free flavor.
1022 if (BuildConfig.FLAVOR.contentEquals("free")) {
1023 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1024 AdHelper.pauseAd(findViewById(R.id.adview));
1027 // Remove the translucent overlays.
1028 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1030 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
1031 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
1033 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
1034 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
1035 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
1037 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
1039 // Set `rootCoordinatorLayout` to fill the entire screen.
1040 rootCoordinatorLayout.setFitsSystemWindows(false);
1042 // Disable the sliding drawers.
1043 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED);
1045 // Add `view` to `fullScreenVideoFrameLayout` and display it on the screen.
1046 fullScreenVideoFrameLayout.addView(view);
1047 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
1050 // Exit full screen video.
1052 public void onHideCustomView() {
1053 // Unset the full screen video flag.
1054 displayingFullScreenVideo = false;
1056 // Hide `fullScreenVideoFrameLayout`.
1057 fullScreenVideoFrameLayout.removeAllViews();
1058 fullScreenVideoFrameLayout.setVisibility(View.GONE);
1060 // Enable the sliding drawers.
1061 drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED);
1063 // Apply the appropriate full screen mode the `SYSTEM_UI` flags.
1064 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
1065 if (hideSystemBarsOnFullscreen) { // Hide everything.
1066 // Remove the translucent navigation setting if it is currently flagged.
1067 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
1069 // Remove the translucent status bar overlay.
1070 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1072 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
1073 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
1075 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
1076 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
1077 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
1079 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
1080 } else { // Hide everything except the status and navigation bars.
1081 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
1082 rootCoordinatorLayout.setSystemUiVisibility(0);
1084 // Add the translucent status flag if it is unset.
1085 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1087 if (translucentNavigationBarOnFullscreen) {
1088 // Set the navigation bar to be translucent. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
1089 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
1091 // Set the navigation bar to be black.
1092 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
1095 } else { // Switch to normal viewing mode.
1096 // Show the `appBar` if `findOnPageLinearLayout` is not visible.
1097 if (findOnPageLinearLayout.getVisibility() == View.GONE) {
1101 // Show the `BannerAd` in the free flavor.
1102 if (BuildConfig.FLAVOR.contentEquals("free")) {
1103 // Initialize the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1104 AdHelper.initializeAds(findViewById(R.id.adview), getApplicationContext(), getFragmentManager(), getString(R.string.google_app_id), getString(R.string.ad_unit_id));
1107 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
1108 rootCoordinatorLayout.setSystemUiVisibility(0);
1110 // Remove the translucent navigation bar flag if it is set.
1111 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
1113 // Add the translucent status flag if it is unset. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
1114 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1116 // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
1117 rootCoordinatorLayout.setFitsSystemWindows(true);
1120 // Show the ad if this is the free flavor.
1121 if (BuildConfig.FLAVOR.contentEquals("free")) {
1122 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1123 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
1129 public boolean onShowFileChooser(WebView webView, ValueCallback<Uri[]> filePathCallback, FileChooserParams fileChooserParams) {
1130 // Show the file chooser if the device is running API >= 21.
1131 if (Build.VERSION.SDK_INT >= 21) {
1132 // Store the file path callback.
1133 fileChooserCallback = filePathCallback;
1135 // Create an intent to open a chooser based ont the file chooser parameters.
1136 Intent fileChooserIntent = fileChooserParams.createIntent();
1138 // Open the file chooser. Currently only one `startActivityForResult` exists in this activity, so the request code, used to differentiate them, is simply `0`.
1139 startActivityForResult(fileChooserIntent, 0);
1145 // Register `mainWebView` for a context menu. This is used to see link targets and download images.
1146 registerForContextMenu(mainWebView);
1148 // Allow the downloading of files.
1149 mainWebView.setDownloadListener((String url, String userAgent, String contentDisposition, String mimetype, long contentLength) -> {
1150 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
1151 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
1152 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
1154 // Store the variables for future use by `onRequestPermissionsResult()`.
1156 downloadContentDisposition = contentDisposition;
1157 downloadContentLength = contentLength;
1159 // Show a dialog if the user has previously denied the permission.
1160 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
1161 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
1162 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
1164 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
1165 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
1166 } else { // Show the permission request directly.
1167 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
1168 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
1170 } else { // The storage permission has already been granted.
1171 // Get a handle for the download file alert dialog.
1172 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(url, contentDisposition, contentLength);
1174 // Show the download file alert dialog.
1175 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
1179 // Allow pinch to zoom.
1180 mainWebView.getSettings().setBuiltInZoomControls(true);
1182 // Hide zoom controls.
1183 mainWebView.getSettings().setDisplayZoomControls(false);
1185 // Set `mainWebView` to use a wide viewport. Otherwise, some web pages will be scrunched and some content will render outside the screen.
1186 mainWebView.getSettings().setUseWideViewPort(true);
1188 // Set `mainWebView` to load in overview mode (zoomed out to the maximum width).
1189 mainWebView.getSettings().setLoadWithOverviewMode(true);
1191 // Explicitly disable geolocation.
1192 mainWebView.getSettings().setGeolocationEnabled(false);
1194 // Initialize cookieManager.
1195 cookieManager = CookieManager.getInstance();
1197 // 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).
1198 customHeaders.put("X-Requested-With", "");
1200 // Initialize the default preference values the first time the program is run. `false` keeps this command from resetting any current preferences back to default.
1201 PreferenceManager.setDefaultValues(this, R.xml.preferences, false);
1203 // Get the intent that started the app.
1204 final Intent launchingIntent = getIntent();
1206 // Extract the launching intent data as `launchingIntentUriData`.
1207 final Uri launchingIntentUriData = launchingIntent.getData();
1209 // Convert the launching intent URI data (if it exists) to a string and store it in `formattedUrlString`.
1210 if (launchingIntentUriData != null) {
1211 formattedUrlString = launchingIntentUriData.toString();
1214 // Get a handle for the `Runtime`.
1215 privacyBrowserRuntime = Runtime.getRuntime();
1217 // Store the application's private data directory.
1218 privateDataDirectoryString = getApplicationInfo().dataDir;
1219 // `dataDir` will vary, but will be something like `/data/user/0/com.stoutner.privacybrowser.standard`, which links to `/data/data/com.stoutner.privacybrowser.standard`.
1221 // Initialize `inFullScreenBrowsingMode`, which is always false at this point because Privacy Browser never starts in full screen browsing mode.
1222 inFullScreenBrowsingMode = false;
1224 // Initialize the privacy settings variables.
1225 javaScriptEnabled = false;
1226 firstPartyCookiesEnabled = false;
1227 thirdPartyCookiesEnabled = false;
1228 domStorageEnabled = false;
1229 saveFormDataEnabled = false; // Form data can be removed once the minimum API >= 26.
1232 // Store the default user agent.
1233 webViewDefaultUserAgent = mainWebView.getSettings().getUserAgentString();
1235 // Initialize the WebView title.
1236 webViewTitle = getString(R.string.no_title);
1238 // Initialize the favorite icon bitmap. `ContextCompat` must be used until API >= 21.
1239 Drawable favoriteIconDrawable = ContextCompat.getDrawable(getApplicationContext(), R.drawable.world);
1240 BitmapDrawable favoriteIconBitmapDrawable = (BitmapDrawable) favoriteIconDrawable;
1241 assert favoriteIconBitmapDrawable != null;
1242 favoriteIconDefaultBitmap = favoriteIconBitmapDrawable.getBitmap();
1244 // If the favorite icon is null, load the default.
1245 if (favoriteIconBitmap == null) {
1246 favoriteIconBitmap = favoriteIconDefaultBitmap;
1249 // Initialize the user agent array adapter and string array.
1250 userAgentNamesArray = ArrayAdapter.createFromResource(this, R.array.user_agent_names, R.layout.spinner_item);
1251 userAgentDataArray = getResources().getStringArray(R.array.user_agent_data);
1253 // Apply the app settings from the shared preferences.
1256 // Instantiate the block list helper.
1257 BlockListHelper blockListHelper = new BlockListHelper();
1259 // Initialize the list of resource requests.
1260 resourceRequests = new ArrayList<>();
1262 // Parse the block lists.
1263 final ArrayList<List<String[]>> easyList = blockListHelper.parseBlockList(getAssets(), "blocklists/easylist.txt");
1264 final ArrayList<List<String[]>> easyPrivacy = blockListHelper.parseBlockList(getAssets(), "blocklists/easyprivacy.txt");
1265 final ArrayList<List<String[]>> fanboysAnnoyanceList = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-annoyance.txt");
1266 final ArrayList<List<String[]>> fanboysSocialList = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-social.txt");
1267 final ArrayList<List<String[]>> ultraPrivacy = blockListHelper.parseBlockList(getAssets(), "blocklists/ultraprivacy.txt");
1269 // Store the list versions.
1270 easyListVersion = easyList.get(0).get(0)[0];
1271 easyPrivacyVersion = easyPrivacy.get(0).get(0)[0];
1272 fanboysAnnoyanceVersion = fanboysAnnoyanceList.get(0).get(0)[0];
1273 fanboysSocialVersion = fanboysSocialList.get(0).get(0)[0];
1274 ultraPrivacyVersion = ultraPrivacy.get(0).get(0)[0];
1276 // Get a handle for the activity. This is used to update the requests counter while the navigation menu is open.
1277 Activity activity = this;
1279 mainWebView.setWebViewClient(new WebViewClient() {
1280 // `shouldOverrideUrlLoading` makes this `WebView` the default handler for URLs inside the app, so that links are not kicked out to other apps.
1281 // The deprecated `shouldOverrideUrlLoading` must be used until API >= 24.
1282 @SuppressWarnings("deprecation")
1284 public boolean shouldOverrideUrlLoading(WebView view, String url) {
1285 if (url.startsWith("http")) { // Load the URL in Privacy Browser.
1286 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
1287 formattedUrlString = "";
1289 // Apply the domain settings for the new URL. `applyDomainSettings` doesn't do anything if the domain has not changed.
1290 applyDomainSettings(url, true, false);
1292 // Returning false causes the current WebView to handle the URL and prevents it from adding redirects to the history list.
1294 } else if (url.startsWith("mailto:")) { // Load the email address in an external email program.
1295 // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
1296 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
1298 // Parse the url and set it as the data for the intent.
1299 emailIntent.setData(Uri.parse(url));
1301 // Open the email program in a new task instead of as part of Privacy Browser.
1302 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1305 startActivity(emailIntent);
1307 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1309 } else if (url.startsWith("tel:")) { // Load the phone number in the dialer.
1310 // Open the dialer and load the phone number, but wait for the user to place the call.
1311 Intent dialIntent = new Intent(Intent.ACTION_DIAL);
1313 // Add the phone number to the intent.
1314 dialIntent.setData(Uri.parse(url));
1316 // Open the dialer in a new task instead of as part of Privacy Browser.
1317 dialIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1320 startActivity(dialIntent);
1322 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1324 } else { // Load a system chooser to select an app that can handle the URL.
1325 // Open an app that can handle the URL.
1326 Intent genericIntent = new Intent(Intent.ACTION_VIEW);
1328 // Add the URL to the intent.
1329 genericIntent.setData(Uri.parse(url));
1331 // List all apps that can handle the URL instead of just opening the first one.
1332 genericIntent.addCategory(Intent.CATEGORY_BROWSABLE);
1334 // Open the app in a new task instead of as part of Privacy Browser.
1335 genericIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1337 // Start the app or display a snackbar if no app is available to handle the URL.
1339 startActivity(genericIntent);
1340 } catch (ActivityNotFoundException exception) {
1341 Snackbar.make(mainWebView, getString(R.string.unrecognized_url) + " " + url, Snackbar.LENGTH_SHORT).show();
1344 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1349 // Check requests against the block lists. The deprecated `shouldInterceptRequest()` must be used until minimum API >= 21.
1350 @SuppressWarnings("deprecation")
1352 public WebResourceResponse shouldInterceptRequest(WebView view, String url){
1353 // Create an empty web resource response to be used if the resource request is blocked.
1354 WebResourceResponse emptyWebResourceResponse = new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
1356 // Reset the whitelist results tracker.
1357 whiteListResultStringArray = null;
1359 // Initialize the third party request tracker.
1360 boolean isThirdPartyRequest = false;
1362 // Initialize the current domain string.
1363 String currentDomain = "";
1365 // Nobody is happy when comparing null strings.
1366 if (!(formattedUrlString == null) && !(url == null)) {
1367 // Get the domain strings to URIs.
1368 Uri currentDomainUri = Uri.parse(formattedUrlString);
1369 Uri requestDomainUri = Uri.parse(url);
1371 // Get the domain host names.
1372 String currentBaseDomain = currentDomainUri.getHost();
1373 String requestBaseDomain = requestDomainUri.getHost();
1375 // Update the current domain variable.
1376 currentDomain = currentBaseDomain;
1378 // Only compare the current base domain and the request base domain if neither is null.
1379 if (!(currentBaseDomain == null) && !(requestBaseDomain == null)) {
1380 // Determine the current base domain.
1381 while (currentBaseDomain.indexOf(".", currentBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
1382 // Remove the first subdomain.
1383 currentBaseDomain = currentBaseDomain.substring(currentBaseDomain.indexOf(".") + 1);
1386 // Determine the request base domain.
1387 while (requestBaseDomain.indexOf(".", requestBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
1388 // Remove the first subdomain.
1389 requestBaseDomain = requestBaseDomain.substring(requestBaseDomain.indexOf(".") + 1);
1392 // Update the third party request tracker.
1393 isThirdPartyRequest = !currentBaseDomain.equals(requestBaseDomain);
1397 // Block third-party requests if enabled.
1398 if (isThirdPartyRequest && blockAllThirdPartyRequests) {
1399 // Increment the blocked requests counters.
1401 thirdPartyBlockedRequests++;
1403 // Update the titles of the blocklist menu items. This must be run from the UI thread.
1404 activity.runOnUiThread(() -> {
1405 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1406 blocklistsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1407 blockAllThirdPartyRequestsMenuItem.setTitle(thirdPartyBlockedRequests + " - " + getString(R.string.block_all_third_party_requests));
1410 // Add the request to the log.
1411 resourceRequests.add(new String[]{String.valueOf(REQUEST_THIRD_PARTY), url});
1413 // Return an empty web resource response.
1414 return emptyWebResourceResponse;
1417 // Check UltraPrivacy if it is enabled.
1418 if (ultraPrivacyEnabled) {
1419 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, ultraPrivacy)) {
1420 // Increment the blocked requests counters.
1422 ultraPrivacyBlockedRequests++;
1424 // Update the titles of the blocklist menu items. This must be run from the UI thread.
1425 activity.runOnUiThread(() -> {
1426 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1427 blocklistsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1428 ultraPrivacyMenuItem.setTitle(ultraPrivacyBlockedRequests + " - " + getString(R.string.ultraprivacy));
1431 // The resource request was blocked. Return an empty web resource response.
1432 return emptyWebResourceResponse;
1435 // If the whitelist result is not null, the request has been allowed by UltraPrivacy.
1436 if (whiteListResultStringArray != null) {
1437 // Add a whitelist entry to the resource requests array.
1438 resourceRequests.add(whiteListResultStringArray);
1440 // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
1445 // Check EasyList if it is enabled.
1446 if (easyListEnabled) {
1447 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, easyList)) {
1448 // Increment the blocked requests counters.
1450 easyListBlockedRequests++;
1452 // Update the titles of the blocklist menu items. This must be run from the UI thread.
1453 activity.runOnUiThread(() -> {
1454 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1455 blocklistsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1456 easyListMenuItem.setTitle(easyListBlockedRequests + " - " + getString(R.string.easylist));
1459 // Reset the whitelist results tracker (because otherwise it will sometimes add results to the list due to a race condition).
1460 whiteListResultStringArray = null;
1462 // The resource request was blocked. Return an empty web resource response.
1463 return emptyWebResourceResponse;
1467 // Check EasyPrivacy if it is enabled.
1468 if (easyPrivacyEnabled) {
1469 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, easyPrivacy)) {
1470 // Increment the blocked requests counters.
1472 easyPrivacyBlockedRequests++;
1474 // Update the titles of the blocklist menu items. This must be run from the UI thread.
1475 activity.runOnUiThread(() -> {
1476 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1477 blocklistsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1478 easyPrivacyMenuItem.setTitle(easyPrivacyBlockedRequests + " - " + getString(R.string.easyprivacy));
1481 // Reset the whitelist results tracker (because otherwise it will sometimes add results to the list due to a race condition).
1482 whiteListResultStringArray = null;
1484 // The resource request was blocked. Return an empty web resource response.
1485 return emptyWebResourceResponse;
1489 // Check Fanboy’s Annoyance List if it is enabled.
1490 if (fanboysAnnoyanceListEnabled) {
1491 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, fanboysAnnoyanceList)) {
1492 // Increment the blocked requests counters.
1494 fanboysAnnoyanceListBlockedRequests++;
1496 // Update the titles of the blocklist menu items. This must be run from the UI thread.
1497 activity.runOnUiThread(() -> {
1498 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1499 blocklistsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1500 fanboysAnnoyanceListMenuItem.setTitle(fanboysAnnoyanceListBlockedRequests + " - " + getString(R.string.fanboys_annoyance_list));
1503 // Reset the whitelist results tracker (because otherwise it will sometimes add results to the list due to a race condition).
1504 whiteListResultStringArray = null;
1506 // The resource request was blocked. Return an empty web resource response.
1507 return emptyWebResourceResponse;
1509 } else if (fanboysSocialBlockingListEnabled){ // Only check Fanboy’s Social Blocking List if Fanboy’s Annoyance List is disabled.
1510 if (blockListHelper.isBlocked(currentDomain, url, isThirdPartyRequest, fanboysSocialList)) {
1511 // Increment the blocked requests counters.
1513 fanboysSocialBlockingListBlockedRequests++;
1515 // Update the titles of the blocklist menu items. This must be run from the UI thread.
1516 activity.runOnUiThread(() -> {
1517 navigationRequestsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1518 blocklistsMenuItem.setTitle(getString(R.string.requests) + " - " + blockedRequests);
1519 fanboysSocialBlockingListMenuItem.setTitle(fanboysSocialBlockingListBlockedRequests + " - " + getString(R.string.fanboys_social_blocking_list));
1522 // Reset the whitelist results tracker (because otherwise it will sometimes add results to the list due to a race condition).
1523 whiteListResultStringArray = null;
1525 // The resource request was blocked. Return an empty web resource response.
1526 return emptyWebResourceResponse;
1530 // Add the request to the log because it hasn't been processed by any of the previous checks.
1531 if (whiteListResultStringArray != null ) { // The request was processed by a whitelist.
1532 resourceRequests.add(whiteListResultStringArray);
1533 } else { // The request didn't match any blocklist entry. Log it as a default request.
1534 resourceRequests.add(new String[]{String.valueOf(REQUEST_DEFAULT), url});
1537 // The resource request has not been blocked. `return null` loads the requested resource.
1541 // Handle HTTP authentication requests.
1543 public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) {
1544 // Store `handler` so it can be accessed from `onHttpAuthenticationCancel()` and `onHttpAuthenticationProceed()`.
1545 httpAuthHandler = handler;
1547 // Display the HTTP authentication dialog.
1548 AppCompatDialogFragment httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm);
1549 httpAuthenticationDialogFragment.show(getSupportFragmentManager(), getString(R.string.http_authentication));
1552 // Update the URL in urlTextBox when the page starts to load.
1554 public void onPageStarted(WebView view, String url, Bitmap favicon) {
1555 // Reset the list of resource requests.
1556 resourceRequests.clear();
1558 // Initialize the counters for requests blocked by each blocklist.
1559 blockedRequests = 0;
1560 easyListBlockedRequests = 0;
1561 easyPrivacyBlockedRequests = 0;
1562 fanboysAnnoyanceListBlockedRequests = 0;
1563 fanboysSocialBlockingListBlockedRequests = 0;
1564 ultraPrivacyBlockedRequests = 0;
1565 thirdPartyBlockedRequests = 0;
1567 // If night mode is enabled, hide `mainWebView` until after the night mode CSS is applied.
1569 mainWebView.setVisibility(View.INVISIBLE);
1572 // Hide the keyboard. `0` indicates no additional flags.
1573 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
1575 // Check to see if Privacy Browser is waiting on Orbot.
1576 if (!waitingForOrbot) { // We are not waiting on Orbot, so we need to process the URL.
1577 // 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.
1578 formattedUrlString = url;
1580 // Display the formatted URL text.
1581 urlTextBox.setText(formattedUrlString);
1583 // Apply text highlighting to `urlTextBox`.
1586 // Apply any custom domain settings if the URL was loaded by navigating history.
1587 if (navigatingHistory) {
1588 // Reset `navigatingHistory`.
1589 navigatingHistory = false;
1591 // Apply the domain settings.
1592 applyDomainSettings(url, true, false);
1595 // 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.
1596 urlIsLoading = true;
1598 // Replace Refresh with Stop if the menu item has been created. (The WebView typically begins loading before the menu items are instantiated.)
1599 if (refreshMenuItem != null) {
1601 refreshMenuItem.setTitle(R.string.stop);
1603 // If the icon is displayed in the AppBar, set it according to the theme.
1604 if (displayAdditionalAppBarIcons) {
1606 refreshMenuItem.setIcon(R.drawable.close_dark);
1608 refreshMenuItem.setIcon(R.drawable.close_light);
1615 // It is necessary to update `formattedUrlString` and `urlTextBox` after the page finishes loading because the final URL can change during load.
1617 public void onPageFinished(WebView view, String url) {
1618 // Reset the wide view port if it has been turned off by the waiting for Orbot message.
1619 if (!waitingForOrbot) {
1620 mainWebView.getSettings().setUseWideViewPort(true);
1623 // Flush any cookies to persistent storage. `CookieManager` has become very lazy about flushing cookies in recent versions.
1624 if (firstPartyCookiesEnabled && Build.VERSION.SDK_INT >= 21) {
1625 cookieManager.flush();
1628 // Update the Refresh menu item if it has been created.
1629 if (refreshMenuItem != null) {
1630 // Reset the Refresh title.
1631 refreshMenuItem.setTitle(R.string.refresh);
1633 // If the icon is displayed in the AppBar, reset it according to the theme.
1634 if (displayAdditionalAppBarIcons) {
1636 refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
1638 refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
1643 // Reset `urlIsLoading`, which is used to prevent reloads on redirect if the user agent changes.
1644 urlIsLoading = false;
1646 // Clear the cache and history if Incognito Mode is enabled.
1647 if (incognitoModeEnabled) {
1648 // Clear the cache. `true` includes disk files.
1649 mainWebView.clearCache(true);
1651 // Clear the back/forward history.
1652 mainWebView.clearHistory();
1654 // Manually delete cache folders.
1656 // Delete the main cache directory.
1657 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
1659 // Delete the secondary `Service Worker` cache directory.
1660 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
1661 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
1662 } catch (IOException e) {
1663 // Do nothing if an error is thrown.
1667 // Update `urlTextBox` and apply domain settings if not waiting on Orbot.
1668 if (!waitingForOrbot) {
1669 // Check to see if `WebView` has set `url` to be `about:blank`.
1670 if (url.equals("about:blank")) { // `WebView` is blank, so `formattedUrlString` should be `""` and `urlTextBox` should display a hint.
1671 // Set `formattedUrlString` to `""`.
1672 formattedUrlString = "";
1674 urlTextBox.setText(formattedUrlString);
1676 // Request focus for `urlTextBox`.
1677 urlTextBox.requestFocus();
1679 // Display the keyboard.
1680 inputMethodManager.showSoftInput(urlTextBox, 0);
1682 // Apply the domain settings. This clears any settings from the previous domain.
1683 applyDomainSettings(formattedUrlString, true, false);
1684 } else { // `WebView` has loaded a webpage.
1685 // Set `formattedUrlString`.
1686 formattedUrlString = url;
1688 // Only update `urlTextBox` if the user is not typing in it.
1689 if (!urlTextBox.hasFocus()) {
1690 // Display the formatted URL text.
1691 urlTextBox.setText(formattedUrlString);
1693 // Apply text highlighting to `urlTextBox`.
1698 // Store the SSL certificate so it can be accessed from `ViewSslCertificateDialog` and `PinnedSslCertificateMismatchDialog`.
1699 sslCertificate = mainWebView.getCertificate();
1701 // 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.
1702 if (pinnedDomainSslCertificate && !ignorePinnedSslCertificate) {
1703 // Initialize the current SSL certificate variables.
1704 String currentWebsiteIssuedToCName = "";
1705 String currentWebsiteIssuedToOName = "";
1706 String currentWebsiteIssuedToUName = "";
1707 String currentWebsiteIssuedByCName = "";
1708 String currentWebsiteIssuedByOName = "";
1709 String currentWebsiteIssuedByUName = "";
1710 Date currentWebsiteSslStartDate = null;
1711 Date currentWebsiteSslEndDate = null;
1714 // Extract the individual pieces of information from the current website SSL certificate if it is not null.
1715 if (sslCertificate != null) {
1716 currentWebsiteIssuedToCName = sslCertificate.getIssuedTo().getCName();
1717 currentWebsiteIssuedToOName = sslCertificate.getIssuedTo().getOName();
1718 currentWebsiteIssuedToUName = sslCertificate.getIssuedTo().getUName();
1719 currentWebsiteIssuedByCName = sslCertificate.getIssuedBy().getCName();
1720 currentWebsiteIssuedByOName = sslCertificate.getIssuedBy().getOName();
1721 currentWebsiteIssuedByUName = sslCertificate.getIssuedBy().getUName();
1722 currentWebsiteSslStartDate = sslCertificate.getValidNotBeforeDate();
1723 currentWebsiteSslEndDate = sslCertificate.getValidNotAfterDate();
1726 // 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`.
1727 String currentWebsiteSslStartDateString = "";
1728 String currentWebsiteSslEndDateString = "";
1729 String pinnedDomainSslStartDateString = "";
1730 String pinnedDomainSslEndDateString = "";
1732 // Convert the `Dates` to `Strings` if they are not `null`.
1733 if (currentWebsiteSslStartDate != null) {
1734 currentWebsiteSslStartDateString = currentWebsiteSslStartDate.toString();
1737 if (currentWebsiteSslEndDate != null) {
1738 currentWebsiteSslEndDateString = currentWebsiteSslEndDate.toString();
1741 if (pinnedDomainSslStartDate != null) {
1742 pinnedDomainSslStartDateString = pinnedDomainSslStartDate.toString();
1745 if (pinnedDomainSslEndDate != null) {
1746 pinnedDomainSslEndDateString = pinnedDomainSslEndDate.toString();
1749 // Check to see if the pinned SSL certificate matches the current website certificate.
1750 if (!currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) || !currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) ||
1751 !currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) || !currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) ||
1752 !currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) || !currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) ||
1753 !currentWebsiteSslStartDateString.equals(pinnedDomainSslStartDateString) || !currentWebsiteSslEndDateString.equals(pinnedDomainSslEndDateString)) {
1754 // The pinned SSL certificate doesn't match the current domain certificate.
1755 //Display the pinned SSL certificate mismatch `AlertDialog`.
1756 AppCompatDialogFragment pinnedSslCertificateMismatchDialogFragment = new PinnedSslCertificateMismatchDialog();
1757 pinnedSslCertificateMismatchDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_mismatch));
1763 // Handle SSL Certificate errors.
1765 public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
1766 // Get the current website SSL certificate.
1767 SslCertificate currentWebsiteSslCertificate = error.getCertificate();
1769 // Extract the individual pieces of information from the current website SSL certificate.
1770 String currentWebsiteIssuedToCName = currentWebsiteSslCertificate.getIssuedTo().getCName();
1771 String currentWebsiteIssuedToOName = currentWebsiteSslCertificate.getIssuedTo().getOName();
1772 String currentWebsiteIssuedToUName = currentWebsiteSslCertificate.getIssuedTo().getUName();
1773 String currentWebsiteIssuedByCName = currentWebsiteSslCertificate.getIssuedBy().getCName();
1774 String currentWebsiteIssuedByOName = currentWebsiteSslCertificate.getIssuedBy().getOName();
1775 String currentWebsiteIssuedByUName = currentWebsiteSslCertificate.getIssuedBy().getUName();
1776 Date currentWebsiteSslStartDate = currentWebsiteSslCertificate.getValidNotBeforeDate();
1777 Date currentWebsiteSslEndDate = currentWebsiteSslCertificate.getValidNotAfterDate();
1779 // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
1780 if (pinnedDomainSslCertificate &&
1781 currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) && currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) &&
1782 currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) && currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) &&
1783 currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) && currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) &&
1784 currentWebsiteSslStartDate.equals(pinnedDomainSslStartDate) && currentWebsiteSslEndDate.equals(pinnedDomainSslEndDate)) {
1785 // An SSL certificate is pinned and matches the current domain certificate.
1786 // Proceed to the website without displaying an error.
1788 } else { // Either there isn't a pinned SSL certificate or it doesn't match the current website certificate.
1789 // Store `handler` so it can be accesses from `onSslErrorCancel()` and `onSslErrorProceed()`.
1790 sslErrorHandler = handler;
1792 // Display the SSL error `AlertDialog`.
1793 AppCompatDialogFragment sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error);
1794 sslCertificateErrorDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_error));
1799 // Load the website if not waiting for Orbot to connect.
1800 if (!waitingForOrbot) {
1801 loadUrl(formattedUrlString);
1806 protected void onNewIntent(Intent intent) {
1807 // Sets the new intent as the activity intent, so that any future `getIntent()`s pick up this one instead of creating a new activity.
1810 // Check to see if the intent contains a new URL.
1811 if (intent.getData() != null) {
1812 // Get the intent data.
1813 final Uri intentUriData = intent.getData();
1815 // Load the website.
1816 loadUrl(intentUriData.toString());
1818 // Close the navigation drawer if it is open.
1819 if (drawerLayout.isDrawerVisible(GravityCompat.START)) {
1820 drawerLayout.closeDrawer(GravityCompat.START);
1823 // Close the bookmarks drawer if it is open.
1824 if (drawerLayout.isDrawerVisible(GravityCompat.END)) {
1825 drawerLayout.closeDrawer(GravityCompat.END);
1828 // Clear the keyboard if displayed and remove the focus on the urlTextBar if it has it.
1829 mainWebView.requestFocus();
1834 public void onRestart() {
1835 // Run the default commands.
1838 // Make sure Orbot is running if Privacy Browser is proxying through Orbot.
1839 if (proxyThroughOrbot) {
1840 // Request Orbot to start. If Orbot is already running no hard will be caused by this request.
1841 Intent orbotIntent = new Intent("org.torproject.android.intent.action.START");
1843 // Send the intent to the Orbot package.
1844 orbotIntent.setPackage("org.torproject.android");
1847 sendBroadcast(orbotIntent);
1850 // Apply the app settings if returning from the Settings activity..
1851 if (reapplyAppSettingsOnRestart) {
1852 // Apply the app settings.
1855 // Reload the webpage if displaying of images has been disabled in the Settings activity.
1856 if (reloadOnRestart) {
1857 // Reload `mainWebView`.
1858 mainWebView.reload();
1860 // Reset `reloadOnRestartBoolean`.
1861 reloadOnRestart = false;
1864 // Reset the return from settings flag.
1865 reapplyAppSettingsOnRestart = false;
1868 // Apply the domain settings if returning from the Domains activity.
1869 if (reapplyDomainSettingsOnRestart) {
1870 // Reapply the domain settings.
1871 applyDomainSettings(formattedUrlString, false, true);
1873 // Reset `reapplyDomainSettingsOnRestart`.
1874 reapplyDomainSettingsOnRestart = false;
1877 // Load the URL on restart to apply changes to night mode.
1878 if (loadUrlOnRestart) {
1879 // Load the current `formattedUrlString`.
1880 loadUrl(formattedUrlString);
1882 // Reset `loadUrlOnRestart.
1883 loadUrlOnRestart = false;
1886 // Update the bookmarks drawer if returning from the Bookmarks activity.
1887 if (restartFromBookmarksActivity) {
1888 // Close the bookmarks drawer.
1889 drawerLayout.closeDrawer(GravityCompat.END);
1891 // Reload the bookmarks drawer.
1892 loadBookmarksFolder();
1894 // Reset `restartFromBookmarksActivity`.
1895 restartFromBookmarksActivity = false;
1898 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step. This can be important if the screen was rotated.
1899 updatePrivacyIcons(true);
1902 // `onResume()` runs after `onStart()`, which runs after `onCreate()` and `onRestart()`.
1904 public void onResume() {
1905 // Run the default commands.
1908 // Resume JavaScript (if enabled).
1909 mainWebView.resumeTimers();
1911 // Resume `mainWebView`.
1912 mainWebView.onResume();
1914 // Resume the adView for the free flavor.
1915 if (BuildConfig.FLAVOR.contentEquals("free")) {
1917 AdHelper.resumeAd(findViewById(R.id.adview));
1920 // Display a message to the user if waiting for Orbot.
1921 if (waitingForOrbot && !orbotStatus.equals("ON")) {
1922 // Disable the wide view port so that the waiting for Orbot text is displayed correctly.
1923 mainWebView.getSettings().setUseWideViewPort(false);
1925 // Load a waiting page. `null` specifies no encoding, which defaults to ASCII.
1926 mainWebView.loadData(waitingForOrbotHtmlString, "text/html", null);
1929 if (displayingFullScreenVideo) {
1930 // Remove the translucent overlays.
1931 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1933 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
1934 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
1936 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
1937 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
1938 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
1940 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
1945 public void onPause() {
1946 // Run the default commands.
1949 // Pause `mainWebView`.
1950 mainWebView.onPause();
1952 // Stop all JavaScript.
1953 mainWebView.pauseTimers();
1955 // Pause the ad or it will continue to consume resources in the background on the free flavor.
1956 if (BuildConfig.FLAVOR.contentEquals("free")) {
1958 AdHelper.pauseAd(findViewById(R.id.adview));
1963 public void onDestroy() {
1964 // Unregister the Orbot status broadcast receiver.
1965 this.unregisterReceiver(orbotStatusBroadcastReceiver);
1967 // Close the bookmarks cursor and database.
1968 bookmarksCursor.close();
1969 bookmarksDatabaseHelper.close();
1971 // Run the default commands.
1976 public boolean onCreateOptionsMenu(Menu menu) {
1977 // Inflate the menu; this adds items to the action bar if it is present.
1978 getMenuInflater().inflate(R.menu.webview_options_menu, menu);
1980 // Set mainMenu so it can be used by `onOptionsItemSelected()` and `updatePrivacyIcons`.
1983 // Set the initial status of the privacy icons. `false` does not call `invalidateOptionsMenu` as the last step.
1984 updatePrivacyIcons(false);
1986 // Get handles for the menu items.
1987 MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1988 MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1989 MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1990 MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data); // Form data can be removed once the minimum API >= 26.
1991 MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data); // Form data can be removed once the minimum API >= 26.
1992 refreshMenuItem = menu.findItem(R.id.refresh);
1993 blocklistsMenuItem = menu.findItem(R.id.blocklists);
1994 easyListMenuItem = menu.findItem(R.id.easylist);
1995 easyPrivacyMenuItem = menu.findItem(R.id.easyprivacy);
1996 fanboysAnnoyanceListMenuItem = menu.findItem(R.id.fanboys_annoyance_list);
1997 fanboysSocialBlockingListMenuItem = menu.findItem(R.id.fanboys_social_blocking_list);
1998 ultraPrivacyMenuItem = menu.findItem(R.id.ultraprivacy);
1999 blockAllThirdPartyRequestsMenuItem = menu.findItem(R.id.block_all_third_party_requests);
2000 MenuItem adConsentMenuItem = menu.findItem(R.id.ad_consent);
2002 // Only display third-party cookies if API >= 21
2003 toggleThirdPartyCookiesMenuItem.setVisible(Build.VERSION.SDK_INT >= 21);
2005 // Only display the form data menu items if the API < 26.
2006 toggleSaveFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
2007 clearFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
2009 // Only show Ad Consent if this is the free flavor.
2010 adConsentMenuItem.setVisible(BuildConfig.FLAVOR.contentEquals("free"));
2012 // Get the shared preference values.
2013 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2015 // Get the status of the additional AppBar icons.
2016 displayAdditionalAppBarIcons = sharedPreferences.getBoolean("display_additional_app_bar_icons", false);
2018 // 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.
2019 if (displayAdditionalAppBarIcons) {
2020 toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
2021 toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
2022 refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_ALWAYS);
2023 } else { //Do not display the additional icons.
2024 toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
2025 toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
2026 refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
2029 // Replace Refresh with Stop if a URL is already loading.
2032 refreshMenuItem.setTitle(R.string.stop);
2034 // If the icon is displayed in the AppBar, set it according to the theme.
2035 if (displayAdditionalAppBarIcons) {
2037 refreshMenuItem.setIcon(R.drawable.close_dark);
2039 refreshMenuItem.setIcon(R.drawable.close_light);
2048 public boolean onPrepareOptionsMenu(Menu menu) {
2049 // Get handles for the menu items.
2050 MenuItem addOrEditDomain = menu.findItem(R.id.add_or_edit_domain);
2051 MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
2052 MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
2053 MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
2054 MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data); // Form data can be removed once the minimum API >= 26.
2055 MenuItem clearDataMenuItem = menu.findItem(R.id.clear_data);
2056 MenuItem clearCookiesMenuItem = menu.findItem(R.id.clear_cookies);
2057 MenuItem clearDOMStorageMenuItem = menu.findItem(R.id.clear_dom_storage);
2058 MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data); // Form data can be removed once the minimum API >= 26.
2059 MenuItem fontSizeMenuItem = menu.findItem(R.id.font_size);
2060 MenuItem swipeToRefreshMenuItem = menu.findItem(R.id.swipe_to_refresh);
2061 MenuItem displayImagesMenuItem = menu.findItem(R.id.display_images);
2062 MenuItem nightModeMenuItem = menu.findItem(R.id.night_mode);
2063 MenuItem proxyThroughOrbotMenuItem = menu.findItem(R.id.proxy_through_orbot);
2065 // Set the text for the domain menu item.
2066 if (domainSettingsApplied) {
2067 addOrEditDomain.setTitle(R.string.edit_domain_settings);
2069 addOrEditDomain.setTitle(R.string.add_domain_settings);
2072 // Set the status of the menu item checkboxes.
2073 toggleFirstPartyCookiesMenuItem.setChecked(firstPartyCookiesEnabled);
2074 toggleThirdPartyCookiesMenuItem.setChecked(thirdPartyCookiesEnabled);
2075 toggleDomStorageMenuItem.setChecked(domStorageEnabled);
2076 toggleSaveFormDataMenuItem.setChecked(saveFormDataEnabled); // Form data can be removed once the minimum API >= 26.
2077 easyListMenuItem.setChecked(easyListEnabled);
2078 easyPrivacyMenuItem.setChecked(easyPrivacyEnabled);
2079 fanboysAnnoyanceListMenuItem.setChecked(fanboysAnnoyanceListEnabled);
2080 fanboysSocialBlockingListMenuItem.setChecked(fanboysSocialBlockingListEnabled);
2081 ultraPrivacyMenuItem.setChecked(ultraPrivacyEnabled);
2082 blockAllThirdPartyRequestsMenuItem.setChecked(blockAllThirdPartyRequests);
2083 swipeToRefreshMenuItem.setChecked(swipeRefreshLayout.isEnabled());
2084 displayImagesMenuItem.setChecked(mainWebView.getSettings().getLoadsImagesAutomatically());
2085 nightModeMenuItem.setChecked(nightMode);
2086 proxyThroughOrbotMenuItem.setChecked(proxyThroughOrbot);
2088 // Enable third-party cookies if first-party cookies are enabled.
2089 toggleThirdPartyCookiesMenuItem.setEnabled(firstPartyCookiesEnabled);
2091 // Enable DOM Storage if JavaScript is enabled.
2092 toggleDomStorageMenuItem.setEnabled(javaScriptEnabled);
2094 // Enable Clear Cookies if there are any.
2095 clearCookiesMenuItem.setEnabled(cookieManager.hasCookies());
2097 // Get a count of the number of files in the Local Storage directory.
2098 File localStorageDirectory = new File (privateDataDirectoryString + "/app_webview/Local Storage/");
2099 int localStorageDirectoryNumberOfFiles = 0;
2100 if (localStorageDirectory.exists()) {
2101 localStorageDirectoryNumberOfFiles = localStorageDirectory.list().length;
2104 // Get a count of the number of files in the IndexedDB directory.
2105 File indexedDBDirectory = new File (privateDataDirectoryString + "/app_webview/IndexedDB");
2106 int indexedDBDirectoryNumberOfFiles = 0;
2107 if (indexedDBDirectory.exists()) {
2108 indexedDBDirectoryNumberOfFiles = indexedDBDirectory.list().length;
2111 // Enable Clear DOM Storage if there is any.
2112 clearDOMStorageMenuItem.setEnabled(localStorageDirectoryNumberOfFiles > 0 || indexedDBDirectoryNumberOfFiles > 0);
2114 // Enable Clear Form Data is there is any. This can be removed once the minimum API >= 26.
2115 if (Build.VERSION.SDK_INT < 26) {
2116 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(this);
2117 clearFormDataMenuItem.setEnabled(mainWebViewDatabase.hasFormData());
2119 // Disable clear form data because it is not supported on current version of Android.
2120 clearFormDataMenuItem.setEnabled(false);
2123 // Enable Clear Data if any of the submenu items are enabled.
2124 clearDataMenuItem.setEnabled(clearCookiesMenuItem.isEnabled() || clearDOMStorageMenuItem.isEnabled() || clearFormDataMenuItem.isEnabled());
2126 // Disable Fanboy's Social Blocking List if Fanboy's Annoyance List is checked.
2127 fanboysSocialBlockingListMenuItem.setEnabled(!fanboysAnnoyanceListEnabled);
2129 // Initialize the display names for the blocklists with the number of blocked requests.
2130 blocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + blockedRequests);
2131 easyListMenuItem.setTitle(easyListBlockedRequests + " - " + getString(R.string.easylist));
2132 easyPrivacyMenuItem.setTitle(easyPrivacyBlockedRequests + " - " + getString(R.string.easyprivacy));
2133 fanboysAnnoyanceListMenuItem.setTitle(fanboysAnnoyanceListBlockedRequests + " - " + getString(R.string.fanboys_annoyance_list));
2134 fanboysSocialBlockingListMenuItem.setTitle(fanboysSocialBlockingListBlockedRequests + " - " + getString(R.string.fanboys_social_blocking_list));
2135 ultraPrivacyMenuItem.setTitle(ultraPrivacyBlockedRequests + " - " + getString(R.string.ultraprivacy));
2136 blockAllThirdPartyRequestsMenuItem.setTitle(thirdPartyBlockedRequests + " - " + getString(R.string.block_all_third_party_requests));
2138 // Get the current user agent.
2139 String currentUserAgent = mainWebView.getSettings().getUserAgentString();
2141 // Select the current user agent menu item. A switch statement cannot be used because the user agents are not compile time constants.
2142 if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[0])) { // Privacy Browser.
2143 menu.findItem(R.id.user_agent_privacy_browser).setChecked(true);
2144 } else if (currentUserAgent.equals(webViewDefaultUserAgent)) { // WebView Default.
2145 menu.findItem(R.id.user_agent_webview_default).setChecked(true);
2146 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[2])) { // Firefox on Android.
2147 menu.findItem(R.id.user_agent_firefox_on_android).setChecked(true);
2148 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[3])) { // Chrome on Android.
2149 menu.findItem(R.id.user_agent_chrome_on_android).setChecked(true);
2150 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[4])) { // Safari on iOS.
2151 menu.findItem(R.id.user_agent_safari_on_ios).setChecked(true);
2152 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[5])) { // Firefox on Linux.
2153 menu.findItem(R.id.user_agent_firefox_on_linux).setChecked(true);
2154 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[6])) { // Chromium on Linux.
2155 menu.findItem(R.id.user_agent_chromium_on_linux).setChecked(true);
2156 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[7])) { // Firefox on Windows.
2157 menu.findItem(R.id.user_agent_firefox_on_windows).setChecked(true);
2158 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[8])) { // Chrome on Windows.
2159 menu.findItem(R.id.user_agent_chrome_on_windows).setChecked(true);
2160 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[9])) { // Edge on Windows.
2161 menu.findItem(R.id.user_agent_edge_on_windows).setChecked(true);
2162 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[10])) { // Internet Explorer on Windows.
2163 menu.findItem(R.id.user_agent_internet_explorer_on_windows).setChecked(true);
2164 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[11])) { // Safari on macOS.
2165 menu.findItem(R.id.user_agent_safari_on_macos).setChecked(true);
2166 } else { // Custom user agent.
2167 menu.findItem(R.id.user_agent_custom).setChecked(true);
2170 // Initialize font size variables.
2171 int fontSize = mainWebView.getSettings().getTextZoom();
2172 String fontSizeTitle;
2173 MenuItem selectedFontSizeMenuItem;
2175 // Prepare the font size title and current size menu item.
2178 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.twenty_five_percent);
2179 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_twenty_five_percent);
2183 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.fifty_percent);
2184 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_fifty_percent);
2188 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.seventy_five_percent);
2189 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_seventy_five_percent);
2193 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
2194 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
2198 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_twenty_five_percent);
2199 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_twenty_five_percent);
2203 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_fifty_percent);
2204 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_fifty_percent);
2208 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_seventy_five_percent);
2209 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_seventy_five_percent);
2213 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.two_hundred_percent);
2214 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_two_hundred_percent);
2218 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
2219 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
2223 // Set the font size title and select the current size menu item.
2224 fontSizeMenuItem.setTitle(fontSizeTitle);
2225 selectedFontSizeMenuItem.setChecked(true);
2227 // Run all the other default commands.
2228 super.onPrepareOptionsMenu(menu);
2230 // Display the menu.
2235 // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
2236 @SuppressLint("SetJavaScriptEnabled")
2237 // removeAllCookies is deprecated, but it is required for API < 21.
2238 @SuppressWarnings("deprecation")
2239 public boolean onOptionsItemSelected(MenuItem menuItem) {
2240 // Get the selected menu item ID.
2241 int menuItemId = menuItem.getItemId();
2243 // Set the commands that relate to the menu entries.
2244 switch (menuItemId) {
2245 case R.id.toggle_javascript:
2246 // Switch the status of javaScriptEnabled.
2247 javaScriptEnabled = !javaScriptEnabled;
2249 // Apply the new JavaScript status.
2250 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
2252 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2253 updatePrivacyIcons(true);
2255 // Display a `Snackbar`.
2256 if (javaScriptEnabled) { // JavaScrip is enabled.
2257 Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show();
2258 } else if (firstPartyCookiesEnabled) { // JavaScript is disabled, but first-party cookies are enabled.
2259 Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show();
2260 } else { // Privacy mode.
2261 Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
2264 // Reload the WebView.
2265 mainWebView.reload();
2268 case R.id.add_or_edit_domain:
2269 if (domainSettingsApplied) { // Edit the current domain settings.
2270 // Reapply the domain settings on returning to `MainWebViewActivity`.
2271 reapplyDomainSettingsOnRestart = true;
2272 currentDomainName = "";
2274 // Create an intent to launch the domains activity.
2275 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2277 // Put extra information instructing the domains activity to directly load the current domain and close on back instead of returning to the domains list.
2278 domainsIntent.putExtra("loadDomain", domainSettingsDatabaseId);
2279 domainsIntent.putExtra("closeOnBack", true);
2282 startActivity(domainsIntent);
2283 } else { // Add a new domain.
2284 // Apply the new domain settings on returning to `MainWebViewActivity`.
2285 reapplyDomainSettingsOnRestart = true;
2286 currentDomainName = "";
2288 // Get the current domain
2289 Uri currentUri = Uri.parse(formattedUrlString);
2290 String currentDomain = currentUri.getHost();
2292 // Initialize the database handler. The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
2293 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
2295 // Create the domain and store the database ID.
2296 int newDomainDatabaseId = domainsDatabaseHelper.addDomain(currentDomain);
2298 // Create an intent to launch the domains activity.
2299 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2301 // Put extra information instructing the domains activity to directly load the new domain and close on back instead of returning to the domains list.
2302 domainsIntent.putExtra("loadDomain", newDomainDatabaseId);
2303 domainsIntent.putExtra("closeOnBack", true);
2306 startActivity(domainsIntent);
2310 case R.id.toggle_first_party_cookies:
2311 // Switch the status of firstPartyCookiesEnabled.
2312 firstPartyCookiesEnabled = !firstPartyCookiesEnabled;
2314 // Update the menu checkbox.
2315 menuItem.setChecked(firstPartyCookiesEnabled);
2317 // Apply the new cookie status.
2318 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
2320 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2321 updatePrivacyIcons(true);
2323 // Display a `Snackbar`.
2324 if (firstPartyCookiesEnabled) { // First-party cookies are enabled.
2325 Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
2326 } else if (javaScriptEnabled) { // JavaScript is still enabled.
2327 Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
2328 } else { // Privacy mode.
2329 Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
2332 // Reload the WebView.
2333 mainWebView.reload();
2336 case R.id.toggle_third_party_cookies:
2337 if (Build.VERSION.SDK_INT >= 21) {
2338 // Switch the status of thirdPartyCookiesEnabled.
2339 thirdPartyCookiesEnabled = !thirdPartyCookiesEnabled;
2341 // Update the menu checkbox.
2342 menuItem.setChecked(thirdPartyCookiesEnabled);
2344 // Apply the new cookie status.
2345 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
2347 // Display a `Snackbar`.
2348 if (thirdPartyCookiesEnabled) {
2349 Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
2351 Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
2354 // Reload the WebView.
2355 mainWebView.reload();
2356 } // Else do nothing because SDK < 21.
2359 case R.id.toggle_dom_storage:
2360 // Switch the status of domStorageEnabled.
2361 domStorageEnabled = !domStorageEnabled;
2363 // Update the menu checkbox.
2364 menuItem.setChecked(domStorageEnabled);
2366 // Apply the new DOM Storage status.
2367 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
2369 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2370 updatePrivacyIcons(true);
2372 // Display a `Snackbar`.
2373 if (domStorageEnabled) {
2374 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show();
2376 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show();
2379 // Reload the WebView.
2380 mainWebView.reload();
2383 // Form data can be removed once the minimum API >= 26.
2384 case R.id.toggle_save_form_data:
2385 // Switch the status of saveFormDataEnabled.
2386 saveFormDataEnabled = !saveFormDataEnabled;
2388 // Update the menu checkbox.
2389 menuItem.setChecked(saveFormDataEnabled);
2391 // Apply the new form data status.
2392 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
2394 // Display a `Snackbar`.
2395 if (saveFormDataEnabled) {
2396 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show();
2398 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show();
2401 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2402 updatePrivacyIcons(true);
2404 // Reload the WebView.
2405 mainWebView.reload();
2408 case R.id.clear_cookies:
2409 Snackbar.make(findViewById(R.id.main_webview), R.string.cookies_deleted, Snackbar.LENGTH_LONG)
2410 .setAction(R.string.undo, v -> {
2411 // Do nothing because everything will be handled by `onDismissed()` below.
2413 .addCallback(new Snackbar.Callback() {
2415 public void onDismissed(Snackbar snackbar, int event) {
2417 // The user pushed the `Undo` button.
2418 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2422 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2424 // `cookieManager.removeAllCookie()` varies by SDK.
2425 if (Build.VERSION.SDK_INT < 21) {
2426 cookieManager.removeAllCookie();
2428 // `null` indicates no callback.
2429 cookieManager.removeAllCookies(null);
2437 case R.id.clear_dom_storage:
2438 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
2439 .setAction(R.string.undo, v -> {
2440 // Do nothing because everything will be handled by `onDismissed()` below.
2442 .addCallback(new Snackbar.Callback() {
2444 public void onDismissed(Snackbar snackbar, int event) {
2446 // The user pushed the `Undo` button.
2447 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2451 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2453 // Delete the DOM Storage.
2454 WebStorage webStorage = WebStorage.getInstance();
2455 webStorage.deleteAllData();
2457 // Initialize a handler to manually delete the DOM storage files and directories.
2458 Handler deleteDomStorageHandler = new Handler();
2460 // Setup a runnable to manually delete the DOM storage files and directories.
2461 Runnable deleteDomStorageRunnable = () -> {
2463 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2464 privacyBrowserRuntime.exec(new String[]{"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2466 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2467 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2468 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2469 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2470 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2471 } catch (IOException e) {
2472 // Do nothing if an error is thrown.
2476 // Manually delete the DOM storage files after 200 milliseconds.
2477 deleteDomStorageHandler.postDelayed(deleteDomStorageRunnable, 200);
2484 // Form data can be remove once the minimum API >= 26.
2485 case R.id.clear_form_data:
2486 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_deleted, Snackbar.LENGTH_LONG)
2487 .setAction(R.string.undo, v -> {
2488 // Do nothing because everything will be handled by `onDismissed()` below.
2490 .addCallback(new Snackbar.Callback() {
2492 public void onDismissed(Snackbar snackbar, int event) {
2494 // The user pushed the `Undo` button.
2495 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2499 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2501 // Delete the form data.
2502 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(getApplicationContext());
2503 mainWebViewDatabase.clearFormData();
2511 // Toggle the EasyList status.
2512 easyListEnabled = !easyListEnabled;
2514 // Update the menu checkbox.
2515 menuItem.setChecked(easyListEnabled);
2517 // Reload the main WebView.
2518 mainWebView.reload();
2521 case R.id.easyprivacy:
2522 // Toggle the EasyPrivacy status.
2523 easyPrivacyEnabled = !easyPrivacyEnabled;
2525 // Update the menu checkbox.
2526 menuItem.setChecked(easyPrivacyEnabled);
2528 // Reload the main WebView.
2529 mainWebView.reload();
2532 case R.id.fanboys_annoyance_list:
2533 // Toggle Fanboy's Annoyance List status.
2534 fanboysAnnoyanceListEnabled = !fanboysAnnoyanceListEnabled;
2536 // Update the menu checkbox.
2537 menuItem.setChecked(fanboysAnnoyanceListEnabled);
2539 // Update the staus of Fanboy's Social Blocking List.
2540 MenuItem fanboysSocialBlockingListMenuItem = mainMenu.findItem(R.id.fanboys_social_blocking_list);
2541 fanboysSocialBlockingListMenuItem.setEnabled(!fanboysAnnoyanceListEnabled);
2543 // Reload the main WebView.
2544 mainWebView.reload();
2547 case R.id.fanboys_social_blocking_list:
2548 // Toggle Fanboy's Social Blocking List status.
2549 fanboysSocialBlockingListEnabled = !fanboysSocialBlockingListEnabled;
2551 // Update the menu checkbox.
2552 menuItem.setChecked(fanboysSocialBlockingListEnabled);
2554 // Reload the main WebView.
2555 mainWebView.reload();
2558 case R.id.ultraprivacy:
2559 // Toggle the UltraPrivacy status.
2560 ultraPrivacyEnabled = !ultraPrivacyEnabled;
2562 // Update the menu checkbox.
2563 menuItem.setChecked(ultraPrivacyEnabled);
2565 // Reload the main WebView.
2566 mainWebView.reload();
2569 case R.id.block_all_third_party_requests:
2570 //Toggle the third-party requests blocker status.
2571 blockAllThirdPartyRequests = !blockAllThirdPartyRequests;
2573 // Update the menu checkbox.
2574 menuItem.setChecked(blockAllThirdPartyRequests);
2576 // Reload the main WebView.
2577 mainWebView.reload();
2580 case R.id.user_agent_privacy_browser:
2581 // Update the user agent.
2582 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[0]);
2584 // Reload the WebView.
2585 mainWebView.reload();
2588 case R.id.user_agent_webview_default:
2589 // Update the user agent.
2590 mainWebView.getSettings().setUserAgentString("");
2592 // Reload the WebView.
2593 mainWebView.reload();
2596 case R.id.user_agent_firefox_on_android:
2597 // Update the user agent.
2598 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[2]);
2600 // Reload the WebView.
2601 mainWebView.reload();
2604 case R.id.user_agent_chrome_on_android:
2605 // Update the user agent.
2606 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[3]);
2608 // Reload the WebView.
2609 mainWebView.reload();
2612 case R.id.user_agent_safari_on_ios:
2613 // Update the user agent.
2614 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[4]);
2616 // Reload the WebView.
2617 mainWebView.reload();
2620 case R.id.user_agent_firefox_on_linux:
2621 // Update the user agent.
2622 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[5]);
2624 // Reload the WebView.
2625 mainWebView.reload();
2628 case R.id.user_agent_chromium_on_linux:
2629 // Update the user agent.
2630 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[6]);
2632 // Reload the WebView.
2633 mainWebView.reload();
2636 case R.id.user_agent_firefox_on_windows:
2637 // Update the user agent.
2638 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[7]);
2640 // Reload the WebView.
2641 mainWebView.reload();
2644 case R.id.user_agent_chrome_on_windows:
2645 // Update the user agent.
2646 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[8]);
2648 // Reload the WebView.
2649 mainWebView.reload();
2652 case R.id.user_agent_edge_on_windows:
2653 // Update the user agent.
2654 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[9]);
2656 // Reload the WebView.
2657 mainWebView.reload();
2660 case R.id.user_agent_internet_explorer_on_windows:
2661 // Update the user agent.
2662 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[10]);
2664 // Reload the WebView.
2665 mainWebView.reload();
2668 case R.id.user_agent_safari_on_macos:
2669 // Update the user agent.
2670 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[11]);
2672 // Reload the WebView.
2673 mainWebView.reload();
2676 case R.id.user_agent_custom:
2677 // Update the user agent.
2678 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
2680 // Reload the WebView.
2681 mainWebView.reload();
2684 case R.id.font_size_twenty_five_percent:
2685 mainWebView.getSettings().setTextZoom(25);
2688 case R.id.font_size_fifty_percent:
2689 mainWebView.getSettings().setTextZoom(50);
2692 case R.id.font_size_seventy_five_percent:
2693 mainWebView.getSettings().setTextZoom(75);
2696 case R.id.font_size_one_hundred_percent:
2697 mainWebView.getSettings().setTextZoom(100);
2700 case R.id.font_size_one_hundred_twenty_five_percent:
2701 mainWebView.getSettings().setTextZoom(125);
2704 case R.id.font_size_one_hundred_fifty_percent:
2705 mainWebView.getSettings().setTextZoom(150);
2708 case R.id.font_size_one_hundred_seventy_five_percent:
2709 mainWebView.getSettings().setTextZoom(175);
2712 case R.id.font_size_two_hundred_percent:
2713 mainWebView.getSettings().setTextZoom(200);
2716 case R.id.swipe_to_refresh:
2717 // Toggle swipe to refresh.
2718 swipeRefreshLayout.setEnabled(!swipeRefreshLayout.isEnabled());
2721 case R.id.display_images:
2722 if (mainWebView.getSettings().getLoadsImagesAutomatically()) { // Images are currently loaded automatically.
2723 mainWebView.getSettings().setLoadsImagesAutomatically(false);
2724 mainWebView.reload();
2725 } else { // Images are not currently loaded automatically.
2726 mainWebView.getSettings().setLoadsImagesAutomatically(true);
2729 // Set `onTheFlyDisplayImagesSet`.
2730 onTheFlyDisplayImagesSet = true;
2733 case R.id.night_mode:
2734 // Toggle night mode.
2735 nightMode = !nightMode;
2737 // Enable or disable JavaScript according to night mode, the global preference, and any domain settings.
2738 if (nightMode) { // Night mode is enabled. Enable JavaScript.
2739 // Update the global variable.
2740 javaScriptEnabled = true;
2741 } else if (domainSettingsApplied) { // Night mode is disabled and domain settings are applied. Set JavaScript according to the domain settings.
2742 // Get the JavaScript preference that was stored the last time domain settings were loaded.
2743 javaScriptEnabled = domainSettingsJavaScriptEnabled;
2744 } else { // Night mode is disabled and domain settings are not applied. Set JavaScript according to the global preference.
2745 // Get a handle for the shared preference.
2746 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2748 // Get the JavaScript preference.
2749 javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
2752 // Apply the JavaScript setting to the WebView.
2753 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
2755 // Update the privacy icons.
2756 updatePrivacyIcons(false);
2758 // Reload the website.
2759 mainWebView.reload();
2763 // Get a `PrintManager` instance.
2764 PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
2766 // Convert `mainWebView` to `printDocumentAdapter`.
2767 PrintDocumentAdapter printDocumentAdapter = mainWebView.createPrintDocumentAdapter();
2769 // Remove the lint error below that `printManager` might be `null`.
2770 assert printManager != null;
2772 // Print the document. The print attributes are `null`.
2773 printManager.print(getString(R.string.privacy_browser_web_page), printDocumentAdapter, null);
2776 case R.id.view_source:
2777 // Launch the View Source activity.
2778 Intent viewSourceIntent = new Intent(this, ViewSourceActivity.class);
2779 startActivity(viewSourceIntent);
2782 case R.id.proxy_through_orbot:
2783 // Toggle the proxy through Orbot variable.
2784 proxyThroughOrbot = !proxyThroughOrbot;
2786 // Apply the proxy through Orbot settings.
2787 applyProxyThroughOrbot(true);
2791 // Setup the share string.
2792 String shareString = webViewTitle + " – " + urlTextBox.getText().toString();
2794 // Create the share intent.
2795 Intent shareIntent = new Intent();
2796 shareIntent.setAction(Intent.ACTION_SEND);
2797 shareIntent.putExtra(Intent.EXTRA_TEXT, shareString);
2798 shareIntent.setType("text/plain");
2801 startActivity(Intent.createChooser(shareIntent, "Share URL"));
2804 case R.id.find_on_page:
2805 // Hide the URL app bar.
2806 supportAppBar.setVisibility(View.GONE);
2808 // Show the Find on Page `RelativeLayout`.
2809 findOnPageLinearLayout.setVisibility(View.VISIBLE);
2811 // Display the keyboard. We have to wait 200 ms before running the command to work around a bug in Android.
2812 // http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
2813 findOnPageEditText.postDelayed(() -> {
2814 // Set the focus on `findOnPageEditText`.
2815 findOnPageEditText.requestFocus();
2817 // Display the keyboard. `0` sets no input flags.
2818 inputMethodManager.showSoftInput(findOnPageEditText, 0);
2822 case R.id.add_to_homescreen:
2823 // Show the `CreateHomeScreenShortcutDialog` `AlertDialog` and name this instance `R.string.create_shortcut`.
2824 AppCompatDialogFragment createHomeScreenShortcutDialogFragment = new CreateHomeScreenShortcutDialog();
2825 createHomeScreenShortcutDialogFragment.show(getSupportFragmentManager(), getString(R.string.create_shortcut));
2827 //Everything else will be handled by `CreateHomeScreenShortcutDialog` and the associated listener below.
2831 if (menuItem.getTitle().equals(getString(R.string.refresh))) { // The refresh button was pushed.
2832 // Reload the WebView.
2833 mainWebView.reload();
2834 } else { // The stop button was pushed.
2835 // Stop the loading of the WebView.
2836 mainWebView.stopLoading();
2840 case R.id.ad_consent:
2841 // Display the ad consent dialog.
2842 DialogFragment adConsentDialogFragment = new AdConsentDialog();
2843 adConsentDialogFragment.show(getFragmentManager(), getString(R.string.ad_consent));
2847 // Don't consume the event.
2848 return super.onOptionsItemSelected(menuItem);
2852 // removeAllCookies is deprecated, but it is required for API < 21.
2853 @SuppressWarnings("deprecation")
2855 public boolean onNavigationItemSelected(@NonNull MenuItem menuItem) {
2856 int menuItemId = menuItem.getItemId();
2858 switch (menuItemId) {
2864 if (mainWebView.canGoBack()) {
2865 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
2866 formattedUrlString = "";
2868 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2869 navigatingHistory = true;
2871 // Load the previous website in the history.
2872 mainWebView.goBack();
2877 if (mainWebView.canGoForward()) {
2878 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
2879 formattedUrlString = "";
2881 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2882 navigatingHistory = true;
2884 // Load the next website in the history.
2885 mainWebView.goForward();
2890 // Get the `WebBackForwardList`.
2891 WebBackForwardList webBackForwardList = mainWebView.copyBackForwardList();
2893 // Show the `UrlHistoryDialog` `AlertDialog` and name this instance `R.string.history`. `this` is the `Context`.
2894 AppCompatDialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(this, webBackForwardList);
2895 urlHistoryDialogFragment.show(getSupportFragmentManager(), getString(R.string.history));
2899 // Launch the requests activity.
2900 Intent requestsIntent = new Intent(this, RequestsActivity.class);
2901 startActivity(requestsIntent);
2904 case R.id.downloads:
2905 // Launch the system Download Manager.
2906 Intent downloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
2908 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
2909 downloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2911 startActivity(downloadManagerIntent);
2915 // Set the flag to reapply the domain settings on restart when returning from Domain Settings.
2916 reapplyDomainSettingsOnRestart = true;
2917 currentDomainName = "";
2919 // Launch the domains activity.
2920 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2921 startActivity(domainsIntent);
2925 // Set the flag to reapply app settings on restart when returning from Settings.
2926 reapplyAppSettingsOnRestart = true;
2928 // Set the flag to reapply the domain settings on restart when returning from Settings.
2929 reapplyDomainSettingsOnRestart = true;
2930 currentDomainName = "";
2932 // Launch the settings activity.
2933 Intent settingsIntent = new Intent(this, SettingsActivity.class);
2934 startActivity(settingsIntent);
2937 case R.id.import_export:
2938 // Launch the import/export activity.
2939 Intent importExportIntent = new Intent (this, ImportExportActivity.class);
2940 startActivity(importExportIntent);
2944 // Launch `GuideActivity`.
2945 Intent guideIntent = new Intent(this, GuideActivity.class);
2946 startActivity(guideIntent);
2950 // Launch `AboutActivity`.
2951 Intent aboutIntent = new Intent(this, AboutActivity.class);
2952 startActivity(aboutIntent);
2955 case R.id.clearAndExit:
2956 // Close the bookmarks cursor and database.
2957 bookmarksCursor.close();
2958 bookmarksDatabaseHelper.close();
2960 // Get a handle for `sharedPreferences`. `this` references the current context.
2961 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2963 boolean clearEverything = sharedPreferences.getBoolean("clear_everything", true);
2966 if (clearEverything || sharedPreferences.getBoolean("clear_cookies", true)) {
2967 // The command to remove cookies changed slightly in API 21.
2968 if (Build.VERSION.SDK_INT >= 21) {
2969 cookieManager.removeAllCookies(null);
2971 cookieManager.removeAllCookie();
2974 // Manually delete the cookies database, as `CookieManager` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2976 // We have to use two commands because `Runtime.exec()` does not like `*`.
2977 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies");
2978 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies-journal");
2979 } catch (IOException e) {
2980 // Do nothing if an error is thrown.
2984 // Clear DOM storage.
2985 if (clearEverything || sharedPreferences.getBoolean("clear_dom_storage", true)) {
2986 // Ask `WebStorage` to clear the DOM storage.
2987 WebStorage webStorage = WebStorage.getInstance();
2988 webStorage.deleteAllData();
2990 // Manually delete the DOM storage files and directories, as `WebStorage` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2992 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2993 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2995 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2996 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2997 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2998 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2999 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
3000 } catch (IOException e) {
3001 // Do nothing if an error is thrown.
3005 // Clear form data if the API < 26.
3006 if ((Build.VERSION.SDK_INT < 26) && (clearEverything || sharedPreferences.getBoolean("clear_form_data", true))) {
3007 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
3008 webViewDatabase.clearFormData();
3010 // Manually delete the form data database, as `WebViewDatabase` sometimes will not flush its changes to disk before `System.exit(0)` is run.
3012 // We have to use a `String[]` because the database contains a space and `Runtime.exec` will not escape the string correctly otherwise.
3013 privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data"});
3014 privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data-journal"});
3015 } catch (IOException e) {
3016 // Do nothing if an error is thrown.
3021 if (clearEverything || sharedPreferences.getBoolean("clear_cache", true)) {
3022 // `true` includes disk files.
3023 mainWebView.clearCache(true);
3025 // Manually delete the cache directories.
3027 // Delete the main cache directory.
3028 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
3030 // Delete the secondary `Service Worker` cache directory.
3031 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
3032 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
3033 } catch (IOException e) {
3034 // Do nothing if an error is thrown.
3038 // Clear SSL certificate preferences.
3039 mainWebView.clearSslPreferences();
3041 // Clear the back/forward history.
3042 mainWebView.clearHistory();
3044 // Clear `formattedUrlString`.
3045 formattedUrlString = null;
3047 // Clear `customHeaders`.
3048 customHeaders.clear();
3050 // Detach all views from `mainWebViewRelativeLayout`.
3051 mainWebViewRelativeLayout.removeAllViews();
3053 // Destroy the internal state of `mainWebView`.
3054 mainWebView.destroy();
3056 // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
3057 // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
3058 if (clearEverything) {
3060 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
3061 } catch (IOException e) {
3062 // Do nothing if an error is thrown.
3066 // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
3067 if (Build.VERSION.SDK_INT >= 21) {
3068 finishAndRemoveTask();
3073 // Remove the terminated program from RAM. The status code is `0`.
3078 // Close the navigation drawer.
3079 drawerLayout.closeDrawer(GravityCompat.START);
3084 public void onPostCreate(Bundle savedInstanceState) {
3085 super.onPostCreate(savedInstanceState);
3087 // Sync the state of the DrawerToggle after onRestoreInstanceState has finished.
3088 drawerToggle.syncState();
3092 public void onConfigurationChanged(Configuration newConfig) {
3093 super.onConfigurationChanged(newConfig);
3095 // Reload the ad for the free flavor if we not in full screen mode.
3096 if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
3097 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
3098 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
3101 // `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:
3102 // https://code.google.com/p/android/issues/detail?id=20493#c8
3103 // ActivityCompat.invalidateOptionsMenu(this);
3107 public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
3108 // Store the `HitTestResult`.
3109 final WebView.HitTestResult hitTestResult = mainWebView.getHitTestResult();
3112 final String imageUrl;
3113 final String linkUrl;
3115 // Get a handle for the `ClipboardManager`.
3116 final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
3118 // Remove the lint errors below that `clipboardManager` might be `null`.
3119 assert clipboardManager != null;
3121 switch (hitTestResult.getType()) {
3122 // `SRC_ANCHOR_TYPE` is a link.
3123 case WebView.HitTestResult.SRC_ANCHOR_TYPE:
3124 // Get the target URL.
3125 linkUrl = hitTestResult.getExtra();
3127 // Set the target URL as the title of the `ContextMenu`.
3128 menu.setHeaderTitle(linkUrl);
3130 // Add a Load URL entry.
3131 menu.add(R.string.load_url).setOnMenuItemClickListener((MenuItem item) -> {
3136 // Add a Copy URL entry.
3137 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
3138 // Save the link URL in a `ClipData`.
3139 ClipData srcAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
3141 // Set the `ClipData` as the clipboard's primary clip.
3142 clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
3146 // Add a Download URL entry.
3147 menu.add(R.string.download_url).setOnMenuItemClickListener((MenuItem item) -> {
3148 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
3149 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
3150 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
3152 // Store the variables for future use by `onRequestPermissionsResult()`.
3153 downloadUrl = linkUrl;
3154 downloadContentDisposition = "none";
3155 downloadContentLength = -1;
3157 // Show a dialog if the user has previously denied the permission.
3158 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
3159 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
3160 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
3162 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
3163 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
3164 } else { // Show the permission request directly.
3165 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
3166 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
3168 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
3169 // Get a handle for the download file alert dialog.
3170 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(linkUrl, "none", -1);
3172 // Show the download file alert dialog.
3173 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3178 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
3179 menu.add(R.string.cancel);
3182 case WebView.HitTestResult.EMAIL_TYPE:
3183 // Get the target URL.
3184 linkUrl = hitTestResult.getExtra();
3186 // Set the target URL as the title of the `ContextMenu`.
3187 menu.setHeaderTitle(linkUrl);
3189 // Add a `Write Email` entry.
3190 menu.add(R.string.write_email).setOnMenuItemClickListener(item -> {
3191 // We use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
3192 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
3194 // Parse the url and set it as the data for the `Intent`.
3195 emailIntent.setData(Uri.parse("mailto:" + linkUrl));
3197 // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
3198 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
3201 startActivity(emailIntent);
3205 // Add a `Copy Email Address` entry.
3206 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(item -> {
3207 // Save the email address in a `ClipData`.
3208 ClipData srcEmailTypeClipData = ClipData.newPlainText(getString(R.string.email_address), linkUrl);
3210 // Set the `ClipData` as the clipboard's primary clip.
3211 clipboardManager.setPrimaryClip(srcEmailTypeClipData);
3215 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
3216 menu.add(R.string.cancel);
3219 // `IMAGE_TYPE` is an image.
3220 case WebView.HitTestResult.IMAGE_TYPE:
3221 // Get the image URL.
3222 imageUrl = hitTestResult.getExtra();
3224 // Set the image URL as the title of the `ContextMenu`.
3225 menu.setHeaderTitle(imageUrl);
3227 // Add a `View Image` entry.
3228 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
3233 // Add a `Download Image` entry.
3234 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
3235 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
3236 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
3237 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
3239 // Store the image URL for use by `onRequestPermissionResult()`.
3240 downloadImageUrl = imageUrl;
3242 // Show a dialog if the user has previously denied the permission.
3243 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
3244 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
3245 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
3247 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
3248 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
3249 } else { // Show the permission request directly.
3250 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
3251 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
3253 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
3254 // Get a handle for the download image alert dialog.
3255 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
3257 // Show the download image alert dialog.
3258 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3263 // Add a `Copy URL` entry.
3264 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
3265 // Save the image URL in a `ClipData`.
3266 ClipData srcImageTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
3268 // Set the `ClipData` as the clipboard's primary clip.
3269 clipboardManager.setPrimaryClip(srcImageTypeClipData);
3273 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
3274 menu.add(R.string.cancel);
3278 // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
3279 case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
3280 // Get the image URL.
3281 imageUrl = hitTestResult.getExtra();
3283 // Set the image URL as the title of the `ContextMenu`.
3284 menu.setHeaderTitle(imageUrl);
3286 // Add a `View Image` entry.
3287 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
3292 // Add a `Download Image` entry.
3293 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
3294 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
3295 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
3296 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
3298 // Store the image URL for use by `onRequestPermissionResult()`.
3299 downloadImageUrl = imageUrl;
3301 // Show a dialog if the user has previously denied the permission.
3302 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
3303 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
3304 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
3306 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
3307 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
3308 } else { // Show the permission request directly.
3309 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
3310 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
3312 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
3313 // Get a handle for the download image alert dialog.
3314 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
3316 // Show the download image alert dialog.
3317 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3322 // Add a `Copy URL` entry.
3323 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
3324 // Save the image URL in a `ClipData`.
3325 ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
3327 // Set the `ClipData` as the clipboard's primary clip.
3328 clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
3332 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
3333 menu.add(R.string.cancel);
3339 public void onCreateBookmark(AppCompatDialogFragment dialogFragment) {
3340 // Get the `EditTexts` from the `dialogFragment`.
3341 EditText createBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_name_edittext);
3342 EditText createBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_url_edittext);
3344 // Extract the strings from the `EditTexts`.
3345 String bookmarkNameString = createBookmarkNameEditText.getText().toString();
3346 String bookmarkUrlString = createBookmarkUrlEditText.getText().toString();
3348 // Convert the favoriteIcon Bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
3349 ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
3350 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
3351 byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
3353 // Display the new bookmark below the current items in the (0 indexed) list.
3354 int newBookmarkDisplayOrder = bookmarksListView.getCount();
3356 // Create the bookmark.
3357 bookmarksDatabaseHelper.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray);
3359 // Update `bookmarksCursor` with the current contents of this folder.
3360 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3362 // Update the `ListView`.
3363 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3365 // Scroll to the new bookmark.
3366 bookmarksListView.setSelection(newBookmarkDisplayOrder);
3370 public void onCreateBookmarkFolder(AppCompatDialogFragment dialogFragment) {
3371 // Get handles for the views in `dialogFragment`.
3372 EditText createFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.create_folder_name_edittext);
3373 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon_radiobutton);
3374 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon);
3376 // Get new folder name string.
3377 String folderNameString = createFolderNameEditText.getText().toString();
3379 // Get the new folder icon `Bitmap`.
3380 Bitmap folderIconBitmap;
3381 if (defaultFolderIconRadioButton.isChecked()) { // Use the default folder icon.
3382 // Get the default folder icon and convert it to a `Bitmap`.
3383 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3384 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3385 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3386 } else { // Use the `WebView` favorite icon.
3387 folderIconBitmap = favoriteIconBitmap;
3390 // Convert `folderIconBitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
3391 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3392 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3393 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3395 // Move all the bookmarks down one in the display order.
3396 for (int i = 0; i < bookmarksListView.getCount(); i++) {
3397 int databaseId = (int) bookmarksListView.getItemIdAtPosition(i);
3398 bookmarksDatabaseHelper.updateDisplayOrder(databaseId, i + 1);
3401 // Create the folder, which will be placed at the top of the `ListView`.
3402 bookmarksDatabaseHelper.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray);
3404 // Update `bookmarksCursor` with the current contents of this folder.
3405 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3407 // Update the `ListView`.
3408 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3410 // Scroll to the new folder.
3411 bookmarksListView.setSelection(0);
3415 public void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment) {
3416 // Get the shortcut name.
3417 EditText shortcutNameEditText = dialogFragment.getDialog().findViewById(R.id.shortcut_name_edittext);
3418 String shortcutNameString = shortcutNameEditText.getText().toString();
3420 // Convert the favorite icon bitmap to an `Icon`. `IconCompat` is required until API >= 26.
3421 IconCompat favoriteIcon = IconCompat.createWithBitmap(favoriteIconBitmap);
3423 // Setup the shortcut intent.
3424 Intent shortcutIntent = new Intent();
3425 shortcutIntent.setAction(Intent.ACTION_VIEW);
3426 shortcutIntent.setData(Uri.parse(formattedUrlString));
3428 // Create a shortcut info builder. The shortcut name becomes the shortcut ID.
3429 ShortcutInfoCompat.Builder shortcutInfoBuilder = new ShortcutInfoCompat.Builder(this, shortcutNameString);
3431 // Add the required fields to the shortcut info builder.
3432 shortcutInfoBuilder.setIcon(favoriteIcon);
3433 shortcutInfoBuilder.setIntent(shortcutIntent);
3434 shortcutInfoBuilder.setShortLabel(shortcutNameString);
3436 // Request the pin. `ShortcutManagerCompat` can be switched to `ShortcutManager` once API >= 26.
3437 ShortcutManagerCompat.requestPinShortcut(this, shortcutInfoBuilder.build(), null);
3441 public void onCloseDownloadLocationPermissionDialog(int downloadType) {
3442 switch (downloadType) {
3443 case DownloadLocationPermissionDialog.DOWNLOAD_FILE:
3444 // Request the WRITE_EXTERNAL_STORAGE permission with a file request code.
3445 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
3448 case DownloadLocationPermissionDialog.DOWNLOAD_IMAGE:
3449 // Request the WRITE_EXTERNAL_STORAGE permission with an image request code.
3450 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
3456 public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
3457 switch (requestCode) {
3458 case DOWNLOAD_FILE_REQUEST_CODE:
3459 // Show the download file alert dialog. When the dialog closes, the correct command will be used based on the permission status.
3460 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(downloadUrl, downloadContentDisposition, downloadContentLength);
3462 // On API 23, displaying the fragment must be delayed or the app will crash.
3463 if (Build.VERSION.SDK_INT == 23) {
3464 new Handler().postDelayed(() -> downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
3466 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3469 // Reset the download variables.
3471 downloadContentDisposition = "";
3472 downloadContentLength = 0;
3475 case DOWNLOAD_IMAGE_REQUEST_CODE:
3476 // Show the download image alert dialog. When the dialog closes, the correct command will be used based on the permission status.
3477 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(downloadImageUrl);
3479 // On API 23, displaying the fragment must be delayed or the app will crash.
3480 if (Build.VERSION.SDK_INT == 23) {
3481 new Handler().postDelayed(() -> downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
3483 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3486 // Reset the image URL variable.
3487 downloadImageUrl = "";
3493 public void onDownloadImage(AppCompatDialogFragment dialogFragment, String imageUrl) {
3494 // Download the image if it has an HTTP or HTTPS URI.
3495 if (imageUrl.startsWith("http")) {
3496 // Get a handle for the system `DOWNLOAD_SERVICE`.
3497 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3499 // Parse `imageUrl`.
3500 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(imageUrl));
3502 // Pass cookies to download manager if cookies are enabled. This is required to download images from websites that require a login.
3503 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3504 if (firstPartyCookiesEnabled) {
3505 // Get the cookies for `imageUrl`.
3506 String cookies = cookieManager.getCookie(imageUrl);
3508 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3509 downloadRequest.addRequestHeader("Cookie", cookies);
3512 // Get the file name from the dialog fragment.
3513 EditText downloadImageNameEditText = dialogFragment.getDialog().findViewById(R.id.download_image_name);
3514 String imageName = downloadImageNameEditText.getText().toString();
3516 // Specify the download location.
3517 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3518 // Download to the public download directory.
3519 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, imageName);
3520 } else { // External write permission denied.
3521 // Download to the app's external download directory.
3522 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, imageName);
3525 // Allow `MediaScanner` to index the download if it is a media file.
3526 downloadRequest.allowScanningByMediaScanner();
3528 // Add the URL as the description for the download.
3529 downloadRequest.setDescription(imageUrl);
3531 // Show the download notification after the download is completed.
3532 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3534 // Remove the lint warning below that `downloadManager` might be `null`.
3535 assert downloadManager != null;
3537 // Initiate the download.
3538 downloadManager.enqueue(downloadRequest);
3539 } else { // The image is not an HTTP or HTTPS URI.
3540 Snackbar.make(mainWebView, R.string.cannot_download_image, Snackbar.LENGTH_INDEFINITE).show();
3545 public void onDownloadFile(AppCompatDialogFragment dialogFragment, String downloadUrl) {
3546 // Download the file if it has an HTTP or HTTPS URI.
3547 if (downloadUrl.startsWith("http")) {
3548 // Get a handle for the system `DOWNLOAD_SERVICE`.
3549 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3551 // Parse `downloadUrl`.
3552 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(downloadUrl));
3554 // Pass cookies to download manager if cookies are enabled. This is required to download files from websites that require a login.
3555 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3556 if (firstPartyCookiesEnabled) {
3557 // Get the cookies for `downloadUrl`.
3558 String cookies = cookieManager.getCookie(downloadUrl);
3560 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3561 downloadRequest.addRequestHeader("Cookie", cookies);
3564 // Get the file name from the dialog fragment.
3565 EditText downloadFileNameEditText = dialogFragment.getDialog().findViewById(R.id.download_file_name);
3566 String fileName = downloadFileNameEditText.getText().toString();
3568 // Specify the download location.
3569 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3570 // Download to the public download directory.
3571 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, fileName);
3572 } else { // External write permission denied.
3573 // Download to the app's external download directory.
3574 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, fileName);
3577 // Allow `MediaScanner` to index the download if it is a media file.
3578 downloadRequest.allowScanningByMediaScanner();
3580 // Add the URL as the description for the download.
3581 downloadRequest.setDescription(downloadUrl);
3583 // Show the download notification after the download is completed.
3584 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3586 // Remove the lint warning below that `downloadManager` might be `null`.
3587 assert downloadManager != null;
3589 // Initiate the download.
3590 downloadManager.enqueue(downloadRequest);
3591 } else { // The download is not an HTTP or HTTPS URI.
3592 Snackbar.make(mainWebView, R.string.cannot_download_file, Snackbar.LENGTH_INDEFINITE).show();
3597 public void onSaveBookmark(AppCompatDialogFragment dialogFragment, int selectedBookmarkDatabaseId) {
3598 // Get handles for the views from `dialogFragment`.
3599 EditText editBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_name_edittext);
3600 EditText editBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_url_edittext);
3601 RadioButton currentBookmarkIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_current_icon_radiobutton);
3603 // Store the bookmark strings.
3604 String bookmarkNameString = editBookmarkNameEditText.getText().toString();
3605 String bookmarkUrlString = editBookmarkUrlEditText.getText().toString();
3607 // Update the bookmark.
3608 if (currentBookmarkIconRadioButton.isChecked()) { // Update the bookmark without changing the favorite icon.
3609 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString);
3610 } else { // Update the bookmark using the `WebView` favorite icon.
3611 // Convert the favorite icon to a byte array. `0` is for lossless compression (the only option for a PNG).
3612 ByteArrayOutputStream newFavoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
3613 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFavoriteIconByteArrayOutputStream);
3614 byte[] newFavoriteIconByteArray = newFavoriteIconByteArrayOutputStream.toByteArray();
3616 // Update the bookmark and the favorite icon.
3617 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString, newFavoriteIconByteArray);
3620 // Update `bookmarksCursor` with the current contents of this folder.
3621 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3623 // Update the `ListView`.
3624 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3628 public void onSaveBookmarkFolder(AppCompatDialogFragment dialogFragment, int selectedFolderDatabaseId) {
3629 // Get handles for the views from `dialogFragment`.
3630 EditText editFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_folder_name_edittext);
3631 RadioButton currentFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_current_icon_radiobutton);
3632 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_radiobutton);
3633 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_imageview);
3635 // Get the new folder name.
3636 String newFolderNameString = editFolderNameEditText.getText().toString();
3638 // Check if the favorite icon has changed.
3639 if (currentFolderIconRadioButton.isChecked()) { // Only the name has changed.
3640 // Update the name in the database.
3641 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString);
3642 } else if (!currentFolderIconRadioButton.isChecked() && newFolderNameString.equals(oldFolderNameString)) { // Only the icon has changed.
3643 // Get the new folder icon `Bitmap`.
3644 Bitmap folderIconBitmap;
3645 if (defaultFolderIconRadioButton.isChecked()) {
3646 // Get the default folder icon and convert it to a `Bitmap`.
3647 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3648 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3649 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3650 } else { // Use the `WebView` favorite icon.
3651 folderIconBitmap = favoriteIconBitmap;
3654 // Convert the folder `Bitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
3655 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3656 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3657 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3659 // Update the folder icon in the database.
3660 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, folderIconByteArray);
3661 } else { // The folder icon and the name have changed.
3662 // Get the new folder icon `Bitmap`.
3663 Bitmap folderIconBitmap;
3664 if (defaultFolderIconRadioButton.isChecked()) {
3665 // Get the default folder icon and convert it to a `Bitmap`.
3666 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3667 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3668 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3669 } else { // Use the `WebView` favorite icon.
3670 folderIconBitmap = MainWebViewActivity.favoriteIconBitmap;
3673 // Convert the folder `Bitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
3674 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3675 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3676 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3678 // Update the folder name and icon in the database.
3679 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString, folderIconByteArray);
3682 // Update `bookmarksCursor` with the current contents of this folder.
3683 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3685 // Update the `ListView`.
3686 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3690 public void onHttpAuthenticationCancel() {
3691 // Cancel the `HttpAuthHandler`.
3692 httpAuthHandler.cancel();
3696 public void onHttpAuthenticationProceed(AppCompatDialogFragment dialogFragment) {
3697 // Get handles for the `EditTexts`.
3698 EditText usernameEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_username);
3699 EditText passwordEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_password);
3701 // Proceed with the HTTP authentication.
3702 httpAuthHandler.proceed(usernameEditText.getText().toString(), passwordEditText.getText().toString());
3705 public void viewSslCertificate(View view) {
3706 // Show the `ViewSslCertificateDialog` `AlertDialog` and name this instance `@string/view_ssl_certificate`.
3707 DialogFragment viewSslCertificateDialogFragment = new ViewSslCertificateDialog();
3708 viewSslCertificateDialogFragment.show(getFragmentManager(), getString(R.string.view_ssl_certificate));
3712 public void onSslErrorCancel() {
3713 sslErrorHandler.cancel();
3717 public void onSslErrorProceed() {
3718 sslErrorHandler.proceed();
3722 public void onSslMismatchBack() {
3723 if (mainWebView.canGoBack()) { // There is a back page in the history.
3724 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
3725 formattedUrlString = "";
3727 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3728 navigatingHistory = true;
3731 mainWebView.goBack();
3732 } else { // There are no pages to go back to.
3733 // Load a blank page
3739 public void onSslMismatchProceed() {
3740 // Do not check the pinned SSL certificate for this domain again until the domain changes.
3741 ignorePinnedSslCertificate = true;
3745 public void onUrlHistoryEntrySelected(int moveBackOrForwardSteps) {
3746 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
3747 formattedUrlString = "";
3749 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3750 navigatingHistory = true;
3752 // Load the history entry.
3753 mainWebView.goBackOrForward(moveBackOrForwardSteps);
3757 public void onClearHistory() {
3758 // Clear the history.
3759 mainWebView.clearHistory();
3762 // Override `onBackPressed` to handle the navigation drawer and `mainWebView`.
3764 public void onBackPressed() {
3765 if (drawerLayout.isDrawerVisible(GravityCompat.START)) { // The navigation drawer is open.
3766 // Close the navigation drawer.
3767 drawerLayout.closeDrawer(GravityCompat.START);
3768 } else if (drawerLayout.isDrawerVisible(GravityCompat.END)){ // The bookmarks drawer is open.
3769 if (currentBookmarksFolder.isEmpty()) { // The home folder is displayed.
3770 // close the bookmarks drawer.
3771 drawerLayout.closeDrawer(GravityCompat.END);
3772 } else { // A subfolder is displayed.
3773 // Place the former parent folder in `currentFolder`.
3774 currentBookmarksFolder = bookmarksDatabaseHelper.getParentFolder(currentBookmarksFolder);
3776 // Load the new folder.
3777 loadBookmarksFolder();
3780 } else if (mainWebView.canGoBack()) { // There is at least one item in the `WebView` history.
3781 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
3782 formattedUrlString = "";
3784 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3785 navigatingHistory = true;
3788 mainWebView.goBack();
3789 } else { // There isn't anything to do in Privacy Browser.
3790 // Pass `onBackPressed()` to the system.
3791 super.onBackPressed();
3795 // 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.
3797 public void onActivityResult(int requestCode, int resultCode, Intent data) {
3798 // File uploads only work on API >= 21.
3799 if (Build.VERSION.SDK_INT >= 21) {
3800 // Pass the file to the WebView.
3801 fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(resultCode, data));
3805 private void loadUrlFromTextBox() throws UnsupportedEncodingException {
3806 // Get the text from urlTextBox and convert it to a string. trim() removes white spaces from the beginning and end of the string.
3807 String unformattedUrlString = urlTextBox.getText().toString().trim();
3809 // Check to see if `unformattedUrlString` is a valid URL. Otherwise, convert it into a search.
3810 if ((Patterns.WEB_URL.matcher(unformattedUrlString).matches()) || (unformattedUrlString.startsWith("http://")) || (unformattedUrlString.startsWith("https://"))) {
3811 // Add `https://` at the beginning if it is missing. Otherwise the app will segfault.
3812 if (!unformattedUrlString.startsWith("http")) {
3813 unformattedUrlString = "https://" + unformattedUrlString;
3816 // Initialize `unformattedUrl`.
3817 URL unformattedUrl = null;
3819 // 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.
3821 unformattedUrl = new URL(unformattedUrlString);
3822 } catch (MalformedURLException e) {
3823 e.printStackTrace();
3826 // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if `.get` was called on a `null` value.
3827 final String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
3828 final String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
3829 final String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
3830 final String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
3831 final String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
3834 Uri.Builder formattedUri = new Uri.Builder();
3835 formattedUri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
3837 // Decode `formattedUri` as a `String` in `UTF-8`.
3838 formattedUrlString = URLDecoder.decode(formattedUri.build().toString(), "UTF-8");
3839 } else if (unformattedUrlString.isEmpty()){ // Load a blank web site.
3840 // Load a blank string.
3841 formattedUrlString = "";
3842 } else { // Search for the contents of the URL box.
3843 // Sanitize the search input and convert it to a search.
3844 final String encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
3846 // Add the base search URL.
3847 formattedUrlString = searchURL + encodedUrlString;
3850 // 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.
3851 urlTextBox.clearFocus();
3854 loadUrl(formattedUrlString);
3857 private void loadUrl(String url) {// Apply any custom domain settings.
3858 // Set the URL as the formatted URL string so that checking third-party requests works correctly.
3859 formattedUrlString = url;
3861 // Apply the domain settings.
3862 applyDomainSettings(url, true, false);
3864 // If loading a website, set `urlIsLoading` to prevent changes in the user agent on websites with redirects from reloading the current website.
3865 urlIsLoading = !url.equals("");
3868 mainWebView.loadUrl(url, customHeaders);
3871 public void findPreviousOnPage(View view) {
3872 // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards.
3873 mainWebView.findNext(false);
3876 public void findNextOnPage(View view) {
3877 // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
3878 mainWebView.findNext(true);
3881 public void closeFindOnPage(View view) {
3882 // Delete the contents of `find_on_page_edittext`.
3883 findOnPageEditText.setText(null);
3885 // Clear the highlighted phrases.
3886 mainWebView.clearMatches();
3888 // Hide the Find on Page `RelativeLayout`.
3889 findOnPageLinearLayout.setVisibility(View.GONE);
3891 // Show the URL app bar.
3892 supportAppBar.setVisibility(View.VISIBLE);
3894 // Hide the keyboard so we can see the webpage. `0` indicates no additional flags.
3895 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
3898 private void applyAppSettings() {
3899 // Get a handle for the shared preferences.
3900 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3902 // Store the values from the shared preferences in variables.
3903 incognitoModeEnabled = sharedPreferences.getBoolean("incognito_mode", false);
3904 boolean doNotTrackEnabled = sharedPreferences.getBoolean("do_not_track", false);
3905 proxyThroughOrbot = sharedPreferences.getBoolean("proxy_through_orbot", false);
3906 fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean("full_screen_browsing_mode", false);
3907 hideSystemBarsOnFullscreen = sharedPreferences.getBoolean("hide_system_bars", false);
3908 translucentNavigationBarOnFullscreen = sharedPreferences.getBoolean("translucent_navigation_bar", true);
3909 displayWebpageImagesBoolean = sharedPreferences.getBoolean("display_webpage_images", true);
3911 // Apply the proxy through Orbot settings.
3912 applyProxyThroughOrbot(false);
3914 // Set Do Not Track status.
3915 if (doNotTrackEnabled) {
3916 customHeaders.put("DNT", "1");
3918 customHeaders.remove("DNT");
3921 // Apply the appropriate full screen mode the `SYSTEM_UI` flags.
3922 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
3923 if (hideSystemBarsOnFullscreen) { // Hide everything.
3924 // Remove the translucent navigation setting if it is currently flagged.
3925 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3927 // Remove the translucent status bar overlay.
3928 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3930 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
3931 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
3933 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
3934 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
3935 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
3937 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
3938 } else { // Hide everything except the status and navigation bars.
3939 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
3940 rootCoordinatorLayout.setSystemUiVisibility(0);
3942 // Add the translucent status flag if it is unset.
3943 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3945 if (translucentNavigationBarOnFullscreen) {
3946 // Set the navigation bar to be translucent.
3947 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3949 // Set the navigation bar to be black.
3950 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3953 } else { // Privacy Browser is not in full screen browsing mode.
3954 // 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.
3955 inFullScreenBrowsingMode = false;
3957 // Show the `appBar` if `findOnPageLinearLayout` is not visible.
3958 if (findOnPageLinearLayout.getVisibility() == View.GONE) {
3962 // Show the `BannerAd` in the free flavor.
3963 if (BuildConfig.FLAVOR.contentEquals("free")) {
3964 // Initialize the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
3965 AdHelper.initializeAds(findViewById(R.id.adview), getApplicationContext(), getFragmentManager(), getString(R.string.google_app_id), getString(R.string.ad_unit_id));
3968 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
3969 rootCoordinatorLayout.setSystemUiVisibility(0);
3971 // Remove the translucent navigation bar flag if it is set.
3972 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3974 // Add the translucent status flag if it is unset. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
3975 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3977 // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
3978 rootCoordinatorLayout.setFitsSystemWindows(true);
3982 // `reloadWebsite` is used if returning from the Domains activity. Otherwise JavaScript might not function correctly if it is newly enabled.
3983 // The deprecated `.getDrawable()` must be used until the minimum API >= 21.
3984 @SuppressWarnings("deprecation")
3985 private void applyDomainSettings(String url, boolean resetFavoriteIcon, boolean reloadWebsite) {
3986 // Parse the URL into a URI.
3987 Uri uri = Uri.parse(url);
3989 // Extract the domain from `uri`.
3990 String hostName = uri.getHost();
3992 // Initialize `loadingNewDomainName`.
3993 boolean loadingNewDomainName;
3995 // If either `hostName` or `currentDomainName` are `null`, run the options for loading a new domain name.
3996 // The lint suggestion to simplify the `if` statement is incorrect, because `hostName.equals(currentDomainName)` can produce a `null object reference.`
3997 //noinspection SimplifiableIfStatement
3998 if ((hostName == null) || (currentDomainName == null)) {
3999 loadingNewDomainName = true;
4000 } else { // Determine if `hostName` equals `currentDomainName`.
4001 loadingNewDomainName = !hostName.equals(currentDomainName);
4004 // Strings don't like to be null.
4005 if (hostName == null) {
4009 // 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.
4010 if (loadingNewDomainName) {
4011 // Set the new `hostname` as the `currentDomainName`.
4012 currentDomainName = hostName;
4014 // Reset `ignorePinnedSslCertificate`.
4015 ignorePinnedSslCertificate = false;
4017 // Reset the favorite icon if specified.
4018 if (resetFavoriteIcon) {
4019 favoriteIconBitmap = favoriteIconDefaultBitmap;
4020 favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(favoriteIconBitmap, 64, 64, true));
4023 // Initialize the database handler. The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
4024 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
4026 // Get a full cursor from `domainsDatabaseHelper`.
4027 Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain();
4029 // Initialize `domainSettingsSet`.
4030 Set<String> domainSettingsSet = new HashSet<>();
4032 // Get the domain name column index.
4033 int domainNameColumnIndex = domainNameCursor.getColumnIndex(DomainsDatabaseHelper.DOMAIN_NAME);
4035 // Populate `domainSettingsSet`.
4036 for (int i = 0; i < domainNameCursor.getCount(); i++) {
4037 // Move `domainsCursor` to the current row.
4038 domainNameCursor.moveToPosition(i);
4040 // Store the domain name in `domainSettingsSet`.
4041 domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex));
4044 // Close `domainNameCursor.
4045 domainNameCursor.close();
4047 // Initialize variables to track if domain settings will be applied and, if so, under which name.
4048 domainSettingsApplied = false;
4049 String domainNameInDatabase = null;
4051 // Check the hostname.
4052 if (domainSettingsSet.contains(hostName)) {
4053 domainSettingsApplied = true;
4054 domainNameInDatabase = hostName;
4057 // Check all the subdomains of the host name against wildcard domains in the domain cursor.
4058 while (!domainSettingsApplied && hostName.contains(".")) { // Stop checking if domain settings are already applied or there are no more `.` in the host name.
4059 if (domainSettingsSet.contains("*." + hostName)) { // Check the host name prepended by `*.`.
4060 // Apply the domain settings.
4061 domainSettingsApplied = true;
4063 // Store the applied domain names as it appears in the database.
4064 domainNameInDatabase = "*." + hostName;
4067 // Strip out the lowest subdomain of of the host name.
4068 hostName = hostName.substring(hostName.indexOf(".") + 1);
4072 // Get a handle for the shared preference.
4073 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
4075 // Store the general preference information.
4076 String defaultFontSizeString = sharedPreferences.getString("default_font_size", "100");
4077 String defaultUserAgentName = sharedPreferences.getString("user_agent", "Privacy Browser");
4078 defaultCustomUserAgentString = sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0");
4079 boolean defaultSwipeToRefresh = sharedPreferences.getBoolean("swipe_to_refresh", true);
4080 nightMode = sharedPreferences.getBoolean("night_mode", false);
4082 if (domainSettingsApplied) { // The url we are loading has custom domain settings.
4083 // Get a cursor for the current host and move it to the first position.
4084 Cursor currentHostDomainSettingsCursor = domainsDatabaseHelper.getCursorForDomainName(domainNameInDatabase);
4085 currentHostDomainSettingsCursor.moveToFirst();
4087 // Get the settings from the cursor.
4088 domainSettingsDatabaseId = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper._ID)));
4089 javaScriptEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1);
4090 firstPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FIRST_PARTY_COOKIES)) == 1);
4091 thirdPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_THIRD_PARTY_COOKIES)) == 1);
4092 domStorageEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1);
4093 // Form data can be removed once the minimum API >= 26.
4094 saveFormDataEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1);
4095 easyListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYLIST)) == 1);
4096 easyPrivacyEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYPRIVACY)) == 1);
4097 fanboysAnnoyanceListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_ANNOYANCE_LIST)) == 1);
4098 fanboysSocialBlockingListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST)) == 1);
4099 ultraPrivacyEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_ULTRAPRIVACY)) == 1);
4100 blockAllThirdPartyRequests = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.BLOCK_ALL_THIRD_PARTY_REQUESTS)) == 1);
4101 String userAgentName = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.USER_AGENT));
4102 int fontSize = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.FONT_SIZE));
4103 int swipeToRefreshInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SWIPE_TO_REFRESH));
4104 int nightModeInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.NIGHT_MODE));
4105 displayWebpageImagesInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.DISPLAY_IMAGES));
4106 pinnedDomainSslCertificate = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.PINNED_SSL_CERTIFICATE)) == 1);
4107 pinnedDomainSslIssuedToCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_COMMON_NAME));
4108 pinnedDomainSslIssuedToONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATION));
4109 pinnedDomainSslIssuedToUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT));
4110 pinnedDomainSslIssuedByCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_COMMON_NAME));
4111 pinnedDomainSslIssuedByONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATION));
4112 pinnedDomainSslIssuedByUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT));
4114 // Set `nightMode` according to `nightModeInt`. If `nightModeInt` is `DomainsDatabaseHelper.NIGHT_MODE_SYSTEM_DEFAULT` the current setting from `sharedPreferences` will be used.
4115 switch (nightModeInt) {
4116 case DomainsDatabaseHelper.NIGHT_MODE_ENABLED:
4120 case DomainsDatabaseHelper.NIGHT_MODE_DISABLED:
4125 // Store the domain JavaScript status. This is used by the options menu night mode toggle.
4126 domainSettingsJavaScriptEnabled = javaScriptEnabled;
4128 // Enable JavaScript if night mode is enabled.
4130 javaScriptEnabled = true;
4133 // Set the pinned SSL certificate start date to `null` if the saved date `long` is 0.
4134 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)) == 0) {
4135 pinnedDomainSslStartDate = null;
4137 pinnedDomainSslStartDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)));
4140 // Set the pinned SSL certificate end date to `null` if the saved date `long` is 0.
4141 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)) == 0) {
4142 pinnedDomainSslEndDate = null;
4144 pinnedDomainSslEndDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)));
4147 // Close `currentHostDomainSettingsCursor`.
4148 currentHostDomainSettingsCursor.close();
4150 // Apply the domain settings.
4151 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
4152 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
4153 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
4155 // Apply the form data setting if the API < 26.
4156 if (Build.VERSION.SDK_INT < 26) {
4157 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
4160 // Apply the font size.
4161 if (fontSize == 0) { // Apply the default font size.
4162 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
4163 } else { // Apply the specified font size.
4164 mainWebView.getSettings().setTextZoom(fontSize);
4167 // Set third-party cookies status if API >= 21.
4168 if (Build.VERSION.SDK_INT >= 21) {
4169 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
4172 // 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.
4173 // <https://redmine.stoutner.com/issues/160>
4174 if (!urlIsLoading) {
4175 // Set the user agent.
4176 if (userAgentName.equals(getString(R.string.system_default_user_agent))) { // Use the system default user agent.
4177 // Get the array position of the default user agent name.
4178 int defaultUserAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
4180 // Set the user agent according to the system default.
4181 switch (defaultUserAgentArrayPosition) {
4182 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
4183 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
4184 mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
4187 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
4188 // Set the user agent to `""`, which uses the default value.
4189 mainWebView.getSettings().setUserAgentString("");
4192 case SETTINGS_CUSTOM_USER_AGENT:
4193 // Set the custom user agent.
4194 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
4198 // Get the user agent string from the user agent data array
4199 mainWebView.getSettings().setUserAgentString(userAgentDataArray[defaultUserAgentArrayPosition]);
4201 } else { // Set the user agent according to the stored name.
4202 // Get the array position of the user agent name.
4203 int userAgentArrayPosition = userAgentNamesArray.getPosition(userAgentName);
4205 switch (userAgentArrayPosition) {
4206 case UNRECOGNIZED_USER_AGENT: // The user agent name contains a custom user agent.
4207 mainWebView.getSettings().setUserAgentString(userAgentName);
4210 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
4211 // Set the user agent to `""`, which uses the default value.
4212 mainWebView.getSettings().setUserAgentString("");
4216 // Get the user agent string from the user agent data array.
4217 mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
4221 // Set swipe to refresh.
4222 switch (swipeToRefreshInt) {
4223 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_SYSTEM_DEFAULT:
4224 // Set swipe to refresh according to the default.
4225 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
4228 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_ENABLED:
4229 // Enable swipe to refresh.
4230 swipeRefreshLayout.setEnabled(true);
4233 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_DISABLED:
4234 // Disable swipe to refresh.
4235 swipeRefreshLayout.setEnabled(false);
4238 // Store the applied user agent string, which is used in the View Source activity.
4239 appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
4242 // 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.
4244 urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_dark_blue));
4246 urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_light_green));
4248 } else { // The new URL does not have custom domain settings. Load the defaults.
4249 // Store the values from `sharedPreferences` in variables.
4250 javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
4251 firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
4252 thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
4253 domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
4254 saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false); // Form data can be removed once the minimum API >= 26.
4255 easyListEnabled = sharedPreferences.getBoolean("easylist", true);
4256 easyPrivacyEnabled = sharedPreferences.getBoolean("easyprivacy", true);
4257 fanboysAnnoyanceListEnabled = sharedPreferences.getBoolean("fanboy_annoyance_list", true);
4258 fanboysSocialBlockingListEnabled = sharedPreferences.getBoolean("fanboy_social_blocking_list", true);
4259 ultraPrivacyEnabled = sharedPreferences.getBoolean("ultraprivacy", true);
4260 blockAllThirdPartyRequests = sharedPreferences.getBoolean("block_all_third_party_requests", false);
4262 // Set `javaScriptEnabled` to be `true` if `night_mode` is `true`.
4264 javaScriptEnabled = true;
4267 // Apply the default settings.
4268 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
4269 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
4270 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
4271 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
4272 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
4274 // Apply the form data setting if the API < 26.
4275 if (Build.VERSION.SDK_INT < 26) {
4276 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
4279 // Reset the pinned SSL certificate information.
4280 domainSettingsDatabaseId = -1;
4281 pinnedDomainSslCertificate = false;
4282 pinnedDomainSslIssuedToCNameString = "";
4283 pinnedDomainSslIssuedToONameString = "";
4284 pinnedDomainSslIssuedToUNameString = "";
4285 pinnedDomainSslIssuedByCNameString = "";
4286 pinnedDomainSslIssuedByONameString = "";
4287 pinnedDomainSslIssuedByUNameString = "";
4288 pinnedDomainSslStartDate = null;
4289 pinnedDomainSslEndDate = null;
4291 // Set third-party cookies status if API >= 21.
4292 if (Build.VERSION.SDK_INT >= 21) {
4293 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
4296 // 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.
4297 // <https://redmine.stoutner.com/issues/160>
4298 if (!urlIsLoading) {
4299 // Get the array position of the user agent name.
4300 int userAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
4302 // Set the user agent.
4303 switch (userAgentArrayPosition) {
4304 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
4305 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
4306 mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
4309 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
4310 // Set the user agent to `""`, which uses the default value.
4311 mainWebView.getSettings().setUserAgentString("");
4314 case SETTINGS_CUSTOM_USER_AGENT:
4315 // Set the custom user agent.
4316 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
4320 // Get the user agent string from the user agent data array
4321 mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
4324 // Store the applied user agent string, which is used in the View Source activity.
4325 appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
4328 // Set a transparent background on `urlTextBox`. We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
4329 urlAppBarRelativeLayout.setBackgroundDrawable(getResources().getDrawable(R.color.transparent));
4332 // Close the domains database helper.
4333 domainsDatabaseHelper.close();
4335 // Remove the `onTheFlyDisplayImagesSet` flag and set the display webpage images mode. `true` indicates that custom domain settings are applied.
4336 onTheFlyDisplayImagesSet = false;
4337 setDisplayWebpageImages();
4339 // Update the privacy icons, but only if `mainMenu` has already been populated.
4340 if (mainMenu != null) {
4341 updatePrivacyIcons(true);
4345 // Reload the website if returning from the Domains activity.
4346 if (reloadWebsite) {
4347 mainWebView.reload();
4351 private void applyProxyThroughOrbot(boolean reloadWebsite) {
4352 // Get a handle for the shared preferences.
4353 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
4355 // Get the search preferences.
4356 String homepageString = sharedPreferences.getString("homepage", "https://searx.me/");
4357 String torHomepageString = sharedPreferences.getString("tor_homepage", "http://ulrn6sryqaifefld.onion/");
4358 String torSearchString = sharedPreferences.getString("tor_search", "http://ulrn6sryqaifefld.onion/?q=");
4359 String torSearchCustomUrlString = sharedPreferences.getString("tor_search_custom_url", "");
4360 String searchString = sharedPreferences.getString("search", "https://searx.me/?q=");
4361 String searchCustomUrlString = sharedPreferences.getString("search_custom_url", "");
4363 // Set the homepage, search, and proxy options.
4364 if (proxyThroughOrbot) { // Set the Tor options.
4365 // Set `torHomepageString` as `homepage`.
4366 homepage = torHomepageString;
4368 // If formattedUrlString is null assign the homepage to it.
4369 if (formattedUrlString == null) {
4370 formattedUrlString = homepage;
4373 // Set the search URL.
4374 if (torSearchString.equals("Custom URL")) { // Get the custom URL string.
4375 searchURL = torSearchCustomUrlString;
4376 } else { // Use the string from the pre-built list.
4377 searchURL = torSearchString;
4380 // Set the proxy. `this` refers to the current activity where an `AlertDialog` might be displayed.
4381 OrbotProxyHelper.setProxy(getApplicationContext(), this, "localhost", "8118");
4383 // Set the `appBar` background to indicate proxying through Orbot is enabled. `this` refers to the context.
4385 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.dark_blue_30));
4387 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.blue_50));
4390 // Check to see if Orbot is ready.
4391 if (!orbotStatus.equals("ON")) { // Orbot is not ready.
4392 // Set `waitingForOrbot`.
4393 waitingForOrbot = true;
4395 // Disable the wide view port so that the waiting for Orbot text is displayed correctly.
4396 mainWebView.getSettings().setUseWideViewPort(false);
4398 // Load a waiting page. `null` specifies no encoding, which defaults to ASCII.
4399 mainWebView.loadData(waitingForOrbotHtmlString, "text/html", null);
4400 } else if (reloadWebsite) { // Orbot is ready and the website should be reloaded.
4401 // Reload the website.
4402 mainWebView.reload();
4404 } else { // Set the non-Tor options.
4405 // Set `homepageString` as `homepage`.
4406 homepage = homepageString;
4408 // If formattedUrlString is null assign the homepage to it.
4409 if (formattedUrlString == null) {
4410 formattedUrlString = homepage;
4413 // Set the search URL.
4414 if (searchString.equals("Custom URL")) { // Get the custom URL string.
4415 searchURL = searchCustomUrlString;
4416 } else { // Use the string from the pre-built list.
4417 searchURL = searchString;
4420 // Reset the proxy to default. The host is `""` and the port is `"0"`.
4421 OrbotProxyHelper.setProxy(getApplicationContext(), this, "", "0");
4423 // Set the default `appBar` background. `this` refers to the context.
4425 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_900));
4427 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_100));
4430 // Reset `waitingForOrbot.
4431 waitingForOrbot = false;
4433 // Reload the website if requested.
4434 if (reloadWebsite) {
4435 mainWebView.reload();
4440 private void setDisplayWebpageImages() {
4441 if (!onTheFlyDisplayImagesSet) {
4442 if (domainSettingsApplied) { // Custom domain settings are applied.
4443 switch (displayWebpageImagesInt) {
4444 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_SYSTEM_DEFAULT:
4445 mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
4448 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_ENABLED:
4449 mainWebView.getSettings().setLoadsImagesAutomatically(true);
4452 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_DISABLED:
4453 mainWebView.getSettings().setLoadsImagesAutomatically(false);
4456 } else { // Default settings are applied.
4457 mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
4462 private void updatePrivacyIcons(boolean runInvalidateOptionsMenu) {
4463 // Get handles for the menu items.
4464 MenuItem privacyMenuItem = mainMenu.findItem(R.id.toggle_javascript);
4465 MenuItem firstPartyCookiesMenuItem = mainMenu.findItem(R.id.toggle_first_party_cookies);
4466 MenuItem domStorageMenuItem = mainMenu.findItem(R.id.toggle_dom_storage);
4467 MenuItem refreshMenuItem = mainMenu.findItem(R.id.refresh);
4469 // Update the privacy icon.
4470 if (javaScriptEnabled) { // JavaScript is enabled.
4471 privacyMenuItem.setIcon(R.drawable.javascript_enabled);
4472 } else if (firstPartyCookiesEnabled) { // JavaScript is disabled but cookies are enabled.
4473 privacyMenuItem.setIcon(R.drawable.warning);
4474 } else { // All the dangerous features are disabled.
4475 privacyMenuItem.setIcon(R.drawable.privacy_mode);
4478 // Update the first-party cookies icon.
4479 if (firstPartyCookiesEnabled) { // First-party cookies are enabled.
4480 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_enabled);
4481 } else { // First-party cookies are disabled.
4483 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_dark);
4485 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_light);
4489 // Update the DOM storage icon.
4490 if (javaScriptEnabled && domStorageEnabled) { // Both JavaScript and DOM storage are enabled.
4491 domStorageMenuItem.setIcon(R.drawable.dom_storage_enabled);
4492 } else if (javaScriptEnabled) { // JavaScript is enabled but DOM storage is disabled.
4494 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_dark);
4496 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_light);
4498 } else { // JavaScript is disabled, so DOM storage is ghosted.
4500 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_dark);
4502 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_light);
4506 // Update the refresh icon.
4508 refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
4510 refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
4513 // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`.
4514 if (runInvalidateOptionsMenu) {
4515 invalidateOptionsMenu();
4519 private void highlightUrlText() {
4520 String urlString = urlTextBox.getText().toString();
4522 if (urlString.startsWith("http://")) { // Highlight the protocol of connections that are not encrypted.
4523 urlTextBox.getText().setSpan(redColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4524 } else if (urlString.startsWith("https://")) { // De-emphasize the protocol of connections that are encrypted.
4525 urlTextBox.getText().setSpan(initialGrayColorSpan, 0, 8, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4528 // Get the index of the `/` immediately after the domain name.
4529 int endOfDomainName = urlString.indexOf("/", (urlString.indexOf("//") + 2));
4531 // De-emphasize the text after the domain name.
4532 if (endOfDomainName > 0) {
4533 urlTextBox.getText().setSpan(finalGrayColorSpan, endOfDomainName, urlString.length(), Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4537 private void loadBookmarksFolder() {
4538 // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
4539 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
4541 // Populate the bookmarks cursor adapter. `this` specifies the `Context`. `false` disables `autoRequery`.
4542 bookmarksCursorAdapter = new CursorAdapter(this, bookmarksCursor, false) {
4544 public View newView(Context context, Cursor cursor, ViewGroup parent) {
4545 // Inflate the individual item layout. `false` does not attach it to the root.
4546 return getLayoutInflater().inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false);
4550 public void bindView(View view, Context context, Cursor cursor) {
4551 // Get handles for the views.
4552 ImageView bookmarkFavoriteIcon = view.findViewById(R.id.bookmark_favorite_icon);
4553 TextView bookmarkNameTextView = view.findViewById(R.id.bookmark_name);
4555 // Get the favorite icon byte array from the cursor.
4556 byte[] favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
4558 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
4559 Bitmap favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.length);
4561 // Display the bitmap in `bookmarkFavoriteIcon`.
4562 bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap);
4564 // Get the bookmark name from the cursor and display it in `bookmarkNameTextView`.
4565 String bookmarkNameString = cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
4566 bookmarkNameTextView.setText(bookmarkNameString);
4568 // Make the font bold for folders.
4569 if (cursor.getInt(cursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {
4570 bookmarkNameTextView.setTypeface(Typeface.DEFAULT_BOLD);
4571 } else { // Reset the font to default for normal bookmarks.
4572 bookmarkNameTextView.setTypeface(Typeface.DEFAULT);
4577 // Populate the `ListView` with the adapter.
4578 bookmarksListView.setAdapter(bookmarksCursorAdapter);
4580 // Set the bookmarks drawer title.
4581 if (currentBookmarksFolder.isEmpty()) {
4582 bookmarksTitleTextView.setText(R.string.bookmarks);
4584 bookmarksTitleTextView.setText(currentBookmarksFolder);