/*
- * Copyright © 2015-2017 Soren Stoutner <soren@stoutner.com>.
+ * Copyright © 2015-2018 Soren Stoutner <soren@stoutner.com>.
*
* Download cookie code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
*
import android.support.design.widget.FloatingActionButton;
import android.support.design.widget.NavigationView;
import android.support.design.widget.Snackbar;
-import android.support.v4.app.ActivityCompat;
import android.support.v4.content.ContextCompat;
// `ShortcutInfoCompat`, `ShortcutManagerCompat`, and `IconCompat` can be switched to the non-compat version once API >= 26.
import android.support.v4.content.pm.ShortcutInfoCompat;
import android.text.Spanned;
import android.text.TextWatcher;
import android.text.style.ForegroundColorSpan;
+import android.util.Log;
import android.util.Patterns;
import android.view.ContextMenu;
import android.view.GestureDetector;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
+import java.util.LinkedList;
+import java.util.List;
import java.util.Map;
import java.util.Set;
+import java.util.regex.Pattern;
// We need to use AppCompatActivity from android.support.v7.app.AppCompatActivity to have access to the SupportActionBar until the minimum API is >= 21.
-public class MainWebViewActivity extends AppCompatActivity implements AddDomainDialog.AddDomainListener, CreateBookmarkDialog.CreateBookmarkListener, CreateBookmarkFolderDialog.CreateBookmarkFolderListener, CreateHomeScreenShortcutDialog.CreateHomeScreenSchortcutListener,
- DownloadFileDialog.DownloadFileListener, DownloadImageDialog.DownloadImageListener, EditBookmarkDialog.EditBookmarkListener, EditBookmarkFolderDialog.EditBookmarkFolderListener, HttpAuthenticationDialog.HttpAuthenticationListener,
- NavigationView.OnNavigationItemSelectedListener, PinnedSslCertificateMismatchDialog.PinnedSslCertificateMismatchListener, SslCertificateErrorDialog.SslCertificateErrorListener, UrlHistoryDialog.UrlHistoryListener {
-
- // `darkTheme` is public static so it can be accessed from `AboutActivity`, `GuideActivity`, `AddDomainDialog`, `SettingsActivity`, `DomainsActivity`, `DomainsListFragment`, `BookmarksActivity`, `BookmarksDatabaseViewActivity`,
- // `CreateBookmarkDialog`, `CreateBookmarkFolderDialog`, `DownloadFileDialog`, `DownloadImageDialog`, `EditBookmarkDialog`, `EditBookmarkFolderDialog`, `EditBookmarkDatabaseViewDialog`, `HttpAuthenticationDialog`, `MoveToFolderDialog`,
- // `SslCertificateErrorDialog`, `UrlHistoryDialog`, `ViewSslCertificateDialog`, `CreateHomeScreenShortcutDialog`, and `OrbotProxyHelper`. It is also used in `onCreate()`, `applyAppSettings()`, `applyDomainSettings()`, and `updatePrivacyIcons()`.
+public class MainWebViewActivity extends AppCompatActivity implements AddDomainDialog.AddDomainListener, CreateBookmarkDialog.CreateBookmarkListener,
+ CreateBookmarkFolderDialog.CreateBookmarkFolderListener, CreateHomeScreenShortcutDialog.CreateHomeScreenSchortcutListener, DownloadFileDialog.DownloadFileListener,
+ DownloadImageDialog.DownloadImageListener, EditBookmarkDialog.EditBookmarkListener, EditBookmarkFolderDialog.EditBookmarkFolderListener, HttpAuthenticationDialog.HttpAuthenticationListener,
+ NavigationView.OnNavigationItemSelectedListener, PinnedSslCertificateMismatchDialog.PinnedSslCertificateMismatchListener, SslCertificateErrorDialog.SslCertificateErrorListener,
+ UrlHistoryDialog.UrlHistoryListener {
+
+ // `darkTheme` is public static so it can be accessed from `AboutActivity`, `GuideActivity`, `AddDomainDialog`, `SettingsActivity`, `DomainsActivity`, `DomainsListFragment`, `BookmarksActivity`,
+ // `BookmarksDatabaseViewActivity`, `CreateBookmarkDialog`, `CreateBookmarkFolderDialog`, `DownloadFileDialog`, `DownloadImageDialog`, `EditBookmarkDialog`, `EditBookmarkFolderDialog`,
+ // `EditBookmarkDatabaseViewDialog`, `HttpAuthenticationDialog`, `MoveToFolderDialog`, `SslCertificateErrorDialog`, `UrlHistoryDialog`, `ViewSslCertificateDialog`, `CreateHomeScreenShortcutDialog`,
+ // and `OrbotProxyHelper`. It is also used in `onCreate()`, `applyAppSettings()`, `applyDomainSettings()`, and `updatePrivacyIcons()`.
public static boolean darkTheme;
- // `favoriteIconBitmap` is public static so it can be accessed from `CreateHomeScreenShortcutDialog`, `BookmarksActivity`, `BookmarksDatabaseViewActivity`, `CreateBookmarkDialog`, `CreateBookmarkFolderDialog`, `EditBookmarkDialog`,
- // `EditBookmarkFolderDialog`, `EditBookmarkDatabaseViewDialog`, and `ViewSslCertificateDialog`. It is also used in `onCreate()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onCreateHomeScreenShortcutCreate()`, `onSaveEditBookmark()`,
- // `onSaveEditBookmarkFolder()`, and `applyDomainSettings()`.
+ // `favoriteIconBitmap` is public static so it can be accessed from `CreateHomeScreenShortcutDialog`, `BookmarksActivity`, `BookmarksDatabaseViewActivity`, `CreateBookmarkDialog`,
+ // `CreateBookmarkFolderDialog`, `EditBookmarkDialog`, `EditBookmarkFolderDialog`, `EditBookmarkDatabaseViewDialog`, and `ViewSslCertificateDialog`. It is also used in `onCreate()`,
+ // `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onCreateHomeScreenShortcutCreate()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `applyDomainSettings()`.
public static Bitmap favoriteIconBitmap;
// `formattedUrlString` is public static so it can be accessed from `BookmarksActivity`, `CreateBookmarkDialog`, and `AddDomainDialog`.
// It is also used in `onCreate()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onCreateHomeScreenShortcutCreate()`, and `loadUrlFromTextBox()`.
public static String formattedUrlString;
- // `sslCertificate` is public static so it can be accessed from `DomainsActivity`, `DomainsListFragment`, `DomainSettingsFragment`, `PinnedSslCertificateMismatchDialog`, and `ViewSslCertificateDialog`. It is also used in `onCreate()`.
+ // `sslCertificate` is public static so it can be accessed from `DomainsActivity`, `DomainsListFragment`, `DomainSettingsFragment`, `PinnedSslCertificateMismatchDialog`,
+ // and `ViewSslCertificateDialog`. It is also used in `onCreate()`.
public static SslCertificate sslCertificate;
// `orbotStatus` is public static so it can be accessed from `OrbotProxyHelper`. It is also used in `onCreate()`.
// `webViewTitle` is public static so it can be accessed from `CreateBookmarkDialog` and `CreateHomeScreenShortcutDialog`. It is also used in `onCreate()`.
public static String webViewTitle;
+ // `appliedUserAgentString` is public static so it can be accessed from `ViewSourceActivity`. It is also used in `applyDomainSettings()`.
+ public static String appliedUserAgentString;
+
// `displayWebpageImagesBoolean` is public static so it can be accessed from `DomainSettingsFragment`. It is also used in `applyAppSettings()` and `applyDomainSettings()`.
public static boolean displayWebpageImagesBoolean;
// `restartFromBookmarksActivity` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onRestart()`.
public static boolean restartFromBookmarksActivity;
- // `currentBookmarksFolder` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onCreate()`, `onBackPressed()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`, `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and
- // `loadBookmarksFolder()`.
+ // `easyListVersion` is public static so it can be accessed from `AboutTabFragment`. It is also used in `onCreate()`.
+ public static String easyListVersion;
+
+ // `currentBookmarksFolder` is public static so it can be accessed from `BookmarksActivity`. It is also used in `onCreate()`, `onBackPressed()`, `onCreateBookmark()`, `onCreateBookmarkFolder()`,
+ // `onSaveEditBookmark()`, `onSaveEditBookmarkFolder()`, and `loadBookmarksFolder()`.
public static String currentBookmarksFolder;
// `domainSettingsDatabaseId` is public static so it can be accessed from `PinnedSslCertificateMismatchDialog`. It is also used in `onCreate()`, `onOptionsItemSelected()`, and `applyDomainSettings()`.
// `rootCoordinatorLayout` is used in `onCreate()` and `applyAppSettings()`.
private CoordinatorLayout rootCoordinatorLayout;
- // `mainWebView` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`, `findNextOnPage()`, `closeFindOnPage()`, `loadUrlFromTextBox()`
- // `onSslMismatchBack()`, and `setDisplayWebpageImages()`.
+ // `mainWebView` is used in `onCreate()`, `onPrepareOptionsMenu()`, `onOptionsItemSelected()`, `onNavigationItemSelected()`, `onRestart()`, `onCreateContextMenu()`, `findPreviousOnPage()`,
+ // `findNextOnPage()`, `closeFindOnPage()`, `loadUrlFromTextBox()`, `onSslMismatchBack()`, and `setDisplayWebpageImages()`.
private WebView mainWebView;
// `fullScreenVideoFrameLayout` is used in `onCreate()` and `onConfigurationChanged()`.
// `urlTextBox` is used in `onCreate()`, `onOptionsItemSelected()`, `loadUrlFromTextBox()`, `loadUrl()`, and `highlightUrlText()`.
private EditText urlTextBox;
- // `redColorSpan` is used in `onCreate()` and `highlightUrlText()`.
+ // The color spans are used in `onCreate()` and `highlightUrlText()`.
private ForegroundColorSpan redColorSpan;
-
- // `initialGrayColorSpan` is sued in `onCreate()` and `highlightUrlText()`.
private ForegroundColorSpan initialGrayColorSpan;
-
- // `finalGrayColorSpam` is used in `onCreate()` and `highlightUrlText()`.
private ForegroundColorSpan finalGrayColorSpan;
// `adView` is used in `onCreate()` and `onConfigurationChanged()`.
// Run the default commands.
super.onCreate(savedInstanceState);
+ Log.i("BlockLists", "Begin populating block lists.");
+
+ // Initialize the block lists.
+ List<String> mainWhiteList = new LinkedList<>();
+ List<String[]> multiEntryWhiteList = new LinkedList<>();
+ List<String[]> domainWhiteList = new LinkedList<>();
+ List<String[]> thirdPartyDomainWhiteList = new LinkedList<>();
+ List<String> mainBlockList = new LinkedList<>();
+ List<String> initialBlockList = new LinkedList<>();
+ List<String> finalBlockList = new LinkedList<>();
+ List<String> thirdPartyBlockList = new LinkedList<>();
+ List<String> thirdPartyInitialBlockList = new LinkedList<>();
+ List<String[]> multiEntryBlockList = new LinkedList<>();
+ List<String[]> multiEntryInitialBlockList = new LinkedList<>();
+ List<String[]> multiEntryFinalBlockList = new LinkedList<>();
+ List<String[]> domainBlockList = new LinkedList<>();
+ List<String[]> domainInitialBlockList = new LinkedList<>();
+ List<String[]> domainFinalBlockList = new LinkedList<>();
+ List<String[]> domainRegularExpressionBlockList = new LinkedList<>();
+ List<String[]> thirdPartyMultiEntryBlockList = new LinkedList<>();
+ List<String[]> thirdPartyMultiEntryInitialBlockList = new LinkedList<>();
+ List<String[]> thirdPartyDomainBlockList = new LinkedList<>();
+ List<String> regularExpressionBlockList = new LinkedList<>();
+ List<String> thirdPartyRegularExpressionBlockList = new LinkedList<>();
+
+ // Populate the block lists.
+ try {
+ // Load `easylist.txt` into a `BufferedReader`.
+ BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(getAssets().open("easylist.txt")));
+
+ // Create a string for storing the block list entries.
+ String blockListEntry;
+
+ // Parse EasyList.
+ while ((blockListEntry = bufferedReader.readLine()) != null) {
+ // Remove any `^` from the block list entry. Privacy Browser does not process them in the interest of efficiency.
+ blockListEntry = blockListEntry.replace("^", "");
+
+ //noinspection StatementWithEmptyBody
+ if (blockListEntry.contains("##") || blockListEntry.contains("#?#") || blockListEntry.contains("#@#") || blockListEntry.startsWith("[")) {
+ // Entries that contain `##`, `#?#`, and `#@#` are for hiding elements in the main page's HTML. Entries that start with `[` describe the AdBlock compatibility level.
+
+ // Do nothing. Privacy Browser does not currently use these entries.
+
+ //Log.i("BlackLists", "Not added: " + adBlockerEntry);
+ } else if (blockListEntry.startsWith("!")){ // Entries that begin with `!` are comments.
+ if (blockListEntry.startsWith("! Version:")) {
+ // Store the EasyList version number.
+ easyListVersion = blockListEntry.substring(11);
+ }
+
+ //Log.i("BlackLists", "Not added: " + adBlockerEntry);
+ } else if (blockListEntry.startsWith("@@")) { // Entries that begin with `@@` are whitelists.
+ // Remove the `@@`
+ blockListEntry = blockListEntry.substring(2);
+
+ // Strip out an initial `||` Privacy Browser doesn't differentiate against items that only match against the end of the domain name.
+ if (blockListEntry.startsWith("||")) {
+ blockListEntry = blockListEntry.substring(2);
+ }
+
+ // TODO
+
+ // mainWhiteList.add(blockListEntry);
+
+ // Log.i("BlockLists", "Main white list added: " + blockListEntry);
+ } else if (blockListEntry.endsWith("|")){ // Entries that end with `|` match against the end of the URL.
+ // Strip out the final "|"
+ blockListEntry = blockListEntry.substring(0, blockListEntry.length() - 1);
+
+ // Strip out any initial `||`. They are redundant in this case because the block list entry is being matched against the end of the URL.
+ if (blockListEntry.startsWith("||")) {
+ blockListEntry = blockListEntry.substring(2);
+ }
+
+ if (blockListEntry.contains("*")) { // Process a double final entry.
+ int wildcardIndex = blockListEntry.indexOf("*");
+
+ String firstEntry = blockListEntry.substring(0, wildcardIndex);
+ String secondEntry = blockListEntry.substring(wildcardIndex + 1);
+
+
+ String[] doubleEntry = {firstEntry, secondEntry};
+
+ multiEntryFinalBlockList.add(doubleEntry);
+
+ //Log.i("BlockLists", "Multi entry final block list added: " + firstEntry + " , " + secondEntry).
+ } else { // Process a standard final entry.
+ finalBlockList.add(blockListEntry);
+
+ //Log.i("BlockLists", "Final block list added: " + blockListEntry);
+ }
+ } else if (blockListEntry.contains("$")) { // Entries that contain `$` use filter options.
+ // Strip out any initial `||`. These will be treated like any other entry.
+ if (blockListEntry.startsWith("||")) {
+ blockListEntry = blockListEntry.substring(2);
+ }
+
+ if (blockListEntry.contains("third-party")) { // Process third party blocklist entries.
+ //noinspection StatementWithEmptyBody
+ if (blockListEntry.contains("~third-party")) { // Process third-party white list entries.
+ // Do not process these white list entries. They are designed to combine with block filters that Privacy Browser doesn't use, like `subdocument` and `xmlhttprequest`.
+
+ // Log.i("BlockLists", "Not added: " + blockListEntry);
+ } else if (blockListEntry.contains("domain=")) { // Process third-party domain block list entries.
+ if (blockListEntry.startsWith("|")) { // Third-party domain initial block list entries.
+
+ } else if (blockListEntry.contains("\\")) { // Third-party domain regular expressions.
+
+ } else { // Third-party domain entries.
+ // Parse the entry
+ String entry = blockListEntry.substring(0, blockListEntry.indexOf("$"));
+ String filters = blockListEntry.substring(blockListEntry.indexOf("$") + 1);
+ String domains = filters.substring(filters.indexOf("domain=") + 7);
+
+ // Strip any trailing "*" on the entries.
+ if (entry.endsWith("*")) {
+ entry = entry.substring(0, entry.length() - 1);
+ }
+
+ if (entry.contains("*")) { // Third-party domain multi-entry.
+
+ } else { // Third-party domain single entry.
+
+ boolean whiteListDomain = false;
+
+ // Process each domain.
+ do {
+ String domain;
+
+ if (domains.contains("|")) {
+ // Get the first domain
+ domain = domains.substring(0, domains.indexOf("|"));
+
+ // Remove the first domain from the list.
+ domains = domains.substring(domains.indexOf("|") + 1);
+ } else {
+ domain = domains;
+ }
+
+ // Differentiate between block list domains and white list domains.
+ if (domain.startsWith("~")) { // White list third-party domain entry.
+ // Strip the initial `~`.
+ domain = domain.substring(1);
+
+ // Set the white list domain flag and store the domain.
+ whiteListDomain = true;
+
+ // Create the domain entry.
+ String[] domainEntry = {domain, entry};
+
+ // Add the entry to the third-party domain white list.
+ thirdPartyDomainWhiteList.add(domainEntry);
+
+ Log.i("BlockLists", "Third-party domain white list added: " + domain + " , " + entry);
+ } else { // Block list third-party domain entry.
+ String[] domainEntry = {domain, entry};
+
+ thirdPartyDomainBlockList.add(domainEntry);
+
+ // Log.i("BlockLists", "Third-party domain block list added: " + domain + " , " + entry);
+ }
+ } while (domains.contains("|"));
+
+ // Add a third-party block list entry if a white list domain was processed.
+ if (whiteListDomain) {
+ // Add an entry to the third-party block list.
+ thirdPartyBlockList.add(entry);
+
+ Log.i("BlockLists", "Third-party block list added: " + entry);
+ }
+ }
+ }
+ } else if (blockListEntry.startsWith("|")) { // Third-party initial block list entries.
+ // Strip the initial `|`.
+ blockListEntry = blockListEntry.substring(1);
+
+ // Get the entry.
+ String entry = blockListEntry.substring(0, blockListEntry.indexOf("$"));
+
+ if (entry.contains("*")) { // Process a third-party multi-entry initial block list.
+ int wildcardIndex = entry.indexOf("*");
+
+ String firstEntry = entry.substring(0, wildcardIndex);
+ String secondEntry = entry.substring(wildcardIndex + 1);
+
+ String[] thirdPartyDoubleEntry = {firstEntry, secondEntry};
+
+ thirdPartyMultiEntryInitialBlockList.add(thirdPartyDoubleEntry);
+
+ //Log.i("BlockLists", "Third-party multi-entry initial block list added: " + firstEntry + " , " + secondEntry);
+ } else {
+ thirdPartyInitialBlockList.add(entry);
+
+ //Log.i("BlockLists", "Third-party initial block list added: " + entry);
+ }
+ } else if (blockListEntry.contains("*")) { // Process third-party multi-entry or regular expression blocklist entries.
+ // Get the entry.
+ String entry = blockListEntry.substring(0, blockListEntry.indexOf("$"));
+
+ if (entry.endsWith("*")) {
+ // Strip the final `*`.
+ entry = entry.substring(0, entry.length() - 1);
+
+ // Add the entry to the block list.
+ thirdPartyBlockList.add(entry);
+
+ //Log.i("BlockLists", "Third party block list added: " + entry);
+ } else if (entry.contains("\\")) { // Process a third-party regular expression.
+ // Add the entry to the third-party regular expression block list.
+ thirdPartyRegularExpressionBlockList.add(entry);
+
+ //Log.i("BlockLists", "Third-party regular expression block list added: " + entry);
+ } else { // There are two or more entries.
+ int wildcardIndex = entry.indexOf("*");
+
+ String firstEntry = entry.substring(0, wildcardIndex);
+ String secondEntry = entry.substring(wildcardIndex + 1);
+
+ if (secondEntry.contains("*")) { // there are three or more entries.
+ int secondWildcardIndex = secondEntry.indexOf("*");
+
+ String realSecondEntry = secondEntry.substring(0, secondWildcardIndex);
+ String thirdEntry = secondEntry.substring(secondWildcardIndex + 1);
+
+ if (thirdEntry.contains("*")) { // Process a third-party quadruple entry.
+ int thirdWildcardIndex = thirdEntry.indexOf("*");
+
+ String realThirdEntry = thirdEntry.substring(0, thirdWildcardIndex);
+ String fourthEntry = thirdEntry.substring(thirdWildcardIndex + 1);
+
+ String[] thirdPartyQuadrupleEntry = {firstEntry, realSecondEntry, realThirdEntry, fourthEntry};
+
+ thirdPartyMultiEntryBlockList.add(thirdPartyQuadrupleEntry);
+
+ //Log.i("BlockLists", "Third-party multi-entry block list added: " + firstEntry + " , " + realSecondEntry + " , " + realThirdEntry + " , " + fourthEntry);
+ } else { // Process a third-party triple entry.
+ String[] thirdPartyTripleEntry = {firstEntry, realSecondEntry, thirdEntry};
+
+ thirdPartyMultiEntryBlockList.add(thirdPartyTripleEntry);
+
+ //Log.i("BlockLists", "Third-party multi-entry block list added: " + firstEntry + " , " + realSecondEntry + " , " + thirdEntry);
+ }
+ } else { // Process a third-party double entry.
+ String[] thirdPartyDoubleEntry = {firstEntry, secondEntry};
+
+ thirdPartyMultiEntryBlockList.add(thirdPartyDoubleEntry);
+
+ //Log.i("BlockLists", "Third-party multi-entry block list added: " + firstEntry + " , " + secondEntry);
+ }
+ }
+ } else { // Process standard third party entries.
+ // Get the entry.
+ String entry = blockListEntry.substring(0, blockListEntry.indexOf("$"));
+
+ // Add the entry to the block list.
+ thirdPartyBlockList.add(entry);
+
+ //Log.i("BlockLists", "Third party block list added: " + entry);
+ }
+ } else if (blockListEntry.substring(blockListEntry.indexOf("$")).contains("domain")) {
+ if (blockListEntry.contains("~")) { // Whitelist.
+ // Separate the filters.
+ String entry = blockListEntry.substring(0, blockListEntry.indexOf("$"));
+ String filters = blockListEntry.substring(blockListEntry.indexOf("$") + 1);
+ String domains = filters.substring(filters.indexOf("domain=") + 7);
+
+ // Strip any final `*` from the entry. They are redundant.
+ if (entry.endsWith("*")) {
+ entry = entry.substring(0, entry.length() - 1);
+ }
+
+ // Process each domain.
+ do {
+ String domain;
+
+ if (domains.contains("|")) {
+ // Get the first domain
+ domain = domains.substring(0, domains.indexOf("|"));
+
+ // Remove the first domain from the list.
+ domains = domains.substring(domains.indexOf("|") + 1);
+ } else {
+ domain = domains;
+ }
+
+ // Strip the initial `~`.
+ domain = domain.substring(1);
+
+ if (entry.contains("*")) { // Process a double entry.
+ int wildcardIndex = entry.indexOf("*");
+
+ String firstEntry = entry.substring(0, wildcardIndex);
+ String secondEntry = entry.substring(wildcardIndex + 1);
+
+ String[] domainDoubleEntry = {firstEntry, secondEntry};
+
+ domainWhiteList.add(domainDoubleEntry);
+
+ //Log.i("BlockLists", "Domain white list added: " + domain + " , " + firstEntry + " , " + secondEntry);
+ } else { // Process a single entry.
+ String[] domainEntry = {domain, entry};
+
+ domainWhiteList.add(domainEntry);
+
+ //Log.i("BlockLists", "Domain white list added: " + domain + " , " + entry);
+ }
+ } while (domains.contains("|"));
+ } else { // The block list entry contains a domain, but not a third party designation and isn't a whitelist.
+ // Separate the filters.
+ String entry = blockListEntry.substring(0, blockListEntry.indexOf("$"));
+ String filters = blockListEntry.substring(blockListEntry.indexOf("$") + 1);
+ String domains = filters.substring(filters.indexOf("domain=") + 7);
+
+ // Only process the block list item if the entry is not null. Some lines in EasyList begin with `$websocket`, which create a null entry.
+ if (!entry.equals("")) {
+ do {
+ String domain;
+
+ if (domains.contains("|")) {
+ // Get the first domain.
+ domain = domains.substring(0, domains.indexOf("|"));
+
+ // Remove the first domain from the list.
+ domains = domains.substring(domains.indexOf("|") + 1);
+ } else {
+ domain = domains;
+ }
+
+ if (entry.contains("*")) {
+ int wildcardIndex = entry.indexOf("*");
+
+ String firstEntry = entry.substring(0, wildcardIndex);
+ String secondEntry = entry.substring(wildcardIndex + 1);
+
+ String[] domainDoubleEntry = {domain, firstEntry, secondEntry};
+
+ domainBlockList.add(domainDoubleEntry);
+
+ //Log.i("BlockLists", "Domain double entry block list added: " + domain + " , " + firstEntry + " , " + secondEntry);
+ } else if (entry.startsWith("|")) {
+ // Remove the initial `|`;
+ String entryBase = entry.substring(1);
+
+ //noinspection StatementWithEmptyBody
+ if (entryBase.equals("http://") || entryBase.equals("https://")) {
+ // Do nothing. These entries will entirely block the website.
+ // Often the original entry blocks `$script` but Privacy Browser does not currently differentiate between scripts and other entries.
+ } else {
+ String[] domainEntry = {domain, entryBase};
+
+ domainInitialBlockList.add(domainEntry);
+
+ //Log.i("BlockLists", "Domain initial block list added: " + domain + " , " + entryBase);
+ }
+ } else if (entry.endsWith("|")) {
+ // Remove the final `|`.
+ String entryBase = entry.substring(0, entry.length() - 1);
+
+ String[] domainEntry = {domain, entryBase};
+
+ domainFinalBlockList.add(domainEntry);
+
+ //Log.i("BlockLists", "Domain final block list added: " + domain + " , " + entryBase);
+ } else if (entry.contains("\\")) {
+ String[] domainEntry = {domain, entry};
+
+ domainRegularExpressionBlockList.add(domainEntry);
+
+ // Log.i("BlockLists", "Domain regular expression block list added: " + domain + " , " + entry);
+ } else {
+ String[] domainEntry = {domain, entry};
+
+ domainBlockList.add(domainEntry);
+
+ //Log.i("BlockLists", "Domain block list added: " + domain + " , " + entry);
+ }
+ } while (domains.contains("|"));
+ }
+ }
+ } else if (blockListEntry.contains("~")) { // Whitelist entries.
+ // Remove the filter options.
+ blockListEntry = blockListEntry.substring(0, blockListEntry.indexOf("$"));
+
+ // Strip any trailing `*`.
+ if (blockListEntry.endsWith("*")) {
+ blockListEntry = blockListEntry.substring(0, blockListEntry.length() -1);
+ }
+
+ if (blockListEntry.contains("*")) {
+ int wildcardIndex = blockListEntry.indexOf("*");
+
+ String firstEntry = blockListEntry.substring(0, wildcardIndex);
+ String secondEntry = blockListEntry.substring(wildcardIndex + 1);
+
+
+ String[] doubleEntry = {firstEntry, secondEntry};
+
+ multiEntryWhiteList.add(doubleEntry);
+
+ //Log.i("BlockLists", "Multi entry white list added: " + firstEntry + " , " + secondEntry);
+ } else {
+ mainWhiteList.add(blockListEntry);
+
+ // Log.i("BlockLists", "Main white list added: " + blockListEntry);
+ }
+ } else if (blockListEntry.contains("\\")) { // Regular expressions.
+ // Remove the filter options.
+ blockListEntry = blockListEntry.substring(0, blockListEntry.indexOf("$"));
+
+ regularExpressionBlockList.add(blockListEntry);
+
+ //Log.i("BlockLists", "Regular expression list added: " + blockListEntry);
+ } else {
+ // Remove the filter options.
+ blockListEntry = blockListEntry.substring(0, blockListEntry.indexOf("$"));
+
+ // Strip any trailing `*`. These are redundant.
+ if (blockListEntry.endsWith("*")) {
+ blockListEntry = blockListEntry.substring(0, blockListEntry.length() - 1);
+ }
+
+ if (blockListEntry.contains("*")) { // Use a multi entry list.
+ int wildcardIndex = blockListEntry.indexOf("*");
+
+ String firstEntry = blockListEntry.substring(0, wildcardIndex);
+ String secondEntry = blockListEntry.substring(wildcardIndex + 1);
+
+ // Remove `.*` if it appears at the beginning of the second entry.
+ if (secondEntry.startsWith(".*")) {
+ secondEntry = secondEntry.substring(2);
+ }
+
+ // Create a third entry if required.
+ if (secondEntry.contains("*")) {
+ wildcardIndex = secondEntry.indexOf("*");
+
+ String thirdEntry = secondEntry.substring(wildcardIndex + 1);
+ secondEntry = secondEntry.substring(0, wildcardIndex);
+
+
+ if (thirdEntry.endsWith("|")) {
+ thirdEntry = thirdEntry.substring(0, thirdEntry.length() - 1);
+
+ String[] tripleEntry = {firstEntry, secondEntry, thirdEntry};
+
+ multiEntryFinalBlockList.add(tripleEntry);
+
+ //Log.i("BlockLists", "Multi entry final tripple block list added: " + firstEntry + " , " + secondEntry + " , " + thirdEntry);
+ } else {
+ String[] tripleEntry = {firstEntry, secondEntry, thirdEntry};
+
+ multiEntryBlockList.add(tripleEntry);
+
+ // Log.i("BlockLists", "Multi entry tripple block list added: " + firstEntry + " , " + secondEntry + " , " + thirdEntry);
+ }
+ } else { // This is a double entry.
+ if (firstEntry.startsWith("|")) {
+ String[] doubleEntry = {firstEntry.substring(1), secondEntry};
+
+ multiEntryInitialBlockList.add(doubleEntry);
+
+ //Log.i("BlockLists", "Multi entry initial block list added: " + firstEntry.substring(1) + " , " + secondEntry);
+ } else {
+ String[] doubleEntry = {firstEntry, secondEntry};
+
+ multiEntryBlockList.add(doubleEntry);
+
+ //Log.i("BlockLists", "Multi entry block list added: " + firstEntry + " , " + secondEntry);
+ }
+ }
+ } else if (blockListEntry.startsWith("|")) { // Populate the initial block list.
+ // Strip the initial `|`.
+ blockListEntry = blockListEntry.substring(1);
+
+ // Populate the initial block list.
+ initialBlockList.add(blockListEntry);
+
+ //Log.i("BlockLists", "Initial block list added: " + blockListEntry);
+ } else { // Populate the main block list.
+ mainBlockList.add(blockListEntry);
+
+ //Log.i("BlockLists", "Main block list added: " + blockListEntry);
+ }
+ }
+ } else { // Populate the standard lists.
+ // Strip out any initial `||`. These will be treated like any other entry.
+ if (blockListEntry.startsWith("||")) {
+ blockListEntry = blockListEntry.substring(2);
+ }
+
+ // Strip out any initial `*`.
+ if (blockListEntry.startsWith("*")) {
+ blockListEntry = blockListEntry.substring(1);
+ }
+
+ // Strip out any trailing `*`.
+ if (blockListEntry.endsWith("*")) {
+ blockListEntry = blockListEntry.substring(0, blockListEntry.length() - 1);
+ }
+
+ if (blockListEntry.contains("*")) { // Entries that contain a `*` in the middle have to be treated specially.
+ int wildcardIndex = blockListEntry.indexOf("*");
+
+ String firstEntry = blockListEntry.substring(0, wildcardIndex);
+ String secondEntry = blockListEntry.substring(wildcardIndex + 1);
+
+ // Remove `.*` if it appears at the beginning of the second entry.
+ if (secondEntry.startsWith(".*")) {
+ secondEntry = secondEntry.substring(2);
+ }
+
+ // Create a third entry if required.
+ if (secondEntry.contains("*")) {
+ wildcardIndex = secondEntry.indexOf("*");
+
+ String thirdEntry = secondEntry.substring(wildcardIndex + 1);
+ secondEntry = secondEntry.substring(0, wildcardIndex);
+
+ String[] tripleEntry = {firstEntry, secondEntry, thirdEntry};
+
+ multiEntryBlockList.add(tripleEntry);
+
+ //Log.i("BlockLists", "Multi entry tripple block list added: " + firstEntry + " , " + secondEntry + " , " + thirdEntry);
+ } else {
+ if (firstEntry.startsWith("|")) {
+ String[] doubleEntry = {firstEntry.substring(1), secondEntry};
+
+ multiEntryInitialBlockList.add(doubleEntry);
+
+ //Log.i("BlockLists", "Multi entry initial block list added: " + firstEntry.substring(1) + " , " + secondEntry);
+ } else {
+ String[] doubleEntry = {firstEntry, secondEntry};
+
+ multiEntryBlockList.add(doubleEntry);
+
+ //Log.i("BlockLists", "Multi entry block list added: " + firstEntry + " , " + secondEntry);
+ }
+ }
+ } else { // This is a basic entry.
+ // Add the modified block list entry to the main block list.
+ mainBlockList.add(blockListEntry);
+
+ //Log.i("BlockLists", "Main block list added: " + blockListEntry);
+ }
+ }
+ }
+
+ // Close `bufferedReader`.
+ bufferedReader.close();
+ } catch (IOException e) {
+ // The asset exists, so the `IOException` will never be thrown.
+ }
+
+ Log.i("BlockLists", "Finish populating block lists");
+
// Set the content view.
setContentView(R.layout.main_drawerlayout);
appBar.setCustomView(R.layout.url_app_bar);
appBar.setDisplayOptions(ActionBar.DISPLAY_SHOW_CUSTOM);
- // Initialize the `ForegroundColorSpans` and `StyleSpan` for highlighting `urlTextBox`. We have to use the deprecated `getColor()` until API >= 23.
+ // Initialize the foreground color spans for highlighting the URLs. We have to use the deprecated `getColor()` until API >= 23.
redColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.red_a700));
initialGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
finalGrayColorSpan = new ForegroundColorSpan(getResources().getColor(R.color.gray_500));
// Get a handle for `urlTextBox`.
- urlTextBox = appBar.getCustomView().findViewById(R.id.url_edittext);
+ urlTextBox = findViewById(R.id.url_edittext);
// Remove the formatting from `urlTextBar` when the user is editing the text.
- urlTextBox.setOnFocusChangeListener((v, hasFocus) -> {
+ urlTextBox.setOnFocusChangeListener((View v, boolean hasFocus) -> {
if (hasFocus) { // The user is editing `urlTextBox`.
// Remove the highlighting.
urlTextBox.getText().removeSpan(redColorSpan);
}
});
- // Set the `Go` button on the keyboard to load the URL in `urlTextBox`.
- urlTextBox.setOnKeyListener((v, keyCode, event) -> {
+ // Set the go button on the keyboard to load the URL in `urlTextBox`.
+ urlTextBox.setOnKeyListener((View v, int keyCode, KeyEvent event) -> {
// If the event is a key-down event on the `enter` button, load the URL.
if ((event.getAction() == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) {
// Load the URL into the mainWebView and consume the event.
// Set `rootCoordinatorLayout` to fit under the status and navigation bars.
rootCoordinatorLayout.setFitsSystemWindows(false);
- if (translucentNavigationBarOnFullscreen) { // There is an Android Support Library bug that causes a scrim to print on the right side of the `Drawer Layout` when the navigation bar is displayed on the right of the screen.
+ // 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.
+ if (translucentNavigationBarOnFullscreen) {
// Set the navigation bar to be translucent.
getWindow().addFlags(WindowManager.LayoutParams.FLAG_TRANSLUCENT_NAVIGATION);
}
// The `DrawerListener` allows us to update the Navigation Menu.
drawerLayout.addDrawerListener(new DrawerLayout.DrawerListener() {
@Override
- public void onDrawerSlide(View drawerView, float slideOffset) {
+ public void onDrawerSlide(@NonNull View drawerView, float slideOffset) {
}
@Override
- public void onDrawerOpened(View drawerView) {
+ public void onDrawerOpened(@NonNull View drawerView) {
}
@Override
- public void onDrawerClosed(View drawerView) {
+ public void onDrawerClosed(@NonNull View drawerView) {
}
@Override
// drawerToggle creates the hamburger icon at the start of the AppBar.
drawerToggle = new ActionBarDrawerToggle(this, drawerLayout, supportAppBar, R.string.open_navigation_drawer, R.string.close_navigation_drawer);
- // Initialize `adServerSet`.
- final Set<String> adServersSet = new HashSet<>();
-
- // Load the list of ad servers into memory.
- try {
- // Load `pgl.yoyo.org_adservers.txt` into a `BufferedReader`.
- BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(getAssets().open("pgl.yoyo.org_adservers.txt")));
-
- // Create a string for storing each ad server.
- String adServer;
-
- // Populate `adServersSet`.
- while ((adServer = bufferedReader.readLine()) != null) {
- adServersSet.add(adServer);
- }
-
- // Close `bufferedReader`.
- bufferedReader.close();
- } catch (IOException ioException) {
- // We're pretty sure the asset exists, so we don't need to worry about the `IOException` ever being thrown.
- }
-
mainWebView.setWebViewClient(new WebViewClient() {
// `shouldOverrideUrlLoading` makes this `WebView` the default handler for URLs inside the app, so that links are not kicked out to other apps.
// We have to use the deprecated `shouldOverrideUrlLoading` until API >= 24.
}
}
- // Block ads. We have to use the deprecated `shouldInterceptRequest` until minimum API >= 21.
+ // Check requests against the block lists. The deprecated `shouldInterceptRequest` must be used until minimum API >= 21.
@SuppressWarnings("deprecation")
@Override
public WebResourceResponse shouldInterceptRequest(WebView view, String url){
- if (adBlockerEnabled) { // Block ads.
- // Extract the host from `url`.
+ if (adBlockerEnabled) { // Check the block lists.
+ Log.i("BlockLists", "Begin check for " + url);
+
+ Uri currentUri = Uri.parse(formattedUrlString);
+ String currentDomain = currentUri.getHost();
+
Uri requestUri = Uri.parse(url);
- String requestHost = requestUri.getHost();
+ String requestDomain = requestUri.getHost();
+
+ boolean thirdPartyRequest = !requestDomain.equals(currentDomain);
+
+ WebResourceResponse emptyWebResourceResponse = new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
+
+ for (String whiteListEntry : mainWhiteList) {
+ if (url.contains(whiteListEntry)) {
+ Log.i("BlockLists", "Request allowed by main white list: " + whiteListEntry + " | " + url);
+
+ // `Return null` loads the requested resource.
+ return null;
+ }
+ }
+
+ for (String[] whiteListEntry : multiEntryWhiteList) {
+ if (whiteListEntry.length == 2) { // There are two entries.
+ if (url.contains(whiteListEntry[0]) && url.contains(whiteListEntry[1])) {
+ Log.i("BlockLists", "Request allowed by multi entry white list: " + whiteListEntry[0] + " , " + whiteListEntry[1] + " | " + url);
+
+ // `Return null` loads the requested resource.
+ return null;
+ }
+ } else { // There are three entries.
+ if (url.contains(whiteListEntry[0]) && url.contains(whiteListEntry[1]) && url.contains(whiteListEntry[2])) {
+ Log.i("BlockLists", "Request allowed by multi entry white list: " + whiteListEntry[0] + " , " + whiteListEntry[1] + " , " + whiteListEntry[2] + " | " + url);
+
+ // `Return null` loads the requested resource.
+ return null;
+ }
+ }
+ }
+
+ for (String[] whiteListEntry : domainWhiteList) {
+ if (requestDomain.endsWith(whiteListEntry[0]) && url.contains(whiteListEntry[1])) {
+ Log.i("BlockLists", "Request allowed by domain white list: " + whiteListEntry[0] + " , " + whiteListEntry[1] + " | " + url);
+
+ // `Return null` loads the requested resource.
+ return null;
+ }
+ }
+
+ // Only check the third-party white lists if this is a third-party request.
+ if (thirdPartyRequest) {
+ for (String[] whiteListEntry : thirdPartyDomainWhiteList) {
+ if (requestDomain.endsWith(whiteListEntry[0]) && url.contains(whiteListEntry[1])) {
+ Log.i("BlockLists", "Request allowed by third-party domain white list: " + whiteListEntry[0] + " , " + whiteListEntry[1] + " | " + url);
+
+ // `Return null` loads the requested resource.
+ return null;
+ }
+ }
+ }
+
+ for (String blockListEntry : mainBlockList) {
+ if (url.contains(blockListEntry)) {
+ Log.i("BlockLists", "Request blocked by main block list: " + blockListEntry + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ for (String blockListEntry : initialBlockList) {
+ if (url.startsWith(blockListEntry)) {
+ Log.i("BlockLists", "Request blocked by initial block list: " + blockListEntry + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ for (String blockListEntry : finalBlockList) {
+ if (url.endsWith(blockListEntry)) {
+ Log.i("BlockLists", "Request blocked by final block list: " + blockListEntry + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ for (String[] blockListEntry : multiEntryBlockList) {
+ if (blockListEntry.length == 2) { // There are two entries.
+ if (url.contains(blockListEntry[0]) && url.contains(blockListEntry[1])) {
+ Log.i("BlockLists", "Request blocked by multi entry block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " | " + url);
- // Initialize a variable to track if this is an ad server.
- boolean requestHostIsAdServer = false;
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ } else { // There are three entries.
+ if (url.contains(blockListEntry[0]) && url.contains(blockListEntry[1]) && url.contains(blockListEntry[2])) {
+ Log.i("BlockLists", "Request blocked by multi entry block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " , " + blockListEntry[2] + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+ }
+
+ for (String[] blockListEntry : multiEntryInitialBlockList) {
+ if (url.startsWith(blockListEntry[0]) && url.contains(blockListEntry[1])) {
+ Log.i("BlockLists", "Request blocked by multi entry initial block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ for (String[] blockListEntry : multiEntryFinalBlockList) {
+ if (url.contains(blockListEntry[0]) && url.endsWith(blockListEntry[1])) {
+ Log.i("BlockLists", "Request blocked by multi entry final block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " | " + url);
- // Check all the subdomains of `requestHost` if it is not `null` against the ad server database.
- if (requestHost != null) {
- while (requestHost.contains(".") && !requestHostIsAdServer) { // Stop checking if we run out of `.` or if we already know that `requestHostIsAdServer` is `true`.
- if (adServersSet.contains(requestHost)) {
- requestHostIsAdServer = true;
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ for (String[] blockListEntry : domainBlockList) {
+ if (blockListEntry.length == 2) { // There is one entry.
+ if (requestDomain.endsWith(blockListEntry[0]) && url.contains(blockListEntry[1])) {
+ Log.i("BlockLists", "Request blocked by domain block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ } else { // There are two entries.
+ if (requestDomain.endsWith(blockListEntry[0]) && url.contains(blockListEntry[1]) && url.contains(blockListEntry[2])) {
+ Log.i("BlockLists", "Request blocked by domain block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " , " + blockListEntry[2] + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
}
+ }
+ }
+
+ for (String[] blockListEntry : domainInitialBlockList) {
+ if (requestDomain.endsWith(blockListEntry[0]) && url.startsWith(blockListEntry[1])) {
+ Log.i("BlockLists", "Request blocked by domain initial block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ for (String[] blockListEntry : domainFinalBlockList) {
+ if (requestDomain.endsWith(blockListEntry[0]) && url.endsWith(blockListEntry[2])) {
+ Log.i("BlockLists", "Request blocked by domain final block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " | " + url);
- // Strip out the lowest subdomain of `requestHost`.
- requestHost = requestHost.substring(requestHost.indexOf(".") + 1);
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
}
}
- if (requestHostIsAdServer) { // It is an ad server.
- // Return an empty `WebResourceResponse`.
- return new WebResourceResponse("text/plain", "utf8", new ByteArrayInputStream("".getBytes()));
- } else { // It is not an ad server.
- // `return null` loads the requested resource.
- return null;
+ for (String[] blockListEntry : domainRegularExpressionBlockList) {
+ if (requestDomain.endsWith(blockListEntry[0]) && Pattern.matches(blockListEntry[1], url)) {
+ Log.i("BlockLists", "Request blocked by domain regular expression block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
}
+
+ // Only check the third-party block lists if this is a third-party request.
+ if (thirdPartyRequest) {
+ for (String blockListEntry : thirdPartyBlockList) {
+ if (url.contains(blockListEntry)) {
+ Log.i("BlockLists", "Request blocked by third-party block list: " + blockListEntry + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ for (String blockListEntry : thirdPartyInitialBlockList) {
+ if (url.startsWith(blockListEntry)) {
+ Log.i("BlockLists", "Request blocked by third-party initial block list: " + blockListEntry + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ for (String[] blockListEntry : thirdPartyMultiEntryBlockList) {
+ switch (blockListEntry.length) {
+ case 2: // There are two entries.
+ if (url.contains(blockListEntry[0]) && url.contains(blockListEntry[1])) {
+ Log.i("BlockLists", "Request blocked by third-party multi-entry block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ break;
+
+ case 3: // There are three entries.
+ if (url.contains(blockListEntry[0]) && url.contains(blockListEntry[1]) && url.contains(blockListEntry[2])) {
+ Log.i("BlockLists", "Request blocked by third-party multi-entry block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " , " + blockListEntry[2] +
+ " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ break;
+
+ case 4: // There are four entries.
+ if (url.contains(blockListEntry[0]) && url.contains(blockListEntry[1]) && url.contains(blockListEntry[2]) && url.contains(blockListEntry[3])) {
+ Log.i("BlockLists", "Request blocked by third-party multi-entry block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " , " + blockListEntry[2] +
+ " , " + blockListEntry[3] + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ break;
+ }
+ }
+
+ for (String[] blockListEntry : thirdPartyMultiEntryInitialBlockList) {
+ if (url.startsWith(blockListEntry[0]) && url.contains(blockListEntry[1])) {
+ Log.i("BlockLists", "Request blocked by third-party multi-entry initial block list");
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ for (String[] blockListEntry : thirdPartyDomainBlockList) {
+ if (blockListEntry.length == 2) { // There is one entry.
+ if (requestDomain.endsWith(blockListEntry[0]) && url.contains(blockListEntry[1])) {
+ Log.i("BlockLists", "Request blocked by third-party domain block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ } else { // There are two entries.
+ if (requestDomain.endsWith(blockListEntry[0]) && url.contains(blockListEntry[1]) && url.contains(blockListEntry[2])) {
+ Log.i("BlockLists", "Request blocked by third-party domain block list: " + blockListEntry[0] + " , " + blockListEntry[1] + " , " + blockListEntry[2] + " | " +
+ url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+ }
+
+ for (String blockListEntry : thirdPartyRegularExpressionBlockList) {
+ if (Pattern.matches(blockListEntry, url)) {
+ Log.i("BlockLists", "Request blocked by third-party regular expression block list: " + blockListEntry + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+ }
+
+ for (String blockListEntry : regularExpressionBlockList) {
+ if (Pattern.matches(blockListEntry, url)) {
+ Log.i("BlockLists", "Request blocked by regular expression block list: " + blockListEntry + " | " + url);
+
+ // Return an empty `WebResourceResponse`.
+ return emptyWebResourceResponse;
+ }
+ }
+
+ Log.i("BlockLists", "End check for " + url);
+
+ // `return null` loads the requested resource.
+ return null;
} else { // Ad blocking is disabled.
// `return null` loads the requested resource.
return null;
}
// Check to see if the pinned SSL certificate matches the current website certificate.
- if (!currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) || !currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) || !currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) ||
- !currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) || !currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) || !currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) ||
- !currentWebsiteSslStartDateString.equals(pinnedDomainSslStartDateString) || !currentWebsiteSslEndDateString.equals(pinnedDomainSslEndDateString)) { // The pinned SSL certificate doesn't match the current domain certificate.
+ if (!currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) || !currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) ||
+ !currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) || !currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) ||
+ !currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) || !currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) ||
+ !currentWebsiteSslStartDateString.equals(pinnedDomainSslStartDateString) || !currentWebsiteSslEndDateString.equals(pinnedDomainSslEndDateString)) {
+ // The pinned SSL certificate doesn't match the current domain certificate.
//Display the pinned SSL certificate mismatch `AlertDialog`.
AppCompatDialogFragment pinnedSslCertificateMismatchDialogFragment = new PinnedSslCertificateMismatchDialog();
pinnedSslCertificateMismatchDialogFragment.show(getSupportFragmentManager(), getString(R.string.ssl_certificate_mismatch));
// Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
if (pinnedDomainSslCertificate &&
- currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) && currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) && currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) &&
- currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) && currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) && currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) &&
- currentWebsiteSslStartDate.equals(pinnedDomainSslStartDate) && currentWebsiteSslEndDate.equals(pinnedDomainSslEndDate)) { // An SSL certificate is pinned and matches the current domain certificate.
+ currentWebsiteIssuedToCName.equals(pinnedDomainSslIssuedToCNameString) && currentWebsiteIssuedToOName.equals(pinnedDomainSslIssuedToONameString) &&
+ currentWebsiteIssuedToUName.equals(pinnedDomainSslIssuedToUNameString) && currentWebsiteIssuedByCName.equals(pinnedDomainSslIssuedByCNameString) &&
+ currentWebsiteIssuedByOName.equals(pinnedDomainSslIssuedByONameString) && currentWebsiteIssuedByUName.equals(pinnedDomainSslIssuedByUNameString) &&
+ currentWebsiteSslStartDate.equals(pinnedDomainSslStartDate) && currentWebsiteSslEndDate.equals(pinnedDomainSslEndDate)) {
+ // An SSL certificate is pinned and matches the current domain certificate.
// Proceed to the website without displaying an error.
handler.proceed();
} else { // Either there isn't a pinned SSL certificate or it doesn't match the current website certificate.
public void onProgressChanged(WebView view, int progress) {
// Inject the night mode CSS if night mode is enabled.
if (nightMode) {
- // `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 used by WordPress.
- // `text-decoration: none` removes all text underlines. `text-shadow: none` removes text shadows, which usually have a hard coded color. `border: none` removes all borders, which can also be used to underline text.
+ // `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
+ // used by WordPress. `text-decoration: none` removes all text underlines. `text-shadow: none` removes text shadows, which usually have a hard coded color.
+ // `border: none` removes all borders, which can also be used to underline text.
// `a {color: #1565C0}` sets links to be a dark blue. `!important` takes precedent over any existing sub-settings.
- mainWebView.evaluateJavascript("(function() {var parent = document.getElementsByTagName('head').item(0); var style = document.createElement('style'); style.type = 'text/css'; style.innerHTML = '" +
- "* {background-color: #212121 !important; color: #BDBDBD !important; box-shadow: none !important; text-decoration: none !important; text-shadow: none !important; border: none !important;}" +
- "a {color: #1565C0 !important;}" +
- "'; parent.appendChild(style)})()", value -> {
+ mainWebView.evaluateJavascript("(function() {var parent = document.getElementsByTagName('head').item(0); var style = document.createElement('style'); style.type = 'text/css'; " +
+ "style.innerHTML = '* {background-color: #212121 !important; color: #BDBDBD !important; box-shadow: none !important; text-decoration: none !important;" +
+ "text-shadow: none !important; border: none !important;} a {color: #1565C0 !important;}'; parent.appendChild(style)})()", value -> {
// Initialize a `Handler` to display `mainWebView`.
Handler displayWebViewHandler = new Handler();
});
}
+ // Update the progress bar.
progressBar.setProgress(progress);
+
+ // Set the visibility of the progress bar.
if (progress < 100) {
// Show the progress bar.
progressBar.setVisibility(View.VISIBLE);
progressBar.setVisibility(View.GONE);
// Display `mainWebView` if night mode is disabled.
- // 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 currently enabled.
+ // 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
+ // currently enabled.
if (!nightMode) {
mainWebView.setVisibility(View.VISIBLE);
}
registerForContextMenu(mainWebView);
// Allow the downloading of files.
- mainWebView.setDownloadListener((url, userAgent, contentDisposition, mimetype, contentLength) -> {
+ mainWebView.setDownloadListener((String url, String userAgent, String contentDisposition, String mimetype, long contentLength) -> {
// Show the `DownloadFileDialog` `AlertDialog` and name this instance `@string/download`.
AppCompatDialogFragment downloadFileDialogFragment = DownloadFileDialog.fromUrl(url, contentDisposition, contentLength);
downloadFileDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
privacyBrowserRuntime = Runtime.getRuntime();
// Store the application's private data directory.
- privateDataDirectoryString = getApplicationInfo().dataDir; // `dataDir` will vary, but will be something like `/data/user/0/com.stoutner.privacybrowser.standard`, which links to `/data/data/com.stoutner.privacybrowser.standard`.
+ privateDataDirectoryString = getApplicationInfo().dataDir;
+ // `dataDir` will vary, but will be something like `/data/user/0/com.stoutner.privacybrowser.standard`, which links to `/data/data/com.stoutner.privacybrowser.standard`.
// Initialize `inFullScreenBrowsingMode`, which is always false at this point because Privacy Browser never starts in full screen browsing mode.
inFullScreenBrowsingMode = false;
// Initialize `webViewTitle`.
webViewTitle = getString(R.string.no_title);
- // Initialize `favoriteIconBitmap`. We have to use `ContextCompat` until API >= 21.
+ // Initialize `favoriteIconBitmap`. `ContextCompat` must be used until API >= 21.
Drawable favoriteIconDrawable = ContextCompat.getDrawable(getApplicationContext(), R.drawable.world);
BitmapDrawable favoriteIconBitmapDrawable = (BitmapDrawable) favoriteIconDrawable;
+ assert favoriteIconBitmapDrawable != null;
favoriteIconDefaultBitmap = favoriteIconBitmapDrawable.getBitmap();
// If the favorite icon is null, load the default.
// Run all the other default commands.
super.onPrepareOptionsMenu(menu);
- // `return true` displays the menu.
+ // Display the menu.
return true;
}
// removeAllCookies is deprecated, but it is required for API < 21.
@SuppressWarnings("deprecation")
public boolean onOptionsItemSelected(MenuItem menuItem) {
+ // Get the selected menu item ID.
int menuItemId = menuItem.getItemId();
// Set the commands that relate to the menu entries.
// Show the Find on Page `RelativeLayout`.
findOnPageLinearLayout.setVisibility(View.VISIBLE);
- // Display the keyboard. We have to wait 200 ms before running the command to work around a bug in Android. http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
+ // Display the keyboard. We have to wait 200 ms before running the command to work around a bug in Android.
+ // http://stackoverflow.com/questions/5520085/android-show-softkeyboard-with-showsoftinput-is-not-working
findOnPageEditText.postDelayed(() -> {
// Set the focus on `findOnPageEditText`.
findOnPageEditText.requestFocus();
printManager.print(getString(R.string.privacy_browser_web_page), printDocumentAdapter, null);
return true;
+ case R.id.view_source:
+ // Launch the Vew Source activity.
+ Intent viewSourceIntent = new Intent(this, ViewSourceActivity.class);
+ startActivity(viewSourceIntent);
+ return true;
+
case R.id.add_to_homescreen:
// Show the `CreateHomeScreenShortcutDialog` `AlertDialog` and name this instance `R.string.create_shortcut`.
AppCompatDialogFragment createHomeScreenShortcutDialogFragment = new CreateHomeScreenShortcutDialog();
try {
// Delete the main cache directory.
privacyBrowserRuntime.exec("rm -rf " + privateDataDirectoryString + "/cache");
-
- // Delete the secondary `Service Worker` cache directory. We have to use a `String[]` because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
+ // Delete the secondary `Service Worker` cache directory.
+ // We have to use a `String[]` because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
privacyBrowserRuntime.exec(new String[] {"rm", "-rf", privateDataDirectoryString + "/app_webview/Service Worker/"});
} catch (IOException e) {
// Do nothing if an error is thrown.
adView = findViewById(R.id.adview);
}
- // `invalidateOptionsMenu` should recalculate the number of action buttons from the menu to display on the app bar, but it doesn't because of the this bug: https://code.google.com/p/android/issues/detail?id=20493#c8
+ // `invalidateOptionsMenu` should recalculate the number of action buttons from the menu to display on the app bar, but it doesn't because of the this bug:
+ // https://code.google.com/p/android/issues/detail?id=20493#c8
// ActivityCompat.invalidateOptionsMenu(this);
}
});
// Add a `Download Image` entry.
- menu.add(R.string.download_image).setOnMenuItemClickListener(item -> {
+ menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
// Show the `DownloadImageDialog` `AlertDialog` and name this instance `@string/download`.
AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
});
// Add a `Download Image` entry.
- menu.add(R.string.download_image).setOnMenuItemClickListener(item -> {
+ menu.add(R.string.download_image).setOnMenuItemClickListener((MenuItem item) -> {
// Show the `DownloadImageDialog` `AlertDialog` and name this instance `@string/download`.
AppCompatDialogFragment downloadImageDialogFragment = DownloadImageDialog.imageUrl(imageUrl);
downloadImageDialogFragment.show(getSupportFragmentManager(), getString(R.string.download));
formattedUrlString = searchURL + encodedUrlString;
}
+ // 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.
+ urlTextBox.clearFocus();
+
loadUrl(formattedUrlString);
}
}
private void applyAppSettings() {
- // Get a handle for `sharedPreferences`. `this` references the current context.
+ // Get a handle for the shared preferences.
SharedPreferences sharedPreferences = PreferenceManager.getDefaultSharedPreferences(this);
- // Store the values from `sharedPreferences` in variables.
+ // Store the values from the shared preferences in variables.
String homepageString = sharedPreferences.getString("homepage", "https://start.duckduckgo.com");
String torHomepageString = sharedPreferences.getString("tor_homepage", "https://3g2upl4pq6kufc4m.onion");
String torSearchString = sharedPreferences.getString("tor_search", "https://3g2upl4pq6kufc4m.onion/html/?q=");
cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
}
- // 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. <https://redmine.stoutner.com/issues/160>
+ // 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.
+ // <https://redmine.stoutner.com/issues/160>
if (!urlIsLoading) {
switch (userAgentString) {
case "System default user agent":
// Use the selected user agent.
mainWebView.getSettings().setUserAgentString(userAgentString);
}
+
+ // Store the applied user agent string.
+ appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
}
// 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.
cookieManager.setAcceptThirdPartyCookies(mainWebView, thirdPartyCookiesEnabled);
}
- // 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. <https://redmine.stoutner.com/issues/160>
+ // 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.
+ // <https://redmine.stoutner.com/issues/160>
if (!urlIsLoading) {
switch (defaultUserAgentString) {
case "WebView default user agent":
// Use the selected user agent.
mainWebView.getSettings().setUserAgentString(defaultUserAgentString);
}
+
+ // Store the applied user agent string.
+ appliedUserAgentString = mainWebView.getSettings().getUserAgentString();
}
// Set a transparent background on `urlTextBox`. We have to use the deprecated `.getDrawable()` until the minimum API >= 21.
}
}
- // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`. `this` references the current activity.
+ // `invalidateOptionsMenu` calls `onPrepareOptionsMenu()` and redraws the icons in the `AppBar`.
if (runInvalidateOptionsMenu) {
- ActivityCompat.invalidateOptionsMenu(this);
+ invalidateOptionsMenu();
}
}
private void highlightUrlText() {
String urlString = urlTextBox.getText().toString();
- if (urlString.startsWith("http://")) { // Highlight connections that are not encrypted.
+ if (urlString.startsWith("http://")) { // Highlight the protocol of connections that are not encrypted.
urlTextBox.getText().setSpan(redColorSpan, 0, 7, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
- } else if (urlString.startsWith("https://")) { // Highlight connections that are encrypted.
+ } else if (urlString.startsWith("https://")) { // De-emphasize the protocol of connections that are encrypted.
urlTextBox.getText().setSpan(initialGrayColorSpan, 0, 8, Spanned.SPAN_INCLUSIVE_INCLUSIVE);
}
projects / PrivacyBrowserAndroid.git / blobdiff