2 * Copyright © 2015-2018 Soren Stoutner <soren@stoutner.com>.
4 * Download cookie code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
6 * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
8 * Privacy Browser is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * Privacy Browser is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with Privacy Browser. If not, see <http://www.gnu.org/licenses/>.
22 package com.stoutner.privacybrowser.activities;
24 import android.Manifest;
25 import android.annotation.SuppressLint;
26 import android.app.DialogFragment;
27 import android.app.DownloadManager;
28 import android.content.ActivityNotFoundException;
29 import android.content.BroadcastReceiver;
30 import android.content.ClipData;
31 import android.content.ClipboardManager;
32 import android.content.Context;
33 import android.content.Intent;
34 import android.content.IntentFilter;
35 import android.content.SharedPreferences;
36 import android.content.pm.PackageManager;
37 import android.content.res.Configuration;
38 import android.database.Cursor;
39 import android.graphics.Bitmap;
40 import android.graphics.BitmapFactory;
41 import android.graphics.Typeface;
42 import android.graphics.drawable.BitmapDrawable;
43 import android.graphics.drawable.Drawable;
44 import android.net.Uri;
45 import android.net.http.SslCertificate;
46 import android.net.http.SslError;
47 import android.os.Build;
48 import android.os.Bundle;
49 import android.os.Environment;
50 import android.os.Handler;
51 import android.preference.PreferenceManager;
52 import android.print.PrintDocumentAdapter;
53 import android.print.PrintManager;
54 import android.support.annotation.NonNull;
55 import android.support.design.widget.CoordinatorLayout;
56 import android.support.design.widget.FloatingActionButton;
57 import android.support.design.widget.NavigationView;
58 import android.support.design.widget.Snackbar;
59 import android.support.v4.app.ActivityCompat;
60 import android.support.v4.content.ContextCompat;
61 // `ShortcutInfoCompat`, `ShortcutManagerCompat`, and `IconCompat` can be switched to the non-compat version once API >= 26.
62 import android.support.v4.content.pm.ShortcutInfoCompat;
63 import android.support.v4.content.pm.ShortcutManagerCompat;
64 import android.support.v4.graphics.drawable.IconCompat;
65 import android.support.v4.view.GravityCompat;
66 import android.support.v4.widget.DrawerLayout;
67 import android.support.v4.widget.SwipeRefreshLayout;
68 import android.support.v7.app.ActionBar;
69 import android.support.v7.app.ActionBarDrawerToggle;
70 import android.support.v7.app.AppCompatActivity;
71 import android.support.v7.app.AppCompatDialogFragment;
72 import android.support.v7.widget.Toolbar;
73 import android.text.Editable;
74 import android.text.Spanned;
75 import android.text.TextWatcher;
76 import android.text.style.ForegroundColorSpan;
77 import android.util.Patterns;
78 import android.view.ContextMenu;
79 import android.view.GestureDetector;
80 import android.view.KeyEvent;
81 import android.view.Menu;
82 import android.view.MenuItem;
83 import android.view.MotionEvent;
84 import android.view.View;
85 import android.view.ViewGroup;
86 import android.view.WindowManager;
87 import android.view.inputmethod.InputMethodManager;
88 import android.webkit.CookieManager;
89 import android.webkit.HttpAuthHandler;
90 import android.webkit.SslErrorHandler;
91 import android.webkit.ValueCallback;
92 import android.webkit.WebBackForwardList;
93 import android.webkit.WebChromeClient;
94 import android.webkit.WebResourceResponse;
95 import android.webkit.WebStorage;
96 import android.webkit.WebView;
97 import android.webkit.WebViewClient;
98 import android.webkit.WebViewDatabase;
99 import android.widget.ArrayAdapter;
100 import android.widget.CursorAdapter;
101 import android.widget.EditText;
102 import android.widget.FrameLayout;
103 import android.widget.ImageView;
104 import android.widget.LinearLayout;
105 import android.widget.ListView;
106 import android.widget.ProgressBar;
107 import android.widget.RadioButton;
108 import android.widget.RelativeLayout;
109 import android.widget.TextView;
111 import com.stoutner.privacybrowser.BuildConfig;
112 import com.stoutner.privacybrowser.R;
113 import com.stoutner.privacybrowser.dialogs.AdConsentDialog;
114 import com.stoutner.privacybrowser.dialogs.CreateBookmarkDialog;
115 import com.stoutner.privacybrowser.dialogs.CreateBookmarkFolderDialog;
116 import com.stoutner.privacybrowser.dialogs.CreateHomeScreenShortcutDialog;
117 import com.stoutner.privacybrowser.dialogs.DownloadImageDialog;
118 import com.stoutner.privacybrowser.dialogs.DownloadLocationPermissionDialog;
119 import com.stoutner.privacybrowser.dialogs.EditBookmarkDialog;
120 import com.stoutner.privacybrowser.dialogs.EditBookmarkFolderDialog;
121 import com.stoutner.privacybrowser.dialogs.HttpAuthenticationDialog;
122 import com.stoutner.privacybrowser.dialogs.PinnedSslCertificateMismatchDialog;
123 import com.stoutner.privacybrowser.dialogs.UrlHistoryDialog;
124 import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog;
125 import com.stoutner.privacybrowser.helpers.AdHelper;
126 import com.stoutner.privacybrowser.helpers.BlockListHelper;
127 import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper;
128 import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper;
129 import com.stoutner.privacybrowser.helpers.OrbotProxyHelper;
130 import com.stoutner.privacybrowser.dialogs.DownloadFileDialog;
131 import com.stoutner.privacybrowser.dialogs.SslCertificateErrorDialog;
133 import java.io.ByteArrayInputStream;
134 import java.io.ByteArrayOutputStream;
136 import java.io.IOException;
137 import java.io.UnsupportedEncodingException;
138 import java.net.MalformedURLException;
140 import java.net.URLDecoder;
141 import java.net.URLEncoder;
142 import java.util.ArrayList;
143 import java.util.Date;
144 import java.util.HashMap;
145 import java.util.HashSet;
146 import java.util.List;
147 import java.util.Map;
148 import java.util.Set;
150 // AppCompatActivity from android.support.v7.app.AppCompatActivity must be used to have access to the SupportActionBar until the minimum API is >= 21.
151 public class MainWebViewActivity extends AppCompatActivity implements CreateBookmarkDialog.CreateBookmarkListener, CreateBookmarkFolderDialog.CreateBookmarkFolderListener,
152 CreateHomeScreenShortcutDialog.CreateHomeScreenShortcutListener, DownloadFileDialog.DownloadFileListener, DownloadImageDialog.DownloadImageListener,
153 DownloadLocationPermissionDialog.DownloadLocationPermissionDialogListener, EditBookmarkDialog.EditBookmarkListener, EditBookmarkFolderDialog.EditBookmarkFolderListener,
154 HttpAuthenticationDialog.HttpAuthenticationListener, NavigationView.OnNavigationItemSelectedListener, PinnedSslCertificateMismatchDialog.PinnedSslCertificateMismatchListener,
155 SslCertificateErrorDialog.SslCertificateErrorListener, UrlHistoryDialog.UrlHistoryListener {
157 // `darkTheme` is public static so it can be accessed from everywhere.
158 public static boolean darkTheme;
160 // `allowScreenshots` is public static so it can be accessed from everywhere. It is also used in `onCreate()`.
161 public static boolean allowScreenshots;
163 // `favoriteIconBitmap` is public static so it can be accessed from `CreateHomeScreenShortcutDialog`, `BookmarksActivity`, `BookmarksDatabaseViewActivity`, `CreateBookmarkDialog`,
164 // `CreateBookmarkFolderDialog`, `EditBookmarkDialog`, `EditBookmarkFolderDialog`, `EditBookmarkDatabaseViewDialog`, and `ViewSslCertificateDialog`. It is also used in `onCreate()`,
165 // `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onCreateHomeScreenShortcutCreate()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `applyDomainSettings()`.
166 public static Bitmap favoriteIconBitmap;
168 // `formattedUrlString` is public static so it can be accessed from `BookmarksActivity`, `CreateBookmarkDialog`, and `AddDomainDialog`.
169 // It is also used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onCreateHomeScreenShortcutCreate()`, and `loadUrlFromTextBox()`.
170 public static String formattedUrlString;
172 // `sslCertificate` is public static so it can be accessed from `DomainsActivity`, `DomainsListFragment`, `DomainSettingsFragment`, `PinnedSslCertificateMismatchDialog`,
173 // and `ViewSslCertificateDialog`. It is also used in `onCreate()`.
174 public static SslCertificate sslCertificate;
176 // `orbotStatus` is public static so it can be accessed from `OrbotProxyHelper`. It is also used in `onCreate()`.
177 public static String orbotStatus;
179 // `webViewTitle` is public static so it can be accessed from `CreateBookmarkDialog` and `CreateHomeScreenShortcutDialog`. It is also used in `onCreate()`.
180 public static String webViewTitle;
182 // `appliedUserAgentString` is public static so it can be accessed from `ViewSourceActivity`. It is also used in `applyDomainSettings()`.
183 public static String appliedUserAgentString;
185 // `reloadOnRestart` is public static so it can be accessed from `SettingsFragment`. It is also used in `onRestart()`
186 public static boolean reloadOnRestart;
188 // `reloadUrlOnRestart` is public static so it can be accessed from `SettingsFragment` and `BookmarksActivity`. It is also used in `onRestart()`.
189 public static boolean loadUrlOnRestart;
191 // `restartFromBookmarksActivity` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onRestart()`.
192 public static boolean restartFromBookmarksActivity;
194 // The block list versions are public static so they can be accessed from `AboutTabFragment`. They are also used in `onCreate()`.
195 public static String easyListVersion;
196 public static String easyPrivacyVersion;
197 public static String fanboyAnnoyanceVersion;
198 public static String fanboySocialVersion;
200 // The request items are public static so they can be accessed by `BlockListHelper`, `RequestsArrayAdapter`, and `ViewRequestsDialog`. They are also used in `onCreate()`.
201 public static List<String[]> resourceRequests;
202 public static String[] whiteListResultStringArray;
203 public final static int REQUEST_DISPOSITION = 0;
204 public final static int REQUEST_URL = 1;
205 public final static int REQUEST_BLOCKLIST = 2;
206 public final static int REQUEST_SUBLIST = 3;
207 public final static int REQUEST_BLOCKLIST_ENTRIES = 4;
208 public final static int REQUEST_BLOCKLIST_ORIGINAL_ENTRY = 5;
210 public final static int REQUEST_DEFAULT = 0;
211 public final static int REQUEST_ALLOWED = 1;
212 public final static int REQUEST_BLOCKED = 2;
214 public final static int MAIN_WHITELIST = 1;
215 public final static int FINAL_WHITELIST = 2;
216 public final static int DOMAIN_WHITELIST = 3;
217 public final static int DOMAIN_INITIAL_WHITELIST = 4;
218 public final static int DOMAIN_FINAL_WHITELIST = 5;
219 public final static int THIRD_PARTY_WHITELIST = 6;
220 public final static int THIRD_PARTY_DOMAIN_WHITELIST = 7;
221 public final static int THIRD_PARTY_DOMAIN_INITIAL_WHITELIST = 8;
223 public final static int MAIN_BLACKLIST = 9;
224 public final static int INITIAL_BLACKLIST = 10;
225 public final static int FINAL_BLACKLIST = 11;
226 public final static int DOMAIN_BLACKLIST = 12;
227 public final static int DOMAIN_INITIAL_BLACKLIST = 13;
228 public final static int DOMAIN_FINAL_BLACKLIST = 14;
229 public final static int DOMAIN_REGULAR_EXPRESSION_BLACKLIST = 15;
230 public final static int THIRD_PARTY_BLACKLIST = 16;
231 public final static int THIRD_PARTY_INITIAL_BLACKLIST = 17;
232 public final static int THIRD_PARTY_DOMAIN_BLACKLIST = 18;
233 public final static int THIRD_PARTY_DOMAIN_INITIAL_BLACKLIST = 19;
234 public final static int THIRD_PARTY_REGULAR_EXPRESSION_BLACKLIST = 20;
235 public final static int THIRD_PARTY_DOMAIN_REGULAR_EXPRESSION_BLACKLIST = 21;
236 public final static int REGULAR_EXPRESSION_BLACKLIST = 22;
238 // `currentBookmarksFolder` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onCreate()`, `onBackPressed()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`,
239 // `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
240 public static String currentBookmarksFolder;
242 // `domainSettingsDatabaseId` is public static so it can be accessed from `PinnedSslCertificateMismatchDialog`. It is also used in `onCreate()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
243 public static int domainSettingsDatabaseId;
245 // The pinned domain SSL Certificate variables are public static so they can be accessed from `PinnedSslCertificateMismatchDialog`. They are also used in `onCreate()` and `applyDomainSettings()`.
246 public static String pinnedDomainSslIssuedToCNameString;
247 public static String pinnedDomainSslIssuedToONameString;
248 public static String pinnedDomainSslIssuedToUNameString;
249 public static String pinnedDomainSslIssuedByCNameString;
250 public static String pinnedDomainSslIssuedByONameString;
251 public static String pinnedDomainSslIssuedByUNameString;
252 public static Date pinnedDomainSslStartDate;
253 public static Date pinnedDomainSslEndDate;
255 // The user agent constants are public static so they can be accessed from `SettingsFragment`, `DomainsActivity`, and `DomainSettingsFragment`.
256 public final static int UNRECOGNIZED_USER_AGENT = -1;
257 public final static int SETTINGS_WEBVIEW_DEFAULT_USER_AGENT = 1;
258 public final static int SETTINGS_CUSTOM_USER_AGENT = 12;
259 public final static int DOMAINS_SYSTEM_DEFAULT_USER_AGENT = 0;
260 public final static int DOMAINS_WEBVIEW_DEFAULT_USER_AGENT = 2;
261 public final static int DOMAINS_CUSTOM_USER_AGENT = 13;
264 // `appBar` is used in `onCreate()`, `onOptionsItemSelected()`, `closeFindOnPage()`, and `applyAppSettings()`.
265 private ActionBar appBar;
267 // `navigatingHistory` is used in `onCreate()`, `onNavigationItemSelected()`, `onSslMismatchBack()`, and `applyDomainSettings()`.
268 private boolean navigatingHistory;
270 // `favoriteIconDefaultBitmap` is used in `onCreate()` and `applyDomainSettings`.
271 private Bitmap favoriteIconDefaultBitmap;
273 // `drawerLayout` is used in `onCreate()`, `onNewIntent()`, `onBackPressed()`, and `onRestart()`.
274 private DrawerLayout drawerLayout;
276 // `rootCoordinatorLayout` is used in `onCreate()` and `applyAppSettings()`.
277 private CoordinatorLayout rootCoordinatorLayout;
279 // `mainWebView` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`,
280 // `findNextOnPage()`, `closeFindOnPage()`, `loadUrlFromTextBox()`, `onSslMismatchBack()`, and `setDisplayWebpageImages()`.
281 private WebView mainWebView;
283 // `fullScreenVideoFrameLayout` is used in `onCreate()` and `onConfigurationChanged()`.
284 private FrameLayout fullScreenVideoFrameLayout;
286 // `swipeRefreshLayout` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsMenuSelected()`, and `onRestart()`.
287 private SwipeRefreshLayout swipeRefreshLayout;
289 // `urlAppBarRelativeLayout` is used in `onCreate()` and `applyDomainSettings()`.
290 private RelativeLayout urlAppBarRelativeLayout;
292 // `favoriteIconImageView` is used in `onCreate()` and `applyDomainSettings()`
293 private ImageView favoriteIconImageView;
295 // `cookieManager` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`, `loadUrlFromTextBox()`, `onDownloadImage()`, `onDownloadFile()`, and `onRestart()`.
296 private CookieManager cookieManager;
298 // `customHeader` is used in `onCreate()`, `onOptionsItemSelected()`, `onCreateContextMenu()`, and `loadUrl()`.
299 private final Map<String, String> customHeaders = new HashMap<>();
301 // `javaScriptEnabled` is also used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `applyDomainSettings()`, and `updatePrivacyIcons()`.
302 private boolean javaScriptEnabled;
304 // `firstPartyCookiesEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onDownloadImage()`, `onDownloadFile()`, and `applyDomainSettings()`.
305 private boolean firstPartyCookiesEnabled;
307 // `thirdPartyCookiesEnabled` used in `onCreate()`, `onPrepareOptionsMenu()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
308 private boolean thirdPartyCookiesEnabled;
310 // `domStorageEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
311 private boolean domStorageEnabled;
313 // `saveFormDataEnabled` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, and `applyDomainSettings()`. It can be removed once the minimum API >= 26.
314 private boolean saveFormDataEnabled;
316 // `nightMode` is used in `onCreate()` and `applyDomainSettings()`.
317 private boolean nightMode;
319 // `displayWebpageImagesBoolean` is used in `applyAppSettings()` and `applyDomainSettings()`.
320 private boolean displayWebpageImagesBoolean;
322 // 'homepage' is used in `onCreate()`, `onNavigationItemSelected()`, and `applyAppSettings()`.
323 private String homepage;
325 // `searchURL` is used in `loadURLFromTextBox()` and `applyAppSettings()`.
326 private String searchURL;
328 // The block list variables are used in `onCreate()` and `applyAppSettings()`.
329 private boolean easyListEnabled;
330 private boolean easyPrivacyEnabled;
331 private boolean fanboysAnnoyanceListEnabled;
332 private boolean fanboysSocialBlockingListEnabled;
334 // `privacyBrowserRuntime` is used in `onCreate()`, `onOptionsItemSelected()`, and `applyAppSettings()`.
335 private Runtime privacyBrowserRuntime;
337 // `proxyThroughOrbot` is used in `onRestart()` and `applyAppSettings()`.
338 private boolean proxyThroughOrbot;
340 // `incognitoModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
341 private boolean incognitoModeEnabled;
343 // `fullScreenBrowsingModeEnabled` is used in `onCreate()` and `applyAppSettings()`.
344 private boolean fullScreenBrowsingModeEnabled;
346 // `inFullScreenBrowsingMode` is used in `onCreate()`, `onConfigurationChanged()`, and `applyAppSettings()`.
347 private boolean inFullScreenBrowsingMode;
349 // `hideSystemBarsOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
350 private boolean hideSystemBarsOnFullscreen;
352 // `translucentNavigationBarOnFullscreen` is used in `onCreate()` and `applyAppSettings()`.
353 private boolean translucentNavigationBarOnFullscreen;
355 // `reapplyDomainSettingsOnRestart` is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, and `onAddDomain()`, .
356 private boolean reapplyDomainSettingsOnRestart;
358 // `reapplyAppSettingsOnRestart` is used in `onNavigationItemSelected()` and `onRestart()`.
359 private boolean reapplyAppSettingsOnRestart;
361 // `currentDomainName` is used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onAddDomain()`, and `applyDomainSettings()`.
362 private String currentDomainName;
364 // `ignorePinnedSslCertificateForDomain` is used in `onCreate()`, `onSslMismatchProceed()`, and `applyDomainSettings()`.
365 private boolean ignorePinnedSslCertificate;
367 // `waitingForOrbot` is used in `onCreate()` and `applyAppSettings()`.
368 private boolean waitingForOrbot;
370 // `domainSettingsApplied` is used in `prepareOptionsMenu()`, `applyDomainSettings()`, and `setDisplayWebpageImages()`.
371 private boolean domainSettingsApplied;
373 // `displayWebpageImagesInt` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
374 private int displayWebpageImagesInt;
376 // `onTheFlyDisplayImagesSet` is used in `applyDomainSettings()` and `setDisplayWebpageImages()`.
377 private boolean onTheFlyDisplayImagesSet;
379 // `waitingForOrbotData` is used in `onCreate()` and `applyAppSettings()`.
380 private String waitingForOrbotHTMLString;
382 // `privateDataDirectoryString` is used in `onCreate()`, `onOptionsItemSelected()`, and `onNavigationItemSelected()`.
383 private String privateDataDirectoryString;
385 // `findOnPageLinearLayout` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
386 private LinearLayout findOnPageLinearLayout;
388 // `findOnPageEditText` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
389 private EditText findOnPageEditText;
391 // `mainMenu` is used in `onCreateOptionsMenu()` and `updatePrivacyIcons()`.
392 private Menu mainMenu;
394 // `drawerToggle` is used in `onCreate()`, `onPostCreate()`, `onConfigurationChanged()`, `onNewIntent()`, and `onNavigationItemSelected()`.
395 private ActionBarDrawerToggle drawerToggle;
397 // `supportAppBar` is used in `onCreate()`, `onOptionsItemSelected()`, and `closeFindOnPage()`.
398 private Toolbar supportAppBar;
400 // `urlTextBox` is used in `onCreate()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, `loadUrl()`, and `highlightUrlText()`.
401 private EditText urlTextBox;
403 // The color spans are used in `onCreate()` and `highlightUrlText()`.
404 private ForegroundColorSpan redColorSpan;
405 private ForegroundColorSpan initialGrayColorSpan;
406 private ForegroundColorSpan finalGrayColorSpan;
408 // `sslErrorHandler` is used in `onCreate()`, `onSslErrorCancel()`, and `onSslErrorProceed`.
409 private SslErrorHandler sslErrorHandler;
411 // `httpAuthHandler` is used in `onCreate()`, `onHttpAuthenticationCancel()`, and `onHttpAuthenticationProceed()`.
412 private static HttpAuthHandler httpAuthHandler;
414 // `inputMethodManager` is used in `onOptionsItemSelected()`, `loadUrlFromTextBox()`, and `closeFindOnPage()`.
415 private InputMethodManager inputMethodManager;
417 // `mainWebViewRelativeLayout` is used in `onCreate()` and `onNavigationItemSelected()`.
418 private RelativeLayout mainWebViewRelativeLayout;
420 // `urlIsLoading` is used in `onCreate()`, `loadUrl()`, and `applyDomainSettings()`.
421 private boolean urlIsLoading;
423 // `pinnedDomainSslCertificate` is used in `onCreate()` and `applyDomainSettings()`.
424 private boolean pinnedDomainSslCertificate;
426 // `bookmarksDatabaseHelper` is used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
427 private BookmarksDatabaseHelper bookmarksDatabaseHelper;
429 // `bookmarksListView` is used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, and `loadBookmarksFolder()`.
430 private ListView bookmarksListView;
432 // `bookmarksTitleTextView` is used in `onCreate()` and `loadBookmarksFolder()`.
433 private TextView bookmarksTitleTextView;
435 // `bookmarksCursor` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
436 private Cursor bookmarksCursor;
438 // `bookmarksCursorAdapter` is used in `onCreateBookmark()`, `onCreateBookmarkFolder()` `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
439 private CursorAdapter bookmarksCursorAdapter;
441 // `oldFolderNameString` is used in `onCreate()` and `onSaveEditBookmarkFolder()`.
442 private String oldFolderNameString;
444 // `fileChooserCallback` is used in `onCreate()` and `onActivityResult()`.
445 private ValueCallback<Uri[]> fileChooserCallback;
447 // The download strings are used in `onCreate()` and `onRequestPermissionResult()`.
448 private String downloadUrl;
449 private String downloadContentDisposition;
450 private long downloadContentLength;
452 // `downloadImageUrl` is used in `onCreateContextMenu()` and `onRequestPermissionResult()`.
453 private String downloadImageUrl;
455 // The user agent variables are used in `onCreate()` and `applyDomainSettings()`.
456 private ArrayAdapter<CharSequence> userAgentNamesArray;
457 private String[] userAgentDataArray;
459 // The request codes are used in `onCreate()`, `onCreateContextMenu()`, `onCloseDownloadLocationPermissionDialog()`, and `onRequestPermissionResult()`.
460 private final int DOWNLOAD_FILE_REQUEST_CODE = 1;
461 private final int DOWNLOAD_IMAGE_REQUEST_CODE = 2;
464 // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled. The whole premise of Privacy Browser is built around an understanding of these dangers.
465 // Also, remove the warning about needing to override `performClick()` when using an `OnTouchListener` with `WebView`.
466 @SuppressLint({"SetJavaScriptEnabled", "ClickableViewAccessibility"})
467 // Remove Android Studio's warning about deprecations. We have to use the deprecated `getColor()` until API >= 23.
468 @SuppressWarnings("deprecation")
469 protected void onCreate(Bundle savedInstanceState) {
470 // Get a handle for the shared preferences.
471 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
473 // Get the theme and screenshot preferences.
474 darkTheme = sharedPreferences.getBoolean("dark_theme", false);
475 allowScreenshots = sharedPreferences.getBoolean("allow_screenshots", false);
477 // Disable screenshots if not allowed.
478 if (!allowScreenshots) {
479 getWindow().addFlags(WindowManager.LayoutParams.FLAG_SECURE);
482 // Set the activity theme.
484 setTheme(R.style.PrivacyBrowserDark);
486 setTheme(R.style.PrivacyBrowserLight);
489 // Run the default commands.
490 super.onCreate(savedInstanceState);
492 // Set the content view.
493 setContentView(R.layout.main_drawerlayout);
495 // Get a handle for `inputMethodManager`.
496 inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
498 // `SupportActionBar` from `android.support.v7.app.ActionBar` must be used until the minimum API is >= 21.
499 supportAppBar = findViewById(R.id.app_bar);
500 setSupportActionBar(supportAppBar);
501 appBar = getSupportActionBar();
503 // This is needed to get rid of the Android Studio warning that `appBar` might be null.
504 assert appBar != null;
506 // Add the custom `url_app_bar` layout, which shows the favorite icon and the URL text bar.
507 appBar.setCustomView(R.layout.url_app_bar);
508 appBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
510 // Initialize the foreground color spans for highlighting the URLs. We have to use the deprecated `getColor()` until API >= 23.
511 redColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.red_a700));
512 initialGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
513 finalGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
515 // Get a handle for `urlTextBox`.
516 urlTextBox = findViewById(R.id.url_edittext);
518 // Remove the formatting from `urlTextBar` when the user is editing the text.
519 urlTextBox.setOnFocusChangeListener((View v, boolean hasFocus) -> {
520 if (hasFocus) { // The user is editing `urlTextBox`.
521 // Remove the highlighting.
522 urlTextBox.getText().removeSpan(redColorSpan);
523 urlTextBox.getText().removeSpan(initialGrayColorSpan);
524 urlTextBox.getText().removeSpan(finalGrayColorSpan);
525 } else { // The user has stopped editing `urlTextBox`.
526 // Reapply the highlighting.
531 // Set the go button on the keyboard to load the URL in `urlTextBox`.
532 urlTextBox.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
533 // If the event is a key-down event on the `enter` button, load the URL.
534 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
535 // Load the URL into the mainWebView and consume the event.
537 loadUrlFromTextBox();
538 } catch (UnsupportedEncodingException e) {
541 // If the enter key was pressed, consume the event.
544 // If any other key was pressed, do not consume the event.
549 // Set `waitingForOrbotHTMLString`.
550 waitingForOrbotHTMLString = "<html><body><br/><center><h1>" + getString(R.string.waiting_for_orbot) + "</h1></center></body></html>";
552 // Initialize `currentDomainName`, `orbotStatus`, and `waitingForOrbot`.
553 currentDomainName = "";
554 orbotStatus = "unknown";
555 waitingForOrbot = false;
557 // Create an Orbot status `BroadcastReceiver`.
558 BroadcastReceiver orbotStatusBroadcastReceiver = new BroadcastReceiver() {
560 public void onReceive(Context context, Intent intent) {
561 // Store the content of the status message in `orbotStatus`.
562 orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS");
564 // If we are waiting on Orbot, load the website now that Orbot is connected.
565 if (orbotStatus.equals("ON") && waitingForOrbot) {
566 // Reset `waitingForOrbot`.
567 waitingForOrbot = false;
569 // Load `formattedUrlString
570 loadUrl(formattedUrlString);
575 // Register `orbotStatusBroadcastReceiver` on `this` context.
576 this.registerReceiver(orbotStatusBroadcastReceiver, new IntentFilter("org.torproject.android.intent.action.STATUS"));
578 // Get handles for views that need to be accessed.
579 drawerLayout = findViewById(R.id.drawerlayout);
580 rootCoordinatorLayout = findViewById(R.id.root_coordinatorlayout);
581 bookmarksListView = findViewById(R.id.bookmarks_drawer_listview);
582 bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview);
583 FloatingActionButton launchBookmarksActivityFab = findViewById(R.id.launch_bookmarks_activity_fab);
584 FloatingActionButton createBookmarkFolderFab = findViewById(R.id.create_bookmark_folder_fab);
585 FloatingActionButton createBookmarkFab = findViewById(R.id.create_bookmark_fab);
586 mainWebViewRelativeLayout = findViewById(R.id.main_webview_relativelayout);
587 mainWebView = findViewById(R.id.main_webview);
588 findOnPageLinearLayout = findViewById(R.id.find_on_page_linearlayout);
589 findOnPageEditText = findViewById(R.id.find_on_page_edittext);
590 fullScreenVideoFrameLayout = findViewById(R.id.full_screen_video_framelayout);
591 urlAppBarRelativeLayout = findViewById(R.id.url_app_bar_relativelayout);
592 favoriteIconImageView = findViewById(R.id.favorite_icon);
594 // Set the bookmarks drawer resources according to the theme. This can't be done in the layout due to compatibility issues with the `DrawerLayout` support widget.
596 launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_dark));
597 createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_dark));
598 createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_dark));
599 bookmarksListView.setBackgroundColor(getResources().getColor(R.color.gray_850));
601 launchBookmarksActivityFab.setImageDrawable(getResources().getDrawable(R.drawable.bookmarks_light));
602 createBookmarkFolderFab.setImageDrawable(getResources().getDrawable(R.drawable.create_folder_light));
603 createBookmarkFab.setImageDrawable(getResources().getDrawable(R.drawable.create_bookmark_light));
604 bookmarksListView.setBackgroundColor(getResources().getColor(R.color.white));
607 // Set the launch bookmarks activity FAB to launch the bookmarks activity.
608 launchBookmarksActivityFab.setOnClickListener(v -> {
609 // Create an intent to launch the bookmarks activity.
610 Intent bookmarksIntent = new Intent(getApplicationContext(), BookmarksActivity.class);
612 // Include the current folder with the `Intent`.
613 bookmarksIntent.putExtra("Current Folder", currentBookmarksFolder);
616 startActivity(bookmarksIntent);
619 // Set the create new bookmark folder FAB to display an alert dialog.
620 createBookmarkFolderFab.setOnClickListener(v -> {
621 // Show the `CreateBookmarkFolderDialog` `AlertDialog` and name the instance `@string/create_folder`.
622 AppCompatDialogFragment createBookmarkFolderDialog = new CreateBookmarkFolderDialog();
623 createBookmarkFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_folder));
626 // Set the create new bookmark FAB to display an alert dialog.
627 createBookmarkFab.setOnClickListener(view -> {
628 // Show the `CreateBookmarkDialog` `AlertDialog` and name the instance `@string/create_bookmark`.
629 AppCompatDialogFragment createBookmarkDialog = new CreateBookmarkDialog();
630 createBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.create_bookmark));
633 // Create a double-tap listener to toggle full-screen mode.
634 final GestureDetector gestureDetector = new GestureDetector(this, new GestureDetector.SimpleOnGestureListener() {
635 // Override `onDoubleTap()`. All other events are handled using the default settings.
637 public boolean onDoubleTap(MotionEvent event) {
638 if (fullScreenBrowsingModeEnabled) { // Only process the double-tap if full screen browsing mode is enabled.
639 // Toggle `inFullScreenBrowsingMode`.
640 inFullScreenBrowsingMode = !inFullScreenBrowsingMode;
642 if (inFullScreenBrowsingMode) { // Switch to full screen mode.
643 // Hide the `appBar`.
646 // Hide the banner ad in the free flavor.
647 if (BuildConfig.FLAVOR.contentEquals("free")) {
648 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
649 AdHelper.hideAd(findViewById(R.id.adview));
652 // Modify the system bars.
653 if (hideSystemBarsOnFullscreen) { // Hide everything.
654 // Remove the translucent overlays.
655 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
657 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
658 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
660 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
661 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
662 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
664 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
666 // Set `rootCoordinatorLayout` to fill the whole screen.
667 rootCoordinatorLayout.setFitsSystemWindows(false);
668 } else { // Hide everything except the status and navigation bars.
669 // Set `rootCoordinatorLayout` to fit under the status and navigation bars.
670 rootCoordinatorLayout.setFitsSystemWindows(false);
672 // There is an Android Support Library bug that causes a scrim to print on the right side of the `Drawer Layout` when the navigation bar is displayed on the right of the screen.
673 if (translucentNavigationBarOnFullscreen) {
674 // Set the navigation bar to be translucent.
675 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
678 } else { // Switch to normal viewing mode.
679 // Show the `appBar`.
682 // Show the `BannerAd` in the free flavor.
683 if (BuildConfig.FLAVOR.contentEquals("free")) {
684 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
685 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_id));
688 // Remove the translucent navigation bar flag if it is set.
689 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
691 // Add the translucent status flag if it is unset. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
692 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
694 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
695 rootCoordinatorLayout.setSystemUiVisibility(0);
697 // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
698 rootCoordinatorLayout.setFitsSystemWindows(true);
701 // Consume the double-tap.
703 } else { // Do not consume the double-tap because full screen browsing mode is disabled.
709 // Pass all touch events on `mainWebView` through `gestureDetector` to check for double-taps.
710 mainWebView.setOnTouchListener((View v, MotionEvent event) -> {
711 // Call `performClick()` on the view, which is required for accessibility.
714 // Send the `event` to `gestureDetector`.
715 return gestureDetector.onTouchEvent(event);
718 // Update `findOnPageCountTextView`.
719 mainWebView.setFindListener(new WebView.FindListener() {
720 // Get a handle for `findOnPageCountTextView`.
721 final TextView findOnPageCountTextView = (TextView) findViewById(R.id.find_on_page_count_textview);
724 public void onFindResultReceived(int activeMatchOrdinal, int numberOfMatches, boolean isDoneCounting) {
725 if ((isDoneCounting) && (numberOfMatches == 0)) { // There are no matches.
726 // Set `findOnPageCountTextView` to `0/0`.
727 findOnPageCountTextView.setText(R.string.zero_of_zero);
728 } else if (isDoneCounting) { // There are matches.
729 // `activeMatchOrdinal` is zero-based.
730 int activeMatch = activeMatchOrdinal + 1;
732 // Build the match string.
733 String matchString = activeMatch + "/" + numberOfMatches;
735 // Set `findOnPageCountTextView`.
736 findOnPageCountTextView.setText(matchString);
741 // Search for the string on the page whenever a character changes in the `findOnPageEditText`.
742 findOnPageEditText.addTextChangedListener(new TextWatcher() {
744 public void beforeTextChanged(CharSequence s, int start, int count, int after) {
749 public void onTextChanged(CharSequence s, int start, int before, int count) {
754 public void afterTextChanged(Editable s) {
755 // Search for the text in `mainWebView`.
756 mainWebView.findAllAsync(findOnPageEditText.getText().toString());
760 // Set the `check mark` button for the `findOnPageEditText` keyboard to close the soft keyboard.
761 findOnPageEditText.setOnKeyListener((v, keyCode, event) -> {
762 if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) { // The `enter` key was pressed.
763 // Hide the soft keyboard. `0` indicates no additional flags.
764 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
766 // Consume the event.
768 } else { // A different key was pressed.
769 // Do not consume the event.
774 // Implement swipe to refresh
775 swipeRefreshLayout = findViewById(R.id.swipe_refreshlayout);
776 swipeRefreshLayout.setColorSchemeResources(R.color.blue_700);
777 swipeRefreshLayout.setOnRefreshListener(() -> mainWebView.reload());
779 // `DrawerTitle` identifies the `DrawerLayouts` in accessibility mode.
780 drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer));
781 drawerLayout.setDrawerTitle(GravityCompat.END, getString(R.string.bookmarks));
783 // Listen for touches on the navigation menu.
784 final NavigationView navigationView = findViewById(R.id.navigationview);
785 navigationView.setNavigationItemSelectedListener(this);
787 // Get handles for `navigationMenu` and the back and forward menu items. The menu is zero-based, so items 1, 2, and 3 are the second, third, and fourth entries in the menu.
788 final Menu navigationMenu = navigationView.getMenu();
789 final MenuItem navigationBackMenuItem = navigationMenu.getItem(1);
790 final MenuItem navigationForwardMenuItem = navigationMenu.getItem(2);
791 final MenuItem navigationHistoryMenuItem = navigationMenu.getItem(3);
792 final MenuItem navigationRequestsMenuItem = navigationMenu.getItem(4);
794 // Initialize the bookmarks database helper. `this` specifies the context. The two `nulls` do not specify the database name or a `CursorFactory`.
795 // The `0` specifies a database version, but that is ignored and set instead using a constant in `BookmarksDatabaseHelper`.
796 bookmarksDatabaseHelper = new BookmarksDatabaseHelper(this, null, null, 0);
798 // Initialize `currentBookmarksFolder`. `""` is the home folder in the database.
799 currentBookmarksFolder = "";
801 // Load the home folder, which is `""` in the database.
802 loadBookmarksFolder();
804 bookmarksListView.setOnItemClickListener((parent, view, position, id) -> {
805 // Convert the id from long to int to match the format of the bookmarks database.
806 int databaseID = (int) id;
808 // Get the bookmark cursor for this ID and move it to the first row.
809 Cursor bookmarkCursor = bookmarksDatabaseHelper.getBookmarkCursor(databaseID);
810 bookmarkCursor.moveToFirst();
812 // Act upon the bookmark according to the type.
813 if (bookmarkCursor.getInt(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) { // The selected bookmark is a folder.
814 // Store the new folder name in `currentBookmarksFolder`.
815 currentBookmarksFolder = bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
817 // Load the new folder.
818 loadBookmarksFolder();
819 } else { // The selected bookmark is not a folder.
820 // Load the bookmark URL.
821 loadUrl(bookmarkCursor.getString(bookmarkCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_URL)));
823 // Close the bookmarks drawer.
824 drawerLayout.closeDrawer(GravityCompat.END);
827 // Close the `Cursor`.
828 bookmarkCursor.close();
831 bookmarksListView.setOnItemLongClickListener((parent, view, position, id) -> {
832 // Convert the database ID from `long` to `int`.
833 int databaseId = (int) id;
835 // Find out if the selected bookmark is a folder.
836 boolean isFolder = bookmarksDatabaseHelper.isFolder(databaseId);
839 // Save the current folder name, which is used in `onSaveEditBookmarkFolder()`.
840 oldFolderNameString = bookmarksCursor.getString(bookmarksCursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
842 // Show the edit bookmark folder `AlertDialog` and name the instance `@string/edit_folder`.
843 AppCompatDialogFragment editFolderDialog = EditBookmarkFolderDialog.folderDatabaseId(databaseId);
844 editFolderDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_folder));
846 // Show the edit bookmark `AlertDialog` and name the instance `@string/edit_bookmark`.
847 AppCompatDialogFragment editBookmarkDialog = EditBookmarkDialog.bookmarkDatabaseId(databaseId);
848 editBookmarkDialog.show(getSupportFragmentManager(), getResources().getString(R.string.edit_bookmark));
851 // Consume the event.
855 // The `DrawerListener` is used to update the Navigation Menu.
856 drawerLayout.addDrawerListener(new DrawerLayout.DrawerListener() {
858 public void onDrawerSlide(@NonNull View drawerView, float slideOffset) {
862 public void onDrawerOpened(@NonNull View drawerView) {
866 public void onDrawerClosed(@NonNull View drawerView) {
870 public void onDrawerStateChanged(int newState) {
871 if ((newState == DrawerLayout.STATE_SETTLING) || (newState == DrawerLayout.STATE_DRAGGING)) { // The drawer is opening or closing.
872 // Initialize a the blocked requests counter.
873 int blockedRequests = 0;
875 // Count the number of blocked requests.
876 for (int i = 0; i < resourceRequests.size(); i++) {
877 if (Integer.valueOf(resourceRequests.get(i)[REQUEST_DISPOSITION]) == REQUEST_BLOCKED) {
882 // Update the back, forward, history, and requests menu items.
883 navigationBackMenuItem.setEnabled(mainWebView.canGoBack());
884 navigationForwardMenuItem.setEnabled(mainWebView.canGoForward());
885 navigationHistoryMenuItem.setEnabled((mainWebView.canGoBack() || mainWebView.canGoForward()));
886 navigationRequestsMenuItem.setTitle(getResources().getString(R.string.requests) + " - " + blockedRequests);
888 // Hide the keyboard (if displayed) so we can see the navigation menu. `0` indicates no additional flags.
889 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
891 // Clear the focus from `urlTextBox` if it has it.
892 urlTextBox.clearFocus();
897 // drawerToggle creates the hamburger icon at the start of the AppBar.
898 drawerToggle = new ActionBarDrawerToggle(this, drawerLayout, supportAppBar, R.string.open_navigation_drawer, R.string.close_navigation_drawer);
900 // Get a handle for the progress bar.
901 final ProgressBar progressBar = findViewById(R.id.progress_bar);
903 mainWebView.setWebChromeClient(new WebChromeClient() {
904 // Update the progress bar when a page is loading.
906 public void onProgressChanged(WebView view, int progress) {
907 // Inject the night mode CSS if night mode is enabled.
909 // `background-color: #212121` sets the background to be dark gray. `color: #BDBDBD` sets the text color to be light gray. `box-shadow: none` removes a lower underline on links
910 // used by WordPress. `text-decoration: none` removes all text underlines. `text-shadow: none` removes text shadows, which usually have a hard coded color.
911 // `border: none` removes all borders, which can also be used to underline text.
912 // `a {color: #1565C0}` sets links to be a dark blue. `!important` takes precedent over any existing sub-settings.
913 mainWebView.evaluateJavascript("(function() {var parent = document.getElementsByTagName('head').item(0); var style = document.createElement('style'); style.type = 'text/css'; " +
914 "style.innerHTML = '* {background-color: #212121 !important; color: #BDBDBD !important; box-shadow: none !important; text-decoration: none !important;" +
915 "text-shadow: none !important; border: none !important;} a {color: #1565C0 !important;}'; parent.appendChild(style)})()", value -> {
916 // Initialize a `Handler` to display `mainWebView`.
917 Handler displayWebViewHandler = new Handler();
919 // Setup a `Runnable` to display `mainWebView` after a delay to allow the CSS to be applied.
920 Runnable displayWebViewRunnable = () -> {
921 // Only display `mainWebView` if the progress bar is one. This prevents the display of the `WebView` while it is still loading.
922 if (progressBar.getVisibility() == View.GONE) {
923 mainWebView.setVisibility(View.VISIBLE);
927 // Use `displayWebViewHandler` to delay the displaying of `mainWebView` for 500 milliseconds.
928 displayWebViewHandler.postDelayed(displayWebViewRunnable, 500);
932 // Update the progress bar.
933 progressBar.setProgress(progress);
935 // Set the visibility of the progress bar.
936 if (progress < 100) {
937 // Show the progress bar.
938 progressBar.setVisibility(View.VISIBLE);
940 // Hide the progress bar.
941 progressBar.setVisibility(View.GONE);
943 // Display `mainWebView` if night mode is disabled.
944 // Because of a race condition between `applyDomainSettings` and `onPageStarted`, when night mode is set by domain settings the `WebView` may be hidden even if night mode is not
945 // currently enabled.
947 mainWebView.setVisibility(View.VISIBLE);
950 //Stop the swipe to refresh indicator if it is running
951 swipeRefreshLayout.setRefreshing(false);
955 // Set the favorite icon when it changes.
957 public void onReceivedIcon(WebView view, Bitmap icon) {
958 // Only update the favorite icon if the website has finished loading.
959 if (progressBar.getVisibility() == View.GONE) {
960 // Save a copy of the favorite icon.
961 favoriteIconBitmap = icon;
963 // Place the favorite icon in the appBar.
964 favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true));
968 // Save a copy of the title when it changes.
970 public void onReceivedTitle(WebView view, String title) {
971 // Save a copy of the title.
972 webViewTitle = title;
975 // Enter full screen video.
977 public void onShowCustomView(View view, CustomViewCallback callback) {
978 // Pause the ad if this is the free flavor.
979 if (BuildConfig.FLAVOR.contentEquals("free")) {
980 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
981 AdHelper.pauseAd(findViewById(R.id.adview));
984 // Remove the translucent overlays.
985 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
987 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
988 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
990 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
991 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
992 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
994 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
996 // Set `rootCoordinatorLayout` to fill the entire screen.
997 rootCoordinatorLayout.setFitsSystemWindows(false);
999 // Add `view` to `fullScreenVideoFrameLayout` and display it on the screen.
1000 fullScreenVideoFrameLayout.addView(view);
1001 fullScreenVideoFrameLayout.setVisibility(View.VISIBLE);
1004 // Exit full screen video.
1006 public void onHideCustomView() {
1007 // Hide `fullScreenVideoFrameLayout`.
1008 fullScreenVideoFrameLayout.removeAllViews();
1009 fullScreenVideoFrameLayout.setVisibility(View.GONE);
1011 // Add the translucent status flag. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
1012 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
1014 // Set `rootCoordinatorLayout` to fit inside the status and navigation bars. This also clears the `SYSTEM_UI` flags.
1015 rootCoordinatorLayout.setFitsSystemWindows(true);
1017 // Show the ad if this is the free flavor.
1018 if (BuildConfig.FLAVOR.contentEquals("free")) {
1019 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1020 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_id));
1026 public boolean onShowFileChooser(WebView webView, ValueCallback<Uri[]> filePathCallback, FileChooserParams fileChooserParams) {
1027 // Show the file chooser if the device is running API >= 21.
1028 if (Build.VERSION.SDK_INT >= 21) {
1029 // Store the file path callback.
1030 fileChooserCallback = filePathCallback;
1032 // Create an intent to open a chooser based ont the file chooser parameters.
1033 Intent fileChooserIntent = fileChooserParams.createIntent();
1035 // Open the file chooser. Currently only one `startActivityForResult` exists in this activity, so the request code, used to differentiate them, is simply `0`.
1036 startActivityForResult(fileChooserIntent, 0);
1042 // Register `mainWebView` for a context menu. This is used to see link targets and download images.
1043 registerForContextMenu(mainWebView);
1045 // Allow the downloading of files.
1046 mainWebView.setDownloadListener((String url, String userAgent, String contentDisposition, String mimetype, long contentLength) -> {
1047 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
1048 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
1049 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
1051 // Store the variables for future use by `onRequestPermissionsResult()`.
1053 downloadContentDisposition = contentDisposition;
1054 downloadContentLength = contentLength;
1056 // Show a dialog if the user has previously denied the permission.
1057 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
1058 // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
1059 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
1061 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
1062 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
1063 } else { // Show the permission request directly.
1064 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
1065 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
1067 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
1068 // Get a handle for the download file alert dialog.
1069 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(url, contentDisposition, contentLength);
1071 // Show the download file alert dialog.
1072 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
1076 // Allow pinch to zoom.
1077 mainWebView.getSettings().setBuiltInZoomControls(true);
1079 // Hide zoom controls.
1080 mainWebView.getSettings().setDisplayZoomControls(false);
1082 // Set `mainWebView` to use a wide viewport. Otherwise, some web pages will be scrunched and some content will render outside the screen.
1083 mainWebView.getSettings().setUseWideViewPort(true);
1085 // Set `mainWebView` to load in overview mode (zoomed out to the maximum width).
1086 mainWebView.getSettings().setLoadWithOverviewMode(true);
1088 // Explicitly disable geolocation.
1089 mainWebView.getSettings().setGeolocationEnabled(false);
1091 // Initialize cookieManager.
1092 cookieManager = CookieManager.getInstance();
1094 // Replace the header that `WebView` creates for `X-Requested-With` with a null value. The default value is the application ID (com.stoutner.privacybrowser.standard).
1095 customHeaders.put("X-Requested-With", "");
1097 // Initialize the default preference values the first time the program is run. `this` is the context. `false` keeps this command from resetting any current preferences back to default.
1098 PreferenceManager.setDefaultValues(this, R.xml.preferences, false);
1100 // Get the intent that started the app.
1101 final Intent launchingIntent = getIntent();
1103 // Extract the launching intent data as `launchingIntentUriData`.
1104 final Uri launchingIntentUriData = launchingIntent.getData();
1106 // Convert the launching intent URI data (if it exists) to a string and store it in `formattedUrlString`.
1107 if (launchingIntentUriData != null) {
1108 formattedUrlString = launchingIntentUriData.toString();
1111 // Get a handle for the `Runtime`.
1112 privacyBrowserRuntime = Runtime.getRuntime();
1114 // Store the application's private data directory.
1115 privateDataDirectoryString = getApplicationInfo().dataDir;
1116 // `dataDir` will vary, but will be something like `/data/user/0/com.stoutner.privacybrowser.standard`, which links to `/data/data/com.stoutner.privacybrowser.standard`.
1118 // Initialize `inFullScreenBrowsingMode`, which is always false at this point because Privacy Browser never starts in full screen browsing mode.
1119 inFullScreenBrowsingMode = false;
1121 // Initialize the privacy settings variables.
1122 javaScriptEnabled = false;
1123 firstPartyCookiesEnabled = false;
1124 thirdPartyCookiesEnabled = false;
1125 domStorageEnabled = false;
1126 saveFormDataEnabled = false; // Form data can be removed once the minimum API >= 26.
1129 // Initialize the WebView title.
1130 webViewTitle = getString(R.string.no_title);
1132 // Initialize the favorite icon bitmap. `ContextCompat` must be used until API >= 21.
1133 Drawable favoriteIconDrawable = ContextCompat.getDrawable(getApplicationContext(), R.drawable.world);
1134 BitmapDrawable favoriteIconBitmapDrawable = (BitmapDrawable) favoriteIconDrawable;
1135 assert favoriteIconBitmapDrawable != null;
1136 favoriteIconDefaultBitmap = favoriteIconBitmapDrawable.getBitmap();
1138 // If the favorite icon is null, load the default.
1139 if (favoriteIconBitmap == null) {
1140 favoriteIconBitmap = favoriteIconDefaultBitmap;
1143 // Initialize the user agent array adapter and string array.
1144 userAgentNamesArray = ArrayAdapter.createFromResource(this, R.array.user_agent_names, R.layout.domain_settings_spinner_item);
1145 userAgentDataArray = getResources().getStringArray(R.array.user_agent_data);
1147 // Apply the app settings from the shared preferences.
1150 // Instantiate the block list helper.
1151 BlockListHelper blockListHelper = new BlockListHelper();
1153 // Initialize the list of resource requests.
1154 resourceRequests = new ArrayList<>();
1156 // Parse the block lists.
1157 final ArrayList<List<String[]>> easyList = blockListHelper.parseBlockList(getAssets(), "blocklists/easylist.txt");
1158 final ArrayList<List<String[]>> easyPrivacy = blockListHelper.parseBlockList(getAssets(), "blocklists/easyprivacy.txt");
1159 final ArrayList<List<String[]>> fanboyAnnoyance = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-annoyance.txt");
1160 final ArrayList<List<String[]>> fanboySocial = blockListHelper.parseBlockList(getAssets(), "blocklists/fanboy-social.txt");
1162 // Store the list versions.
1163 easyListVersion = easyList.get(0).get(0)[0];
1164 easyPrivacyVersion = easyPrivacy.get(0).get(0)[0];
1165 fanboyAnnoyanceVersion = fanboyAnnoyance.get(0).get(0)[0];
1166 fanboySocialVersion = fanboySocial.get(0).get(0)[0];
1168 mainWebView.setWebViewClient(new WebViewClient() {
1169 // `shouldOverrideUrlLoading` makes this `WebView` the default handler for URLs inside the app, so that links are not kicked out to other apps.
1170 // The deprecated `shouldOverrideUrlLoading` must be used until API >= 24.
1171 @SuppressWarnings("deprecation")
1173 public boolean shouldOverrideUrlLoading(WebView view, String url) {
1174 if (url.startsWith("http")) { // Load the URL in Privacy Browser.
1175 // Hide the WebView while applying domain settings so changes to things like JavaScript aren't rendered on the current URL, which otherwise will reload automatically.
1176 mainWebView.setVisibility(View.INVISIBLE);
1178 // Apply the domain settings for the new URL.
1179 applyDomainSettings(url, true, false);
1181 // Display the WebView again so that the new URL can be loaded.
1182 mainWebView.setVisibility(View.VISIBLE);
1184 // Returning false causes the current WebView to handle the URL and prevents it from adding redirects to the history list.
1186 } else if (url.startsWith("mailto:")) { // Load the email address in an external email program.
1187 // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
1188 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
1190 // Parse the url and set it as the data for the intent.
1191 emailIntent.setData(Uri.parse(url));
1193 // Open the email program in a new task instead of as part of Privacy Browser.
1194 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1197 startActivity(emailIntent);
1199 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1201 } else if (url.startsWith("tel:")) { // Load the phone number in the dialer.
1202 // Open the dialer and load the phone number, but wait for the user to place the call.
1203 Intent dialIntent = new Intent(Intent.ACTION_DIAL);
1205 // Add the phone number to the intent.
1206 dialIntent.setData(Uri.parse(url));
1208 // Open the dialer in a new task instead of as part of Privacy Browser.
1209 dialIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1212 startActivity(dialIntent);
1214 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1216 } else { // Load a system chooser to select an app that can handle the URL.
1217 // Open an app that can handle the URL.
1218 Intent genericIntent = new Intent(Intent.ACTION_VIEW);
1220 // Add the URL to the intent.
1221 genericIntent.setData(Uri.parse(url));
1223 // List all apps that can handle the URL instead of just opening the first one.
1224 genericIntent.addCategory(Intent.CATEGORY_BROWSABLE);
1226 // Open the app in a new task instead of as part of Privacy Browser.
1227 genericIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
1229 // Start the app or display a snackbar if no app is available to handle the URL.
1231 startActivity(genericIntent);
1232 } catch (ActivityNotFoundException exception) {
1233 Snackbar.make(mainWebView, getString(R.string.unrecognized_url) + " " + url, Snackbar.LENGTH_SHORT).show();
1236 // Returning true indicates Privacy Browser is handling the URL by creating an intent.
1241 // Check requests against the block lists. The deprecated `shouldInterceptRequest()` must be used until minimum API >= 21.
1242 @SuppressWarnings("deprecation")
1244 public WebResourceResponse shouldInterceptRequest(WebView view, String url){
1245 // Create an empty web resource response to be used if the resource request is blocked.
1246 WebResourceResponse emptyWebResourceResponse = new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
1248 // Reset `whiteListResultStringArray`.
1249 whiteListResultStringArray = null;
1251 // Check EasyList if it is enabled.
1252 if (easyListEnabled) {
1253 if (blockListHelper.isBlocked(formattedUrlString, url, easyList)) {
1254 // The resource request was blocked. Return an empty web resource response.
1255 return emptyWebResourceResponse;
1259 // Check EasyPrivacy if it is enabled.
1260 if (easyPrivacyEnabled) {
1261 if (blockListHelper.isBlocked(formattedUrlString, url, easyPrivacy)) {
1262 // The resource request was blocked. Return an empty web resource response.
1263 return emptyWebResourceResponse;
1267 // Check Fanboy’s Annoyance List if it is enabled.
1268 if (fanboysAnnoyanceListEnabled) {
1269 if (blockListHelper.isBlocked(formattedUrlString, url, fanboyAnnoyance)) {
1270 // The resource request was blocked. Return an empty web resource response.
1271 return emptyWebResourceResponse;
1273 } else if (fanboysSocialBlockingListEnabled){ // Only check Fanboy’s Social Blocking List if Fanboy’s Annoyance List is disabled.
1274 if (blockListHelper.isBlocked(formattedUrlString, url, fanboySocial)) {
1275 // The resource request was blocked. Return an empty web resource response.
1276 return emptyWebResourceResponse;
1280 // Add the request to the log.
1281 if (whiteListResultStringArray != null ) { // The request was processed by a whitelist.
1282 resourceRequests.add(whiteListResultStringArray);
1283 } else { // The request didn't match any blocklist entry. Log it as a defult request.
1284 resourceRequests.add(new String[]{String.valueOf(REQUEST_DEFAULT), url});
1287 // The resource request has not been blocked. `return null` loads the requested resource.
1291 // Handle HTTP authentication requests.
1293 public void onReceivedHttpAuthRequest(WebView view, HttpAuthHandler handler, String host, String realm) {
1294 // Store `handler` so it can be accessed from `onHttpAuthenticationCancel()` and `onHttpAuthenticationProceed()`.
1295 httpAuthHandler = handler;
1297 // Display the HTTP authentication dialog.
1298 AppCompatDialogFragment httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm);
1299 httpAuthenticationDialogFragment.show(getSupportFragmentManager(), getString(R.string.http_authentication));
1302 // Update the URL in urlTextBox when the page starts to load.
1304 public void onPageStarted(WebView view, String url, Bitmap favicon) {
1305 // Reset the list of resource requests.
1306 resourceRequests.clear();
1308 // If night mode is enabled, hide `mainWebView` until after the night mode CSS is applied.
1310 mainWebView.setVisibility(View.INVISIBLE);
1313 // Hide the keyboard. `0` indicates no additional flags.
1314 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
1316 // Check to see if we are waiting on Orbot.
1317 if (!waitingForOrbot) { // We are not waiting on Orbot, so we need to process the URL.
1318 // 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.
1319 formattedUrlString = url;
1321 // Display the formatted URL text.
1322 urlTextBox.setText(formattedUrlString);
1324 // Apply text highlighting to `urlTextBox`.
1327 // Apply any custom domain settings if the URL was loaded by navigating history.
1328 if (navigatingHistory) {
1329 applyDomainSettings(url, true, false);
1332 // 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.
1333 urlIsLoading = true;
1337 // It is necessary to update `formattedUrlString` and `urlTextBox` after the page finishes loading because the final URL can change during load.
1339 public void onPageFinished(WebView view, String url) {
1340 // Flush any cookies to persistent storage. `CookieManager` has become very lazy about flushing cookies in recent versions.
1341 if (firstPartyCookiesEnabled && Build.VERSION.SDK_INT >= 21) {
1342 cookieManager.flush();
1345 // Reset `urlIsLoading`, which is used to prevent reloads on redirect if the user agent changes.
1346 urlIsLoading = false;
1348 // Clear the cache and history if Incognito Mode is enabled.
1349 if (incognitoModeEnabled) {
1350 // Clear the cache. `true` includes disk files.
1351 mainWebView.clearCache(true);
1353 // Clear the back/forward history.
1354 mainWebView.clearHistory();
1356 // Manually delete cache folders.
1358 // Delete the main cache directory.
1359 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
1361 // Delete the secondary `Service Worker` cache directory.
1362 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
1363 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
1364 } catch (IOException e) {
1365 // Do nothing if an error is thrown.
1369 // Update `urlTextBox` and apply domain settings if not waiting on Orbot.
1370 if (!waitingForOrbot) {
1371 // Check to see if `WebView` has set `url` to be `about:blank`.
1372 if (url.equals("about:blank")) { // `WebView` is blank, so `formattedUrlString` should be `""` and `urlTextBox` should display a hint.
1373 // Set `formattedUrlString` to `""`.
1374 formattedUrlString = "";
1376 urlTextBox.setText(formattedUrlString);
1378 // Request focus for `urlTextBox`.
1379 urlTextBox.requestFocus();
1381 // Display the keyboard.
1382 inputMethodManager.showSoftInput(urlTextBox, 0);
1384 // Apply the domain settings. This clears any settings from the previous domain.
1385 applyDomainSettings(formattedUrlString, true, false);
1386 } else { // `WebView` has loaded a webpage.
1387 // Set `formattedUrlString`.
1388 formattedUrlString = url;
1390 // Only update `urlTextBox` if the user is not typing in it.
1391 if (!urlTextBox.hasFocus()) {
1392 // Display the formatted URL text.
1393 urlTextBox.setText(formattedUrlString);
1395 // Apply text highlighting to `urlTextBox`.
1400 // Store the SSL certificate so it can be accessed from `ViewSslCertificateDialog` and `PinnedSslCertificateMismatchDialog`.
1401 sslCertificate = mainWebView.getCertificate();
1403 // 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.
1404 if (pinnedDomainSslCertificate && !ignorePinnedSslCertificate) {
1405 // Initialize the current SSL certificate variables.
1406 String currentWebsiteIssuedToCName = "";
1407 String currentWebsiteIssuedToOName = "";
1408 String currentWebsiteIssuedToUName = "";
1409 String currentWebsiteIssuedByCName = "";
1410 String currentWebsiteIssuedByOName = "";
1411 String currentWebsiteIssuedByUName = "";
1412 Date currentWebsiteSslStartDate = null;
1413 Date currentWebsiteSslEndDate = null;
1416 // Extract the individual pieces of information from the current website SSL certificate if it is not null.
1417 if (sslCertificate != null) {
1418 currentWebsiteIssuedToCName = sslCertificate.getIssuedTo().getCName();
1419 currentWebsiteIssuedToOName = sslCertificate.getIssuedTo().getOName();
1420 currentWebsiteIssuedToUName = sslCertificate.getIssuedTo().getUName();
1421 currentWebsiteIssuedByCName = sslCertificate.getIssuedBy().getCName();
1422 currentWebsiteIssuedByOName = sslCertificate.getIssuedBy().getOName();
1423 currentWebsiteIssuedByUName = sslCertificate.getIssuedBy().getUName();
1424 currentWebsiteSslStartDate = sslCertificate.getValidNotBeforeDate();
1425 currentWebsiteSslEndDate = sslCertificate.getValidNotAfterDate();
1428 // 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`.
1429 String currentWebsiteSslStartDateString = "";
1430 String currentWebsiteSslEndDateString = "";
1431 String pinnedDomainSslStartDateString = "";
1432 String pinnedDomainSslEndDateString = "";
1434 // Convert the `Dates` to `Strings` if they are not `null`.
1435 if (currentWebsiteSslStartDate != null) {
1436 currentWebsiteSslStartDateString = currentWebsiteSslStartDate.toString();
1439 if (currentWebsiteSslEndDate != null) {
1440 currentWebsiteSslEndDateString = currentWebsiteSslEndDate.toString();
1443 if (pinnedDomainSslStartDate != null) {
1444 pinnedDomainSslStartDateString = pinnedDomainSslStartDate.toString();
1447 if (pinnedDomainSslEndDate != null) {
1448 pinnedDomainSslEndDateString = pinnedDomainSslEndDate.toString();
1451 // Check to see if the pinned SSL certificate matches the current website certificate.
1452 if (!currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) || !currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) ||
1453 !currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) || !currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) ||
1454 !currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) || !currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) ||
1455 !currentWebsiteSslStartDateString.equals(pinnedDomainSslStartDateString) || !currentWebsiteSslEndDateString.equals(pinnedDomainSslEndDateString)) {
1456 // The pinned SSL certificate doesn't match the current domain certificate.
1457 //Display the pinned SSL certificate mismatch `AlertDialog`.
1458 AppCompatDialogFragment pinnedSslCertificateMismatchDialogFragment = new PinnedSslCertificateMismatchDialog();
1459 pinnedSslCertificateMismatchDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_mismatch));
1465 // Handle SSL Certificate errors.
1467 public void onReceivedSslError(WebView view, SslErrorHandler handler, SslError error) {
1468 // Get the current website SSL certificate.
1469 SslCertificate currentWebsiteSslCertificate = error.getCertificate();
1471 // Extract the individual pieces of information from the current website SSL certificate.
1472 String currentWebsiteIssuedToCName = currentWebsiteSslCertificate.getIssuedTo().getCName();
1473 String currentWebsiteIssuedToOName = currentWebsiteSslCertificate.getIssuedTo().getOName();
1474 String currentWebsiteIssuedToUName = currentWebsiteSslCertificate.getIssuedTo().getUName();
1475 String currentWebsiteIssuedByCName = currentWebsiteSslCertificate.getIssuedBy().getCName();
1476 String currentWebsiteIssuedByOName = currentWebsiteSslCertificate.getIssuedBy().getOName();
1477 String currentWebsiteIssuedByUName = currentWebsiteSslCertificate.getIssuedBy().getUName();
1478 Date currentWebsiteSslStartDate = currentWebsiteSslCertificate.getValidNotBeforeDate();
1479 Date currentWebsiteSslEndDate = currentWebsiteSslCertificate.getValidNotAfterDate();
1481 // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
1482 if (pinnedDomainSslCertificate &&
1483 currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) && currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) &&
1484 currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) && currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) &&
1485 currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) && currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) &&
1486 currentWebsiteSslStartDate.equals(pinnedDomainSslStartDate) && currentWebsiteSslEndDate.equals(pinnedDomainSslEndDate)) {
1487 // An SSL certificate is pinned and matches the current domain certificate.
1488 // Proceed to the website without displaying an error.
1490 } else { // Either there isn't a pinned SSL certificate or it doesn't match the current website certificate.
1491 // Store `handler` so it can be accesses from `onSslErrorCancel()` and `onSslErrorProceed()`.
1492 sslErrorHandler = handler;
1494 // Display the SSL error `AlertDialog`.
1495 AppCompatDialogFragment sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error);
1496 sslCertificateErrorDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_error));
1501 // Load the website if not waiting for Orbot to connect.
1502 if (!waitingForOrbot) {
1503 loadUrl(formattedUrlString);
1508 protected void onNewIntent(Intent intent) {
1509 // Sets the new intent as the activity intent, so that any future `getIntent()`s pick up this one instead of creating a new activity.
1512 // Check to see if the intent contains a new URL.
1513 if (intent.getData() != null) {
1514 // Get the intent data and convert it to a string.
1515 final Uri intentUriData = intent.getData();
1516 formattedUrlString = intentUriData.toString();
1518 // Load the website.
1519 loadUrl(formattedUrlString);
1521 // Close the navigation drawer if it is open.
1522 if (drawerLayout.isDrawerVisible(GravityCompat.START)) {
1523 drawerLayout.closeDrawer(GravityCompat.START);
1526 // Close the bookmarks drawer if it is open.
1527 if (drawerLayout.isDrawerVisible(GravityCompat.END)) {
1528 drawerLayout.closeDrawer(GravityCompat.END);
1531 // Clear the keyboard if displayed and remove the focus on the urlTextBar if it has it.
1532 mainWebView.requestFocus();
1537 public void onRestart() {
1538 // Run the default commands.
1541 // Make sure Orbot is running if Privacy Browser is proxying through Orbot.
1542 if (proxyThroughOrbot) {
1543 // Request Orbot to start. If Orbot is already running no hard will be caused by this request.
1544 Intent orbotIntent = new Intent("org.torproject.android.intent.action.START");
1546 // Send the intent to the Orbot package.
1547 orbotIntent.setPackage("org.torproject.android");
1550 sendBroadcast(orbotIntent);
1553 // Apply the app settings if returning from the Settings activity..
1554 if (reapplyAppSettingsOnRestart) {
1555 // Apply the app settings.
1558 // Reload the webpage if displaying of images has been disabled in the Settings activity.
1559 if (reloadOnRestart) {
1560 // Reload `mainWebView`.
1561 mainWebView.reload();
1563 // Reset `reloadOnRestartBoolean`.
1564 reloadOnRestart = false;
1567 // Reset the return from settings flag.
1568 reapplyAppSettingsOnRestart = false;
1571 // Apply the domain settings if returning from the Domains activity.
1572 if (reapplyDomainSettingsOnRestart) {
1573 // Reapply the domain settings.
1574 applyDomainSettings(formattedUrlString, false, true);
1576 // Reset `reapplyDomainSettingsOnRestart`.
1577 reapplyDomainSettingsOnRestart = false;
1580 // Load the URL on restart to apply changes to night mode.
1581 if (loadUrlOnRestart) {
1582 // Load the current `formattedUrlString`.
1583 loadUrl(formattedUrlString);
1585 // Reset `loadUrlOnRestart.
1586 loadUrlOnRestart = false;
1589 // Update the bookmarks drawer if returning from the Bookmarks activity.
1590 if (restartFromBookmarksActivity) {
1591 // Close the bookmarks drawer.
1592 drawerLayout.closeDrawer(GravityCompat.END);
1594 // Reload the bookmarks drawer.
1595 loadBookmarksFolder();
1597 // Reset `restartFromBookmarksActivity`.
1598 restartFromBookmarksActivity = false;
1601 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step. This can be important if the screen was rotated.
1602 updatePrivacyIcons(true);
1605 // `onResume()` runs after `onStart()`, which runs after `onCreate()` and `onRestart()`.
1607 public void onResume() {
1608 // Run the default commands.
1611 // Resume JavaScript (if enabled).
1612 mainWebView.resumeTimers();
1614 // Resume `mainWebView`.
1615 mainWebView.onResume();
1617 // Resume the adView for the free flavor.
1618 if (BuildConfig.FLAVOR.contentEquals("free")) {
1619 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1620 AdHelper.resumeAd(findViewById(R.id.adview));
1625 public void onPause() {
1626 // Pause `mainWebView`.
1627 mainWebView.onPause();
1629 // Stop all JavaScript.
1630 mainWebView.pauseTimers();
1632 // Pause the adView or it will continue to consume resources in the background on the free flavor.
1633 if (BuildConfig.FLAVOR.contentEquals("free")) {
1634 // The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
1635 AdHelper.pauseAd(findViewById(R.id.adview));
1642 public boolean onCreateOptionsMenu(Menu menu) {
1643 // Inflate the menu; this adds items to the action bar if it is present.
1644 getMenuInflater().inflate(R.menu.webview_options_menu, menu);
1646 // Set mainMenu so it can be used by `onOptionsItemSelected()` and `updatePrivacyIcons`.
1649 // Set the initial status of the privacy icons. `false` does not call `invalidateOptionsMenu` as the last step.
1650 updatePrivacyIcons(false);
1652 // Get handles for the menu items.
1653 MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1654 MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1655 MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1656 MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data); // Form data can be removed once the minimum API >= 26.
1657 MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data); // Form data can be removed once the minimum API >= 26.
1658 MenuItem refreshMenuItem = menu.findItem(R.id.refresh);
1659 MenuItem adConsentMenuItem = menu.findItem(R.id.ad_consent);
1661 // Only display third-party cookies if API >= 21
1662 toggleThirdPartyCookiesMenuItem.setVisible(Build.VERSION.SDK_INT >= 21);
1664 // Only display the form data menu items if the API < 26.
1665 toggleSaveFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
1666 clearFormDataMenuItem.setVisible(Build.VERSION.SDK_INT < 26);
1668 // Only show Ad Consent if this is the free flavor.
1669 adConsentMenuItem.setVisible(BuildConfig.FLAVOR.contentEquals("free"));
1671 // Get the shared preference values. `this` references the current context.
1672 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
1674 // 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.
1675 if (sharedPreferences.getBoolean("display_additional_app_bar_icons", false)) {
1676 toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1677 toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_IF_ROOM);
1678 refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_ALWAYS);
1679 } else { //Do not display the additional icons.
1680 toggleFirstPartyCookiesMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1681 toggleDomStorageMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1682 refreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_NEVER);
1689 public boolean onPrepareOptionsMenu(Menu menu) {
1690 // Get handles for the menu items.
1691 MenuItem addOrEditDomain = menu.findItem(R.id.add_or_edit_domain);
1692 MenuItem toggleFirstPartyCookiesMenuItem = menu.findItem(R.id.toggle_first_party_cookies);
1693 MenuItem toggleThirdPartyCookiesMenuItem = menu.findItem(R.id.toggle_third_party_cookies);
1694 MenuItem toggleDomStorageMenuItem = menu.findItem(R.id.toggle_dom_storage);
1695 MenuItem toggleSaveFormDataMenuItem = menu.findItem(R.id.toggle_save_form_data); // Form data can be removed once the minimum API >= 26.
1696 MenuItem clearDataMenuItem = menu.findItem(R.id.clear_data);
1697 MenuItem clearCookiesMenuItem = menu.findItem(R.id.clear_cookies);
1698 MenuItem clearDOMStorageMenuItem = menu.findItem(R.id.clear_dom_storage);
1699 MenuItem clearFormDataMenuItem = menu.findItem(R.id.clear_form_data); // Form data can be removed once the minimum API >= 26.
1700 MenuItem fontSizeMenuItem = menu.findItem(R.id.font_size);
1701 MenuItem swipeToRefreshMenuItem = menu.findItem(R.id.swipe_to_refresh);
1702 MenuItem displayImagesMenuItem = menu.findItem(R.id.display_images);
1704 // Set the text for the domain menu item.
1705 if (domainSettingsApplied) {
1706 addOrEditDomain.setTitle(R.string.edit_domain_settings);
1708 addOrEditDomain.setTitle(R.string.add_domain_settings);
1711 // Set the status of the menu item checkboxes.
1712 toggleFirstPartyCookiesMenuItem.setChecked(firstPartyCookiesEnabled);
1713 toggleThirdPartyCookiesMenuItem.setChecked(thirdPartyCookiesEnabled);
1714 toggleDomStorageMenuItem.setChecked(domStorageEnabled);
1715 toggleSaveFormDataMenuItem.setChecked(saveFormDataEnabled); // Form data can be removed once the minimum API >= 26.
1716 swipeToRefreshMenuItem.setChecked(swipeRefreshLayout.isEnabled());
1717 displayImagesMenuItem.setChecked(mainWebView.getSettings().getLoadsImagesAutomatically());
1719 // Enable third-party cookies if first-party cookies are enabled.
1720 toggleThirdPartyCookiesMenuItem.setEnabled(firstPartyCookiesEnabled);
1722 // Enable `DOM Storage` if JavaScript is enabled.
1723 toggleDomStorageMenuItem.setEnabled(javaScriptEnabled);
1725 // Enable `Clear Cookies` if there are any.
1726 clearCookiesMenuItem.setEnabled(cookieManager.hasCookies());
1728 // Get a count of the number of files in the `Local Storage` directory.
1729 File localStorageDirectory = new File (privateDataDirectoryString + "/app_webview/Local Storage/");
1730 int localStorageDirectoryNumberOfFiles = 0;
1731 if (localStorageDirectory.exists()) {
1732 localStorageDirectoryNumberOfFiles = localStorageDirectory.list().length;
1735 // Get a count of the number of files in the `IndexedDB` directory.
1736 File indexedDBDirectory = new File (privateDataDirectoryString + "/app_webview/IndexedDB");
1737 int indexedDBDirectoryNumberOfFiles = 0;
1738 if (indexedDBDirectory.exists()) {
1739 indexedDBDirectoryNumberOfFiles = indexedDBDirectory.list().length;
1742 // Enable `Clear DOM Storage` if there is any.
1743 clearDOMStorageMenuItem.setEnabled(localStorageDirectoryNumberOfFiles > 0 || indexedDBDirectoryNumberOfFiles > 0);
1745 // Enable `Clear Form Data` is there is any. This can be removed once the minimum API >= 26.
1746 if (Build.VERSION.SDK_INT < 26) {
1747 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(this);
1748 clearFormDataMenuItem.setEnabled(mainWebViewDatabase.hasFormData());
1751 // Enable `Clear Data` if any of the submenu items are enabled.
1752 clearDataMenuItem.setEnabled(clearCookiesMenuItem.isEnabled() || clearDOMStorageMenuItem.isEnabled() || clearFormDataMenuItem.isEnabled());
1754 // Initialize font size variables.
1755 int fontSize = mainWebView.getSettings().getTextZoom();
1756 String fontSizeTitle;
1757 MenuItem selectedFontSizeMenuItem;
1759 // Prepare the font size title and current size menu item.
1762 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.twenty_five_percent);
1763 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_twenty_five_percent);
1767 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.fifty_percent);
1768 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_fifty_percent);
1772 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.seventy_five_percent);
1773 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_seventy_five_percent);
1777 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1778 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1782 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_twenty_five_percent);
1783 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_twenty_five_percent);
1787 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_fifty_percent);
1788 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_fifty_percent);
1792 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_seventy_five_percent);
1793 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_seventy_five_percent);
1797 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.two_hundred_percent);
1798 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_two_hundred_percent);
1802 fontSizeTitle = getString(R.string.font_size) + " - " + getString(R.string.one_hundred_percent);
1803 selectedFontSizeMenuItem = menu.findItem(R.id.font_size_one_hundred_percent);
1807 // Set the font size title and select the current size menu item.
1808 fontSizeMenuItem.setTitle(fontSizeTitle);
1809 selectedFontSizeMenuItem.setChecked(true);
1811 // Run all the other default commands.
1812 super.onPrepareOptionsMenu(menu);
1814 // Display the menu.
1819 // Remove Android Studio's warning about the dangers of using SetJavaScriptEnabled.
1820 @SuppressLint("SetJavaScriptEnabled")
1821 // removeAllCookies is deprecated, but it is required for API < 21.
1822 @SuppressWarnings("deprecation")
1823 public boolean onOptionsItemSelected(MenuItem menuItem) {
1824 // Get the selected menu item ID.
1825 int menuItemId = menuItem.getItemId();
1827 // Set the commands that relate to the menu entries.
1828 switch (menuItemId) {
1829 case R.id.toggle_javascript:
1830 // Switch the status of javaScriptEnabled.
1831 javaScriptEnabled = !javaScriptEnabled;
1833 // Apply the new JavaScript status.
1834 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
1836 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
1837 updatePrivacyIcons(true);
1839 // Display a `Snackbar`.
1840 if (javaScriptEnabled) { // JavaScrip is enabled.
1841 Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show();
1842 } else if (firstPartyCookiesEnabled) { // JavaScript is disabled, but first-party cookies are enabled.
1843 Snackbar.make(findViewById(R.id.main_webview), R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show();
1844 } else { // Privacy mode.
1845 Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1848 // Reload the WebView.
1849 mainWebView.reload();
1852 case R.id.add_or_edit_domain:
1853 if (domainSettingsApplied) { // Edit the current domain settings.
1854 // Reapply the domain settings on returning to `MainWebViewActivity`.
1855 reapplyDomainSettingsOnRestart = true;
1856 currentDomainName = "";
1858 // Create an intent to launch the domains activity.
1859 Intent domainsIntent = new Intent(this, DomainsActivity.class);
1861 // Put extra information instructing the domains activity to directly load the current domain and close on back instead of returning to the domains list.
1862 domainsIntent.putExtra("loadDomain", domainSettingsDatabaseId);
1863 domainsIntent.putExtra("closeOnBack", true);
1866 startActivity(domainsIntent);
1867 } else { // Add a new domain.
1868 // Apply the new domain settings on returning to `MainWebViewActivity`.
1869 reapplyDomainSettingsOnRestart = true;
1870 currentDomainName = "";
1872 // Get the current domain
1873 Uri currentUri = Uri.parse(formattedUrlString);
1874 String currentDomain = currentUri.getHost();
1876 // Initialize the database handler. The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
1877 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
1879 // Create the domain and store the database ID.
1880 int newDomainDatabaseId = domainsDatabaseHelper.addDomain(currentDomain);
1882 // Create an intent to launch the domains activity.
1883 Intent domainsIntent = new Intent(this, DomainsActivity.class);
1885 // Put extra information instructing the domains activity to directly load the new domain and close on back instead of returning to the domains list.
1886 domainsIntent.putExtra("loadDomain", newDomainDatabaseId);
1887 domainsIntent.putExtra("closeOnBack", true);
1890 startActivity(domainsIntent);
1894 case R.id.toggle_first_party_cookies:
1895 // Switch the status of firstPartyCookiesEnabled.
1896 firstPartyCookiesEnabled = !firstPartyCookiesEnabled;
1898 // Update the menu checkbox.
1899 menuItem.setChecked(firstPartyCookiesEnabled);
1901 // Apply the new cookie status.
1902 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
1904 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
1905 updatePrivacyIcons(true);
1907 // Display a `Snackbar`.
1908 if (firstPartyCookiesEnabled) { // First-party cookies are enabled.
1909 Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1910 } else if (javaScriptEnabled) { // JavaScript is still enabled.
1911 Snackbar.make(findViewById(R.id.main_webview), R.string.first_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1912 } else { // Privacy mode.
1913 Snackbar.make(findViewById(R.id.main_webview), R.string.privacy_mode, Snackbar.LENGTH_SHORT).show();
1916 // Reload the WebView.
1917 mainWebView.reload();
1920 case R.id.toggle_third_party_cookies:
1921 if (Build.VERSION.SDK_INT >= 21) {
1922 // Switch the status of thirdPartyCookiesEnabled.
1923 thirdPartyCookiesEnabled = !thirdPartyCookiesEnabled;
1925 // Update the menu checkbox.
1926 menuItem.setChecked(thirdPartyCookiesEnabled);
1928 // Apply the new cookie status.
1929 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
1931 // Display a `Snackbar`.
1932 if (thirdPartyCookiesEnabled) {
1933 Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_enabled, Snackbar.LENGTH_SHORT).show();
1935 Snackbar.make(findViewById(R.id.main_webview), R.string.third_party_cookies_disabled, Snackbar.LENGTH_SHORT).show();
1938 // Reload the WebView.
1939 mainWebView.reload();
1940 } // Else do nothing because SDK < 21.
1943 case R.id.toggle_dom_storage:
1944 // Switch the status of domStorageEnabled.
1945 domStorageEnabled = !domStorageEnabled;
1947 // Update the menu checkbox.
1948 menuItem.setChecked(domStorageEnabled);
1950 // Apply the new DOM Storage status.
1951 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
1953 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
1954 updatePrivacyIcons(true);
1956 // Display a `Snackbar`.
1957 if (domStorageEnabled) {
1958 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show();
1960 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show();
1963 // Reload the WebView.
1964 mainWebView.reload();
1967 // Form data can be removed once the minimum API >= 26.
1968 case R.id.toggle_save_form_data:
1969 // Switch the status of saveFormDataEnabled.
1970 saveFormDataEnabled = !saveFormDataEnabled;
1972 // Update the menu checkbox.
1973 menuItem.setChecked(saveFormDataEnabled);
1975 // Apply the new form data status.
1976 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
1978 // Display a `Snackbar`.
1979 if (saveFormDataEnabled) {
1980 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show();
1982 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show();
1985 // Update the privacy icon. `true` runs `invalidateOptionsMenu` as the last step.
1986 updatePrivacyIcons(true);
1988 // Reload the WebView.
1989 mainWebView.reload();
1992 case R.id.clear_cookies:
1993 Snackbar.make(findViewById(R.id.main_webview), R.string.cookies_deleted, Snackbar.LENGTH_LONG)
1994 .setAction(R.string.undo, v -> {
1995 // Do nothing because everything will be handled by `onDismissed()` below.
1997 .addCallback(new Snackbar.Callback() {
1999 public void onDismissed(Snackbar snackbar, int event) {
2001 // The user pushed the `Undo` button.
2002 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2006 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2008 // `cookieManager.removeAllCookie()` varies by SDK.
2009 if (Build.VERSION.SDK_INT < 21) {
2010 cookieManager.removeAllCookie();
2012 // `null` indicates no callback.
2013 cookieManager.removeAllCookies(null);
2021 case R.id.clear_dom_storage:
2022 Snackbar.make(findViewById(R.id.main_webview), R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
2023 .setAction(R.string.undo, v -> {
2024 // Do nothing because everything will be handled by `onDismissed()` below.
2026 .addCallback(new Snackbar.Callback() {
2028 public void onDismissed(Snackbar snackbar, int event) {
2030 // The user pushed the `Undo` button.
2031 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2035 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2037 // Delete the DOM Storage.
2038 WebStorage webStorage = WebStorage.getInstance();
2039 webStorage.deleteAllData();
2041 // Manually delete the DOM storage files and directories.
2043 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2044 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2046 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2047 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2048 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2049 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2050 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2051 } catch (IOException e) {
2052 // Do nothing if an error is thrown.
2060 // Form data can be remove once the minimum API >= 26.
2061 case R.id.clear_form_data:
2062 Snackbar.make(findViewById(R.id.main_webview), R.string.form_data_deleted, Snackbar.LENGTH_LONG)
2063 .setAction(R.string.undo, v -> {
2064 // Do nothing because everything will be handled by `onDismissed()` below.
2066 .addCallback(new Snackbar.Callback() {
2068 public void onDismissed(Snackbar snackbar, int event) {
2070 // The user pushed the `Undo` button.
2071 case Snackbar.Callback.DISMISS_EVENT_ACTION:
2075 // The `Snackbar` was dismissed without the `Undo` button being pushed.
2077 // Delete the form data.
2078 WebViewDatabase mainWebViewDatabase = WebViewDatabase.getInstance(getApplicationContext());
2079 mainWebViewDatabase.clearFormData();
2086 case R.id.font_size_twenty_five_percent:
2087 mainWebView.getSettings().setTextZoom(25);
2090 case R.id.font_size_fifty_percent:
2091 mainWebView.getSettings().setTextZoom(50);
2094 case R.id.font_size_seventy_five_percent:
2095 mainWebView.getSettings().setTextZoom(75);
2098 case R.id.font_size_one_hundred_percent:
2099 mainWebView.getSettings().setTextZoom(100);
2102 case R.id.font_size_one_hundred_twenty_five_percent:
2103 mainWebView.getSettings().setTextZoom(125);
2106 case R.id.font_size_one_hundred_fifty_percent:
2107 mainWebView.getSettings().setTextZoom(150);
2110 case R.id.font_size_one_hundred_seventy_five_percent:
2111 mainWebView.getSettings().setTextZoom(175);
2114 case R.id.font_size_two_hundred_percent:
2115 mainWebView.getSettings().setTextZoom(200);
2118 case R.id.swipe_to_refresh:
2119 // Toggle swipe to refresh.
2120 swipeRefreshLayout.setEnabled(!swipeRefreshLayout.isEnabled());
2123 case R.id.display_images:
2124 if (mainWebView.getSettings().getLoadsImagesAutomatically()) { // Images are currently loaded automatically.
2125 mainWebView.getSettings().setLoadsImagesAutomatically(false);
2126 mainWebView.reload();
2127 } else { // Images are not currently loaded automatically.
2128 mainWebView.getSettings().setLoadsImagesAutomatically(true);
2131 // Set `onTheFlyDisplayImagesSet`.
2132 onTheFlyDisplayImagesSet = true;
2135 case R.id.view_source:
2136 // Launch the View Source activity.
2137 Intent viewSourceIntent = new Intent(this, ViewSourceActivity.class);
2138 startActivity(viewSourceIntent);
2142 // Setup the share string.
2143 String shareString = webViewTitle + " – " + urlTextBox.getText().toString();
2145 // Create the share intent.
2146 Intent shareIntent = new Intent();
2147 shareIntent.setAction(Intent.ACTION_SEND);
2148 shareIntent.putExtra(Intent.EXTRA_TEXT, shareString);
2149 shareIntent.setType("text/plain");
2152 startActivity(Intent.createChooser(shareIntent, "Share URL"));
2155 case R.id.find_on_page:
2156 // Hide the URL app bar.
2157 supportAppBar.setVisibility(View.GONE);
2159 // Show the Find on Page `RelativeLayout`.
2160 findOnPageLinearLayout.setVisibility(View.VISIBLE);
2162 // Display the keyboard. We have to wait 200 ms before running the command to work around a bug in Android.
2163 // http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
2164 findOnPageEditText.postDelayed(() -> {
2165 // Set the focus on `findOnPageEditText`.
2166 findOnPageEditText.requestFocus();
2168 // Display the keyboard. `0` sets no input flags.
2169 inputMethodManager.showSoftInput(findOnPageEditText, 0);
2174 // Get a `PrintManager` instance.
2175 PrintManager printManager = (PrintManager) getSystemService(Context.PRINT_SERVICE);
2177 // Convert `mainWebView` to `printDocumentAdapter`.
2178 PrintDocumentAdapter printDocumentAdapter = mainWebView.createPrintDocumentAdapter();
2180 // Remove the lint error below that `printManager` might be `null`.
2181 assert printManager != null;
2183 // Print the document. The print attributes are `null`.
2184 printManager.print(getString(R.string.privacy_browser_web_page), printDocumentAdapter, null);
2187 case R.id.add_to_homescreen:
2188 // Show the `CreateHomeScreenShortcutDialog` `AlertDialog` and name this instance `R.string.create_shortcut`.
2189 AppCompatDialogFragment createHomeScreenShortcutDialogFragment = new CreateHomeScreenShortcutDialog();
2190 createHomeScreenShortcutDialogFragment.show(getSupportFragmentManager(), getString(R.string.create_shortcut));
2192 //Everything else will be handled by `CreateHomeScreenShortcutDialog` and the associated listener below.
2196 mainWebView.reload();
2199 case R.id.ad_consent:
2200 // Display the ad consent dialog.
2201 DialogFragment adConsentDialogFragment = new AdConsentDialog();
2202 adConsentDialogFragment.show(getFragmentManager(), getString(R.string.ad_consent));
2206 // Don't consume the event.
2207 return super.onOptionsItemSelected(menuItem);
2211 // removeAllCookies is deprecated, but it is required for API < 21.
2212 @SuppressWarnings("deprecation")
2214 public boolean onNavigationItemSelected(@NonNull MenuItem menuItem) {
2215 int menuItemId = menuItem.getItemId();
2217 switch (menuItemId) {
2223 if (mainWebView.canGoBack()) {
2224 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2225 navigatingHistory = true;
2227 // Load the previous website in the history.
2228 mainWebView.goBack();
2233 if (mainWebView.canGoForward()) {
2234 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
2235 navigatingHistory = true;
2237 // Load the next website in the history.
2238 mainWebView.goForward();
2243 // Get the `WebBackForwardList`.
2244 WebBackForwardList webBackForwardList = mainWebView.copyBackForwardList();
2246 // Show the `UrlHistoryDialog` `AlertDialog` and name this instance `R.string.history`. `this` is the `Context`.
2247 AppCompatDialogFragment urlHistoryDialogFragment = UrlHistoryDialog.loadBackForwardList(this, webBackForwardList);
2248 urlHistoryDialogFragment.show(getSupportFragmentManager(), getString(R.string.history));
2252 // Launch the requests activity.
2253 Intent requestsIntent = new Intent(this, RequestsActivity.class);
2254 startActivity(requestsIntent);
2257 case R.id.downloads:
2258 // Launch the system Download Manager.
2259 Intent downloadManagerIntent = new Intent(DownloadManager.ACTION_VIEW_DOWNLOADS);
2261 // Launch as a new task so that Download Manager and Privacy Browser show as separate windows in the recent tasks list.
2262 downloadManagerIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2264 startActivity(downloadManagerIntent);
2268 // Set the flag to reapply the domain settings on restart when returning from Domain Settings.
2269 reapplyDomainSettingsOnRestart = true;
2270 currentDomainName = "";
2272 // Launch the domains activity.
2273 Intent domainsIntent = new Intent(this, DomainsActivity.class);
2274 startActivity(domainsIntent);
2278 // Set the flag to reapply app settings on restart when returning from Settings.
2279 reapplyAppSettingsOnRestart = true;
2281 // Set the flag to reapply the domain settings on restart when returning from Settings.
2282 reapplyDomainSettingsOnRestart = true;
2283 currentDomainName = "";
2285 // Launch the settings activity.
2286 Intent settingsIntent = new Intent(this, SettingsActivity.class);
2287 startActivity(settingsIntent);
2291 // Launch `GuideActivity`.
2292 Intent guideIntent = new Intent(this, GuideActivity.class);
2293 startActivity(guideIntent);
2297 // Launch `AboutActivity`.
2298 Intent aboutIntent = new Intent(this, AboutActivity.class);
2299 startActivity(aboutIntent);
2302 case R.id.clearAndExit:
2303 // Get a handle for `sharedPreferences`. `this` references the current context.
2304 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
2306 boolean clearEverything = sharedPreferences.getBoolean("clear_everything", true);
2309 if (clearEverything || sharedPreferences.getBoolean("clear_cookies", true)) {
2310 // The command to remove cookies changed slightly in API 21.
2311 if (Build.VERSION.SDK_INT >= 21) {
2312 cookieManager.removeAllCookies(null);
2314 cookieManager.removeAllCookie();
2317 // Manually delete the cookies database, as `CookieManager` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2319 // We have to use two commands because `Runtime.exec()` does not like `*`.
2320 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies");
2321 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/Cookies-journal");
2322 } catch (IOException e) {
2323 // Do nothing if an error is thrown.
2327 // Clear DOM storage.
2328 if (clearEverything || sharedPreferences.getBoolean("clear_dom_storage", true)) {
2329 // Ask `WebStorage` to clear the DOM storage.
2330 WebStorage webStorage = WebStorage.getInstance();
2331 webStorage.deleteAllData();
2333 // Manually delete the DOM storage files and directories, as `WebStorage` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2335 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
2336 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Local Storage/"});
2338 // Multiple commands must be used because `Runtime.exec()` does not like `*`.
2339 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/IndexedDB");
2340 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager");
2341 privacyBrowserRuntime.exec("rm -f " + privateDataDirectoryString + "/app_webview/QuotaManager-journal");
2342 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview/databases");
2343 } catch (IOException e) {
2344 // Do nothing if an error is thrown.
2348 // Clear form data if the API < 26.
2349 if ((Build.VERSION.SDK_INT < 26) && (clearEverything || sharedPreferences.getBoolean("clear_form_data", true))) {
2350 WebViewDatabase webViewDatabase = WebViewDatabase.getInstance(this);
2351 webViewDatabase.clearFormData();
2353 // Manually delete the form data database, as `WebViewDatabase` sometimes will not flush its changes to disk before `System.exit(0)` is run.
2355 // We have to use a `String[]` because the database contains a space and `Runtime.exec` will not escape the string correctly otherwise.
2356 privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data"});
2357 privacyBrowserRuntime.exec(new String[] {"rm", "-f", privateDataDirectoryString + "/app_webview/Web Data-journal"});
2358 } catch (IOException e) {
2359 // Do nothing if an error is thrown.
2364 if (clearEverything || sharedPreferences.getBoolean("clear_cache", true)) {
2365 // `true` includes disk files.
2366 mainWebView.clearCache(true);
2368 // Manually delete the cache directories.
2370 // Delete the main cache directory.
2371 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
2373 // Delete the secondary `Service Worker` cache directory.
2374 // A `String[]` must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
2375 privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
2376 } catch (IOException e) {
2377 // Do nothing if an error is thrown.
2381 // Clear SSL certificate preferences.
2382 mainWebView.clearSslPreferences();
2384 // Clear the back/forward history.
2385 mainWebView.clearHistory();
2387 // Clear `formattedUrlString`.
2388 formattedUrlString = null;
2390 // Clear `customHeaders`.
2391 customHeaders.clear();
2393 // Detach all views from `mainWebViewRelativeLayout`.
2394 mainWebViewRelativeLayout.removeAllViews();
2396 // Destroy the internal state of `mainWebView`.
2397 mainWebView.destroy();
2399 // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
2400 // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
2401 if (clearEverything) {
2403 privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/app_webview");
2404 } catch (IOException e) {
2405 // Do nothing if an error is thrown.
2409 // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
2410 if (Build.VERSION.SDK_INT >= 21) {
2411 finishAndRemoveTask();
2416 // Remove the terminated program from RAM. The status code is `0`.
2421 // Close the navigation drawer.
2422 drawerLayout.closeDrawer(GravityCompat.START);
2427 public void onPostCreate(Bundle savedInstanceState) {
2428 super.onPostCreate(savedInstanceState);
2430 // Sync the state of the DrawerToggle after onRestoreInstanceState has finished.
2431 drawerToggle.syncState();
2435 public void onConfigurationChanged(Configuration newConfig) {
2436 super.onConfigurationChanged(newConfig);
2438 // Reload the ad for the free flavor if we are not in full screen mode.
2439 if (BuildConfig.FLAVOR.contentEquals("free") && !inFullScreenBrowsingMode) {
2440 // Reload the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
2441 AdHelper.loadAd(findViewById(R.id.adview), getApplicationContext(), getString(R.string.ad_id));
2444 // `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:
2445 // https://code.google.com/p/android/issues/detail?id=20493#c8
2446 // ActivityCompat.invalidateOptionsMenu(this);
2450 public void onCreateContextMenu(ContextMenu menu, View view, ContextMenu.ContextMenuInfo menuInfo) {
2451 // Store the `HitTestResult`.
2452 final WebView.HitTestResult hitTestResult = mainWebView.getHitTestResult();
2455 final String imageUrl;
2456 final String linkUrl;
2458 // Get a handle for the `ClipboardManager`.
2459 final ClipboardManager clipboardManager = (ClipboardManager) getSystemService(CLIPBOARD_SERVICE);
2461 // Remove the lint errors below that `clipboardManager` might be `null`.
2462 assert clipboardManager != null;
2464 switch (hitTestResult.getType()) {
2465 // `SRC_ANCHOR_TYPE` is a link.
2466 case WebView.HitTestResult.SRC_ANCHOR_TYPE:
2467 // Get the target URL.
2468 linkUrl = hitTestResult.getExtra();
2470 // Set the target URL as the title of the `ContextMenu`.
2471 menu.setHeaderTitle(linkUrl);
2473 // Add a Load URL entry.
2474 menu.add(R.string.load_url).setOnMenuItemClickListener((MenuItem item) -> {
2479 // Add a Copy URL entry.
2480 menu.add(R.string.copy_url).setOnMenuItemClickListener((MenuItem item) -> {
2481 // Save the link URL in a `ClipData`.
2482 ClipData srcAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), linkUrl);
2484 // Set the `ClipData` as the clipboard's primary clip.
2485 clipboardManager.setPrimaryClip(srcAnchorTypeClipData);
2489 // Add a Download URL entry.
2490 menu.add(R.string.download_url).setOnMenuItemClickListener((MenuItem item) -> {
2491 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
2492 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
2493 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
2495 // Store the variables for future use by `onRequestPermissionsResult()`.
2496 downloadUrl = linkUrl;
2497 downloadContentDisposition = "none";
2498 downloadContentLength = -1;
2500 // Show a dialog if the user has previously denied the permission.
2501 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2502 // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_FILE.
2503 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_FILE);
2505 // Show the download location permission alert dialog. The permission will be requested when the the dialog is closed.
2506 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
2507 } else { // Show the permission request directly.
2508 // Request the permission. The download dialog will be launched by `onRequestPermissionResult()`.
2509 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
2511 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
2512 // Get a handle for the download file alert dialog.
2513 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(linkUrl, "none", -1);
2515 // Show the download file alert dialog.
2516 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2521 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2522 menu.add(R.string.cancel);
2525 case WebView.HitTestResult.EMAIL_TYPE:
2526 // Get the target URL.
2527 linkUrl = hitTestResult.getExtra();
2529 // Set the target URL as the title of the `ContextMenu`.
2530 menu.setHeaderTitle(linkUrl);
2532 // Add a `Write Email` entry.
2533 menu.add(R.string.write_email).setOnMenuItemClickListener(item -> {
2534 // We use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
2535 Intent emailIntent = new Intent(Intent.ACTION_SENDTO);
2537 // Parse the url and set it as the data for the `Intent`.
2538 emailIntent.setData(Uri.parse("mailto:" + linkUrl));
2540 // `FLAG_ACTIVITY_NEW_TASK` opens the email program in a new task instead as part of Privacy Browser.
2541 emailIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
2544 startActivity(emailIntent);
2548 // Add a `Copy Email Address` entry.
2549 menu.add(R.string.copy_email_address).setOnMenuItemClickListener(item -> {
2550 // Save the email address in a `ClipData`.
2551 ClipData srcEmailTypeClipData = ClipData.newPlainText(getString(R.string.email_address), linkUrl);
2553 // Set the `ClipData` as the clipboard's primary clip.
2554 clipboardManager.setPrimaryClip(srcEmailTypeClipData);
2558 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2559 menu.add(R.string.cancel);
2562 // `IMAGE_TYPE` is an image.
2563 case WebView.HitTestResult.IMAGE_TYPE:
2564 // Get the image URL.
2565 imageUrl = hitTestResult.getExtra();
2567 // Set the image URL as the title of the `ContextMenu`.
2568 menu.setHeaderTitle(imageUrl);
2570 // Add a `View Image` entry.
2571 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2576 // Add a `Download Image` entry.
2577 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2578 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
2579 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
2580 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
2582 // Store the image URL for use by `onRequestPermissionResult()`.
2583 downloadImageUrl = imageUrl;
2585 // Show a dialog if the user has previously denied the permission.
2586 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2587 // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2588 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2590 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
2591 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
2592 } else { // Show the permission request directly.
2593 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
2594 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2596 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
2597 // Get a handle for the download image alert dialog.
2598 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2600 // Show the download image alert dialog.
2601 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2606 // Add a `Copy URL` entry.
2607 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2608 // Save the image URL in a `ClipData`.
2609 ClipData srcImageTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2611 // Set the `ClipData` as the clipboard's primary clip.
2612 clipboardManager.setPrimaryClip(srcImageTypeClipData);
2616 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2617 menu.add(R.string.cancel);
2621 // `SRC_IMAGE_ANCHOR_TYPE` is an image that is also a link.
2622 case WebView.HitTestResult.SRC_IMAGE_ANCHOR_TYPE:
2623 // Get the image URL.
2624 imageUrl = hitTestResult.getExtra();
2626 // Set the image URL as the title of the `ContextMenu`.
2627 menu.setHeaderTitle(imageUrl);
2629 // Add a `View Image` entry.
2630 menu.add(R.string.view_image).setOnMenuItemClickListener(item -> {
2635 // Add a `Download Image` entry.
2636 menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
2637 // Check to see if the WRITE_EXTERNAL_STORAGE permission has already been granted.
2638 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_DENIED) {
2639 // The WRITE_EXTERNAL_STORAGE permission needs to be requested.
2641 // Store the image URL for use by `onRequestPermissionResult()`.
2642 downloadImageUrl = imageUrl;
2644 // Show a dialog if the user has previously denied the permission.
2645 if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.WRITE_EXTERNAL_STORAGE)) { // Show a dialog explaining the request first.
2646 // Get a handle for the download location permission alert dialog and set the download type to DOWNLOAD_IMAGE.
2647 DialogFragment downloadLocationPermissionDialogFragment = DownloadLocationPermissionDialog.downloadType(DownloadLocationPermissionDialog.DOWNLOAD_IMAGE);
2649 // Show the download location permission alert dialog. The permission will be requested when the dialog is closed.
2650 downloadLocationPermissionDialogFragment.show(getFragmentManager(), getString(R.string.download_location));
2651 } else { // Show the permission request directly.
2652 // Request the permission. The download dialog will be launched by `onRequestPermissionResult().
2653 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2655 } else { // The WRITE_EXTERNAL_STORAGE permission has already been granted.
2656 // Get a handle for the download image alert dialog.
2657 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
2659 // Show the download image alert dialog.
2660 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2665 // Add a `Copy URL` entry.
2666 menu.add(R.string.copy_url).setOnMenuItemClickListener(item -> {
2667 // Save the image URL in a `ClipData`.
2668 ClipData srcImageAnchorTypeClipData = ClipData.newPlainText(getString(R.string.url), imageUrl);
2670 // Set the `ClipData` as the clipboard's primary clip.
2671 clipboardManager.setPrimaryClip(srcImageAnchorTypeClipData);
2675 // Add a `Cancel` entry, which by default closes the `ContextMenu`.
2676 menu.add(R.string.cancel);
2682 public void onCreateBookmark(AppCompatDialogFragment dialogFragment) {
2683 // Get the `EditTexts` from the `dialogFragment`.
2684 EditText createBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_name_edittext);
2685 EditText createBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.create_bookmark_url_edittext);
2687 // Extract the strings from the `EditTexts`.
2688 String bookmarkNameString = createBookmarkNameEditText.getText().toString();
2689 String bookmarkUrlString = createBookmarkUrlEditText.getText().toString();
2691 // Convert the favoriteIcon Bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
2692 ByteArrayOutputStream favoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2693 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream);
2694 byte[] favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray();
2696 // Display the new bookmark below the current items in the (0 indexed) list.
2697 int newBookmarkDisplayOrder = bookmarksListView.getCount();
2699 // Create the bookmark.
2700 bookmarksDatabaseHelper.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray);
2702 // Update `bookmarksCursor` with the current contents of this folder.
2703 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2705 // Update the `ListView`.
2706 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2708 // Scroll to the new bookmark.
2709 bookmarksListView.setSelection(newBookmarkDisplayOrder);
2713 public void onCreateBookmarkFolder(AppCompatDialogFragment dialogFragment) {
2714 // Get handles for the views in `dialogFragment`.
2715 EditText createFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.create_folder_name_edittext);
2716 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon_radiobutton);
2717 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.create_folder_default_icon);
2719 // Get new folder name string.
2720 String folderNameString = createFolderNameEditText.getText().toString();
2722 // Get the new folder icon `Bitmap`.
2723 Bitmap folderIconBitmap;
2724 if (defaultFolderIconRadioButton.isChecked()) { // Use the default folder icon.
2725 // Get the default folder icon and convert it to a `Bitmap`.
2726 Drawable folderIconDrawable = folderIconImageView.getDrawable();
2727 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2728 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2729 } else { // Use the `WebView` favorite icon.
2730 folderIconBitmap = favoriteIconBitmap;
2733 // Convert `folderIconBitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
2734 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2735 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
2736 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
2738 // Move all the bookmarks down one in the display order.
2739 for (int i = 0; i < bookmarksListView.getCount(); i++) {
2740 int databaseId = (int) bookmarksListView.getItemIdAtPosition(i);
2741 bookmarksDatabaseHelper.updateDisplayOrder(databaseId, i + 1);
2744 // Create the folder, which will be placed at the top of the `ListView`.
2745 bookmarksDatabaseHelper.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray);
2747 // Update `bookmarksCursor` with the current contents of this folder.
2748 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2750 // Update the `ListView`.
2751 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2753 // Scroll to the new folder.
2754 bookmarksListView.setSelection(0);
2758 public void onCreateHomeScreenShortcut(AppCompatDialogFragment dialogFragment) {
2759 // Get the shortcut name.
2760 EditText shortcutNameEditText = dialogFragment.getDialog().findViewById(R.id.shortcut_name_edittext);
2761 String shortcutNameString = shortcutNameEditText.getText().toString();
2763 // Convert the favorite icon bitmap to an `Icon`. `IconCompat` is required until API >= 26.
2764 IconCompat favoriteIcon = IconCompat.createWithBitmap(favoriteIconBitmap);
2766 // Setup the shortcut intent.
2767 Intent shortcutIntent = new Intent();
2768 shortcutIntent.setAction(Intent.ACTION_VIEW);
2769 shortcutIntent.setData(Uri.parse(formattedUrlString));
2771 // Create a shortcut info builder. The shortcut name becomes the shortcut ID.
2772 ShortcutInfoCompat.Builder shortcutInfoBuilder = new ShortcutInfoCompat.Builder(this, shortcutNameString);
2774 // Add the required fields to the shortcut info builder.
2775 shortcutInfoBuilder.setIcon(favoriteIcon);
2776 shortcutInfoBuilder.setIntent(shortcutIntent);
2777 shortcutInfoBuilder.setShortLabel(shortcutNameString);
2779 // Request the pin. `ShortcutManagerCompat` can be switched to `ShortcutManager` once API >= 26.
2780 ShortcutManagerCompat.requestPinShortcut(this, shortcutInfoBuilder.build(), null);
2784 public void onCloseDownloadLocationPermissionDialog(int downloadType) {
2785 switch (downloadType) {
2786 case DownloadLocationPermissionDialog.DOWNLOAD_FILE:
2787 // Request the WRITE_EXTERNAL_STORAGE permission with a file request code.
2788 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_FILE_REQUEST_CODE);
2791 case DownloadLocationPermissionDialog.DOWNLOAD_IMAGE:
2792 // Request the WRITE_EXTERNAL_STORAGE permission with an image request code.
2793 ActivityCompat.requestPermissions(this, new String[] {Manifest.permission.WRITE_EXTERNAL_STORAGE}, DOWNLOAD_IMAGE_REQUEST_CODE);
2799 public void onRequestPermissionsResult(int requestCode, @NonNull String permissions[], @NonNull int[] grantResults) {
2800 switch (requestCode) {
2801 case DOWNLOAD_FILE_REQUEST_CODE:
2802 // Show the download file alert dialog. When the dialog closes, the correct command will be used based on the permission status.
2803 AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(downloadUrl, downloadContentDisposition, downloadContentLength);
2805 // On API 23, displaying the fragment must be delayed or the app will crash.
2806 if (Build.VERSION.SDK_INT == 23) {
2807 new Handler().postDelayed(() -> downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
2809 downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2812 // Reset the download variables.
2814 downloadContentDisposition = "";
2815 downloadContentLength = 0;
2818 case DOWNLOAD_IMAGE_REQUEST_CODE:
2819 // Show the download image alert dialog. When the dialog closes, the correct command will be used based on the permission status.
2820 AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(downloadImageUrl);
2822 // On API 23, displaying the fragment must be delayed or the app will crash.
2823 if (Build.VERSION.SDK_INT == 23) {
2824 new Handler().postDelayed(() -> downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download)), 500);
2826 downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
2829 // Reset the image URL variable.
2830 downloadImageUrl = "";
2836 public void onDownloadImage(AppCompatDialogFragment dialogFragment, String imageUrl) {
2837 // Download the image if it has an HTTP or HTTPS URI.
2838 if (imageUrl.startsWith("http")) {
2839 // Get a handle for the system `DOWNLOAD_SERVICE`.
2840 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
2842 // Parse `imageUrl`.
2843 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(imageUrl));
2845 // Pass cookies to download manager if cookies are enabled. This is required to download images from websites that require a login.
2846 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
2847 if (firstPartyCookiesEnabled) {
2848 // Get the cookies for `imageUrl`.
2849 String cookies = cookieManager.getCookie(imageUrl);
2851 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
2852 downloadRequest.addRequestHeader("Cookie", cookies);
2855 // Get the file name from the dialog fragment.
2856 EditText downloadImageNameEditText = dialogFragment.getDialog().findViewById(R.id.download_image_name);
2857 String imageName = downloadImageNameEditText.getText().toString();
2859 // Specify the download location.
2860 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
2861 // Download to the public download directory.
2862 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, imageName);
2863 } else { // External write permission denied.
2864 // Download to the app's external download directory.
2865 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, imageName);
2868 // Allow `MediaScanner` to index the download if it is a media file.
2869 downloadRequest.allowScanningByMediaScanner();
2871 // Add the URL as the description for the download.
2872 downloadRequest.setDescription(imageUrl);
2874 // Show the download notification after the download is completed.
2875 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
2877 // Remove the lint warning below that `downloadManager` might be `null`.
2878 assert downloadManager != null;
2880 // Initiate the download.
2881 downloadManager.enqueue(downloadRequest);
2882 } else { // The image is not an HTTP or HTTPS URI.
2883 Snackbar.make(mainWebView, R.string.cannot_download_image, Snackbar.LENGTH_INDEFINITE).show();
2888 public void onDownloadFile(AppCompatDialogFragment dialogFragment, String downloadUrl) {
2889 // Download the file if it has an HTTP or HTTPS URI.
2890 if (downloadUrl.startsWith("http")) {
2891 // Get a handle for the system `DOWNLOAD_SERVICE`.
2892 DownloadManager downloadManager = (DownloadManager) getSystemService(DOWNLOAD_SERVICE);
2894 // Parse `downloadUrl`.
2895 DownloadManager.Request downloadRequest = new DownloadManager.Request(Uri.parse(downloadUrl));
2897 // Pass cookies to download manager if cookies are enabled. This is required to download files from websites that require a login.
2898 // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
2899 if (firstPartyCookiesEnabled) {
2900 // Get the cookies for `downloadUrl`.
2901 String cookies = cookieManager.getCookie(downloadUrl);
2903 // Add the cookies to `downloadRequest`. In the HTTP request header, cookies are named `Cookie`.
2904 downloadRequest.addRequestHeader("Cookie", cookies);
2907 // Get the file name from the dialog fragment.
2908 EditText downloadFileNameEditText = dialogFragment.getDialog().findViewById(R.id.download_file_name);
2909 String fileName = downloadFileNameEditText.getText().toString();
2911 // Specify the download location.
2912 if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) == PackageManager.PERMISSION_GRANTED) { // External write permission granted.
2913 // Download to the public download directory.
2914 downloadRequest.setDestinationInExternalPublicDir(Environment.DIRECTORY_DOWNLOADS, fileName);
2915 } else { // External write permission denied.
2916 // Download to the app's external download directory.
2917 downloadRequest.setDestinationInExternalFilesDir(this, Environment.DIRECTORY_DOWNLOADS, fileName);
2920 // Allow `MediaScanner` to index the download if it is a media file.
2921 downloadRequest.allowScanningByMediaScanner();
2923 // Add the URL as the description for the download.
2924 downloadRequest.setDescription(downloadUrl);
2926 // Show the download notification after the download is completed.
2927 downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED);
2929 // Remove the lint warning below that `downloadManager` might be `null`.
2930 assert downloadManager != null;
2932 // Initiate the download.
2933 downloadManager.enqueue(downloadRequest);
2934 } else { // The download is not an HTTP or HTTPS URI.
2935 Snackbar.make(mainWebView, R.string.cannot_download_file, Snackbar.LENGTH_INDEFINITE).show();
2940 public void onSaveBookmark(AppCompatDialogFragment dialogFragment, int selectedBookmarkDatabaseId) {
2941 // Get handles for the views from `dialogFragment`.
2942 EditText editBookmarkNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_name_edittext);
2943 EditText editBookmarkUrlEditText = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_url_edittext);
2944 RadioButton currentBookmarkIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_bookmark_current_icon_radiobutton);
2946 // Store the bookmark strings.
2947 String bookmarkNameString = editBookmarkNameEditText.getText().toString();
2948 String bookmarkUrlString = editBookmarkUrlEditText.getText().toString();
2950 // Update the bookmark.
2951 if (currentBookmarkIconRadioButton.isChecked()) { // Update the bookmark without changing the favorite icon.
2952 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString);
2953 } else { // Update the bookmark using the `WebView` favorite icon.
2954 // Convert the favorite icon to a byte array. `0` is for lossless compression (the only option for a PNG).
2955 ByteArrayOutputStream newFavoriteIconByteArrayOutputStream = new ByteArrayOutputStream();
2956 favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, newFavoriteIconByteArrayOutputStream);
2957 byte[] newFavoriteIconByteArray = newFavoriteIconByteArrayOutputStream.toByteArray();
2959 // Update the bookmark and the favorite icon.
2960 bookmarksDatabaseHelper.updateBookmark(selectedBookmarkDatabaseId, bookmarkNameString, bookmarkUrlString, newFavoriteIconByteArray);
2963 // Update `bookmarksCursor` with the current contents of this folder.
2964 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
2966 // Update the `ListView`.
2967 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
2971 public void onSaveBookmarkFolder(AppCompatDialogFragment dialogFragment, int selectedFolderDatabaseId) {
2972 // Get handles for the views from `dialogFragment`.
2973 EditText editFolderNameEditText = dialogFragment.getDialog().findViewById(R.id.edit_folder_name_edittext);
2974 RadioButton currentFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_current_icon_radiobutton);
2975 RadioButton defaultFolderIconRadioButton = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_radiobutton);
2976 ImageView folderIconImageView = dialogFragment.getDialog().findViewById(R.id.edit_folder_default_icon_imageview);
2978 // Get the new folder name.
2979 String newFolderNameString = editFolderNameEditText.getText().toString();
2981 // Check if the favorite icon has changed.
2982 if (currentFolderIconRadioButton.isChecked()) { // Only the name has changed.
2983 // Update the name in the database.
2984 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString);
2985 } else if (!currentFolderIconRadioButton.isChecked() && newFolderNameString.equals(oldFolderNameString)) { // Only the icon has changed.
2986 // Get the new folder icon `Bitmap`.
2987 Bitmap folderIconBitmap;
2988 if (defaultFolderIconRadioButton.isChecked()) {
2989 // Get the default folder icon and convert it to a `Bitmap`.
2990 Drawable folderIconDrawable = folderIconImageView.getDrawable();
2991 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
2992 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
2993 } else { // Use the `WebView` favorite icon.
2994 folderIconBitmap = favoriteIconBitmap;
2997 // Convert the folder `Bitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
2998 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
2999 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3000 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3002 // Update the folder icon in the database.
3003 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, folderIconByteArray);
3004 } else { // The folder icon and the name have changed.
3005 // Get the new folder icon `Bitmap`.
3006 Bitmap folderIconBitmap;
3007 if (defaultFolderIconRadioButton.isChecked()) {
3008 // Get the default folder icon and convert it to a `Bitmap`.
3009 Drawable folderIconDrawable = folderIconImageView.getDrawable();
3010 BitmapDrawable folderIconBitmapDrawable = (BitmapDrawable) folderIconDrawable;
3011 folderIconBitmap = folderIconBitmapDrawable.getBitmap();
3012 } else { // Use the `WebView` favorite icon.
3013 folderIconBitmap = MainWebViewActivity.favoriteIconBitmap;
3016 // Convert the folder `Bitmap` to a byte array. `0` is for lossless compression (the only option for a PNG).
3017 ByteArrayOutputStream folderIconByteArrayOutputStream = new ByteArrayOutputStream();
3018 folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream);
3019 byte[] folderIconByteArray = folderIconByteArrayOutputStream.toByteArray();
3021 // Update the folder name and icon in the database.
3022 bookmarksDatabaseHelper.updateFolder(selectedFolderDatabaseId, oldFolderNameString, newFolderNameString, folderIconByteArray);
3025 // Update `bookmarksCursor` with the current contents of this folder.
3026 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3028 // Update the `ListView`.
3029 bookmarksCursorAdapter.changeCursor(bookmarksCursor);
3033 public void onHttpAuthenticationCancel() {
3034 // Cancel the `HttpAuthHandler`.
3035 httpAuthHandler.cancel();
3039 public void onHttpAuthenticationProceed(AppCompatDialogFragment dialogFragment) {
3040 // Get handles for the `EditTexts`.
3041 EditText usernameEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_username);
3042 EditText passwordEditText = dialogFragment.getDialog().findViewById(R.id.http_authentication_password);
3044 // Proceed with the HTTP authentication.
3045 httpAuthHandler.proceed(usernameEditText.getText().toString(), passwordEditText.getText().toString());
3048 public void viewSslCertificate(View view) {
3049 // Show the `ViewSslCertificateDialog` `AlertDialog` and name this instance `@string/view_ssl_certificate`.
3050 DialogFragment viewSslCertificateDialogFragment = new ViewSslCertificateDialog();
3051 viewSslCertificateDialogFragment.show(getFragmentManager(), getString(R.string.view_ssl_certificate));
3055 public void onSslErrorCancel() {
3056 sslErrorHandler.cancel();
3060 public void onSslErrorProceed() {
3061 sslErrorHandler.proceed();
3065 public void onSslMismatchBack() {
3066 if (mainWebView.canGoBack()) { // There is a back page in the history.
3067 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3068 navigatingHistory = true;
3071 mainWebView.goBack();
3072 } else { // There are no pages to go back to.
3073 // Load a blank page
3079 public void onSslMismatchProceed() {
3080 // Do not check the pinned SSL certificate for this domain again until the domain changes.
3081 ignorePinnedSslCertificate = true;
3085 public void onUrlHistoryEntrySelected(int moveBackOrForwardSteps) {
3086 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3087 navigatingHistory = true;
3089 // Load the history entry.
3090 mainWebView.goBackOrForward(moveBackOrForwardSteps);
3094 public void onClearHistory() {
3095 // Clear the history.
3096 mainWebView.clearHistory();
3099 // Override `onBackPressed` to handle the navigation drawer and `mainWebView`.
3101 public void onBackPressed() {
3102 if (drawerLayout.isDrawerVisible(GravityCompat.START)) { // The navigation drawer is open.
3103 // Close the navigation drawer.
3104 drawerLayout.closeDrawer(GravityCompat.START);
3105 } else if (drawerLayout.isDrawerVisible(GravityCompat.END)){ // The bookmarks drawer is open.
3106 if (currentBookmarksFolder.isEmpty()) { // The home folder is displayed.
3107 // close the bookmarks drawer.
3108 drawerLayout.closeDrawer(GravityCompat.END);
3109 } else { // A subfolder is displayed.
3110 // Place the former parent folder in `currentFolder`.
3111 currentBookmarksFolder = bookmarksDatabaseHelper.getParentFolder(currentBookmarksFolder);
3113 // Load the new folder.
3114 loadBookmarksFolder();
3117 } else if (mainWebView.canGoBack()) { // There is at least one item in the `WebView` history.
3118 // Set `navigatingHistory` so that the domain settings are applied when the new URL is loaded.
3119 navigatingHistory = true;
3122 mainWebView.goBack();
3123 } else { // There isn't anything to do in Privacy Browser.
3124 // Pass `onBackPressed()` to the system.
3125 super.onBackPressed();
3129 // 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.
3131 public void onActivityResult(int requestCode, int resultCode, Intent data) {
3132 // File uploads only work on API >= 21.
3133 if (Build.VERSION.SDK_INT >= 21) {
3134 // Pass the file to the WebView.
3135 fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(resultCode, data));
3139 private void loadUrlFromTextBox() throws UnsupportedEncodingException {
3140 // Get the text from urlTextBox and convert it to a string. trim() removes white spaces from the beginning and end of the string.
3141 String unformattedUrlString = urlTextBox.getText().toString().trim();
3143 // Check to see if `unformattedUrlString` is a valid URL. Otherwise, convert it into a search.
3144 if ((Patterns.WEB_URL.matcher(unformattedUrlString).matches()) || (unformattedUrlString.startsWith("http://")) || (unformattedUrlString.startsWith("https://"))) {
3145 // Add `http://` at the beginning if it is missing. Otherwise the app will segfault.
3146 if (!unformattedUrlString.startsWith("http")) {
3147 unformattedUrlString = "http://" + unformattedUrlString;
3150 // Initialize `unformattedUrl`.
3151 URL unformattedUrl = null;
3153 // 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.
3155 unformattedUrl = new URL(unformattedUrlString);
3156 } catch (MalformedURLException e) {
3157 e.printStackTrace();
3160 // The ternary operator (? :) makes sure that a null pointer exception is not thrown, which would happen if `.get` was called on a `null` value.
3161 final String scheme = unformattedUrl != null ? unformattedUrl.getProtocol() : null;
3162 final String authority = unformattedUrl != null ? unformattedUrl.getAuthority() : null;
3163 final String path = unformattedUrl != null ? unformattedUrl.getPath() : null;
3164 final String query = unformattedUrl != null ? unformattedUrl.getQuery() : null;
3165 final String fragment = unformattedUrl != null ? unformattedUrl.getRef() : null;
3168 Uri.Builder formattedUri = new Uri.Builder();
3169 formattedUri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment);
3171 // Decode `formattedUri` as a `String` in `UTF-8`.
3172 formattedUrlString = URLDecoder.decode(formattedUri.build().toString(), "UTF-8");
3173 } else if (unformattedUrlString.isEmpty()){ // Load a blank web site.
3174 // Load a blank string.
3175 formattedUrlString = "";
3176 } else { // Search for the contents of the URL box.
3177 // Sanitize the search input and convert it to a search.
3178 final String encodedUrlString = URLEncoder.encode(unformattedUrlString, "UTF-8");
3180 // Add the base search URL.
3181 formattedUrlString = searchURL + encodedUrlString;
3184 // 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.
3185 urlTextBox.clearFocus();
3188 loadUrl(formattedUrlString);
3192 private void loadUrl(String url) {
3193 // Apply any custom domain settings.
3194 applyDomainSettings(url, true, false);
3196 // Set `urlIsLoading` to prevent changes in the user agent on websites with redirects from reloading the current website.
3197 urlIsLoading = true;
3200 mainWebView.loadUrl(url, customHeaders);
3203 public void findPreviousOnPage(View view) {
3204 // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards.
3205 mainWebView.findNext(false);
3208 public void findNextOnPage(View view) {
3209 // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
3210 mainWebView.findNext(true);
3213 public void closeFindOnPage(View view) {
3214 // Delete the contents of `find_on_page_edittext`.
3215 findOnPageEditText.setText(null);
3217 // Clear the highlighted phrases.
3218 mainWebView.clearMatches();
3220 // Hide the Find on Page `RelativeLayout`.
3221 findOnPageLinearLayout.setVisibility(View.GONE);
3223 // Show the URL app bar.
3224 supportAppBar.setVisibility(View.VISIBLE);
3226 // Hide the keyboard so we can see the webpage. `0` indicates no additional flags.
3227 inputMethodManager.hideSoftInputFromWindow(mainWebView.getWindowToken(), 0);
3230 private void applyAppSettings() {
3231 // Get a handle for the shared preferences.
3232 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3234 // Store the values from the shared preferences in variables.
3235 String homepageString = sharedPreferences.getString("homepage", "https://start.duckduckgo.com");
3236 String torHomepageString = sharedPreferences.getString("tor_homepage", "https://3g2upl4pq6kufc4m.onion");
3237 String torSearchString = sharedPreferences.getString("tor_search", "https://3g2upl4pq6kufc4m.onion/html/?q=");
3238 String torSearchCustomURLString = sharedPreferences.getString("tor_search_custom_url", "");
3239 String searchString = sharedPreferences.getString("search", "https://duckduckgo.com/html/?q=");
3240 String searchCustomURLString = sharedPreferences.getString("search_custom_url", "");
3241 incognitoModeEnabled = sharedPreferences.getBoolean("incognito_mode", false);
3242 boolean doNotTrackEnabled = sharedPreferences.getBoolean("do_not_track", false);
3243 proxyThroughOrbot = sharedPreferences.getBoolean("proxy_through_orbot", false);
3244 fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean("full_screen_browsing_mode", false);
3245 hideSystemBarsOnFullscreen = sharedPreferences.getBoolean("hide_system_bars", false);
3246 translucentNavigationBarOnFullscreen = sharedPreferences.getBoolean("translucent_navigation_bar", true);
3247 displayWebpageImagesBoolean = sharedPreferences.getBoolean("display_webpage_images", true);
3249 // Set the homepage, search, and proxy options.
3250 if (proxyThroughOrbot) { // Set the Tor options.
3251 // Set `torHomepageString` as `homepage`.
3252 homepage = torHomepageString;
3254 // If formattedUrlString is null assign the homepage to it.
3255 if (formattedUrlString == null) {
3256 formattedUrlString = homepage;
3259 // Set the search URL.
3260 if (torSearchString.equals("Custom URL")) { // Get the custom URL string.
3261 searchURL = torSearchCustomURLString;
3262 } else { // Use the string from the pre-built list.
3263 searchURL = torSearchString;
3266 // Set the proxy. `this` refers to the current activity where an `AlertDialog` might be displayed.
3267 OrbotProxyHelper.setProxy(getApplicationContext(), this, "localhost", "8118");
3269 // Set the `appBar` background to indicate proxying through Orbot is enabled. `this` refers to the context.
3271 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.dark_blue_30));
3273 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.blue_50));
3276 // Display a message to the user if we are waiting on Orbot.
3277 if (!orbotStatus.equals("ON")) {
3278 // Set `waitingForOrbot`.
3279 waitingForOrbot = true;
3281 // Load a waiting page. `null` specifies no encoding, which defaults to ASCII.
3282 mainWebView.loadData(waitingForOrbotHTMLString, "text/html", null);
3284 } else { // Set the non-Tor options.
3285 // Set `homepageString` as `homepage`.
3286 homepage = homepageString;
3288 // If formattedUrlString is null assign the homepage to it.
3289 if (formattedUrlString == null) {
3290 formattedUrlString = homepage;
3293 // Set the search URL.
3294 if (searchString.equals("Custom URL")) { // Get the custom URL string.
3295 searchURL = searchCustomURLString;
3296 } else { // Use the string from the pre-built list.
3297 searchURL = searchString;
3300 // Reset the proxy to default. The host is `""` and the port is `"0"`.
3301 OrbotProxyHelper.setProxy(getApplicationContext(), this, "", "0");
3303 // Set the default `appBar` background. `this` refers to the context.
3305 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_900));
3307 appBar.setBackgroundDrawable(ContextCompat.getDrawable(this, R.color.gray_100));
3310 // Reset `waitingForOrbot.
3311 waitingForOrbot = false;
3314 // Set Do Not Track status.
3315 if (doNotTrackEnabled) {
3316 customHeaders.put("DNT", "1");
3318 customHeaders.remove("DNT");
3321 // Apply the appropriate full screen mode the `SYSTEM_UI` flags.
3322 if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) {
3323 if (hideSystemBarsOnFullscreen) { // Hide everything.
3324 // Remove the translucent navigation setting if it is currently flagged.
3325 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3327 // Remove the translucent status bar overlay.
3328 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3330 // Remove the translucent status bar overlay on the `Drawer Layout`, which is special and needs its own command.
3331 drawerLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN);
3333 /* SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
3334 * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
3335 * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
3337 rootCoordinatorLayout.setSystemUiVisibility(View.SYSTEM_UI_FLAG_FULLSCREEN | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION | View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY);
3338 } else { // Hide everything except the status and navigation bars.
3339 // Add the translucent status flag if it is unset.
3340 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3342 if (translucentNavigationBarOnFullscreen) {
3343 // Set the navigation bar to be translucent.
3344 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3346 // Set the navigation bar to be black.
3347 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3350 } else { // Switch to normal viewing mode.
3351 // Reset `inFullScreenBrowsingMode` to `false`.
3352 inFullScreenBrowsingMode = false;
3354 // Show the `appBar` if `findOnPageLinearLayout` is not visible.
3355 if (findOnPageLinearLayout.getVisibility() == View.GONE) {
3359 // Show the `BannerAd` in the free flavor.
3360 if (BuildConfig.FLAVOR.contentEquals("free")) {
3361 // Initialize the ad. The AdView is destroyed and recreated, which changes the ID, every time it is reloaded to handle possible rotations.
3362 AdHelper.initializeAds(findViewById(R.id.adview), getApplicationContext(), getFragmentManager(), getString(R.string.ad_id));
3365 // Remove the translucent navigation bar flag if it is set.
3366 getWindow().clearFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
3368 // Add the translucent status flag if it is unset. This also resets `drawerLayout's` `View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`.
3369 getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_STATUS);
3371 // Remove any `SYSTEM_UI` flags from `rootCoordinatorLayout`.
3372 rootCoordinatorLayout.setSystemUiVisibility(0);
3374 // Constrain `rootCoordinatorLayout` inside the status and navigation bars.
3375 rootCoordinatorLayout.setFitsSystemWindows(true);
3379 // `reloadWebsite` is used if returning from the Domains activity. Otherwise JavaScript might not function correctly if it is newly enabled.
3380 // The deprecated `.getDrawable()` must be used until the minimum API >= 21.
3381 @SuppressWarnings("deprecation")
3382 private void applyDomainSettings(String url, boolean resetFavoriteIcon, boolean reloadWebsite) {
3383 // Reset `navigatingHistory`.
3384 navigatingHistory = false;
3386 // Parse the URL into a URI.
3387 Uri uri = Uri.parse(url);
3389 // Extract the domain from `uri`.
3390 String hostName = uri.getHost();
3392 // Initialize `loadingNewDomainName`.
3393 boolean loadingNewDomainName;
3395 // If either `hostName` or `currentDomainName` are `null`, run the options for loading a new domain name.
3396 // The lint suggestion to simplify the `if` statement is incorrect, because `hostName.equals(currentDomainName)` can produce a `null object reference.`
3397 //noinspection SimplifiableIfStatement
3398 if ((hostName == null) || (currentDomainName == null)) {
3399 loadingNewDomainName = true;
3400 } else { // Determine if `hostName` equals `currentDomainName`.
3401 loadingNewDomainName = !hostName.equals(currentDomainName);
3404 // Strings don't like to be null.
3405 if (hostName == null) {
3409 // 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.
3410 if (loadingNewDomainName) {
3411 // Set the new `hostname` as the `currentDomainName`.
3412 currentDomainName = hostName;
3414 // Reset `ignorePinnedSslCertificate`.
3415 ignorePinnedSslCertificate = false;
3417 // Reset the favorite icon if specified.
3418 if (resetFavoriteIcon) {
3419 favoriteIconBitmap = favoriteIconDefaultBitmap;
3420 favoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(favoriteIconBitmap, 64, 64, true));
3423 // Initialize the database handler. `this` specifies the context. The two `nulls` do not specify the database name or a `CursorFactory`.
3424 // The `0` specifies the database version, but that is ignored and set instead using a constant in `DomainsDatabaseHelper`.
3425 DomainsDatabaseHelper domainsDatabaseHelper = new DomainsDatabaseHelper(this, null, null, 0);
3427 // Get a full cursor from `domainsDatabaseHelper`.
3428 Cursor domainNameCursor = domainsDatabaseHelper.getDomainNameCursorOrderedByDomain();
3430 // Initialize `domainSettingsSet`.
3431 Set<String> domainSettingsSet = new HashSet<>();
3433 // Get the domain name column index.
3434 int domainNameColumnIndex = domainNameCursor.getColumnIndex(DomainsDatabaseHelper.DOMAIN_NAME);
3436 // Populate `domainSettingsSet`.
3437 for (int i = 0; i < domainNameCursor.getCount(); i++) {
3438 // Move `domainsCursor` to the current row.
3439 domainNameCursor.moveToPosition(i);
3441 // Store the domain name in `domainSettingsSet`.
3442 domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex));
3445 // Close `domainNameCursor.
3446 domainNameCursor.close();
3448 // Initialize variables to track if domain settings will be applied and, if so, under which name.
3449 domainSettingsApplied = false;
3450 String domainNameInDatabase = null;
3452 // Check the hostname.
3453 if (domainSettingsSet.contains(hostName)) {
3454 domainSettingsApplied = true;
3455 domainNameInDatabase = hostName;
3458 // Check all the subdomains of the host name against wildcard domains in the domain cursor.
3459 while (!domainSettingsApplied && hostName.contains(".")) { // Stop checking if domain settings are already applied or there are no more `.` in the host name.
3460 if (domainSettingsSet.contains("*." + hostName)) { // Check the host name prepended by `*.`.
3461 // Apply the domain settings.
3462 domainSettingsApplied = true;
3464 // Store the applied domain names as it appears in the database.
3465 domainNameInDatabase = "*." + hostName;
3468 // Strip out the lowest subdomain of of the host name.
3469 hostName = hostName.substring(hostName.indexOf(".") + 1);
3473 // Get a handle for the shared preference.
3474 SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
3476 // Store the general preference information.
3477 String defaultFontSizeString = sharedPreferences.getString("default_font_size", "100");
3478 String defaultUserAgentName = sharedPreferences.getString("user_agent", "Privacy Browser");
3479 String defaultCustomUserAgentString = sharedPreferences.getString("custom_user_agent", "PrivacyBrowser/1.0");
3480 boolean defaultSwipeToRefresh = sharedPreferences.getBoolean("swipe_to_refresh", true);
3481 nightMode = sharedPreferences.getBoolean("night_mode", false);
3483 if (domainSettingsApplied) { // The url we are loading has custom domain settings.
3484 // Get a cursor for the current host and move it to the first position.
3485 Cursor currentHostDomainSettingsCursor = domainsDatabaseHelper.getCursorForDomainName(domainNameInDatabase);
3486 currentHostDomainSettingsCursor.moveToFirst();
3488 // Get the settings from the cursor.
3489 domainSettingsDatabaseId = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper._ID)));
3490 javaScriptEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1);
3491 firstPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FIRST_PARTY_COOKIES)) == 1);
3492 thirdPartyCookiesEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_THIRD_PARTY_COOKIES)) == 1);
3493 domStorageEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1);
3494 // Form data can be removed once the minimum API >= 26.
3495 saveFormDataEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1);
3496 easyListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYLIST)) == 1);
3497 easyPrivacyEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_EASYPRIVACY)) == 1);
3498 fanboysAnnoyanceListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_ANNOYANCE_LIST)) == 1);
3499 fanboysSocialBlockingListEnabled = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST)) == 1);
3500 String userAgentName = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.USER_AGENT));
3501 int fontSize = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.FONT_SIZE));
3502 int swipeToRefreshInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SWIPE_TO_REFRESH));
3503 int nightModeInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.NIGHT_MODE));
3504 displayWebpageImagesInt = currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.DISPLAY_IMAGES));
3505 pinnedDomainSslCertificate = (currentHostDomainSettingsCursor.getInt(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.PINNED_SSL_CERTIFICATE)) == 1);
3506 pinnedDomainSslIssuedToCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_COMMON_NAME));
3507 pinnedDomainSslIssuedToONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATION));
3508 pinnedDomainSslIssuedToUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT));
3509 pinnedDomainSslIssuedByCNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_COMMON_NAME));
3510 pinnedDomainSslIssuedByONameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATION));
3511 pinnedDomainSslIssuedByUNameString = currentHostDomainSettingsCursor.getString(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT));
3513 // Set `nightMode` according to `nightModeInt`. If `nightModeInt` is `DomainsDatabaseHelper.NIGHT_MODE_SYSTEM_DEFAULT` the current setting from `sharedPreferences` will be used.
3514 switch (nightModeInt) {
3515 case DomainsDatabaseHelper.NIGHT_MODE_ENABLED:
3519 case DomainsDatabaseHelper.NIGHT_MODE_DISABLED:
3524 // Set `javaScriptEnabled` to be `true` if `night_mode` is `true`.
3526 javaScriptEnabled = true;
3529 // Set the pinned SSL certificate start date to `null` if the saved date `long` is 0.
3530 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)) == 0) {
3531 pinnedDomainSslStartDate = null;
3533 pinnedDomainSslStartDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_START_DATE)));
3536 // Set the pinned SSL certificate end date to `null` if the saved date `long` is 0.
3537 if (currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)) == 0) {
3538 pinnedDomainSslEndDate = null;
3540 pinnedDomainSslEndDate = new Date(currentHostDomainSettingsCursor.getLong(currentHostDomainSettingsCursor.getColumnIndex(DomainsDatabaseHelper.SSL_END_DATE)));
3543 // Close `currentHostDomainSettingsCursor`.
3544 currentHostDomainSettingsCursor.close();
3546 // Apply the domain settings.
3547 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
3548 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
3549 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
3551 // Apply the form data setting if the API < 26.
3552 if (Build.VERSION.SDK_INT < 26) {
3553 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
3556 // Apply the font size.
3557 if (fontSize == 0) { // Apply the default font size.
3558 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3559 } else { // Apply the specified font size.
3560 mainWebView.getSettings().setTextZoom(fontSize);
3563 // Set third-party cookies status if API >= 21.
3564 if (Build.VERSION.SDK_INT >= 21) {
3565 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
3568 // 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.
3569 // <https://redmine.stoutner.com/issues/160>
3570 if (!urlIsLoading) {
3571 // Set the user agent.
3572 if (userAgentName.equals(getString(R.string.system_default_user_agent))) { // Use the system default user agent.
3573 // Get the array position of the default user agent name.
3574 int defaultUserAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3576 // Set the user agent according to the system default.
3577 switch (defaultUserAgentArrayPosition) {
3578 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
3579 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3580 mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
3583 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3584 // Set the user agent to `""`, which uses the default value.
3585 mainWebView.getSettings().setUserAgentString("");
3588 case SETTINGS_CUSTOM_USER_AGENT:
3589 // Set the custom user agent.
3590 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
3594 // Get the user agent string from the user agent data array
3595 mainWebView.getSettings().setUserAgentString(userAgentDataArray[defaultUserAgentArrayPosition]);
3597 } else { // Set the user agent according to the stored name.
3598 // Get the array position of the user agent name.
3599 int userAgentArrayPosition = userAgentNamesArray.getPosition(userAgentName);
3601 switch (userAgentArrayPosition) {
3602 case UNRECOGNIZED_USER_AGENT: // The user agent name contains a custom user agent.
3603 mainWebView.getSettings().setUserAgentString(userAgentName);
3606 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3607 // Set the user agent to `""`, which uses the default value.
3608 mainWebView.getSettings().setUserAgentString("");
3612 // Get the user agent string from the user agent data array.
3613 mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3617 // Set swipe to refresh.
3618 switch (swipeToRefreshInt) {
3619 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_SYSTEM_DEFAULT:
3620 // Set swipe to refresh according to the default.
3621 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3624 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_ENABLED:
3625 // Enable swipe to refresh.
3626 swipeRefreshLayout.setEnabled(true);
3629 case DomainsDatabaseHelper.SWIPE_TO_REFRESH_DISABLED:
3630 // Disable swipe to refresh.
3631 swipeRefreshLayout.setEnabled(false);
3634 // Store the applied user agent string, which is used in the View Source activity.
3635 appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
3638 // 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.
3640 urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_dark_blue));
3642 urlAppBarRelativeLayout.setBackground(getResources().getDrawable(R.drawable.url_bar_background_light_green));
3644 } else { // The URL we are loading does not have custom domain settings. Load the defaults.
3645 // Store the values from `sharedPreferences` in variables.
3646 javaScriptEnabled = sharedPreferences.getBoolean("javascript_enabled", false);
3647 firstPartyCookiesEnabled = sharedPreferences.getBoolean("first_party_cookies_enabled", false);
3648 thirdPartyCookiesEnabled = sharedPreferences.getBoolean("third_party_cookies_enabled", false);
3649 domStorageEnabled = sharedPreferences.getBoolean("dom_storage_enabled", false);
3650 saveFormDataEnabled = sharedPreferences.getBoolean("save_form_data_enabled", false); // Form data can be removed once the minimum API >= 26.
3651 easyListEnabled = sharedPreferences.getBoolean("easylist", true);
3652 easyPrivacyEnabled = sharedPreferences.getBoolean("easyprivacy", true);
3653 fanboysAnnoyanceListEnabled = sharedPreferences.getBoolean("fanboy_annoyance_list", true);
3654 fanboysSocialBlockingListEnabled = sharedPreferences.getBoolean("fanboy_social_blocking_list", true);
3656 // Set `javaScriptEnabled` to be `true` if `night_mode` is `true`.
3658 javaScriptEnabled = true;
3661 // Apply the default settings.
3662 mainWebView.getSettings().setJavaScriptEnabled(javaScriptEnabled);
3663 cookieManager.setAcceptCookie(firstPartyCookiesEnabled);
3664 mainWebView.getSettings().setDomStorageEnabled(domStorageEnabled);
3665 mainWebView.getSettings().setTextZoom(Integer.valueOf(defaultFontSizeString));
3666 swipeRefreshLayout.setEnabled(defaultSwipeToRefresh);
3668 // Apply the form data setting if the API < 26.
3669 if (Build.VERSION.SDK_INT < 26) {
3670 mainWebView.getSettings().setSaveFormData(saveFormDataEnabled);
3673 // Reset the pinned SSL certificate information.
3674 domainSettingsDatabaseId = -1;
3675 pinnedDomainSslCertificate = false;
3676 pinnedDomainSslIssuedToCNameString = "";
3677 pinnedDomainSslIssuedToONameString = "";
3678 pinnedDomainSslIssuedToUNameString = "";
3679 pinnedDomainSslIssuedByCNameString = "";
3680 pinnedDomainSslIssuedByONameString = "";
3681 pinnedDomainSslIssuedByUNameString = "";
3682 pinnedDomainSslStartDate = null;
3683 pinnedDomainSslEndDate = null;
3685 // Set third-party cookies status if API >= 21.
3686 if (Build.VERSION.SDK_INT >= 21) {
3687 cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
3690 // 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.
3691 // <https://redmine.stoutner.com/issues/160>
3692 if (!urlIsLoading) {
3693 // Get the array position of the user agent name.
3694 int userAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName);
3696 // Set the user agent.
3697 switch (userAgentArrayPosition) {
3698 case UNRECOGNIZED_USER_AGENT: // The default user agent name is not on the canonical list.
3699 // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
3700 mainWebView.getSettings().setUserAgentString(defaultUserAgentName);
3703 case SETTINGS_WEBVIEW_DEFAULT_USER_AGENT:
3704 // Set the user agent to `""`, which uses the default value.
3705 mainWebView.getSettings().setUserAgentString("");
3708 case SETTINGS_CUSTOM_USER_AGENT:
3709 // Set the custom user agent.
3710 mainWebView.getSettings().setUserAgentString(defaultCustomUserAgentString);
3714 // Get the user agent string from the user agent data array
3715 mainWebView.getSettings().setUserAgentString(userAgentDataArray[userAgentArrayPosition]);
3718 // Store the applied user agent string, which is used in the View Source activity.
3719 appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
3722 // Set a transparent background on `urlTextBox`. We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
3723 urlAppBarRelativeLayout.setBackgroundDrawable(getResources().getDrawable(R.color.transparent));
3726 // Close `domainsDatabaseHelper`.
3727 domainsDatabaseHelper.close();
3729 // Remove the `onTheFlyDisplayImagesSet` flag and set the display webpage images mode. `true` indicates that custom domain settings are applied.
3730 onTheFlyDisplayImagesSet = false;
3731 setDisplayWebpageImages();
3733 // Update the privacy icons, but only if `mainMenu` has already been populated.
3734 if (mainMenu != null) {
3735 updatePrivacyIcons(true);
3738 // Reload the website if returning from the Domains activity.
3739 if (reloadWebsite) {
3740 mainWebView.reload();
3745 private void setDisplayWebpageImages() {
3746 if (!onTheFlyDisplayImagesSet) {
3747 if (domainSettingsApplied) { // Custom domain settings are applied.
3748 switch (displayWebpageImagesInt) {
3749 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_SYSTEM_DEFAULT:
3750 mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
3753 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_ENABLED:
3754 mainWebView.getSettings().setLoadsImagesAutomatically(true);
3757 case DomainsDatabaseHelper.DISPLAY_WEBPAGE_IMAGES_DISABLED:
3758 mainWebView.getSettings().setLoadsImagesAutomatically(false);
3761 } else { // Default settings are applied.
3762 mainWebView.getSettings().setLoadsImagesAutomatically(displayWebpageImagesBoolean);
3767 private void updatePrivacyIcons(boolean runInvalidateOptionsMenu) {
3768 // Get handles for the menu items.
3769 MenuItem privacyMenuItem = mainMenu.findItem(R.id.toggle_javascript);
3770 MenuItem firstPartyCookiesMenuItem = mainMenu.findItem(R.id.toggle_first_party_cookies);
3771 MenuItem domStorageMenuItem = mainMenu.findItem(R.id.toggle_dom_storage);
3772 MenuItem refreshMenuItem = mainMenu.findItem(R.id.refresh);
3774 // Update the privacy icon.
3775 if (javaScriptEnabled) { // JavaScript is enabled.
3776 privacyMenuItem.setIcon(R.drawable.javascript_enabled);
3777 } else if (firstPartyCookiesEnabled) { // JavaScript is disabled but cookies are enabled.
3778 privacyMenuItem.setIcon(R.drawable.warning);
3779 } else { // All the dangerous features are disabled.
3780 privacyMenuItem.setIcon(R.drawable.privacy_mode);
3783 // Update the first-party cookies icon.
3784 if (firstPartyCookiesEnabled) { // First-party cookies are enabled.
3785 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_enabled);
3786 } else { // First-party cookies are disabled.
3788 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_dark);
3790 firstPartyCookiesMenuItem.setIcon(R.drawable.cookies_disabled_light);
3794 // Update the DOM storage icon.
3795 if (javaScriptEnabled && domStorageEnabled) { // Both JavaScript and DOM storage are enabled.
3796 domStorageMenuItem.setIcon(R.drawable.dom_storage_enabled);
3797 } else if (javaScriptEnabled) { // JavaScript is enabled but DOM storage is disabled.
3799 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_dark);
3801 domStorageMenuItem.setIcon(R.drawable.dom_storage_disabled_light);
3803 } else { // JavaScript is disabled, so DOM storage is ghosted.
3805 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_dark);
3807 domStorageMenuItem.setIcon(R.drawable.dom_storage_ghosted_light);
3811 // Update the refresh icon.
3813 refreshMenuItem.setIcon(R.drawable.refresh_enabled_dark);
3815 refreshMenuItem.setIcon(R.drawable.refresh_enabled_light);
3818 // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`.
3819 if (runInvalidateOptionsMenu) {
3820 invalidateOptionsMenu();
3824 private void highlightUrlText() {
3825 String urlString = urlTextBox.getText().toString();
3827 if (urlString.startsWith("http://")) { // Highlight the protocol of connections that are not encrypted.
3828 urlTextBox.getText().setSpan(redColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
3829 } else if (urlString.startsWith("https://")) { // De-emphasize the protocol of connections that are encrypted.
3830 urlTextBox.getText().setSpan(initialGrayColorSpan, 0, 8, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
3833 // Get the index of the `/` immediately after the domain name.
3834 int endOfDomainName = urlString.indexOf("/", (urlString.indexOf("//") + 2));
3836 // De-emphasize the text after the domain name.
3837 if (endOfDomainName > 0) {
3838 urlTextBox.getText().setSpan(finalGrayColorSpan, endOfDomainName, urlString.length(), Spanned.SPAN_INCLUSIVE_INCLUSIVE);
3842 private void loadBookmarksFolder() {
3843 // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
3844 bookmarksCursor = bookmarksDatabaseHelper.getAllBookmarksCursorByDisplayOrder(currentBookmarksFolder);
3846 // Populate the bookmarks cursor adapter. `this` specifies the `Context`. `false` disables `autoRequery`.
3847 bookmarksCursorAdapter = new CursorAdapter(this, bookmarksCursor, false) {
3849 public View newView(Context context, Cursor cursor, ViewGroup parent) {
3850 // Inflate the individual item layout. `false` does not attach it to the root.
3851 return getLayoutInflater().inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false);
3855 public void bindView(View view, Context context, Cursor cursor) {
3856 // Get handles for the views.
3857 ImageView bookmarkFavoriteIcon = view.findViewById(R.id.bookmark_favorite_icon);
3858 TextView bookmarkNameTextView = view.findViewById(R.id.bookmark_name);
3860 // Get the favorite icon byte array from the cursor.
3861 byte[] favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndex(BookmarksDatabaseHelper.FAVORITE_ICON));
3863 // Convert the byte array to a `Bitmap` beginning at the first byte and ending at the last.
3864 Bitmap favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.length);
3866 // Display the bitmap in `bookmarkFavoriteIcon`.
3867 bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap);
3869 // Get the bookmark name from the cursor and display it in `bookmarkNameTextView`.
3870 String bookmarkNameString = cursor.getString(cursor.getColumnIndex(BookmarksDatabaseHelper.BOOKMARK_NAME));
3871 bookmarkNameTextView.setText(bookmarkNameString);
3873 // Make the font bold for folders.
3874 if (cursor.getInt(cursor.getColumnIndex(BookmarksDatabaseHelper.IS_FOLDER)) == 1) {
3875 bookmarkNameTextView.setTypeface(Typeface.DEFAULT_BOLD);
3876 } else { // Reset the font to default for normal bookmarks.
3877 bookmarkNameTextView.setTypeface(Typeface.DEFAULT);
3882 // Populate the `ListView` with the adapter.
3883 bookmarksListView.setAdapter(bookmarksCursorAdapter);
3885 // Set the bookmarks drawer title.
3886 if (currentBookmarksFolder.isEmpty()) {
3887 bookmarksTitleTextView.setText(R.string.bookmarks);
3889 bookmarksTitleTextView.setText(currentBookmarksFolder);