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()`, and `loadUrlFromTextBox()`.
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()` and `onResume()`.
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()`, and `applyAppSettings()`.
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()`, and `setDisplayWebpageImages()`.
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 `applyAppSettings()`.
338 private String homepage;
340 // `searchURL` is used in `loadURLFromTextBox()` and `applyAppSettings()`.
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()` and `applyAppSettings()`.
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 `applyAppSettings()`.
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 // `waitingForOrbotData` is used in `onCreate()` and `applyAppSettings()`.
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.domain_settings_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);
2064 // Set the text for the domain menu item.
2065 if (domainSettingsApplied) {
2066 addOrEditDomain.setTitle(R.string.edit_domain_settings);
2068 addOrEditDomain.setTitle(R.string.add_domain_settings);
2071 // Set the status of the menu item checkboxes.
2072 toggleFirstPartyCookiesMenuItem.setChecked(firstPartyCookiesEnabled);
2073 toggleThirdPartyCookiesMenuItem.setChecked(thirdPartyCookiesEnabled);
2074 toggleDomStorageMenuItem.setChecked(domStorageEnabled);
2075 toggleSaveFormDataMenuItem.setChecked(saveFormDataEnabled); // Form data can be removed once the minimum API >= 26.
2076 easyListMenuItem.setChecked(easyListEnabled);
2077 easyPrivacyMenuItem.setChecked(easyPrivacyEnabled);
2078 fanboysAnnoyanceListMenuItem.setChecked(fanboysAnnoyanceListEnabled);
2079 fanboysSocialBlockingListMenuItem.setChecked(fanboysSocialBlockingListEnabled);
2080 ultraPrivacyMenuItem.setChecked(ultraPrivacyEnabled);
2081 blockAllThirdPartyRequestsMenuItem.setChecked(blockAllThirdPartyRequests);
2082 swipeToRefreshMenuItem.setChecked(swipeRefreshLayout.isEnabled());
2083 displayImagesMenuItem.setChecked(mainWebView.getSettings().getLoadsImagesAutomatically());
2084 nightModeMenuItem.setChecked(nightMode);
2086 // Enable third-party cookies if first-party cookies are enabled.
2087 toggleThirdPartyCookiesMenuItem.setEnabled(firstPartyCookiesEnabled);
2089 // Enable DOM Storage if JavaScript is enabled.
2090 toggleDomStorageMenuItem.setEnabled(javaScriptEnabled);
2092 // Enable Clear Cookies if there are any.
2093 clearCookiesMenuItem.setEnabled(cookieManager.hasCookies());
2095 // Get a count of the number of files in the Local Storage directory.
2096 File localStorageDirectory = new File (privateDataDirectoryString + "/app_webview/Local Storage/");
2097 int localStorageDirectoryNumberOfFiles = 0;
2098 if (localStorageDirectory.exists()) {
2099 localStorageDirectoryNumberOfFiles = localStorageDirectory.list().length;
2102 // Get a count of the number of files in the IndexedDB directory.
2103 File indexedDBDirectory = new File (privateDataDirectoryString + "/app_webview/IndexedDB");
2104 int indexedDBDirectoryNumberOfFiles = 0;
2105 if (indexedDBDirectory.exists()) {
2106 indexedDBDirectoryNumberOfFiles = indexedDBDirectory.list().length;
2109 // Enable Clear DOM Storage if there is any.
2110 clearDOMStorageMenuItem.setEnabled(localStorageDirectoryNumberOfFiles > 0 || indexedDBDirectoryNumberOfFiles > 0);
2112 // Enable Clear Form Data is there is any. This can be removed once the minimum API >= 26.
2113 if (Build.VERSION.SDK_INT < 26) {
2114 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(this);
2115 clearFormDataMenuItem.setEnabled(mainWebViewDatabase.hasFormData());
2117 // Disable clear form data because it is not supported on current version of Android.
2118 clearFormDataMenuItem.setEnabled(false);
2121 // Enable Clear Data if any of the submenu items are enabled.
2122 clearDataMenuItem.setEnabled(clearCookiesMenuItem.isEnabled() || clearDOMStorageMenuItem.isEnabled() || clearFormDataMenuItem.isEnabled());
2124 // Disable Fanboy's Social Blocking List if Fanboy's Annoyance List is checked.
2125 fanboysSocialBlockingListMenuItem.setEnabled(!fanboysAnnoyanceListEnabled);
2127 // Initialize the display names for the blocklists with the number of blocked requests.
2128 blocklistsMenuItem.setTitle(getString(R.string.blocklists) + " - " + blockedRequests);
2129 easyListMenuItem.setTitle(easyListBlockedRequests + " - " + getString(R.string.easylist));
2130 easyPrivacyMenuItem.setTitle(easyPrivacyBlockedRequests + " - " + getString(R.string.easyprivacy));
2131 fanboysAnnoyanceListMenuItem.setTitle(fanboysAnnoyanceListBlockedRequests + " - " + getString(R.string.fanboys_annoyance_list));
2132 fanboysSocialBlockingListMenuItem.setTitle(fanboysSocialBlockingListBlockedRequests + " - " + getString(R.string.fanboys_social_blocking_list));
2133 ultraPrivacyMenuItem.setTitle(ultraPrivacyBlockedRequests + " - " + getString(R.string.ultraprivacy));
2134 blockAllThirdPartyRequestsMenuItem.setTitle(thirdPartyBlockedRequests + " - " + getString(R.string.block_all_third_party_requests));
2136 // Get the current user agent.
2137 String currentUserAgent = mainWebView.getSettings().getUserAgentString();
2139 // Select the current user agent menu item. A switch statement cannot be used because the user agents are not compile time constants.
2140 if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[0])) { // Privacy Browser.
2141 menu.findItem(R.id.user_agent_privacy_browser).setChecked(true);
2142 } else if (currentUserAgent.equals(webViewDefaultUserAgent)) { // WebView Default.
2143 menu.findItem(R.id.user_agent_webview_default).setChecked(true);
2144 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[2])) { // Firefox on Android.
2145 menu.findItem(R.id.user_agent_firefox_on_android).setChecked(true);
2146 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[3])) { // Chrome on Android.
2147 menu.findItem(R.id.user_agent_chrome_on_android).setChecked(true);
2148 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[4])) { // Safari on iOS.
2149 menu.findItem(R.id.user_agent_safari_on_ios).setChecked(true);
2150 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[5])) { // Firefox on Linux.
2151 menu.findItem(R.id.user_agent_firefox_on_linux).setChecked(true);
2152 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[6])) { // Chromium on Linux.
2153 menu.findItem(R.id.user_agent_chromium_on_linux).setChecked(true);
2154 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[7])) { // Firefox on Windows.
2155 menu.findItem(R.id.user_agent_firefox_on_windows).setChecked(true);
2156 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[8])) { // Chrome on Windows.
2157 menu.findItem(R.id.user_agent_chrome_on_windows).setChecked(true);
2158 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[9])) { // Edge on Windows.
2159 menu.findItem(R.id.user_agent_edge_on_windows).setChecked(true);
2160 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[10])) { // Internet Explorer on Windows.
2161 menu.findItem(R.id.user_agent_internet_explorer_on_windows).setChecked(true);
2162 } else if (currentUserAgent.equals(getResources().getStringArray(R.array.user_agent_data)[11])) { // Safari on macOS.
2163 menu.findItem(R.id.user_agent_safari_on_macos).setChecked(true);
2164 } else { // Custom user agent.
2165 menu.findItem(R.id.user_agent_custom).setChecked(true);
2168 // Initialize font size variables.
2169 int fontSize = mainWebView.getSettings().getTextZoom();
2170 String fontSizeTitle;
2171 MenuItem selectedFontSizeMenuItem;
2173 // Prepare the font size title and current size menu item.
2176 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.twenty_five_percent);
2177 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_twenty_five_percent);
2181 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.fifty_percent);
2182 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_fifty_percent);
2186 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.seventy_five_percent);
2187 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_seventy_five_percent);
2191 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
2192 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
2196 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_twenty_five_percent);
2197 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_twenty_five_percent);
2201 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_fifty_percent);
2202 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_fifty_percent);
2206 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_seventy_five_percent);
2207 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_seventy_five_percent);
2211 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.two_hundred_percent);
2212 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_two_hundred_percent);
2216 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
2217 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
2221 // Set the font size title and select the current size menu item.
2222 fontSizeMenuItem.setTitle(fontSizeTitle);
2223 selectedFontSizeMenuItem.setChecked(true);
2225 // Run all the other default commands.
2226 super.onPrepareOptionsMenu(menu);
2228 // Display the menu.
2233 // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
2234 @SuppressLint("SetJavaScriptEnabled")
2235 // removeAllCookies is deprecated, but it is required for API < 21.
2236 @SuppressWarnings("deprecation")
2237 public boolean onOptionsItemSelected(MenuItem menuItem) {
2238 // Get the selected menu item ID.
2239 int menuItemId = menuItem.getItemId();
2241 // Set the commands that relate to the menu entries.
2242 switch (menuItemId) {
2243 case R.id.toggle_javascript:
2244 // Switch the status of javaScriptEnabled.
2245 javaScriptEnabled = !javaScriptEnabled;
2247 // Apply the new JavaScript status.
2248 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
2250 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2251 updatePrivacyIcons(true);
2253 // Display a `Snackbar`.
2254 if (javaScriptEnabled) { // JavaScrip is enabled.
2255 Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show();
2256 } else if (firstPartyCookiesEnabled) { // JavaScript is disabled, but first-party cookies are enabled.
2257 Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show();
2258 } else { // Privacy mode.
2259 Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
2262 // Reload the WebView.
2263 mainWebView.reload();
2266 case R.id.add_or_edit_domain:
2267 if (domainSettingsApplied) { // Edit the current domain settings.
2268 // Reapply the domain settings on returning to `MainWebViewActivity`.
2269 reapplyDomainSettingsOnRestart = true;
2270 currentDomainName = "";
2272 // Create an intent to launch the domains activity.
2273 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2275 // Put extra information instructing the domains activity to directly load the current domain and close on back instead of returning to the domains list.
2276 domainsIntent.putExtra("loadDomain", domainSettingsDatabaseId);
2277 domainsIntent.putExtra("closeOnBack", true);
2280 startActivity(domainsIntent);
2281 } else { // Add a new domain.
2282 // Apply the new domain settings on returning to `MainWebViewActivity`.
2283 reapplyDomainSettingsOnRestart = true;
2284 currentDomainName = "";
2286 // Get the current domain
2287 Uri currentUri = Uri.parse(formattedUrlString);
2288 String currentDomain = currentUri.getHost();
2290 // Initialize the database handler. The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
2291 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
2293 // Create the domain and store the database ID.
2294 int newDomainDatabaseId = domainsDatabaseHelper.addDomain(currentDomain);
2296 // Create an intent to launch the domains activity.
2297 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2299 // Put extra information instructing the domains activity to directly load the new domain and close on back instead of returning to the domains list.
2300 domainsIntent.putExtra("loadDomain", newDomainDatabaseId);
2301 domainsIntent.putExtra("closeOnBack", true);
2304 startActivity(domainsIntent);
2308 case R.id.toggle_first_party_cookies:
2309 // Switch the status of firstPartyCookiesEnabled.
2310 firstPartyCookiesEnabled = !firstPartyCookiesEnabled;
2312 // Update the menu checkbox.
2313 menuItem.setChecked(firstPartyCookiesEnabled);
2315 // Apply the new cookie status.
2316 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
2318 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2319 updatePrivacyIcons(true);
2321 // Display a `Snackbar`.
2322 if (firstPartyCookiesEnabled) { // First-party cookies are enabled.
2323 Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
2324 } else if (javaScriptEnabled) { // JavaScript is still enabled.
2325 Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
2326 } else { // Privacy mode.
2327 Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
2330 // Reload the WebView.
2331 mainWebView.reload();
2334 case R.id.toggle_third_party_cookies:
2335 if (Build.VERSION.SDK_INT >= 21) {
2336 // Switch the status of thirdPartyCookiesEnabled.
2337 thirdPartyCookiesEnabled = !thirdPartyCookiesEnabled;
2339 // Update the menu checkbox.
2340 menuItem.setChecked(thirdPartyCookiesEnabled);
2342 // Apply the new cookie status.
2343 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
2345 // Display a `Snackbar`.
2346 if (thirdPartyCookiesEnabled) {
2347 Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
2349 Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
2352 // Reload the WebView.
2353 mainWebView.reload();
2354 } // Else do nothing because SDK < 21.
2357 case R.id.toggle_dom_storage:
2358 // Switch the status of domStorageEnabled.
2359 domStorageEnabled = !domStorageEnabled;
2361 // Update the menu checkbox.
2362 menuItem.setChecked(domStorageEnabled);
2364 // Apply the new DOM Storage status.
2365 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
2367 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2368 updatePrivacyIcons(true);
2370 // Display a `Snackbar`.
2371 if (domStorageEnabled) {
2372 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show();
2374 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show();
2377 // Reload the WebView.
2378 mainWebView.reload();
2381 // Form data can be removed once the minimum API >= 26.
2382 case R.id.toggle_save_form_data:
2383 // Switch the status of saveFormDataEnabled.
2384 saveFormDataEnabled = !saveFormDataEnabled;
2386 // Update the menu checkbox.
2387 menuItem.setChecked(saveFormDataEnabled);
2389 // Apply the new form data status.
2390 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
2392 // Display a `Snackbar`.
2393 if (saveFormDataEnabled) {
2394 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show();
2396 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show();
2399 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
2400 updatePrivacyIcons(true);
2402 // Reload the WebView.
2403 mainWebView.reload();
2406 case R.id.clear_cookies:
2407 Snackbar.make(findViewById(R.id.main_webview), R.string.cookies_deleted, Snackbar.LENGTH_LONG)
2408 .setAction(R.string.undo, v -> {
2409 // Do nothing because everything will be handled by `onDismissed()` below.
2411 .addCallback(new Snackbar.Callback() {
2413 public void onDismissed(Snackbar snackbar, int event) {
2415 // The user pushed the `Undo` button.
2416 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2420 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2422 // `cookieManager.removeAllCookie()` varies by SDK.
2423 if (Build.VERSION.SDK_INT < 21) {
2424 cookieManager.removeAllCookie();
2426 // `null` indicates no callback.
2427 cookieManager.removeAllCookies(null);
2435 case R.id.clear_dom_storage:
2436 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
2437 .setAction(R.string.undo, v -> {
2438 // Do nothing because everything will be handled by `onDismissed()` below.
2440 .addCallback(new Snackbar.Callback() {
2442 public void onDismissed(Snackbar snackbar, int event) {
2444 // The user pushed the `Undo` button.
2445 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2449 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2451 // Delete the DOM Storage.
2452 WebStorage webStorage = WebStorage.getInstance();
2453 webStorage.deleteAllData();
2455 // Manually delete the DOM storage files and directories.
2457 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2458 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2460 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2461 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2462 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2463 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2464 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2465 } catch (IOException e) {
2466 // Do nothing if an error is thrown.
2474 // Form data can be remove once the minimum API >= 26.
2475 case R.id.clear_form_data:
2476 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_deleted, Snackbar.LENGTH_LONG)
2477 .setAction(R.string.undo, v -> {
2478 // Do nothing because everything will be handled by `onDismissed()` below.
2480 .addCallback(new Snackbar.Callback() {
2482 public void onDismissed(Snackbar snackbar, int event) {
2484 // The user pushed the `Undo` button.
2485 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2489 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2491 // Delete the form data.
2492 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(getApplicationContext());
2493 mainWebViewDatabase.clearFormData();
2501 // Toggle the EasyList status.
2502 easyListEnabled = !easyListEnabled;
2504 // Update the menu checkbox.
2505 menuItem.setChecked(easyListEnabled);
2507 // Reload the main WebView.
2508 mainWebView.reload();
2511 case R.id.easyprivacy:
2512 // Toggle the EasyPrivacy status.
2513 easyPrivacyEnabled = !easyPrivacyEnabled;
2515 // Update the menu checkbox.
2516 menuItem.setChecked(easyPrivacyEnabled);
2518 // Reload the main WebView.
2519 mainWebView.reload();
2522 case R.id.fanboys_annoyance_list:
2523 // Toggle Fanboy's Annoyance List status.
2524 fanboysAnnoyanceListEnabled = !fanboysAnnoyanceListEnabled;
2526 // Update the menu checkbox.
2527 menuItem.setChecked(fanboysAnnoyanceListEnabled);
2529 // Update the staus of Fanboy's Social Blocking List.
2530 MenuItem fanboysSocialBlockingListMenuItem = mainMenu.findItem(R.id.fanboys_social_blocking_list);
2531 fanboysSocialBlockingListMenuItem.setEnabled(!fanboysAnnoyanceListEnabled);
2533 // Reload the main WebView.
2534 mainWebView.reload();
2537 case R.id.fanboys_social_blocking_list:
2538 // Toggle Fanboy's Social Blocking List status.
2539 fanboysSocialBlockingListEnabled = !fanboysSocialBlockingListEnabled;
2541 // Update the menu checkbox.
2542 menuItem.setChecked(fanboysSocialBlockingListEnabled);
2544 // Reload the main WebView.
2545 mainWebView.reload();
2548 case R.id.ultraprivacy:
2549 // Toggle the UltraPrivacy status.
2550 ultraPrivacyEnabled = !ultraPrivacyEnabled;
2552 // Update the menu checkbox.
2553 menuItem.setChecked(ultraPrivacyEnabled);
2555 // Reload the main WebView.
2556 mainWebView.reload();
2559 case R.id.block_all_third_party_requests:
2560 //Toggle the third-party requests blocker status.
2561 blockAllThirdPartyRequests = !blockAllThirdPartyRequests;
2563 // Update the menu checkbox.
2564 menuItem.setChecked(blockAllThirdPartyRequests);
2566 // Reload the main WebView.
2567 mainWebView.reload();
2570 case R.id.user_agent_privacy_browser:
2571 // Update the user agent.
2572 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[0]);
2574 // Reload the WebView.
2575 mainWebView.reload();
2578 case R.id.user_agent_webview_default:
2579 // Update the user agent.
2580 mainWebView.getSettings().setUserAgentString("");
2582 // Reload the WebView.
2583 mainWebView.reload();
2586 case R.id.user_agent_firefox_on_android:
2587 // Update the user agent.
2588 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[2]);
2590 // Reload the WebView.
2591 mainWebView.reload();
2594 case R.id.user_agent_chrome_on_android:
2595 // Update the user agent.
2596 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[3]);
2598 // Reload the WebView.
2599 mainWebView.reload();
2602 case R.id.user_agent_safari_on_ios:
2603 // Update the user agent.
2604 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[4]);
2606 // Reload the WebView.
2607 mainWebView.reload();
2610 case R.id.user_agent_firefox_on_linux:
2611 // Update the user agent.
2612 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[5]);
2614 // Reload the WebView.
2615 mainWebView.reload();
2618 case R.id.user_agent_chromium_on_linux:
2619 // Update the user agent.
2620 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[6]);
2622 // Reload the WebView.
2623 mainWebView.reload();
2626 case R.id.user_agent_firefox_on_windows:
2627 // Update the user agent.
2628 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[7]);
2630 // Reload the WebView.
2631 mainWebView.reload();
2634 case R.id.user_agent_chrome_on_windows:
2635 // Update the user agent.
2636 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[8]);
2638 // Reload the WebView.
2639 mainWebView.reload();
2642 case R.id.user_agent_edge_on_windows:
2643 // Update the user agent.
2644 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[9]);
2646 // Reload the WebView.
2647 mainWebView.reload();
2650 case R.id.user_agent_internet_explorer_on_windows:
2651 // Update the user agent.
2652 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[10]);
2654 // Reload the WebView.
2655 mainWebView.reload();
2658 case R.id.user_agent_safari_on_macos:
2659 // Update the user agent.
2660 mainWebView.getSettings().setUserAgentString(getResources().getStringArray(R.array.user_agent_data)[11]);
2662 // Reload the WebView.
2663 mainWebView.reload();
2666 case R.id.user_agent_custom:
2667 // Update the user agent.
2668 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
2670 // Reload the WebView.
2671 mainWebView.reload();
2674 case R.id.font_size_twenty_five_percent:
2675 mainWebView.getSettings().setTextZoom(25);
2678 case R.id.font_size_fifty_percent:
2679 mainWebView.getSettings().setTextZoom(50);
2682 case R.id.font_size_seventy_five_percent:
2683 mainWebView.getSettings().setTextZoom(75);
2686 case R.id.font_size_one_hundred_percent:
2687 mainWebView.getSettings().setTextZoom(100);
2690 case R.id.font_size_one_hundred_twenty_five_percent:
2691 mainWebView.getSettings().setTextZoom(125);
2694 case R.id.font_size_one_hundred_fifty_percent:
2695 mainWebView.getSettings().setTextZoom(150);
2698 case R.id.font_size_one_hundred_seventy_five_percent:
2699 mainWebView.getSettings().setTextZoom(175);
2702 case R.id.font_size_two_hundred_percent:
2703 mainWebView.getSettings().setTextZoom(200);
2706 case R.id.swipe_to_refresh:
2707 // Toggle swipe to refresh.
2708 swipeRefreshLayout.setEnabled(!swipeRefreshLayout.isEnabled());
2711 case R.id.display_images:
2712 if (mainWebView.getSettings().getLoadsImagesAutomatically()) { // Images are currently loaded automatically.
2713 mainWebView.getSettings().setLoadsImagesAutomatically(false);
2714 mainWebView.reload();
2715 } else { // Images are not currently loaded automatically.
2716 mainWebView.getSettings().setLoadsImagesAutomatically(true);
2719 // Set `onTheFlyDisplayImagesSet`.
2720 onTheFlyDisplayImagesSet = true;
2723 case R.id.night_mode:
2724 // Toggle night mode.
2725 nightMode = !nightMode;
2727 // Enable or disable JavaScript according to night mode, the global preference, and any domain settings.
2728 if (nightMode) { // Night mode is enabled. Enable JavaScript.
2729 // Update the global variable.
2730 javaScriptEnabled = true;
2731 } else if (domainSettingsApplied) { // Night mode is disabled and domain settings are applied. Set JavaScript according to the domain settings.
2732 // Get the JavaScript preference that was stored the last time domain settings were loaded.
2733 javaScriptEnabled = domainSettingsJavaScriptEnabled;
2734 } else { // Night mode is disabled and domain settings are not applied. Set JavaScript according to the global preference.
2735 // Get a handle for the shared preference.
2736 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2738 // Get the JavaScript preference.
2739 javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
2742 // Apply the JavaScript setting to the WebView.
2743 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
2745 // Update the privacy icons.
2746 updatePrivacyIcons(false);
2748 // Reload the website.
2749 mainWebView.reload();
2752 case R.id.view_source:
2753 // Launch the View Source activity.
2754 Intent viewSourceIntent = new Intent(this, ViewSourceActivity.class);
2755 startActivity(viewSourceIntent);
2759 // Setup the share string.
2760 String shareString = webViewTitle + " – " + urlTextBox.getText().toString();
2762 // Create the share intent.
2763 Intent shareIntent = new Intent();
2764 shareIntent.setAction(Intent.ACTION_SEND);
2765 shareIntent.putExtra(Intent.EXTRA_TEXT, shareString);
2766 shareIntent.setType("text/plain");
2769 startActivity(Intent.createChooser(shareIntent, "Share URL"));
2772 case R.id.find_on_page:
2773 // Hide the URL app bar.
2774 supportAppBar.setVisibility(View.GONE);
2776 // Show the Find on Page `RelativeLayout`.
2777 findOnPageLinearLayout.setVisibility(View.VISIBLE);
2779 // Display the keyboard. We have to wait 200 ms before running the command to work around a bug in Android.
2780 // http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
2781 findOnPageEditText.postDelayed(() -> {
2782 // Set the focus on `findOnPageEditText`.
2783 findOnPageEditText.requestFocus();
2785 // Display the keyboard. `0` sets no input flags.
2786 inputMethodManager.showSoftInput(findOnPageEditText, 0);
2791 // Get a `PrintManager` instance.
2792 PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
2794 // Convert `mainWebView` to `printDocumentAdapter`.
2795 PrintDocumentAdapter printDocumentAdapter = mainWebView.createPrintDocumentAdapter();
2797 // Remove the lint error below that `printManager` might be `null`.
2798 assert printManager != null;
2800 // Print the document. The print attributes are `null`.
2801 printManager.print(getString(R.string.privacy_browser_web_page), printDocumentAdapter, null);
2804 case R.id.add_to_homescreen:
2805 // Show the `CreateHomeScreenShortcutDialog` `AlertDialog` and name this instance `R.string.create_shortcut`.
2806 AppCompatDialogFragment createHomeScreenShortcutDialogFragment = new CreateHomeScreenShortcutDialog();
2807 createHomeScreenShortcutDialogFragment.show(getSupportFragmentManager(), getString(R.string.create_shortcut));
2809 //Everything else will be handled by `CreateHomeScreenShortcutDialog` and the associated listener below.
2813 if (menuItem.getTitle().equals(getString(R.string.refresh))) { // The refresh button was pushed.
2814 // Reload the WebView.
2815 mainWebView.reload();
2816 } else { // The stop button was pushed.
2817 // Stop the loading of the WebView.
2818 mainWebView.stopLoading();
2822 case R.id.ad_consent:
2823 // Display the ad consent dialog.
2824 DialogFragment adConsentDialogFragment = new AdConsentDialog();
2825 adConsentDialogFragment.show(getFragmentManager(), getString(R.string.ad_consent));
2829 // Don't consume the event.
2830 return super.onOptionsItemSelected(menuItem);
2834 // removeAllCookies is deprecated, but it is required for API < 21.
2835 @SuppressWarnings("deprecation")
2837 public boolean onNavigationItemSelected(@NonNull MenuItem menuItem) {
2838 int menuItemId = menuItem.getItemId();
2840 switch (menuItemId) {
2846 if (mainWebView.canGoBack()) {
2847 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
2848 formattedUrlString = "";
2850 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2851 navigatingHistory = true;
2853 // Load the previous website in the history.
2854 mainWebView.goBack();
2859 if (mainWebView.canGoForward()) {
2860 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
2861 formattedUrlString = "";
2863 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2864 navigatingHistory = true;
2866 // Load the next website in the history.
2867 mainWebView.goForward();
2872 // Get the `WebBackForwardList`.
2873 WebBackForwardList webBackForwardList = mainWebView.copyBackForwardList();
2875 // Show the `UrlHistoryDialog` `AlertDialog` and name this instance `R.string.history`. `this` is the `Context`.
2876 AppCompatDialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(this, webBackForwardList);
2877 urlHistoryDialogFragment.show(getSupportFragmentManager(), getString(R.string.history));
2881 // Launch the requests activity.
2882 Intent requestsIntent = new Intent(this, RequestsActivity.class);
2883 startActivity(requestsIntent);
2886 case R.id.downloads:
2887 // Launch the system Download Manager.
2888 Intent downloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
2890 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
2891 downloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2893 startActivity(downloadManagerIntent);
2897 // Set the flag to reapply the domain settings on restart when returning from Domain Settings.
2898 reapplyDomainSettingsOnRestart = true;
2899 currentDomainName = "";
2901 // Launch the domains activity.
2902 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2903 startActivity(domainsIntent);
2907 // Set the flag to reapply app settings on restart when returning from Settings.
2908 reapplyAppSettingsOnRestart = true;
2910 // Set the flag to reapply the domain settings on restart when returning from Settings.
2911 reapplyDomainSettingsOnRestart = true;
2912 currentDomainName = "";
2914 // Launch the settings activity.
2915 Intent settingsIntent = new Intent(this, SettingsActivity.class);
2916 startActivity(settingsIntent);
2919 case R.id.import_export:
2920 // Launch the import/export activity.
2921 Intent importExportIntent = new Intent (this, ImportExportActivity.class);
2922 startActivity(importExportIntent);
2926 // Launch `GuideActivity`.
2927 Intent guideIntent = new Intent(this, GuideActivity.class);
2928 startActivity(guideIntent);
2932 // Launch `AboutActivity`.
2933 Intent aboutIntent = new Intent(this, AboutActivity.class);
2934 startActivity(aboutIntent);
2937 case R.id.clearAndExit:
2938 // Close the bookmarks cursor and database.
2939 bookmarksCursor.close();
2940 bookmarksDatabaseHelper.close();
2942 // Get a handle for `sharedPreferences`. `this` references the current context.
2943 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2945 boolean clearEverything = sharedPreferences.getBoolean("clear_everything", true);
2948 if (clearEverything || sharedPreferences.getBoolean("clear_cookies", true)) {
2949 // The command to remove cookies changed slightly in API 21.
2950 if (Build.VERSION.SDK_INT >= 21) {
2951 cookieManager.removeAllCookies(null);
2953 cookieManager.removeAllCookie();
2956 // Manually delete the cookies database, as `CookieManager` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2958 // We have to use two commands because `Runtime.exec()` does not like `*`.
2959 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies");
2960 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies-journal");
2961 } catch (IOException e) {
2962 // Do nothing if an error is thrown.
2966 // Clear DOM storage.
2967 if (clearEverything || sharedPreferences.getBoolean("clear_dom_storage", true)) {
2968 // Ask `WebStorage` to clear the DOM storage.
2969 WebStorage webStorage = WebStorage.getInstance();
2970 webStorage.deleteAllData();
2972 // Manually delete the DOM storage files and directories, as `WebStorage` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2974 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2975 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2977 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2978 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2979 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2980 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2981 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2982 } catch (IOException e) {
2983 // Do nothing if an error is thrown.
2987 // Clear form data if the API < 26.
2988 if ((Build.VERSION.SDK_INT < 26) && (clearEverything || sharedPreferences.getBoolean("clear_form_data", true))) {
2989 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
2990 webViewDatabase.clearFormData();
2992 // Manually delete the form data database, as `WebViewDatabase` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2994 // We have to use a `String[]` because the database contains a space and `Runtime.exec` will not escape the string correctly otherwise.
2995 privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data"});
2996 privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data-journal"});
2997 } catch (IOException e) {
2998 // Do nothing if an error is thrown.
3003 if (clearEverything || sharedPreferences.getBoolean("clear_cache", true)) {
3004 // `true` includes disk files.
3005 mainWebView.clearCache(true);
3007 // Manually delete the cache directories.
3009 // Delete the main cache directory.
3010 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
3012 // Delete the secondary `Service Worker` cache directory.
3013 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
3014 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
3015 } catch (IOException e) {
3016 // Do nothing if an error is thrown.
3020 // Clear SSL certificate preferences.
3021 mainWebView.clearSslPreferences();
3023 // Clear the back/forward history.
3024 mainWebView.clearHistory();
3026 // Clear `formattedUrlString`.
3027 formattedUrlString = null;
3029 // Clear `customHeaders`.
3030 customHeaders.clear();
3032 // Detach all views from `mainWebViewRelativeLayout`.
3033 mainWebViewRelativeLayout.removeAllViews();
3035 // Destroy the internal state of `mainWebView`.
3036 mainWebView.destroy();
3038 // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
3039 // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
3040 if (clearEverything) {
3042 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
3043 } catch (IOException e) {
3044 // Do nothing if an error is thrown.
3048 // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
3049 if (Build.VERSION.SDK_INT >= 21) {
3050 finishAndRemoveTask();
3055 // Remove the terminated program from RAM. The status code is `0`.
3060 // Close the navigation drawer.
3061 drawerLayout.closeDrawer(GravityCompat.START);
3066 public void onPostCreate(Bundle savedInstanceState) {
3067 super.onPostCreate(savedInstanceState);
3069 // Sync the state of the DrawerToggle after onRestoreInstanceState has finished.
3070 drawerToggle.syncState();
3074 public void onConfigurationChanged(Configuration newConfig) {
3075 super.onConfigurationChanged(newConfig);
3077 // Reload the ad for the free flavor if we not in full screen mode.
3078 if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
3079 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
3080 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_unit_id));
3083 // `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:
3084 // https://code.google.com/p/android/issues/detail?id=20493#c8
3085 // ActivityCompat.invalidateOptionsMenu(this);
3089 public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
3090 // Store the `HitTestResult`.
3091 final WebView.HitTestResult hitTestResult = mainWebView.getHitTestResult();
3094 final String imageUrl;
3095 final String linkUrl;
3097 // Get a handle for the `ClipboardManager`.
3098 final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
3100 // Remove the lint errors below that `clipboardManager` might be `null`.
3101 assert clipboardManager != null;
3103 switch (hitTestResult.getType()) {
3104 // `SRC_ANCHOR_TYPE` is a link.
3105 case WebView.HitTestResult.SRC_ANCHOR_TYPE:
3106 // Get the target URL.
3107 linkUrl = hitTestResult.getExtra();
3109 // Set the target URL as the title of the `ContextMenu`.
3110 menu.setHeaderTitle(linkUrl);
3112 // Add a Load URL entry.
3113 menu.add(R.string.load_url).setOnMenuItemClickListener((MenuItem item) -> {
3118 // Add a Copy URL entry.
3119 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
3120 // Save the link URL in a `ClipData`.
3121 ClipData srcAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
3123 // Set the `ClipData` as the clipboard's primary clip.
3124 clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
3128 // Add a Download URL entry.
3129 menu.add(R.string.download_url).setOnMenuItemClickListener((MenuItem item) -> {
3130 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
3131 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
3132 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
3134 // Store the variables for future use by `onRequestPermissionsResult()`.
3135 downloadUrl = linkUrl;
3136 downloadContentDisposition = "none";
3137 downloadContentLength = -1;
3139 // Show a dialog if the user has previously denied the permission.
3140 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
3141 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
3142 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
3144 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
3145 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
3146 } else { // Show the permission request directly.
3147 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
3148 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
3150 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
3151 // Get a handle for the download file alert dialog.
3152 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(linkUrl, "none", -1);
3154 // Show the download file alert dialog.
3155 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3160 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
3161 menu.add(R.string.cancel);
3164 case WebView.HitTestResult.EMAIL_TYPE:
3165 // Get the target URL.
3166 linkUrl = hitTestResult.getExtra();
3168 // Set the target URL as the title of the `ContextMenu`.
3169 menu.setHeaderTitle(linkUrl);
3171 // Add a `Write Email` entry.
3172 menu.add(R.string.write_email).setOnMenuItemClickListener(item -> {
3173 // We use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
3174 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
3176 // Parse the url and set it as the data for the `Intent`.
3177 emailIntent.setData(Uri.parse("mailto:" + linkUrl));
3179 // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
3180 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
3183 startActivity(emailIntent);
3187 // Add a `Copy Email Address` entry.
3188 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(item -> {
3189 // Save the email address in a `ClipData`.
3190 ClipData srcEmailTypeClipData = ClipData.newPlainText(getString(R.string.email_address), linkUrl);
3192 // Set the `ClipData` as the clipboard's primary clip.
3193 clipboardManager.setPrimaryClip(srcEmailTypeClipData);
3197 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
3198 menu.add(R.string.cancel);
3201 // `IMAGE_TYPE` is an image.
3202 case WebView.HitTestResult.IMAGE_TYPE:
3203 // Get the image URL.
3204 imageUrl = hitTestResult.getExtra();
3206 // Set the image URL as the title of the `ContextMenu`.
3207 menu.setHeaderTitle(imageUrl);
3209 // Add a `View Image` entry.
3210 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
3215 // Add a `Download Image` entry.
3216 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
3217 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
3218 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
3219 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
3221 // Store the image URL for use by `onRequestPermissionResult()`.
3222 downloadImageUrl = imageUrl;
3224 // Show a dialog if the user has previously denied the permission.
3225 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
3226 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
3227 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
3229 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
3230 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
3231 } else { // Show the permission request directly.
3232 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
3233 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
3235 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
3236 // Get a handle for the download image alert dialog.
3237 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
3239 // Show the download image alert dialog.
3240 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3245 // Add a `Copy URL` entry.
3246 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
3247 // Save the image URL in a `ClipData`.
3248 ClipData srcImageTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
3250 // Set the `ClipData` as the clipboard's primary clip.
3251 clipboardManager.setPrimaryClip(srcImageTypeClipData);
3255 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
3256 menu.add(R.string.cancel);
3260 // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
3261 case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
3262 // Get the image URL.
3263 imageUrl = hitTestResult.getExtra();
3265 // Set the image URL as the title of the `ContextMenu`.
3266 menu.setHeaderTitle(imageUrl);
3268 // Add a `View Image` entry.
3269 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
3274 // Add a `Download Image` entry.
3275 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
3276 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
3277 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
3278 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
3280 // Store the image URL for use by `onRequestPermissionResult()`.
3281 downloadImageUrl = imageUrl;
3283 // Show a dialog if the user has previously denied the permission.
3284 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
3285 // Instantiate the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
3286 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
3288 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
3289 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
3290 } else { // Show the permission request directly.
3291 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
3292 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
3294 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
3295 // Get a handle for the download image alert dialog.
3296 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
3298 // Show the download image alert dialog.
3299 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3304 // Add a `Copy URL` entry.
3305 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
3306 // Save the image URL in a `ClipData`.
3307 ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
3309 // Set the `ClipData` as the clipboard's primary clip.
3310 clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
3314 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
3315 menu.add(R.string.cancel);
3321 public void onCreateBookmark(AppCompatDialogFragment dialogFragment) {
3322 // Get the `EditTexts` from the `dialogFragment`.
3323 EditText createBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_name_edittext);
3324 EditText createBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_url_edittext);
3326 // Extract the strings from the `EditTexts`.
3327 String bookmarkNameString = createBookmarkNameEditText.getText().toString();
3328 String bookmarkUrlString = createBookmarkUrlEditText.getText().toString();
3330 // Convert the favoriteIcon Bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
3331 ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
3332 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
3333 byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
3335 // Display the new bookmark below the current items in the (0 indexed) list.
3336 int newBookmarkDisplayOrder = bookmarksListView.getCount();
3338 // Create the bookmark.
3339 bookmarksDatabaseHelper.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray);
3341 // Update `bookmarksCursor` with the current contents of this folder.
3342 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3344 // Update the `ListView`.
3345 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3347 // Scroll to the new bookmark.
3348 bookmarksListView.setSelection(newBookmarkDisplayOrder);
3352 public void onCreateBookmarkFolder(AppCompatDialogFragment dialogFragment) {
3353 // Get handles for the views in `dialogFragment`.
3354 EditText createFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.create_folder_name_edittext);
3355 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon_radiobutton);
3356 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon);
3358 // Get new folder name string.
3359 String folderNameString = createFolderNameEditText.getText().toString();
3361 // Get the new folder icon `Bitmap`.
3362 Bitmap folderIconBitmap;
3363 if (defaultFolderIconRadioButton.isChecked()) { // Use the default folder icon.
3364 // Get the default folder icon and convert it to a `Bitmap`.
3365 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3366 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3367 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3368 } else { // Use the `WebView` favorite icon.
3369 folderIconBitmap = favoriteIconBitmap;
3372 // Convert `folderIconBitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
3373 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3374 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3375 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3377 // Move all the bookmarks down one in the display order.
3378 for (int i = 0; i < bookmarksListView.getCount(); i++) {
3379 int databaseId = (int) bookmarksListView.getItemIdAtPosition(i);
3380 bookmarksDatabaseHelper.updateDisplayOrder(databaseId, i + 1);
3383 // Create the folder, which will be placed at the top of the `ListView`.
3384 bookmarksDatabaseHelper.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray);
3386 // Update `bookmarksCursor` with the current contents of this folder.
3387 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3389 // Update the `ListView`.
3390 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3392 // Scroll to the new folder.
3393 bookmarksListView.setSelection(0);
3397 public void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment) {
3398 // Get the shortcut name.
3399 EditText shortcutNameEditText = dialogFragment.getDialog().findViewById(R.id.shortcut_name_edittext);
3400 String shortcutNameString = shortcutNameEditText.getText().toString();
3402 // Convert the favorite icon bitmap to an `Icon`. `IconCompat` is required until API >= 26.
3403 IconCompat favoriteIcon = IconCompat.createWithBitmap(favoriteIconBitmap);
3405 // Setup the shortcut intent.
3406 Intent shortcutIntent = new Intent();
3407 shortcutIntent.setAction(Intent.ACTION_VIEW);
3408 shortcutIntent.setData(Uri.parse(formattedUrlString));
3410 // Create a shortcut info builder. The shortcut name becomes the shortcut ID.
3411 ShortcutInfoCompat.Builder shortcutInfoBuilder = new ShortcutInfoCompat.Builder(this, shortcutNameString);
3413 // Add the required fields to the shortcut info builder.
3414 shortcutInfoBuilder.setIcon(favoriteIcon);
3415 shortcutInfoBuilder.setIntent(shortcutIntent);
3416 shortcutInfoBuilder.setShortLabel(shortcutNameString);
3418 // Request the pin. `ShortcutManagerCompat` can be switched to `ShortcutManager` once API >= 26.
3419 ShortcutManagerCompat.requestPinShortcut(this, shortcutInfoBuilder.build(), null);
3423 public void onCloseDownloadLocationPermissionDialog(int downloadType) {
3424 switch (downloadType) {
3425 case DownloadLocationPermissionDialog.DOWNLOAD_FILE:
3426 // Request the WRITE_EXTERNAL_STORAGE permission with a file request code.
3427 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
3430 case DownloadLocationPermissionDialog.DOWNLOAD_IMAGE:
3431 // Request the WRITE_EXTERNAL_STORAGE permission with an image request code.
3432 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
3438 public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
3439 switch (requestCode) {
3440 case DOWNLOAD_FILE_REQUEST_CODE:
3441 // Show the download file alert dialog. When the dialog closes, the correct command will be used based on the permission status.
3442 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(downloadUrl, downloadContentDisposition, downloadContentLength);
3444 // On API 23, displaying the fragment must be delayed or the app will crash.
3445 if (Build.VERSION.SDK_INT == 23) {
3446 new Handler().postDelayed(() -> downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
3448 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3451 // Reset the download variables.
3453 downloadContentDisposition = "";
3454 downloadContentLength = 0;
3457 case DOWNLOAD_IMAGE_REQUEST_CODE:
3458 // Show the download image alert dialog. When the dialog closes, the correct command will be used based on the permission status.
3459 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(downloadImageUrl);
3461 // On API 23, displaying the fragment must be delayed or the app will crash.
3462 if (Build.VERSION.SDK_INT == 23) {
3463 new Handler().postDelayed(() -> downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
3465 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
3468 // Reset the image URL variable.
3469 downloadImageUrl = "";
3475 public void onDownloadImage(AppCompatDialogFragment dialogFragment, String imageUrl) {
3476 // Download the image if it has an HTTP or HTTPS URI.
3477 if (imageUrl.startsWith("http")) {
3478 // Get a handle for the system `DOWNLOAD_SERVICE`.
3479 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3481 // Parse `imageUrl`.
3482 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(imageUrl));
3484 // Pass cookies to download manager if cookies are enabled. This is required to download images from websites that require a login.
3485 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3486 if (firstPartyCookiesEnabled) {
3487 // Get the cookies for `imageUrl`.
3488 String cookies = cookieManager.getCookie(imageUrl);
3490 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3491 downloadRequest.addRequestHeader("Cookie", cookies);
3494 // Get the file name from the dialog fragment.
3495 EditText downloadImageNameEditText = dialogFragment.getDialog().findViewById(R.id.download_image_name);
3496 String imageName = downloadImageNameEditText.getText().toString();
3498 // Specify the download location.
3499 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3500 // Download to the public download directory.
3501 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, imageName);
3502 } else { // External write permission denied.
3503 // Download to the app's external download directory.
3504 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, imageName);
3507 // Allow `MediaScanner` to index the download if it is a media file.
3508 downloadRequest.allowScanningByMediaScanner();
3510 // Add the URL as the description for the download.
3511 downloadRequest.setDescription(imageUrl);
3513 // Show the download notification after the download is completed.
3514 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3516 // Remove the lint warning below that `downloadManager` might be `null`.
3517 assert downloadManager != null;
3519 // Initiate the download.
3520 downloadManager.enqueue(downloadRequest);
3521 } else { // The image is not an HTTP or HTTPS URI.
3522 Snackbar.make(mainWebView, R.string.cannot_download_image, Snackbar.LENGTH_INDEFINITE).show();
3527 public void onDownloadFile(AppCompatDialogFragment dialogFragment, String downloadUrl) {
3528 // Download the file if it has an HTTP or HTTPS URI.
3529 if (downloadUrl.startsWith("http")) {
3530 // Get a handle for the system `DOWNLOAD_SERVICE`.
3531 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
3533 // Parse `downloadUrl`.
3534 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(downloadUrl));
3536 // Pass cookies to download manager if cookies are enabled. This is required to download files from websites that require a login.
3537 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
3538 if (firstPartyCookiesEnabled) {
3539 // Get the cookies for `downloadUrl`.
3540 String cookies = cookieManager.getCookie(downloadUrl);
3542 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
3543 downloadRequest.addRequestHeader("Cookie", cookies);
3546 // Get the file name from the dialog fragment.
3547 EditText downloadFileNameEditText = dialogFragment.getDialog().findViewById(R.id.download_file_name);
3548 String fileName = downloadFileNameEditText.getText().toString();
3550 // Specify the download location.
3551 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
3552 // Download to the public download directory.
3553 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, fileName);
3554 } else { // External write permission denied.
3555 // Download to the app's external download directory.
3556 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, fileName);
3559 // Allow `MediaScanner` to index the download if it is a media file.
3560 downloadRequest.allowScanningByMediaScanner();
3562 // Add the URL as the description for the download.
3563 downloadRequest.setDescription(downloadUrl);
3565 // Show the download notification after the download is completed.
3566 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
3568 // Remove the lint warning below that `downloadManager` might be `null`.
3569 assert downloadManager != null;
3571 // Initiate the download.
3572 downloadManager.enqueue(downloadRequest);
3573 } else { // The download is not an HTTP or HTTPS URI.
3574 Snackbar.make(mainWebView, R.string.cannot_download_file, Snackbar.LENGTH_INDEFINITE).show();
3579 public void onSaveBookmark(AppCompatDialogFragment dialogFragment, int selectedBookmarkDatabaseId) {
3580 // Get handles for the views from `dialogFragment`.
3581 EditText editBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_name_edittext);
3582 EditText editBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_url_edittext);
3583 RadioButton currentBookmarkIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_current_icon_radiobutton);
3585 // Store the bookmark strings.
3586 String bookmarkNameString = editBookmarkNameEditText.getText().toString();
3587 String bookmarkUrlString = editBookmarkUrlEditText.getText().toString();
3589 // Update the bookmark.
3590 if (currentBookmarkIconRadioButton.isChecked()) { // Update the bookmark without changing the favorite icon.
3591 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString);
3592 } else { // Update the bookmark using the `WebView` favorite icon.
3593 // Convert the favorite icon to a byte array. `0` is for lossless compression (the only option for a PNG).
3594 ByteArrayOutputStream newFavoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
3595 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFavoriteIconByteArrayOutputStream);
3596 byte[] newFavoriteIconByteArray = newFavoriteIconByteArrayOutputStream.toByteArray();
3598 // Update the bookmark and the favorite icon.
3599 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString, newFavoriteIconByteArray);
3602 // Update `bookmarksCursor` with the current contents of this folder.
3603 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3605 // Update the `ListView`.
3606 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3610 public void onSaveBookmarkFolder(AppCompatDialogFragment dialogFragment, int selectedFolderDatabaseId) {
3611 // Get handles for the views from `dialogFragment`.
3612 EditText editFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_folder_name_edittext);
3613 RadioButton currentFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_current_icon_radiobutton);
3614 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_radiobutton);
3615 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_imageview);
3617 // Get the new folder name.
3618 String newFolderNameString = editFolderNameEditText.getText().toString();
3620 // Check if the favorite icon has changed.
3621 if (currentFolderIconRadioButton.isChecked()) { // Only the name has changed.
3622 // Update the name in the database.
3623 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString);
3624 } else if (!currentFolderIconRadioButton.isChecked() && newFolderNameString.equals(oldFolderNameString)) { // Only the icon has changed.
3625 // Get the new folder icon `Bitmap`.
3626 Bitmap folderIconBitmap;
3627 if (defaultFolderIconRadioButton.isChecked()) {
3628 // Get the default folder icon and convert it to a `Bitmap`.
3629 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3630 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3631 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3632 } else { // Use the `WebView` favorite icon.
3633 folderIconBitmap = favoriteIconBitmap;
3636 // Convert the folder `Bitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
3637 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3638 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3639 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3641 // Update the folder icon in the database.
3642 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, folderIconByteArray);
3643 } else { // The folder icon and the name have changed.
3644 // Get the new folder icon `Bitmap`.
3645 Bitmap folderIconBitmap;
3646 if (defaultFolderIconRadioButton.isChecked()) {
3647 // Get the default folder icon and convert it to a `Bitmap`.
3648 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3649 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3650 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3651 } else { // Use the `WebView` favorite icon.
3652 folderIconBitmap = MainWebViewActivity.favoriteIconBitmap;
3655 // Convert the folder `Bitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
3656 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3657 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3658 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3660 // Update the folder name and icon in the database.
3661 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString, folderIconByteArray);
3664 // Update `bookmarksCursor` with the current contents of this folder.
3665 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3667 // Update the `ListView`.
3668 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3672 public void onHttpAuthenticationCancel() {
3673 // Cancel the `HttpAuthHandler`.
3674 httpAuthHandler.cancel();
3678 public void onHttpAuthenticationProceed(AppCompatDialogFragment dialogFragment) {
3679 // Get handles for the `EditTexts`.
3680 EditText usernameEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_username);
3681 EditText passwordEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_password);
3683 // Proceed with the HTTP authentication.
3684 httpAuthHandler.proceed(usernameEditText.getText().toString(), passwordEditText.getText().toString());
3687 public void viewSslCertificate(View view) {
3688 // Show the `ViewSslCertificateDialog` `AlertDialog` and name this instance `@string/view_ssl_certificate`.
3689 DialogFragment viewSslCertificateDialogFragment = new ViewSslCertificateDialog();
3690 viewSslCertificateDialogFragment.show(getFragmentManager(), getString(R.string.view_ssl_certificate));
3694 public void onSslErrorCancel() {
3695 sslErrorHandler.cancel();
3699 public void onSslErrorProceed() {
3700 sslErrorHandler.proceed();
3704 public void onSslMismatchBack() {
3705 if (mainWebView.canGoBack()) { // There is a back page in the history.
3706 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
3707 formattedUrlString = "";
3709 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3710 navigatingHistory = true;
3713 mainWebView.goBack();
3714 } else { // There are no pages to go back to.
3715 // Load a blank page
3721 public void onSslMismatchProceed() {
3722 // Do not check the pinned SSL certificate for this domain again until the domain changes.
3723 ignorePinnedSslCertificate = true;
3727 public void onUrlHistoryEntrySelected(int moveBackOrForwardSteps) {
3728 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
3729 formattedUrlString = "";
3731 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3732 navigatingHistory = true;
3734 // Load the history entry.
3735 mainWebView.goBackOrForward(moveBackOrForwardSteps);
3739 public void onClearHistory() {
3740 // Clear the history.
3741 mainWebView.clearHistory();
3744 // Override `onBackPressed` to handle the navigation drawer and `mainWebView`.
3746 public void onBackPressed() {
3747 if (drawerLayout.isDrawerVisible(GravityCompat.START)) { // The navigation drawer is open.
3748 // Close the navigation drawer.
3749 drawerLayout.closeDrawer(GravityCompat.START);
3750 } else if (drawerLayout.isDrawerVisible(GravityCompat.END)){ // The bookmarks drawer is open.
3751 if (currentBookmarksFolder.isEmpty()) { // The home folder is displayed.
3752 // close the bookmarks drawer.
3753 drawerLayout.closeDrawer(GravityCompat.END);
3754 } else { // A subfolder is displayed.
3755 // Place the former parent folder in `currentFolder`.
3756 currentBookmarksFolder = bookmarksDatabaseHelper.getParentFolder(currentBookmarksFolder);
3758 // Load the new folder.
3759 loadBookmarksFolder();
3762 } else if (mainWebView.canGoBack()) { // There is at least one item in the `WebView` history.
3763 // Reset the formatted URL string so the page will load correctly if blocking of third-party requests is enabled.
3764 formattedUrlString = "";
3766 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3767 navigatingHistory = true;
3770 mainWebView.goBack();
3771 } else { // There isn't anything to do in Privacy Browser.
3772 // Pass `onBackPressed()` to the system.
3773 super.onBackPressed();
3777 // 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.
3779 public void onActivityResult(int requestCode, int resultCode, Intent data) {
3780 // File uploads only work on API >= 21.
3781 if (Build.VERSION.SDK_INT >= 21) {
3782 // Pass the file to the WebView.
3783 fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(resultCode, data));
3787 private void loadUrlFromTextBox() throws UnsupportedEncodingException {
3788 // Get the text from urlTextBox and convert it to a string. trim() removes white spaces from the beginning and end of the string.
3789 String unformattedUrlString = urlTextBox.getText().toString().trim();
3791 // Check to see if `unformattedUrlString` is a valid URL. Otherwise, convert it into a search.
3792 if ((Patterns.WEB_URL.matcher(unformattedUrlString).matches()) || (unformattedUrlString.startsWith("http://")) || (unformattedUrlString.startsWith("https://"))) {
3793 // Add `https://` at the beginning if it is missing. Otherwise the app will segfault.
3794 if (!unformattedUrlString.startsWith("http")) {
3795 unformattedUrlString = "https://" + unformattedUrlString;
3798 // Initialize `unformattedUrl`.
3799 URL unformattedUrl = null;
3801 // 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.
3803 unformattedUrl = new URL(unformattedUrlString);
3804 } catch (MalformedURLException e) {
3805 e.printStackTrace();
3808 // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if `.get` was called on a `null` value.
3809 final String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
3810 final String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
3811 final String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
3812 final String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
3813 final String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
3816 Uri.Builder formattedUri = new Uri.Builder();
3817 formattedUri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
3819 // Decode `formattedUri` as a `String` in `UTF-8`.
3820 formattedUrlString = URLDecoder.decode(formattedUri.build().toString(), "UTF-8");
3821 } else if (unformattedUrlString.isEmpty()){ // Load a blank web site.
3822 // Load a blank string.
3823 formattedUrlString = "";
3824 } else { // Search for the contents of the URL box.
3825 // Sanitize the search input and convert it to a search.
3826 final String encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
3828 // Add the base search URL.
3829 formattedUrlString = searchURL + encodedUrlString;
3832 // 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.
3833 urlTextBox.clearFocus();
3836 loadUrl(formattedUrlString);
3839 private void loadUrl(String url) {// Apply any custom domain settings.
3840 // Set the URL as the formatted URL string so that checking third-party requests works correctly.
3841 formattedUrlString = url;
3843 // Apply the domain settings.
3844 applyDomainSettings(url, true, false);
3846 // If loading a website, set `urlIsLoading` to prevent changes in the user agent on websites with redirects from reloading the current website.
3847 urlIsLoading = !url.equals("");
3850 mainWebView.loadUrl(url, customHeaders);
3853 public void findPreviousOnPage(View view) {
3854 // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards.
3855 mainWebView.findNext(false);
3858 public void findNextOnPage(View view) {
3859 // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
3860 mainWebView.findNext(true);
3863 public void closeFindOnPage(View view) {
3864 // Delete the contents of `find_on_page_edittext`.
3865 findOnPageEditText.setText(null);
3867 // Clear the highlighted phrases.
3868 mainWebView.clearMatches();
3870 // Hide the Find on Page `RelativeLayout`.
3871 findOnPageLinearLayout.setVisibility(View.GONE);
3873 // Show the URL app bar.
3874 supportAppBar.setVisibility(View.VISIBLE);
3876 // Hide the keyboard so we can see the webpage. `0` indicates no additional flags.
3877 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
3880 private void applyAppSettings() {
3881 // Get a handle for the shared preferences.
3882 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3884 // Store the values from the shared preferences in variables.
3885 String homepageString = sharedPreferences.getString("homepage", "https://searx.me/");
3886 String torHomepageString = sharedPreferences.getString("tor_homepage", "http://ulrn6sryqaifefld.onion/");
3887 String torSearchString = sharedPreferences.getString("tor_search", "http://ulrn6sryqaifefld.onion/?q=");
3888 String torSearchCustomURLString = sharedPreferences.getString("tor_search_custom_url", "");
3889 String searchString = sharedPreferences.getString("search", "https://searx.me/?q=");
3890 String searchCustomURLString = sharedPreferences.getString("search_custom_url", "");
3891 incognitoModeEnabled = sharedPreferences.getBoolean("incognito_mode", false);
3892 boolean doNotTrackEnabled = sharedPreferences.getBoolean("do_not_track", false);
3893 proxyThroughOrbot = sharedPreferences.getBoolean("proxy_through_orbot", false);
3894 fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean("full_screen_browsing_mode", false);
3895 hideSystemBarsOnFullscreen = sharedPreferences.getBoolean("hide_system_bars", false);
3896 translucentNavigationBarOnFullscreen = sharedPreferences.getBoolean("translucent_navigation_bar", true);
3897 displayWebpageImagesBoolean = sharedPreferences.getBoolean("display_webpage_images", true);
3899 // Set the homepage, search, and proxy options.
3900 if (proxyThroughOrbot) { // Set the Tor options.
3901 // Set `torHomepageString` as `homepage`.
3902 homepage = torHomepageString;
3904 // If formattedUrlString is null assign the homepage to it.
3905 if (formattedUrlString == null) {
3906 formattedUrlString = homepage;
3909 // Set the search URL.
3910 if (torSearchString.equals("Custom URL")) { // Get the custom URL string.
3911 searchURL = torSearchCustomURLString;
3912 } else { // Use the string from the pre-built list.
3913 searchURL = torSearchString;
3916 // Set the proxy. `this` refers to the current activity where an `AlertDialog` might be displayed.
3917 OrbotProxyHelper.setProxy(getApplicationContext(), this, "localhost", "8118");
3919 // Set the `appBar` background to indicate proxying through Orbot is enabled. `this` refers to the context.
3921 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.dark_blue_30));
3923 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.blue_50));
3926 // Display a message to the user if waiting for Orbot.
3927 if (!orbotStatus.equals("ON")) {
3928 // Set `waitingForOrbot`.
3929 waitingForOrbot = true;
3931 // Disable the wide view port so that the waiting for Orbot text is displayed correctly.
3932 mainWebView.getSettings().setUseWideViewPort(false);
3934 // Load a waiting page. `null` specifies no encoding, which defaults to ASCII.
3935 mainWebView.loadData(waitingForOrbotHTMLString, "text/html", null);
3937 } else { // Set the non-Tor options.
3938 // Set `homepageString` as `homepage`.
3939 homepage = homepageString;
3941 // If formattedUrlString is null assign the homepage to it.
3942 if (formattedUrlString == null) {
3943 formattedUrlString = homepage;
3946 // Set the search URL.
3947 if (searchString.equals("Custom URL")) { // Get the custom URL string.
3948 searchURL = searchCustomURLString;
3949 } else { // Use the string from the pre-built list.
3950 searchURL = searchString;
3953 // Reset the proxy to default. The host is `""` and the port is `"0"`.
3954 OrbotProxyHelper.setProxy(getApplicationContext(), this, "", "0");
3956 // Set the default `appBar` background. `this` refers to the context.
3958 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_900));
3960 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_100));
3963 // Reset `waitingForOrbot.
3964 waitingForOrbot = false;
3967 // Set Do Not Track status.
3968 if (doNotTrackEnabled) {
3969 customHeaders.put("DNT", "1");
3971 customHeaders.remove("DNT");
3974 // Apply the appropriate full screen mode the `SYSTEM_UI` flags.
3975 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
3976 if (hideSystemBarsOnFullscreen) { // Hide everything.
3977 // Remove the translucent navigation setting if it is currently flagged.
3978 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3980 // Remove the translucent status bar overlay.
3981 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3983 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
3984 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
3986 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
3987 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
3988 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
3990 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
3991 } else { // Hide everything except the status and navigation bars.
3992 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
3993 rootCoordinatorLayout.setSystemUiVisibility(0);
3995 // Add the translucent status flag if it is unset.
3996 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3998 if (translucentNavigationBarOnFullscreen) {
3999 // Set the navigation bar to be translucent.
4000 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
4002 // Set the navigation bar to be black.
4003 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
4006 } else { // Privacy Browser is not in full screen browsing mode.
4007 // 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.
4008 inFullScreenBrowsingMode = false;
4010 // Show the `appBar` if `findOnPageLinearLayout` is not visible.
4011 if (findOnPageLinearLayout.getVisibility() == View.GONE) {
4015 // Show the `BannerAd` in the free flavor.
4016 if (BuildConfig.FLAVOR.contentEquals("free")) {
4017 // Initialize the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
4018 AdHelper.initializeAds(findViewById(R.id.adview), getApplicationContext(), getFragmentManager(), getString(R.string.google_app_id), getString(R.string.ad_unit_id));
4021 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
4022 rootCoordinatorLayout.setSystemUiVisibility(0);
4024 // Remove the translucent navigation bar flag if it is set.
4025 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
4027 // Add the translucent status flag if it is unset. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
4028 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
4030 // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
4031 rootCoordinatorLayout.setFitsSystemWindows(true);
4035 // `reloadWebsite` is used if returning from the Domains activity. Otherwise JavaScript might not function correctly if it is newly enabled.
4036 // The deprecated `.getDrawable()` must be used until the minimum API >= 21.
4037 @SuppressWarnings("deprecation")
4038 private void applyDomainSettings(String url, boolean resetFavoriteIcon, boolean reloadWebsite) {
4039 // Parse the URL into a URI.
4040 Uri uri = Uri.parse(url);
4042 // Extract the domain from `uri`.
4043 String hostName = uri.getHost();
4045 // Initialize `loadingNewDomainName`.
4046 boolean loadingNewDomainName;
4048 // If either `hostName` or `currentDomainName` are `null`, run the options for loading a new domain name.
4049 // The lint suggestion to simplify the `if` statement is incorrect, because `hostName.equals(currentDomainName)` can produce a `null object reference.`
4050 //noinspection SimplifiableIfStatement
4051 if ((hostName == null) || (currentDomainName == null)) {
4052 loadingNewDomainName = true;
4053 } else { // Determine if `hostName` equals `currentDomainName`.
4054 loadingNewDomainName = !hostName.equals(currentDomainName);
4057 // Strings don't like to be null.
4058 if (hostName == null) {
4062 // 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.
4063 if (loadingNewDomainName) {
4064 // Set the new `hostname` as the `currentDomainName`.
4065 currentDomainName = hostName;
4067 // Reset `ignorePinnedSslCertificate`.
4068 ignorePinnedSslCertificate = false;
4070 // Reset the favorite icon if specified.
4071 if (resetFavoriteIcon) {
4072 favoriteIconBitmap = favoriteIconDefaultBitmap;
4073 favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(favoriteIconBitmap, 64, 64, true));
4076 // Initialize the database handler. The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
4077 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
4079 // Get a full cursor from `domainsDatabaseHelper`.
4080 Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain();
4082 // Initialize `domainSettingsSet`.
4083 Set<String> domainSettingsSet = new HashSet<>();
4085 // Get the domain name column index.
4086 int domainNameColumnIndex = domainNameCursor.getColumnIndex(DomainsDatabaseHelper.DOMAIN_NAME);
4088 // Populate `domainSettingsSet`.
4089 for (int i = 0; i < domainNameCursor.getCount(); i++) {
4090 // Move `domainsCursor` to the current row.
4091 domainNameCursor.moveToPosition(i);
4093 // Store the domain name in `domainSettingsSet`.
4094 domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex));
4097 // Close `domainNameCursor.
4098 domainNameCursor.close();
4100 // Initialize variables to track if domain settings will be applied and, if so, under which name.
4101 domainSettingsApplied = false;
4102 String domainNameInDatabase = null;
4104 // Check the hostname.
4105 if (domainSettingsSet.contains(hostName)) {
4106 domainSettingsApplied = true;
4107 domainNameInDatabase = hostName;
4110 // Check all the subdomains of the host name against wildcard domains in the domain cursor.
4111 while (!domainSettingsApplied && hostName.contains(".")) { // Stop checking if domain settings are already applied or there are no more `.` in the host name.
4112 if (domainSettingsSet.contains("*." + hostName)) { // Check the host name prepended by `*.`.
4113 // Apply the domain settings.
4114 domainSettingsApplied = true;
4116 // Store the applied domain names as it appears in the database.
4117 domainNameInDatabase = "*." + hostName;
4120 // Strip out the lowest subdomain of of the host name.
4121 hostName = hostName.substring(hostName.indexOf(".") + 1);
4125 // Get a handle for the shared preference.
4126 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
4128 // Store the general preference information.
4129 String defaultFontSizeString = sharedPreferences.getString("default_font_size", "100");
4130 String defaultUserAgentName = sharedPreferences.getString("user_agent", "Privacy Browser");
4131 defaultCustomUserAgentString = sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0");
4132 boolean defaultSwipeToRefresh = sharedPreferences.getBoolean("swipe_to_refresh", true);
4133 nightMode = sharedPreferences.getBoolean("night_mode", false);
4135 if (domainSettingsApplied) { // The url we are loading has custom domain settings.
4136 // Get a cursor for the current host and move it to the first position.
4137 Cursor currentHostDomainSettingsCursor = domainsDatabaseHelper.getCursorForDomainName(domainNameInDatabase);
4138 currentHostDomainSettingsCursor.moveToFirst();
4140 // Get the settings from the cursor.
4141 domainSettingsDatabaseId = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper._ID)));
4142 javaScriptEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1);
4143 firstPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FIRST_PARTY_COOKIES)) == 1);
4144 thirdPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_THIRD_PARTY_COOKIES)) == 1);
4145 domStorageEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1);
4146 // Form data can be removed once the minimum API >= 26.
4147 saveFormDataEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1);
4148 easyListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYLIST)) == 1);
4149 easyPrivacyEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYPRIVACY)) == 1);
4150 fanboysAnnoyanceListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_ANNOYANCE_LIST)) == 1);
4151 fanboysSocialBlockingListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST)) == 1);
4152 ultraPrivacyEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_ULTRAPRIVACY)) == 1);
4153 blockAllThirdPartyRequests = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.BLOCK_ALL_THIRD_PARTY_REQUESTS)) == 1);
4154 String userAgentName = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.USER_AGENT));
4155 int fontSize = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.FONT_SIZE));
4156 int swipeToRefreshInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SWIPE_TO_REFRESH));
4157 int nightModeInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.NIGHT_MODE));
4158 displayWebpageImagesInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.DISPLAY_IMAGES));
4159 pinnedDomainSslCertificate = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.PINNED_SSL_CERTIFICATE)) == 1);
4160 pinnedDomainSslIssuedToCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_COMMON_NAME));
4161 pinnedDomainSslIssuedToONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATION));
4162 pinnedDomainSslIssuedToUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT));
4163 pinnedDomainSslIssuedByCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_COMMON_NAME));
4164 pinnedDomainSslIssuedByONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATION));
4165 pinnedDomainSslIssuedByUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT));
4167 // Set `nightMode` according to `nightModeInt`. If `nightModeInt` is `DomainsDatabaseHelper.NIGHT_MODE_SYSTEM_DEFAULT` the current setting from `sharedPreferences` will be used.
4168 switch (nightModeInt) {
4169 case DomainsDatabaseHelper.NIGHT_MODE_ENABLED:
4173 case DomainsDatabaseHelper.NIGHT_MODE_DISABLED:
4178 // Store the domain JavaScript status. This is used by the options menu night mode toggle.
4179 domainSettingsJavaScriptEnabled = javaScriptEnabled;
4181 // Enable JavaScript if night mode is enabled.
4183 javaScriptEnabled = true;
4186 // Set the pinned SSL certificate start date to `null` if the saved date `long` is 0.
4187 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)) == 0) {
4188 pinnedDomainSslStartDate = null;
4190 pinnedDomainSslStartDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)));
4193 // Set the pinned SSL certificate end date to `null` if the saved date `long` is 0.
4194 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)) == 0) {
4195 pinnedDomainSslEndDate = null;
4197 pinnedDomainSslEndDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)));
4200 // Close `currentHostDomainSettingsCursor`.
4201 currentHostDomainSettingsCursor.close();
4203 // Apply the domain settings.
4204 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
4205 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
4206 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
4208 // Apply the form data setting if the API < 26.
4209 if (Build.VERSION.SDK_INT < 26) {
4210 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
4213 // Apply the font size.
4214 if (fontSize == 0) { // Apply the default font size.
4215 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
4216 } else { // Apply the specified font size.
4217 mainWebView.getSettings().setTextZoom(fontSize);
4220 // Set third-party cookies status if API >= 21.
4221 if (Build.VERSION.SDK_INT >= 21) {
4222 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
4225 // 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.
4226 // <https://redmine.stoutner.com/issues/160>
4227 if (!urlIsLoading) {
4228 // Set the user agent.
4229 if (userAgentName.equals(getString(R.string.system_default_user_agent))) { // Use the system default user agent.
4230 // Get the array position of the default user agent name.
4231 int defaultUserAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
4233 // Set the user agent according to the system default.
4234 switch (defaultUserAgentArrayPosition) {
4235 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
4236 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
4237 mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
4240 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
4241 // Set the user agent to `""`, which uses the default value.
4242 mainWebView.getSettings().setUserAgentString("");
4245 case SETTINGS_CUSTOM_USER_AGENT:
4246 // Set the custom user agent.
4247 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
4251 // Get the user agent string from the user agent data array
4252 mainWebView.getSettings().setUserAgentString(userAgentDataArray[defaultUserAgentArrayPosition]);
4254 } else { // Set the user agent according to the stored name.
4255 // Get the array position of the user agent name.
4256 int userAgentArrayPosition = userAgentNamesArray.getPosition(userAgentName);
4258 switch (userAgentArrayPosition) {
4259 case UNRECOGNIZED_USER_AGENT: // The user agent name contains a custom user agent.
4260 mainWebView.getSettings().setUserAgentString(userAgentName);
4263 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
4264 // Set the user agent to `""`, which uses the default value.
4265 mainWebView.getSettings().setUserAgentString("");
4269 // Get the user agent string from the user agent data array.
4270 mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
4274 // Set swipe to refresh.
4275 switch (swipeToRefreshInt) {
4276 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_SYSTEM_DEFAULT:
4277 // Set swipe to refresh according to the default.
4278 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
4281 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_ENABLED:
4282 // Enable swipe to refresh.
4283 swipeRefreshLayout.setEnabled(true);
4286 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_DISABLED:
4287 // Disable swipe to refresh.
4288 swipeRefreshLayout.setEnabled(false);
4291 // Store the applied user agent string, which is used in the View Source activity.
4292 appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
4295 // 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.
4297 urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_dark_blue));
4299 urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_light_green));
4301 } else { // The new URL does not have custom domain settings. Load the defaults.
4302 // Store the values from `sharedPreferences` in variables.
4303 javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
4304 firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
4305 thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
4306 domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
4307 saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false); // Form data can be removed once the minimum API >= 26.
4308 easyListEnabled = sharedPreferences.getBoolean("easylist", true);
4309 easyPrivacyEnabled = sharedPreferences.getBoolean("easyprivacy", true);
4310 fanboysAnnoyanceListEnabled = sharedPreferences.getBoolean("fanboy_annoyance_list", true);
4311 fanboysSocialBlockingListEnabled = sharedPreferences.getBoolean("fanboy_social_blocking_list", true);
4312 ultraPrivacyEnabled = sharedPreferences.getBoolean("ultraprivacy", true);
4313 blockAllThirdPartyRequests = sharedPreferences.getBoolean("block_all_third_party_requests", false);
4315 // Set `javaScriptEnabled` to be `true` if `night_mode` is `true`.
4317 javaScriptEnabled = true;
4320 // Apply the default settings.
4321 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
4322 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
4323 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
4324 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
4325 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
4327 // Apply the form data setting if the API < 26.
4328 if (Build.VERSION.SDK_INT < 26) {
4329 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
4332 // Reset the pinned SSL certificate information.
4333 domainSettingsDatabaseId = -1;
4334 pinnedDomainSslCertificate = false;
4335 pinnedDomainSslIssuedToCNameString = "";
4336 pinnedDomainSslIssuedToONameString = "";
4337 pinnedDomainSslIssuedToUNameString = "";
4338 pinnedDomainSslIssuedByCNameString = "";
4339 pinnedDomainSslIssuedByONameString = "";
4340 pinnedDomainSslIssuedByUNameString = "";
4341 pinnedDomainSslStartDate = null;
4342 pinnedDomainSslEndDate = null;
4344 // Set third-party cookies status if API >= 21.
4345 if (Build.VERSION.SDK_INT >= 21) {
4346 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
4349 // 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.
4350 // <https://redmine.stoutner.com/issues/160>
4351 if (!urlIsLoading) {
4352 // Get the array position of the user agent name.
4353 int userAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
4355 // Set the user agent.
4356 switch (userAgentArrayPosition) {
4357 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
4358 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
4359 mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
4362 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
4363 // Set the user agent to `""`, which uses the default value.
4364 mainWebView.getSettings().setUserAgentString("");
4367 case SETTINGS_CUSTOM_USER_AGENT:
4368 // Set the custom user agent.
4369 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
4373 // Get the user agent string from the user agent data array
4374 mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
4377 // Store the applied user agent string, which is used in the View Source activity.
4378 appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
4381 // Set a transparent background on `urlTextBox`. We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
4382 urlAppBarRelativeLayout.setBackgroundDrawable(getResources().getDrawable(R.color.transparent));
4385 // Close the domains database helper.
4386 domainsDatabaseHelper.close();
4388 // Remove the `onTheFlyDisplayImagesSet` flag and set the display webpage images mode. `true` indicates that custom domain settings are applied.
4389 onTheFlyDisplayImagesSet = false;
4390 setDisplayWebpageImages();
4392 // Update the privacy icons, but only if `mainMenu` has already been populated.
4393 if (mainMenu != null) {
4394 updatePrivacyIcons(true);
4398 // Reload the website if returning from the Domains activity.
4399 if (reloadWebsite) {
4400 mainWebView.reload();
4404 private void setDisplayWebpageImages() {
4405 if (!onTheFlyDisplayImagesSet) {
4406 if (domainSettingsApplied) { // Custom domain settings are applied.
4407 switch (displayWebpageImagesInt) {
4408 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_SYSTEM_DEFAULT:
4409 mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
4412 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_ENABLED:
4413 mainWebView.getSettings().setLoadsImagesAutomatically(true);
4416 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_DISABLED:
4417 mainWebView.getSettings().setLoadsImagesAutomatically(false);
4420 } else { // Default settings are applied.
4421 mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
4426 private void updatePrivacyIcons(boolean runInvalidateOptionsMenu) {
4427 // Get handles for the menu items.
4428 MenuItem privacyMenuItem = mainMenu.findItem(R.id.toggle_javascript);
4429 MenuItem firstPartyCookiesMenuItem = mainMenu.findItem(R.id.toggle_first_party_cookies);
4430 MenuItem domStorageMenuItem = mainMenu.findItem(R.id.toggle_dom_storage);
4431 MenuItem refreshMenuItem = mainMenu.findItem(R.id.refresh);
4433 // Update the privacy icon.
4434 if (javaScriptEnabled) { // JavaScript is enabled.
4435 privacyMenuItem.setIcon(R.drawable.javascript_enabled);
4436 } else if (firstPartyCookiesEnabled) { // JavaScript is disabled but cookies are enabled.
4437 privacyMenuItem.setIcon(R.drawable.warning);
4438 } else { // All the dangerous features are disabled.
4439 privacyMenuItem.setIcon(R.drawable.privacy_mode);
4442 // Update the first-party cookies icon.
4443 if (firstPartyCookiesEnabled) { // First-party cookies are enabled.
4444 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_enabled);
4445 } else { // First-party cookies are disabled.
4447 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_dark);
4449 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_light);
4453 // Update the DOM storage icon.
4454 if (javaScriptEnabled && domStorageEnabled) { // Both JavaScript and DOM storage are enabled.
4455 domStorageMenuItem.setIcon(R.drawable.dom_storage_enabled);
4456 } else if (javaScriptEnabled) { // JavaScript is enabled but DOM storage is disabled.
4458 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_dark);
4460 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_light);
4462 } else { // JavaScript is disabled, so DOM storage is ghosted.
4464 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_dark);
4466 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_light);
4470 // Update the refresh icon.
4472 refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
4474 refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
4477 // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`.
4478 if (runInvalidateOptionsMenu) {
4479 invalidateOptionsMenu();
4483 private void highlightUrlText() {
4484 String urlString = urlTextBox.getText().toString();
4486 if (urlString.startsWith("http://")) { // Highlight the protocol of connections that are not encrypted.
4487 urlTextBox.getText().setSpan(redColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4488 } else if (urlString.startsWith("https://")) { // De-emphasize the protocol of connections that are encrypted.
4489 urlTextBox.getText().setSpan(initialGrayColorSpan, 0, 8, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4492 // Get the index of the `/` immediately after the domain name.
4493 int endOfDomainName = urlString.indexOf("/", (urlString.indexOf("//") + 2));
4495 // De-emphasize the text after the domain name.
4496 if (endOfDomainName > 0) {
4497 urlTextBox.getText().setSpan(finalGrayColorSpan, endOfDomainName, urlString.length(), Spanned.SPAN_INCLUSIVE_INCLUSIVE);
4501 private void loadBookmarksFolder() {
4502 // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
4503 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
4505 // Populate the bookmarks cursor adapter. `this` specifies the `Context`. `false` disables `autoRequery`.
4506 bookmarksCursorAdapter = new CursorAdapter(this, bookmarksCursor, false) {
4508 public View newView(Context context, Cursor cursor, ViewGroup parent) {
4509 // Inflate the individual item layout. `false` does not attach it to the root.
4510 return getLayoutInflater().inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false);
4514 public void bindView(View view, Context context, Cursor cursor) {
4515 // Get handles for the views.
4516 ImageView bookmarkFavoriteIcon = view.findViewById(R.id.bookmark_favorite_icon);
4517 TextView bookmarkNameTextView = view.findViewById(R.id.bookmark_name);
4519 // Get the favorite icon byte array from the cursor.
4520 byte[] favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
4522 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
4523 Bitmap favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.length);
4525 // Display the bitmap in `bookmarkFavoriteIcon`.
4526 bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap);
4528 // Get the bookmark name from the cursor and display it in `bookmarkNameTextView`.
4529 String bookmarkNameString = cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
4530 bookmarkNameTextView.setText(bookmarkNameString);
4532 // Make the font bold for folders.
4533 if (cursor.getInt(cursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {
4534 bookmarkNameTextView.setTypeface(Typeface.DEFAULT_BOLD);
4535 } else { // Reset the font to default for normal bookmarks.
4536 bookmarkNameTextView.setTypeface(Typeface.DEFAULT);
4541 // Populate the `ListView` with the adapter.
4542 bookmarksListView.setAdapter(bookmarksCursorAdapter);
4544 // Set the bookmarks drawer title.
4545 if (currentBookmarksFolder.isEmpty()) {
4546 bookmarksTitleTextView.setText(R.string.bookmarks);
4548 bookmarksTitleTextView.setText(currentBookmarksFolder);