/*
- * Copyright 2015-2023 Soren Stoutner <soren@stoutner.com>.
+ * Copyright 2015-2024 Soren Stoutner <soren@stoutner.com>.
*
* Download cookie code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
*
- * This file is part of Privacy Browser Android <https://www.stoutner.com/privacy-browser-android>.
+ * This file is part of Privacy Browser Android <https://www.stoutner.com/privacy-browser-android/>.
*
* Privacy Browser Android is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
import android.webkit.WebStorage
import android.webkit.WebView
import android.webkit.WebViewClient
-import android.webkit.WebViewDatabase
import android.widget.AdapterView
import android.widget.ArrayAdapter
import android.widget.CheckBox
import android.widget.ListView
import android.widget.ProgressBar
import android.widget.RadioButton
+import android.widget.RadioGroup
import android.widget.RelativeLayout
import android.widget.TextView
import androidx.activity.OnBackPressedCallback
import androidx.activity.result.contract.ActivityResultContracts
import androidx.appcompat.app.ActionBar
-import androidx.appcompat.app.ActionBarDrawerToggle
import androidx.appcompat.app.AppCompatActivity
import androidx.appcompat.app.AppCompatDelegate
import androidx.appcompat.content.res.AppCompatResources
import androidx.appcompat.widget.Toolbar
import androidx.coordinatorlayout.widget.CoordinatorLayout
+import androidx.core.content.ContextCompat
import androidx.core.view.GravityCompat
import androidx.cursoradapter.widget.CursorAdapter
import androidx.drawerlayout.widget.DrawerLayout
import androidx.fragment.app.DialogFragment
import androidx.preference.PreferenceManager
+import androidx.recyclerview.widget.LinearLayoutManager
+import androidx.recyclerview.widget.RecyclerView
import androidx.swiperefreshlayout.widget.SwipeRefreshLayout
-import androidx.viewpager.widget.ViewPager
+import androidx.viewpager2.widget.ViewPager2
import androidx.webkit.WebSettingsCompat
import androidx.webkit.WebViewFeature
import com.google.android.material.tabs.TabLayout
import com.stoutner.privacybrowser.R
-import com.stoutner.privacybrowser.adapters.WebViewPagerAdapter
+import com.stoutner.privacybrowser.adapters.WebViewStateAdapter
import com.stoutner.privacybrowser.coroutines.GetHostIpAddressesCoroutine
-import com.stoutner.privacybrowser.coroutines.PopulateBlocklistsCoroutine
+import com.stoutner.privacybrowser.coroutines.PopulateFilterListsCoroutine
import com.stoutner.privacybrowser.coroutines.PrepareSaveDialogCoroutine
import com.stoutner.privacybrowser.coroutines.SaveUrlCoroutine
import com.stoutner.privacybrowser.coroutines.SaveWebpageImageCoroutine
import com.stoutner.privacybrowser.dialogs.ViewSslCertificateDialog
import com.stoutner.privacybrowser.dialogs.WaitingForProxyDialog
import com.stoutner.privacybrowser.fragments.WebViewTabFragment
-import com.stoutner.privacybrowser.helpers.BlocklistHelper
+import com.stoutner.privacybrowser.helpers.BOOKMARK_NAME
+import com.stoutner.privacybrowser.helpers.BOOKMARK_URL
+import com.stoutner.privacybrowser.helpers.COOKIES
+import com.stoutner.privacybrowser.helpers.DARK_THEME
+import com.stoutner.privacybrowser.helpers.DISABLED
+import com.stoutner.privacybrowser.helpers.DISPLAY_IMAGES
+import com.stoutner.privacybrowser.helpers.DOMAIN_NAME
+import com.stoutner.privacybrowser.helpers.ENABLE_DOM_STORAGE
+import com.stoutner.privacybrowser.helpers.ENABLE_EASYLIST
+import com.stoutner.privacybrowser.helpers.ENABLE_EASYPRIVACY
+import com.stoutner.privacybrowser.helpers.ENABLE_FANBOYS_ANNOYANCE_LIST
+import com.stoutner.privacybrowser.helpers.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST
+import com.stoutner.privacybrowser.helpers.ENABLE_JAVASCRIPT
+import com.stoutner.privacybrowser.helpers.ENABLE_ULTRAPRIVACY
+import com.stoutner.privacybrowser.helpers.ENABLED
+import com.stoutner.privacybrowser.helpers.FAVORITE_ICON
+import com.stoutner.privacybrowser.helpers.FOLDER_ID
+import com.stoutner.privacybrowser.helpers.FONT_SIZE
+import com.stoutner.privacybrowser.helpers.ID
+import com.stoutner.privacybrowser.helpers.IP_ADDRESSES
+import com.stoutner.privacybrowser.helpers.IS_FOLDER
+import com.stoutner.privacybrowser.helpers.LIGHT_THEME
+import com.stoutner.privacybrowser.helpers.PINNED_IP_ADDRESSES
+import com.stoutner.privacybrowser.helpers.PINNED_SSL_CERTIFICATE
+import com.stoutner.privacybrowser.helpers.REQUEST_ALLOWED
+import com.stoutner.privacybrowser.helpers.REQUEST_BLOCKED
+import com.stoutner.privacybrowser.helpers.REQUEST_DEFAULT
+import com.stoutner.privacybrowser.helpers.REQUEST_THIRD_PARTY
+import com.stoutner.privacybrowser.helpers.SSL_ISSUED_BY_COMMON_NAME
+import com.stoutner.privacybrowser.helpers.SSL_ISSUED_BY_ORGANIZATION
+import com.stoutner.privacybrowser.helpers.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT
+import com.stoutner.privacybrowser.helpers.SSL_ISSUED_TO_COMMON_NAME
+import com.stoutner.privacybrowser.helpers.SSL_ISSUED_TO_ORGANIZATION
+import com.stoutner.privacybrowser.helpers.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT
+import com.stoutner.privacybrowser.helpers.SWIPE_TO_REFRESH
+import com.stoutner.privacybrowser.helpers.SYSTEM_DEFAULT
+import com.stoutner.privacybrowser.helpers.WEBVIEW_THEME
+import com.stoutner.privacybrowser.helpers.WIDE_VIEWPORT
import com.stoutner.privacybrowser.helpers.BookmarksDatabaseHelper
+import com.stoutner.privacybrowser.helpers.CheckFilterListHelper
import com.stoutner.privacybrowser.helpers.DomainsDatabaseHelper
import com.stoutner.privacybrowser.helpers.ProxyHelper
import com.stoutner.privacybrowser.helpers.SanitizeUrlHelper
import com.stoutner.privacybrowser.views.FANBOYS_ANNOYANCE_LIST
import com.stoutner.privacybrowser.views.FANBOYS_SOCIAL_BLOCKING_LIST
import com.stoutner.privacybrowser.views.THIRD_PARTY_REQUESTS
-import com.stoutner.privacybrowser.views.ULTRALIST
import com.stoutner.privacybrowser.views.ULTRAPRIVACY
import com.stoutner.privacybrowser.views.NestedScrollWebView
private const val SAVED_TAB_POSITION = "saved_tab_position"
private const val TEMPORARY_MHT_FILE = "temporary_mht_file"
-// TODO. Reorder methods alphabetically.
-
class MainWebViewActivity : AppCompatActivity(), CreateBookmarkDialog.CreateBookmarkListener, CreateBookmarkFolderDialog.CreateBookmarkFolderListener, FontSizeDialog.UpdateFontSizeListener,
- NavigationView.OnNavigationItemSelectedListener, OpenDialog.OpenListener, PinnedMismatchDialog.PinnedMismatchListener, PopulateBlocklistsCoroutine.PopulateBlocklistsListener, SaveDialog.SaveListener,
+ NavigationView.OnNavigationItemSelectedListener, OpenDialog.OpenListener, PinnedMismatchDialog.PinnedMismatchListener, PopulateFilterListsCoroutine.PopulateFilterListsListener, SaveDialog.SaveListener,
UrlHistoryDialog.NavigateHistoryListener, WebViewTabFragment.NewTabListener {
companion object {
// Define the public static variables.
- var currentBookmarksFolder = ""
+ var currentBookmarksFolderId = 0L
val executorService = Executors.newFixedThreadPool(4)!!
var orbotStatus = "unknown"
val pendingDialogsArrayList = ArrayList<PendingDialogDataClass>()
var proxyMode = ProxyHelper.NONE
var restartFromBookmarksActivity = false
- var webViewPagerAdapter: WebViewPagerAdapter? = null
+ var webViewStateAdapter: WebViewStateAdapter? = null
// Declare the public static variables.
lateinit var appBarLayout: AppBarLayout
+ lateinit var defaultFavoriteIconBitmap : Bitmap
}
// Declare the class variables.
private lateinit var appBar: ActionBar
+ private lateinit var checkFilterListHelper: CheckFilterListHelper
private lateinit var bookmarksCursorAdapter: CursorAdapter
private lateinit var bookmarksListView: ListView
private lateinit var bookmarksDrawerPinnedImageView: ImageView
private lateinit var bookmarksTitleTextView: TextView
private lateinit var coordinatorLayout: CoordinatorLayout
private lateinit var cookieManager: CookieManager
+ private lateinit var defaultFontSizeString: String
+ private lateinit var defaultUserAgentName: String
+ private lateinit var defaultWebViewTheme: String
+ private lateinit var domainsSettingsSet: MutableSet<String>
private lateinit var drawerLayout: DrawerLayout
private lateinit var easyList: ArrayList<List<Array<String>>>
private lateinit var easyPrivacy: ArrayList<List<Array<String>>>
private lateinit var findOnPageLinearLayout: LinearLayout
private lateinit var fullScreenVideoFrameLayout: FrameLayout
private lateinit var initialGrayColorSpan: ForegroundColorSpan
+ private lateinit var inputMethodManager: InputMethodManager
private lateinit var navigationBackMenuItem: MenuItem
private lateinit var navigationForwardMenuItem: MenuItem
private lateinit var navigationHistoryMenuItem: MenuItem
private lateinit var navigationRequestsMenuItem: MenuItem
+ private lateinit var navigationScrollToBottomMenuItem: MenuItem
+ private lateinit var navigationView: NavigationView
private lateinit var optionsAddOrEditDomainMenuItem: MenuItem
private lateinit var optionsBlockAllThirdPartyRequestsMenuItem: MenuItem
- private lateinit var optionsBlocklistsMenuItem: MenuItem
private lateinit var optionsClearCookiesMenuItem: MenuItem
private lateinit var optionsClearDataMenuItem: MenuItem
private lateinit var optionsClearDomStorageMenuItem: MenuItem
- private lateinit var optionsClearFormDataMenuItem: MenuItem
private lateinit var optionsCookiesMenuItem: MenuItem
private lateinit var optionsDarkWebViewMenuItem: MenuItem
private lateinit var optionsDisplayImagesMenuItem: MenuItem
private lateinit var optionsEasyPrivacyMenuItem: MenuItem
private lateinit var optionsFanboysAnnoyanceListMenuItem: MenuItem
private lateinit var optionsFanboysSocialBlockingListMenuItem: MenuItem
+ private lateinit var optionsFilterListsMenuItem: MenuItem
private lateinit var optionsFontSizeMenuItem: MenuItem
private lateinit var optionsPrivacyMenuItem: MenuItem
private lateinit var optionsProxyCustomMenuItem: MenuItem
private lateinit var optionsProxyNoneMenuItem: MenuItem
private lateinit var optionsProxyTorMenuItem: MenuItem
private lateinit var optionsRefreshMenuItem: MenuItem
- private lateinit var optionsSaveFormDataMenuItem: MenuItem
private lateinit var optionsSwipeToRefreshMenuItem: MenuItem
private lateinit var optionsUltraListMenuItem: MenuItem
private lateinit var optionsUltraPrivacyMenuItem: MenuItem
private lateinit var optionsUserAgentFirefoxOnAndroidMenuItem: MenuItem
private lateinit var optionsUserAgentFirefoxOnLinuxMenuItem: MenuItem
private lateinit var optionsUserAgentFirefoxOnWindowsMenuItem: MenuItem
- private lateinit var optionsUserAgentInternetExplorerOnWindowsMenuItem: MenuItem
private lateinit var optionsUserAgentMenuItem: MenuItem
private lateinit var optionsUserAgentPrivacyBrowserMenuItem: MenuItem
private lateinit var optionsUserAgentSafariOnIosMenuItem: MenuItem
private lateinit var optionsUserAgentSafariOnMacosMenuItem: MenuItem
private lateinit var optionsUserAgentWebViewDefaultMenuItem: MenuItem
+ private lateinit var optionsViewSourceMenuItem: MenuItem
private lateinit var optionsWideViewportMenuItem: MenuItem
private lateinit var proxyHelper: ProxyHelper
private lateinit var redColorSpan: ForegroundColorSpan
private lateinit var tabsLinearLayout: LinearLayout
private lateinit var toolbar: Toolbar
private lateinit var webViewDefaultUserAgent: String
- private lateinit var webViewPager: ViewPager
+ private lateinit var webViewThemeEntryValuesStringArray: Array<String>
+ private lateinit var webViewViewPager2: ViewPager2
private lateinit var ultraList: ArrayList<List<Array<String>>>
private lateinit var urlEditText: EditText
private lateinit var urlRelativeLayout: RelativeLayout
+ private lateinit var userAgentDataArray: Array<String>
+ private lateinit var userAgentNamesArray: Array<String>
+ private lateinit var userAgentDataArrayAdapter: ArrayAdapter<CharSequence>
+ private lateinit var userAgentNamesArrayAdapter: ArrayAdapter<CharSequence>
// Define the class variables.
- private var actionBarDrawerToggle: ActionBarDrawerToggle? = null
private var appBarHeight = 0
private var bookmarksCursor: Cursor? = null
private var bookmarksDatabaseHelper: BookmarksDatabaseHelper? = null
private var bookmarksDrawerPinned = false
private var bottomAppBar = false
private var currentWebView: NestedScrollWebView? = null
+ private var defaultBlockAllThirdPartyRequests = false
+ private var defaultCookies = false
+ private var defaultDisplayWebpageImages = true
+ private var defaultDomStorage = false
+ private var defaultEasyList = true
+ private var defaultEasyPrivacy = true
+ private var defaultFanboysAnnoyanceList = true
+ private var defaultFanboysSocialBlockingList = true
private var defaultProgressViewEndOffset = 0
private var defaultProgressViewStartOffset = 0
+ private var defaultJavaScript = false
+ private var defaultSwipeToRefresh = true
+ private var defaultUltraList = true
+ private var defaultUltraPrivacy = true
+ private var defaultWideViewport = true
private var displayAdditionalAppBarIcons = false
private var displayingFullScreenVideo = false
private var domainsDatabaseHelper: DomainsDatabaseHelper? = null
private var downloadWithExternalApp = false
private var fullScreenBrowsingModeEnabled = false
- private var hideAppBar = false
+ private var hideAppBar = true
private var inFullScreenBrowsingMode = false
private var incognitoModeEnabled = false
private var loadingNewIntent = false
+ private var navigationDrawerFirstView = true
private var objectAnimator = ObjectAnimator()
private var optionsMenu: Menu? = null
private var orbotStatusBroadcastReceiver: BroadcastReceiver? = null
private var ultraPrivacy: ArrayList<List<Array<String>>>? = null
private var waitingForProxy = false
+ // Define the save webpage image activity result launcher. It must be defined before `onCreate()` is run or the app will crash.
+ private val browseFileUploadActivityResultLauncher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { activityResult ->
+ // Pass the file to the WebView.
+ fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(activityResult.resultCode, activityResult.data))
+ }
+
// Define the save URL activity result launcher. It must be defined before `onCreate()` is run or the app will crash.
private val saveUrlActivityResultLauncher = registerForActivityResult<String, Uri>(ActivityResultContracts.CreateDocument("*/*")) { fileUri ->
// Only save the URL if the file URI is not null, which happens if the user exited the file picker by pressing back.
private val saveWebpageArchiveActivityResultLauncher = registerForActivityResult<String, Uri>(ActivityResultContracts.CreateDocument("multipart/related")) { fileUri ->
// Only save the webpage archive if the file URI is not null, which happens if the user exited the file picker by pressing back.
if (fileUri != null) {
- // Initialize the file name string from the file URI last path segment.
- var fileNameString = fileUri.lastPathSegment
-
- // Query the exact file name if the API >= 26.
- if (Build.VERSION.SDK_INT >= 26) {
- // Get a cursor from the content resolver.
- val contentResolverCursor = contentResolver.query(fileUri, null, null, null)!!
+ // Get a cursor from the content resolver.
+ val contentResolverCursor = contentResolver.query(fileUri, null, null, null)!!
- // Move to the fist row.
- contentResolverCursor.moveToFirst()
+ // Move to the fist row.
+ contentResolverCursor.moveToFirst()
- // Get the file name from the cursor.
- fileNameString = contentResolverCursor.getString(contentResolverCursor.getColumnIndexOrThrow(OpenableColumns.DISPLAY_NAME))
+ // Get the file name from the cursor.
+ val fileNameString = contentResolverCursor.getString(contentResolverCursor.getColumnIndexOrThrow(OpenableColumns.DISPLAY_NAME))
- // Close the cursor.
- contentResolverCursor.close()
- }
+ // Close the cursor.
+ contentResolverCursor.close()
// Use a coroutine to save the file.
CoroutineScope(Dispatchers.Main).launch {
}
}
- // Define the save webpage image activity result launcher. It must be defined before `onCreate()` is run or the app will crash.
- private val browseFileUploadActivityResultLauncher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { activityResult ->
- // Pass the file to the WebView.
- fileChooserCallback.onReceiveValue(WebChromeClient.FileChooserParams.parseResult(activityResult.resultCode, activityResult.data))
- }
-
override fun onCreate(savedInstanceState: Bundle?) {
// Run the default commands.
super.onCreate(savedInstanceState)
val allowScreenshots = sharedPreferences.getBoolean(getString(R.string.allow_screenshots_key), false)
bottomAppBar = sharedPreferences.getBoolean(getString(R.string.bottom_app_bar_key), false)
displayAdditionalAppBarIcons = sharedPreferences.getBoolean(getString(R.string.display_additional_app_bar_icons_key), false)
+ val displayUnderCutouts = sharedPreferences.getBoolean(getString(R.string.display_under_cutouts_key), false)
+
+ // Display under cutouts if specified. This must be done here as it doesn't appear to work correctly if handled after the app is fully initialized.
+ if (displayUnderCutouts) {
+ if (Build.VERSION.SDK_INT >= 30)
+ window.attributes.layoutInDisplayCutoutMode = WindowManager.LayoutParams.LAYOUT_IN_DISPLAY_CUTOUT_MODE_ALWAYS
+ else if (Build.VERSION.SDK_INT >= 28)
+ window.attributes.layoutInDisplayCutoutMode = WindowManager.LayoutParams.LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES
+ }
- // Get the theme entry values string array.
+ // Get the entry values string arrays.
val appThemeEntryValuesStringArray = resources.getStringArray(R.array.app_theme_entry_values)
// Get the current theme status.
// Do not continue if the app theme is different than the OS theme. The app always initially starts in the OS theme.
// If the user has specified the opposite theme should be used, the app will restart in that mode after the above `setDefaultNightMode()` code processes. However, the restart is delayed.
- // If the blacklist coroutine starts below it will continue to run during the restart, which leads to indeterminate behavior, with the system often not knowing how many tabs exist.
+ // If the filter list coroutine starts below it will continue to run during the restart, which leads to indeterminate behavior, with the system often not knowing how many tabs exist.
// See https://redmine.stoutner.com/issues/952.
if ((appTheme == appThemeEntryValuesStringArray[0]) || // The system default theme is used.
((appTheme == appThemeEntryValuesStringArray[1]) && (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO)) || // The app is running in day theme as desired.
tabsLinearLayout = findViewById(R.id.tabs_linearlayout)
tabLayout = findViewById(R.id.tablayout)
swipeRefreshLayout = findViewById(R.id.swiperefreshlayout)
- webViewPager = findViewById(R.id.webviewpager)
- val navigationView = findViewById<NavigationView>(R.id.navigationview)
+ webViewViewPager2 = findViewById(R.id.webview_viewpager2)
+ navigationView = findViewById(R.id.navigationview)
bookmarksListView = findViewById(R.id.bookmarks_drawer_listview)
bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview)
bookmarksDrawerPinnedImageView = findViewById(R.id.bookmarks_drawer_pinned_imageview)
// Get handles for the navigation menu items.
navigationBackMenuItem = navigationMenu.findItem(R.id.back)
navigationForwardMenuItem = navigationMenu.findItem(R.id.forward)
+ navigationScrollToBottomMenuItem = navigationMenu.findItem(R.id.scroll_to_bottom)
navigationHistoryMenuItem = navigationMenu.findItem(R.id.history)
navigationRequestsMenuItem = navigationMenu.findItem(R.id.requests)
urlRelativeLayout = findViewById(R.id.url_relativelayout)
urlEditText = findViewById(R.id.url_edittext)
- // Create the hamburger icon at the start of the AppBar.
- actionBarDrawerToggle = ActionBarDrawerToggle(this, drawerLayout, toolbar, R.string.open_navigation_drawer, R.string.close_navigation_drawer)
-
- // Initially disable the sliding drawers. They will be enabled once the blocklists are loaded.
+ // Initially disable the sliding drawers. They will be enabled once the filter lists are loaded.
drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED)
- // Initially hide the user interface so that only the blocklist loading screen is shown (if reloading).
+ // Initially hide the user interface so that only the filter list loading screen is shown (if reloading).
drawerLayout.visibility = View.GONE
- // Initialize the WebView pager adapter.
- webViewPagerAdapter = WebViewPagerAdapter(supportFragmentManager)
+ // Initialize the WebView state adapter.
+ webViewStateAdapter = WebViewStateAdapter(this, bottomAppBar)
- // Set the pager adapter on the web view pager.
- webViewPager.adapter = webViewPagerAdapter
+ // Set the WebView pager adapter.
+ webViewViewPager2.adapter = webViewStateAdapter
// Store up to 100 tabs in memory.
- webViewPager.offscreenPageLimit = 100
+ webViewViewPager2.offscreenPageLimit = 100
+
+ // Disable swiping between pages in the view pager.
+ webViewViewPager2.isUserInputEnabled = false
// Get a handle for the cookie manager.
cookieManager = CookieManager.getInstance()
// Update the bookmarks drawer pinned image view.
updateBookmarksDrawerPinnedImageView()
+ // Get the default favorite icon drawable.
+ val favoriteIconDrawable = AppCompatResources.getDrawable(this, R.drawable.world)
+
+ // Cast the favorite icon drawable to a bitmap drawable.
+ val favoriteIconBitmapDrawable = (favoriteIconDrawable as BitmapDrawable?)!!
+
+ // Store the default favorite icon bitmap.
+ defaultFavoriteIconBitmap = favoriteIconBitmapDrawable.bitmap
+
// Initialize the app.
initializeApp()
exitFullScreenVideo()
// It shouldn't be possible for the currentWebView to be null, but crash logs indicate it sometimes happens.
} else if (currentWebView != null && currentWebView!!.canGoBack()) { // There is at least one item in the current WebView history.
- // Get the current web back forward list.
- val webBackForwardList = currentWebView!!.copyBackForwardList()
-
- // Get the previous entry URL.
- val previousUrl = webBackForwardList.getItemAtIndex(webBackForwardList.currentIndex - 1).url
-
- // Apply the domain settings.
- applyDomainSettings(currentWebView!!, previousUrl, resetTab = false, reloadWebsite = false, loadUrl = false)
-
- // Go back.
- currentWebView!!.goBack()
- } else if (tabLayout.tabCount > 1) { // There are at least two tabs.
- // Close the current tab.
- closeCurrentTab()
- } else { // There isn't anything to do in Privacy Browser.
- // Run clear and exit.
- clearAndExit()
+ // Navigate back one page.
+ navigateHistory(-1)
+ } else { // Close the current tab.
+ // A view is required because the method is also called by an XML `onClick`.
+ closeTab(null)
}
}
}
// Register the on back pressed callback.
onBackPressedDispatcher.addCallback(this, onBackPressedCallback)
- // Instantiate the populate blocklists coroutine.
- val populateBlocklistsCoroutine = PopulateBlocklistsCoroutine(this)
+ // Instantiate the populate filter lists coroutine.
+ val populateFilterListsCoroutine = PopulateFilterListsCoroutine(this)
- // Populate the blocklists.
- populateBlocklistsCoroutine.populateBlocklists(this)
+ // Populate the filter lists.
+ populateFilterListsCoroutine.populateFilterLists(this)
}
}
// Run the default commands.
super.onNewIntent(intent)
+ // Close the navigation drawer if it is open.
+ if (drawerLayout.isDrawerVisible(GravityCompat.START))
+ drawerLayout.closeDrawer(GravityCompat.START)
+
+ // Close the bookmarks drawer if it is open.
+ if (drawerLayout.isDrawerVisible(GravityCompat.END))
+ drawerLayout.closeDrawer(GravityCompat.END)
+
// Get the information from the intent.
val intentAction = intent.action
val intentUriData = intent.data
loadingNewIntent = true
// Add a new tab.
- addNewTab(url!!, true)
+ addNewPage(url!!, adjacent = false, moveToTab = true)
} else { // Load the URL in the current tab.
// Make it so.
loadUrl(currentWebView!!, url!!)
}
-
- // Close the navigation drawer if it is open.
- if (drawerLayout.isDrawerVisible(GravityCompat.START))
- drawerLayout.closeDrawer(GravityCompat.START)
-
- // Close the bookmarks drawer if it is open.
- if (drawerLayout.isDrawerVisible(GravityCompat.END))
- drawerLayout.closeDrawer(GravityCompat.END)
}
} else { // The app has been restarted.
- // If the new intent will open a new tab, set the saved tab position to be the size of the saved state array list.
- // The tab position is 0 based, meaning the at the new tab will be the tab position that is restored.
- if ((intentUriData != null) || (intentStringExtra != null) || isWebSearch)
- savedTabPosition = savedStateArrayList!!.size
-
// Replace the intent that started the app with this one. This will load the tab after the others have been restored.
setIntent(intent)
}
// Reset the reapply domain settings on restart flag.
reapplyDomainSettingsOnRestart = false
+ // Update the domains settings set.
+ updateDomainsSettingsSet()
+
// Reapply the domain settings for each tab.
- for (i in 0 until webViewPagerAdapter!!.count) {
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
// Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
// Get the fragment view.
val fragmentView = webViewTabFragment.view
// Run the default commands.
super.onStart()
- // Resume any WebViews if the pager adapter exists. If the app is restarting to change the initial app theme it won't have been populated yet.
- if (webViewPagerAdapter != null) {
- for (i in 0 until webViewPagerAdapter!!.count) {
+ // Resume any WebViews if the state adapter exists. If the app is restarting to change the initial app theme it won't have been populated yet.
+ if (webViewStateAdapter != null) {
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
// Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
// Get the fragment view.
val fragmentView = webViewTabFragment.view
pendingDialogsArrayList.clear()
}
- // `onStop()` runs after `onPause()`. It is used instead of `onPause()` so the commands are not called every time the screen is partially hidden.
- public override fun onStop() {
- // Run the default commands.
- super.onStop()
-
- // Only pause the WebViews if the pager adapter is not null, which is the case if the app is restarting to change the initial app theme.
- if (webViewPagerAdapter != null) {
- // Pause each web view.
- for (i in 0 until webViewPagerAdapter!!.count) {
- // Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
-
- // Get the fragment view.
- val fragmentView = webViewTabFragment.view
-
- // Only pause the WebViews if they exist (they won't when the app is first created).
- if (fragmentView != null) {
- // Get the nested scroll WebView from the tab fragment.
- val nestedScrollWebView = fragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
-
- // Pause the nested scroll WebView.
- nestedScrollWebView.onPause()
- }
- }
- }
-
- // Pause the WebView JavaScript timers. This is a global command that pauses JavaScript on all WebViews.
- if (currentWebView != null)
- currentWebView!!.pauseTimers()
- }
-
public override fun onSaveInstanceState(savedInstanceState: Bundle) {
// Run the default commands.
super.onSaveInstanceState(savedInstanceState)
- // Only save the instance state if the WebView pager adapter is not null, which will be the case if the app is restarting to change the initial app theme.
- if (webViewPagerAdapter != null) {
+ // Only save the instance state if the WebView state adapter is not null, which will be the case if the app is restarting to change the initial app theme.
+ if (webViewStateAdapter != null) {
// Initialize the saved state array lists.
savedStateArrayList = ArrayList<Bundle>()
savedNestedScrollWebViewStateArrayList = ArrayList<Bundle>()
// Get the URLs from each tab.
- for (i in 0 until webViewPagerAdapter!!.count) {
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
// Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
// Get the fragment view.
val fragmentView = webViewTabFragment.view
}
}
+ // `onStop()` runs after `onPause()`. It is used instead of `onPause()` so the commands are not called every time the screen is partially hidden.
+ public override fun onStop() {
+ // Run the default commands.
+ super.onStop()
+
+ // Only pause the WebViews if the state adapter is not null, which is the case if the app is restarting to change the initial app theme.
+ if (webViewStateAdapter != null) {
+ // Pause each web view.
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
+ // Get the WebView tab fragment.
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
+
+ // Get the fragment view.
+ val fragmentView = webViewTabFragment.view
+
+ // Only pause the WebViews if they exist (they won't when the app is first created).
+ if (fragmentView != null) {
+ // Get the nested scroll WebView from the tab fragment.
+ val nestedScrollWebView = fragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
+
+ // Pause the nested scroll WebView.
+ nestedScrollWebView.onPause()
+ }
+ }
+ }
+
+ // Pause the WebView JavaScript timers. This is a global command that pauses JavaScript on all WebViews.
+ if (currentWebView != null)
+ currentWebView!!.pauseTimers()
+ }
+
public override fun onDestroy() {
// Unregister the orbot status broadcast receiver if it exists.
if (orbotStatusBroadcastReceiver != null) {
}
// Close the bookmarks cursor if it exists.
- if (bookmarksCursor != null) {
- bookmarksCursor!!.close()
- }
+ bookmarksCursor?.close()
- // Close the databases database if it exists.
+ // Close the databases if they exist.
bookmarksDatabaseHelper?.close()
domainsDatabaseHelper?.close()
super.onDestroy()
}
+ override fun onConfigurationChanged(newConfig: Configuration) {
+ // Run the default commands.
+ super.onConfigurationChanged(newConfig)
+
+ // Reset the navigation drawer first view flag.
+ navigationDrawerFirstView = true
+
+ // Get the current page.
+ val currentPage = webViewViewPager2.currentItem
+
+ // Toggle the pages if there is more than one so that the view pager will recalculate their size.
+ if (currentPage > 0) {
+ // Switch to the previous page after 25 milliseconds.
+ webViewViewPager2.postDelayed ({ webViewViewPager2.currentItem = (currentPage - 1) }, 25)
+
+ // Switch back to the current page after the view pager has quiesced (which we are deciding should be 25 milliseconds).
+ webViewViewPager2.postDelayed ({ webViewViewPager2.currentItem = currentPage }, 25)
+ }
+
+ // Scroll to the current tab position after 25 milliseconds.
+ tabLayout.postDelayed ({ tabLayout.setScrollPosition(currentPage, 0F, false, false) }, 25)
+ }
+
override fun onCreateOptionsMenu(menu: Menu): Boolean {
// Inflate the menu. This adds items to the app bar if it is present.
menuInflater.inflate(R.menu.webview_options_menu, menu)
val optionsBookmarksMenuItem = menu.findItem(R.id.bookmarks)
optionsCookiesMenuItem = menu.findItem(R.id.cookies)
optionsDomStorageMenuItem = menu.findItem(R.id.dom_storage)
- optionsSaveFormDataMenuItem = menu.findItem(R.id.save_form_data) // Form data can be removed once the minimum API >= 26.
optionsClearDataMenuItem = menu.findItem(R.id.clear_data)
optionsClearCookiesMenuItem = menu.findItem(R.id.clear_cookies)
optionsClearDomStorageMenuItem = menu.findItem(R.id.clear_dom_storage)
- optionsClearFormDataMenuItem = menu.findItem(R.id.clear_form_data) // Form data can be removed once the minimum API >= 26.
- optionsBlocklistsMenuItem = menu.findItem(R.id.blocklists)
optionsEasyListMenuItem = menu.findItem(R.id.easylist)
optionsEasyPrivacyMenuItem = menu.findItem(R.id.easyprivacy)
optionsFanboysAnnoyanceListMenuItem = menu.findItem(R.id.fanboys_annoyance_list)
optionsFanboysSocialBlockingListMenuItem = menu.findItem(R.id.fanboys_social_blocking_list)
+ optionsFilterListsMenuItem = menu.findItem(R.id.filterlists)
optionsUltraListMenuItem = menu.findItem(R.id.ultralist)
optionsUltraPrivacyMenuItem = menu.findItem(R.id.ultraprivacy)
optionsBlockAllThirdPartyRequestsMenuItem = menu.findItem(R.id.block_all_third_party_requests)
optionsUserAgentFirefoxOnWindowsMenuItem = menu.findItem(R.id.user_agent_firefox_on_windows)
optionsUserAgentChromeOnWindowsMenuItem = menu.findItem(R.id.user_agent_chrome_on_windows)
optionsUserAgentEdgeOnWindowsMenuItem = menu.findItem(R.id.user_agent_edge_on_windows)
- optionsUserAgentInternetExplorerOnWindowsMenuItem = menu.findItem(R.id.user_agent_internet_explorer_on_windows)
optionsUserAgentSafariOnMacosMenuItem = menu.findItem(R.id.user_agent_safari_on_macos)
optionsUserAgentCustomMenuItem = menu.findItem(R.id.user_agent_custom)
optionsSwipeToRefreshMenuItem = menu.findItem(R.id.swipe_to_refresh)
optionsDisplayImagesMenuItem = menu.findItem(R.id.display_images)
optionsDarkWebViewMenuItem = menu.findItem(R.id.dark_webview)
optionsFontSizeMenuItem = menu.findItem(R.id.font_size)
+ optionsViewSourceMenuItem = menu.findItem(R.id.view_source)
optionsAddOrEditDomainMenuItem = menu.findItem(R.id.add_or_edit_domain)
// Set the initial status of the privacy icons. `false` does not call `invalidateOptionsMenu` as the last step.
updatePrivacyIcons(false)
- // Only display the form data menu items if the API < 26.
- optionsSaveFormDataMenuItem.isVisible = Build.VERSION.SDK_INT < 26
- optionsClearFormDataMenuItem.isVisible = Build.VERSION.SDK_INT < 26
-
- // Disable the clear form data menu item if the API >= 26 so that the status of the main Clear Data is calculated correctly.
- optionsClearFormDataMenuItem.isEnabled = Build.VERSION.SDK_INT < 26
-
- // Only display the dark WebView menu item if the API >= 29.
- optionsDarkWebViewMenuItem.isVisible = Build.VERSION.SDK_INT >= 29
-
// 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.
if (displayAdditionalAppBarIcons) { // Display the additional icons.
optionsRefreshMenuItem.setShowAsAction(MenuItem.SHOW_AS_ACTION_ALWAYS)
// Set the title.
optionsRefreshMenuItem.setTitle(R.string.stop)
- // Set the icon if it is displayed in the app bar. Once the minimum API is >= 26, the blue and black icons can be combined with a tint list.
+ // Set the icon if it is displayed in the app bar.
if (displayAdditionalAppBarIcons)
optionsRefreshMenuItem.setIcon(R.drawable.close_blue)
}
// Set the status of the menu item checkboxes.
optionsDomStorageMenuItem.isChecked = currentWebView!!.settings.domStorageEnabled
- @Suppress("DEPRECATION")
- optionsSaveFormDataMenuItem.isChecked = currentWebView!!.settings.saveFormData // Form data can be removed once the minimum API >= 26.
optionsEasyListMenuItem.isChecked = currentWebView!!.easyListEnabled
optionsEasyPrivacyMenuItem.isChecked = currentWebView!!.easyPrivacyEnabled
optionsFanboysAnnoyanceListMenuItem.isChecked = currentWebView!!.fanboysAnnoyanceListEnabled
optionsWideViewportMenuItem.isChecked = currentWebView!!.settings.useWideViewPort
optionsDisplayImagesMenuItem.isChecked = currentWebView!!.settings.loadsImagesAutomatically
- // Initialize the display names for the blocklists with the number of blocked requests.
- optionsBlocklistsMenuItem.title = getString(R.string.blocklists) + " - " + currentWebView!!.getRequestsCount(BLOCKED_REQUESTS)
+ // Set the display names for the filter lists with the number of blocked requests.
+ optionsFilterListsMenuItem.title = getString(R.string.filterlists) + " - " + currentWebView!!.getRequestsCount(BLOCKED_REQUESTS)
optionsEasyListMenuItem.title = currentWebView!!.getRequestsCount(EASYLIST).toString() + " - " + getString(R.string.easylist)
optionsEasyPrivacyMenuItem.title = currentWebView!!.getRequestsCount(EASYPRIVACY).toString() + " - " + getString(R.string.easyprivacy)
optionsFanboysAnnoyanceListMenuItem.title = currentWebView!!.getRequestsCount(FANBOYS_ANNOYANCE_LIST).toString() + " - " + getString(R.string.fanboys_annoyance_list)
optionsFanboysSocialBlockingListMenuItem.title = currentWebView!!.getRequestsCount(FANBOYS_SOCIAL_BLOCKING_LIST).toString() + " - " + getString(R.string.fanboys_social_blocking_list)
- optionsUltraListMenuItem.title = currentWebView!!.getRequestsCount(ULTRALIST).toString() + " - " + getString(R.string.ultralist)
+ optionsUltraListMenuItem.title = currentWebView!!.getRequestsCount(com.stoutner.privacybrowser.views.ULTRALIST).toString() + " - " + getString(R.string.ultralist)
optionsUltraPrivacyMenuItem.title = currentWebView!!.getRequestsCount(ULTRAPRIVACY).toString() + " - " + getString(R.string.ultraprivacy)
optionsBlockAllThirdPartyRequestsMenuItem.title = currentWebView!!.getRequestsCount(THIRD_PARTY_REQUESTS).toString() + " - " + getString(R.string.block_all_third_party_requests)
// Enable dark WebView if night mode is enabled.
optionsDarkWebViewMenuItem.isEnabled = (currentThemeStatus == Configuration.UI_MODE_NIGHT_YES)
- // Set the checkbox status for dark WebView if the device is running API >= 29 and algorithmic darkening is supported.
- if ((Build.VERSION.SDK_INT >= 29) && WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING))
+ // Set the checkbox status for dark WebView if algorithmic darkening is supported.
+ if (WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING))
optionsDarkWebViewMenuItem.isChecked = WebSettingsCompat.isAlgorithmicDarkeningAllowed(currentWebView!!.settings)
+
+ // Set the view source title according to the current URL.
+ if (currentWebView!!.currentUrl.startsWith("view-source:"))
+ optionsViewSourceMenuItem.title = getString(R.string.view_rendered_website)
+ else
+ optionsViewSourceMenuItem.title = getString(R.string.view_source)
}
// Set the cookies menu item checked status.
// Enable Clear DOM Storage if there is any.
optionsClearDomStorageMenuItem.isEnabled = localStorageDirectoryNumberOfFiles > 0 || indexedDBDirectoryNumberOfFiles > 0
- // Enable Clear Form Data is there is any. This can be removed once the minimum API >= 26.
- if (Build.VERSION.SDK_INT < 26) {
- // Get the WebView database.
- val webViewDatabase = WebViewDatabase.getInstance(this)
-
- // Enable the clear form data menu item if there is anything to clear.
- @Suppress("DEPRECATION")
- optionsClearFormDataMenuItem.isEnabled = webViewDatabase.hasFormData()
- }
-
// Enable Clear Data if any of the submenu items are enabled.
- optionsClearDataMenuItem.isEnabled = (optionsClearCookiesMenuItem.isEnabled || optionsClearDomStorageMenuItem.isEnabled || optionsClearFormDataMenuItem.isEnabled)
+ optionsClearDataMenuItem.isEnabled = (optionsClearCookiesMenuItem.isEnabled || optionsClearDomStorageMenuItem.isEnabled)
// Disable Fanboy's Social Blocking List menu item if Fanboy's Annoyance List is checked.
optionsFanboysSocialBlockingListMenuItem.isEnabled = !optionsFanboysAnnoyanceListMenuItem.isChecked
optionsUserAgentEdgeOnWindowsMenuItem.isChecked = true
}
- resources.getStringArray(R.array.user_agent_data)[10] -> { // Internet Explorer on Windows.
- // Update the user agent menu item title.
- optionsUserAgentMenuItem.title = getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_internet_explorer_on_windows)
-
- // Select the Internet on Windows radio box.
- optionsUserAgentInternetExplorerOnWindowsMenuItem.isChecked = true
- }
-
- resources.getStringArray(R.array.user_agent_data)[11] -> { // Safari on macOS.
+ resources.getStringArray(R.array.user_agent_data)[10] -> { // Safari on macOS.
// Update the user agent menu item title.
optionsUserAgentMenuItem.title = getString(R.string.options_user_agent) + " - " + getString(R.string.user_agent_safari_on_macos)
// Display a snackbar.
if (currentWebView!!.settings.javaScriptEnabled) // JavaScrip is enabled.
- Snackbar.make(webViewPager, R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show()
+ Snackbar.make(webViewViewPager2, R.string.javascript_enabled, Snackbar.LENGTH_SHORT).show()
else if (cookieManager.acceptCookie()) // JavaScript is disabled, but cookies are enabled.
- Snackbar.make(webViewPager, R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show()
+ Snackbar.make(webViewViewPager2, R.string.javascript_disabled, Snackbar.LENGTH_SHORT).show()
else // Privacy mode.
- Snackbar.make(webViewPager, R.string.privacy_mode, Snackbar.LENGTH_SHORT).show()
+ Snackbar.make(webViewViewPager2, R.string.privacy_mode, Snackbar.LENGTH_SHORT).show()
// Reload the current WebView.
currentWebView!!.reload()
// Display a snackbar.
if (cookieManager.acceptCookie()) // Cookies are enabled.
- Snackbar.make(webViewPager, R.string.cookies_enabled, Snackbar.LENGTH_SHORT).show()
+ Snackbar.make(webViewViewPager2, R.string.cookies_enabled, Snackbar.LENGTH_SHORT).show()
else if (currentWebView!!.settings.javaScriptEnabled) // JavaScript is still enabled.
- Snackbar.make(webViewPager, R.string.cookies_disabled, Snackbar.LENGTH_SHORT).show()
+ Snackbar.make(webViewViewPager2, R.string.cookies_disabled, Snackbar.LENGTH_SHORT).show()
else // Privacy mode.
- Snackbar.make(webViewPager, R.string.privacy_mode, Snackbar.LENGTH_SHORT).show()
+ Snackbar.make(webViewViewPager2, R.string.privacy_mode, Snackbar.LENGTH_SHORT).show()
// Reload the current WebView.
currentWebView!!.reload()
// Display a snackbar.
if (currentWebView!!.settings.domStorageEnabled)
- Snackbar.make(webViewPager, R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show()
- else
- Snackbar.make(webViewPager, R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show()
-
- // Reload the current WebView.
- currentWebView!!.reload()
-
- // Consume the event.
- true
- }
-
- R.id.save_form_data -> { // Form data. This can be removed once the minimum API >= 26.
- // Switch the status of saveFormDataEnabled.
- @Suppress("DEPRECATION")
- currentWebView!!.settings.saveFormData = !currentWebView!!.settings.saveFormData
-
- // Update the menu checkbox.
- @Suppress("DEPRECATION")
- menuItem.isChecked = currentWebView!!.settings.saveFormData
-
- // Display a snackbar.
- @Suppress("DEPRECATION")
- if (currentWebView!!.settings.saveFormData)
- Snackbar.make(webViewPager, R.string.form_data_enabled, Snackbar.LENGTH_SHORT).show()
+ Snackbar.make(webViewViewPager2, R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show()
else
- Snackbar.make(webViewPager, R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show()
-
- // Update the privacy icon.
- updatePrivacyIcons(true)
+ Snackbar.make(webViewViewPager2, R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show()
// Reload the current WebView.
currentWebView!!.reload()
R.id.clear_cookies -> { // Clear cookies.
// Create a snackbar.
- Snackbar.make(webViewPager, R.string.cookies_deleted, Snackbar.LENGTH_LONG)
+ Snackbar.make(webViewViewPager2, R.string.cookies_deleted, Snackbar.LENGTH_LONG)
.setAction(R.string.undo) {} // Everything will be handled by `onDismissed()` below.
.addCallback(object : Snackbar.Callback() {
override fun onDismissed(snackbar: Snackbar, event: Int) {
R.id.clear_dom_storage -> { // Clear DOM storage.
// Create a snackbar.
- Snackbar.make(webViewPager, R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
+ Snackbar.make(webViewViewPager2, R.string.dom_storage_deleted, Snackbar.LENGTH_LONG)
.setAction(R.string.undo) {} // Everything will be handled by `onDismissed()` below.
.addCallback(object : Snackbar.Callback() {
override fun onDismissed(snackbar: Snackbar, event: Int) {
true
}
- R.id.clear_form_data -> { // Clear form data. This can be remove once the minimum API >= 26.
- // Create a snackbar.
- Snackbar.make(webViewPager, R.string.form_data_deleted, Snackbar.LENGTH_LONG)
- .setAction(R.string.undo) {} // Everything will be handled by `onDismissed()` below.
- .addCallback(object : Snackbar.Callback() {
- override fun onDismissed(snackbar: Snackbar, event: Int) {
- if (event != DISMISS_EVENT_ACTION) { // The snackbar was dismissed without the undo button being pushed.
- // Get a handle for the webView database.
- val webViewDatabase = WebViewDatabase.getInstance(applicationContext)
-
- // Delete the form data.
- @Suppress("DEPRECATION")
- webViewDatabase.clearFormData()
- }
- }
- })
- .show()
-
- // Consume the event.
- true
- }
-
R.id.easylist -> { // EasyList.
// Toggle the EasyList status.
currentWebView!!.easyListEnabled = !currentWebView!!.easyListEnabled
true
}
- R.id.user_agent_internet_explorer_on_windows -> { // User Agent - Internet Explorer on Windows.
- // Update the user agent.
- currentWebView!!.settings.userAgentString = resources.getStringArray(R.array.user_agent_data)[10]
-
- // Reload the current WebView.
- currentWebView!!.reload()
-
- // Consume the event.
- true
- }
-
R.id.user_agent_safari_on_macos -> { // User Agent - Safari on macOS.
// Update the user agent.
- currentWebView!!.settings.userAgentString = resources.getStringArray(R.array.user_agent_data)[11]
+ currentWebView!!.settings.userAgentString = resources.getStringArray(R.array.user_agent_data)[10]
// Reload the current WebView.
currentWebView!!.reload()
R.id.dark_webview -> { // Dark WebView.
// Toggle dark WebView if supported.
- if ((Build.VERSION.SDK_INT >= 29) && WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING))
+ if (WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING))
WebSettingsCompat.setAlgorithmicDarkeningAllowed(currentWebView!!.settings, !WebSettingsCompat.isAlgorithmicDarkeningAllowed(currentWebView!!.settings)
)
// Set the focus on the find on page edit text.
findOnPageEditText.requestFocus()
- // Get a handle for the input method manager.
- val inputMethodManager = (getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager)
-
// Display the keyboard. `0` sets no input flags.
inputMethodManager.showSoftInput(findOnPageEditText, 0)
}, 200)
R.id.save_url -> { // Save URL.
// Check the download preference.
if (downloadWithExternalApp) // Download with an external app.
- downloadUrlWithExternalApp(currentWebView!!.currentUrl)
+ saveWithExternalApp(currentWebView!!.currentUrl)
else // Handle the download inside of Privacy Browser. The dialog will be displayed once the file size and the content disposition have been acquired.
PrepareSaveDialogCoroutine.prepareSaveDialog(this, supportFragmentManager, currentWebView!!.currentUrl, currentWebView!!.settings.userAgentString, currentWebView!!.acceptCookies)
}
R.id.save_archive -> {
- // Open the file picker with a default file name built from the current domain name.
- saveWebpageArchiveActivityResultLauncher.launch(currentWebView!!.currentDomainName + ".mht")
+ // Open the file picker with a default file name built from the website title.
+ saveWebpageArchiveActivityResultLauncher.launch(currentWebView!!.title + ".mht")
// Consume the event.
true
}
R.id.view_source -> { // View source.
- // Create an intent to launch the view source activity.
- val viewSourceIntent = Intent(this, ViewSourceActivity::class.java)
+ // Open a new tab according to the current URL.
+ if (currentWebView!!.currentUrl.startsWith("view-source:")) { // The source is currently viewed.
+ // Open the rendered website in a new tab.
+ addNewPage(currentWebView!!.currentUrl.substring(12, currentWebView!!.currentUrl.length), true, moveToTab = true)
+ } else { // The rendered website is currently viewed.
+ // Open the source in a new tab.
+ addNewPage("view-source:${currentWebView!!.currentUrl}", adjacent = true, moveToTab = true)
+ }
+
+ // Consume the event.
+ true
+ }
+
+ R.id.view_headers -> { // View headers.
+ // Create an intent to launch the view headers activity.
+ val viewHeadersIntent = Intent(this, ViewHeadersActivity::class.java)
// Add the variables to the intent.
- viewSourceIntent.putExtra(CURRENT_URL, currentWebView!!.url)
- viewSourceIntent.putExtra(USER_AGENT, currentWebView!!.settings.userAgentString)
+ viewHeadersIntent.putExtra(CURRENT_URL, currentWebView!!.url)
+ viewHeadersIntent.putExtra(USER_AGENT, currentWebView!!.settings.userAgentString)
// Make it so.
- startActivity(viewSourceIntent)
+ startActivity(viewHeadersIntent)
// Consume the event.
true
}
R.id.add_or_edit_domain -> { // Add or edit domain.
- // Reapply the domain settings on returning to `MainWebViewActivity`.
+ // Reapply the domain settings on returning to the main WebView activity.
reapplyDomainSettingsOnRestart = true
// Check if domain settings are currently applied.
// Add the extra information to the intent.
domainsIntent.putExtra(LOAD_DOMAIN, currentWebView!!.domainSettingsDatabaseId)
domainsIntent.putExtra(CLOSE_ON_BACK, true)
- domainsIntent.putExtra(CURRENT_URL, currentWebView!!.url)
domainsIntent.putExtra(CURRENT_IP_ADDRESSES, currentWebView!!.currentIpAddresses)
// Get the current certificate.
// Get the current domain from the URI. Use an empty string if it is null.
val currentDomain = currentUri.host?: ""
+ // Get the current settings status.
+ val javaScriptInt = calculateSettingsInt(currentWebView!!.settings.javaScriptEnabled, sharedPreferences.getBoolean(getString(R.string.javascript_key), false))
+ val cookiesInt = calculateSettingsInt(currentWebView!!.acceptCookies, sharedPreferences.getBoolean(getString(R.string.cookies_key), false))
+ val domStorageInt = calculateSettingsInt(currentWebView!!.settings.domStorageEnabled, sharedPreferences.getBoolean(getString(R.string.dom_storage_key), false))
+ val easyListInt = calculateSettingsInt(currentWebView!!.easyListEnabled, sharedPreferences.getBoolean(getString(R.string.easylist_key), true))
+ val easyPrivacyInt = calculateSettingsInt(currentWebView!!.easyPrivacyEnabled, sharedPreferences.getBoolean(getString(R.string.easyprivacy_key), true))
+ val fanboysAnnoyanceListInt = calculateSettingsInt(currentWebView!!.fanboysAnnoyanceListEnabled, sharedPreferences.getBoolean(getString(R.string.fanboys_annoyance_list_key), true))
+ val fanboysSocialBlockingListInt = calculateSettingsInt(currentWebView!!.fanboysSocialBlockingListEnabled, sharedPreferences.getBoolean(getString(R.string.fanboys_social_blocking_list_key), true))
+ val ultraListInt = calculateSettingsInt(currentWebView!!.ultraListEnabled, sharedPreferences.getBoolean(getString(R.string.ultralist_key), true))
+ val ultraPrivacyInt = calculateSettingsInt(currentWebView!!.ultraPrivacyEnabled, sharedPreferences.getBoolean(getString(R.string.ultraprivacy_key), true))
+ val blockAllThirdPartyRequestsInt = calculateSettingsInt(currentWebView!!.blockAllThirdPartyRequests, sharedPreferences.getBoolean(getString(R.string.block_all_third_party_requests_key), true))
+ val swipeToRefreshInt = calculateSettingsInt(currentWebView!!.swipeToRefresh, sharedPreferences.getBoolean(getString(R.string.swipe_to_refresh_key), true))
+ val wideViewportInt = calculateSettingsInt(currentWebView!!.settings.useWideViewPort, sharedPreferences.getBoolean(getString(R.string.wide_viewport_key), true))
+ val displayImagesInt = calculateSettingsInt(currentWebView!!.settings.loadsImagesAutomatically, sharedPreferences.getBoolean(getString(R.string.display_webpage_images_key), true))
+
+ // Get the current user agent string.
+ val currentUserAgentString = currentWebView!!.settings.userAgentString
+
+ // Get the user agent string array position.
+ val userAgentStringArrayPosition = userAgentDataArrayAdapter.getPosition(currentUserAgentString)
+
+ // Set the user agent name.
+ val userAgentName = if ((userAgentStringArrayPosition >= 0) && (defaultUserAgentName == userAgentNamesArray[userAgentStringArrayPosition])) { // The system default user agent is in use.
+ getString(R.string.system_default_user_agent)
+ } else { // An on-the-fly user agent is being used (or the WebView default user agent is applied).
+ when (userAgentStringArrayPosition) {
+ UNRECOGNIZED_USER_AGENT -> { // The user agent is unrecognized.
+ if (currentUserAgentString == webViewDefaultUserAgent) { // The WebView default user agent is being used.
+ if (defaultUserAgentName == getString(R.string.webview_default)) { // The WebView default user agent is the system default.
+ // Set the user agent name to be the system default.
+ getString(R.string.system_default_user_agent)
+ } else { // The WebView default user agent is set as an on-the-fly setting.
+ // Set the default user agent name.
+ getString(R.string.webview_default)
+ }
+ } else { // A custom user agent is being used.
+ if (defaultUserAgentName == getString(R.string.custom_user_agent_non_translatable)) { // The system custom user agent is in use.
+ // Set the user agent name to be the system default.
+ getString(R.string.system_default_user_agent)
+ } else { // An on-the-fly custom user agent is in use.
+ // Store the user agent as currently applied.
+ currentUserAgentString
+ }
+ }
+ }
+
+ else -> // Store the standard user agent name.
+ userAgentNamesArray[userAgentStringArrayPosition]
+ }
+ }
+
+ // Get the current text zoom integer.
+ val textZoomInt = currentWebView!!.settings.textZoom
+
+ // Set the font size integer.
+ val fontSizeInt = if (textZoomInt == defaultFontSizeString.toInt()) // The current system default is used, which is encoded as a zoom of `0`.
+ SYSTEM_DEFAULT
+ else // A custom font size is used.
+ textZoomInt
+
+ // Get the current WebView dark theme status.
+ val webViewDarkThemeCurrentlyEnabled = if (WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING)) // Algorithmic darkening is supported.
+ WebSettingsCompat.isAlgorithmicDarkeningAllowed(currentWebView!!.settings)
+ else // Algorithmic darkening is not supported.
+ false
+
+ // Get the default WebView dark theme setting.
+ val defaultWebViewDarkThemeEnabled = if (WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING)) { // Algorithmic darkening is supported.
+ when (defaultWebViewTheme) {
+ webViewThemeEntryValuesStringArray[1] -> // The dark theme is disabled by default.
+ false
+
+ webViewThemeEntryValuesStringArray[2] -> // The dark theme is enabled by default.
+ true
+
+ else -> { // The system default theme is selected.
+ // Get the current app theme status.
+ val currentAppThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
+
+ // Check if the current app theme is dark.
+ currentAppThemeStatus == Configuration.UI_MODE_NIGHT_YES
+ }
+ }
+ } else { // Algorithmic darkening is not supported.
+ false
+ }
+
+ // Set the WebView theme int.
+ val webViewThemeInt = if (webViewDarkThemeCurrentlyEnabled == defaultWebViewDarkThemeEnabled) // The current WebView theme matches the default.
+ SYSTEM_DEFAULT
+ else if (webViewDarkThemeCurrentlyEnabled) // The current WebView theme is dark and that is not the default.
+ DARK_THEME
+ else // The current WebView theme is light and that is not the default.
+ LIGHT_THEME
+
// Create the domain and store the database ID.
- val newDomainDatabaseId = domainsDatabaseHelper!!.addDomain(currentDomain)
+ val newDomainDatabaseId = domainsDatabaseHelper!!.addDomain(currentDomain, javaScriptInt, cookiesInt, domStorageInt, userAgentName, easyListInt, easyPrivacyInt,
+ fanboysAnnoyanceListInt, fanboysSocialBlockingListInt, ultraListInt, ultraPrivacyInt, blockAllThirdPartyRequestsInt, fontSizeInt,
+ swipeToRefreshInt, webViewThemeInt, wideViewportInt, displayImagesInt)
// Create an intent to launch the domains activity.
val domainsIntent = Intent(this, DomainsActivity::class.java)
// Add the extra information to the intent.
domainsIntent.putExtra(LOAD_DOMAIN, newDomainDatabaseId)
domainsIntent.putExtra(CLOSE_ON_BACK, true)
- domainsIntent.putExtra(CURRENT_URL, currentWebView!!.url)
domainsIntent.putExtra(CURRENT_IP_ADDRESSES, currentWebView!!.currentIpAddresses)
// Get the current certificate.
R.id.back -> { // Back.
// Check if the WebView can go back.
if (currentWebView!!.canGoBack()) {
- // Get the current web back forward list.
- val webBackForwardList = currentWebView!!.copyBackForwardList()
-
- // Get the previous entry URL.
- val previousUrl = webBackForwardList.getItemAtIndex(webBackForwardList.currentIndex - 1).url
-
- // Apply the domain settings.
- applyDomainSettings(currentWebView!!, previousUrl, resetTab = false, reloadWebsite = false, loadUrl = false)
-
- // Load the previous website in the history.
- currentWebView!!.goBack()
+ // Navigate back one page.
+ navigateHistory(-1)
}
}
R.id.forward -> { // Forward.
// Check if the WebView can go forward.
if (currentWebView!!.canGoForward()) {
- // Get the current web back forward list.
- val webBackForwardList = currentWebView!!.copyBackForwardList()
-
- // Get the next entry URL.
- val nextUrl = webBackForwardList.getItemAtIndex(webBackForwardList.currentIndex + 1).url
-
- // Apply the domain settings.
- applyDomainSettings(currentWebView!!, nextUrl, resetTab = false, reloadWebsite = false, loadUrl = false)
+ // Navigate forward one page.
+ navigateHistory(+1)
+ }
+ }
- // Load the next website in the history.
- currentWebView!!.goForward()
+ R.id.scroll_to_bottom -> { // Scroll to Bottom.
+ // Check if the WebView is scrolled to the top.
+ if (currentWebView!!.scrollY == 0) { // The WebView is at the top; scroll to the bottom. Using a large Y number is more efficient than trying to calculate the exact WebView length.
+ currentWebView!!.scrollTo(0, 1_000_000_000)
+ } else { // The WebView is not at the top; scroll to the top.
+ currentWebView!!.scrollTo(0, 0)
}
}
val domainsIntent = Intent(this, DomainsActivity::class.java)
// Add the extra information to the intent.
- domainsIntent.putExtra(CURRENT_URL, currentWebView!!.url)
domainsIntent.putExtra(CURRENT_IP_ADDRESSES, currentWebView!!.currentIpAddresses)
// Get the current certificate.
// Create an intent to launch the about activity.
val aboutIntent = Intent(this, AboutActivity::class.java)
- // Create a string array for the blocklist versions.
- val blocklistVersions = arrayOf(easyList[0][0][0], easyPrivacy[0][0][0], fanboysAnnoyanceList[0][0][0], fanboysSocialList[0][0][0], ultraList[0][0][0], ultraPrivacy!![0][0][0])
+ // Create a string array for the filter list versions.
+ val filterListVersions = arrayOf(easyList[0][0][0], easyPrivacy[0][0][0], fanboysAnnoyanceList[0][0][0], fanboysSocialList[0][0][0], ultraList[0][0][0], ultraPrivacy!![0][0][0])
- // Add the blocklist versions to the intent.
- aboutIntent.putExtra(AboutActivity.BLOCKLIST_VERSIONS, blocklistVersions)
+ // Add the filter list versions to the intent.
+ aboutIntent.putExtra(FILTERLIST_VERSIONS, filterListVersions)
// Make it so.
startActivity(aboutIntent)
return true
}
- public override fun onPostCreate(savedInstanceState: Bundle?) {
- // Run the default commands.
- super.onPostCreate(savedInstanceState)
-
- // Sync the state of the DrawerToggle after the default `onRestoreInstanceState()` has finished. This creates the navigation drawer icon.
- // If the app is restarting to change the app theme the action bar drawer toggle will not yet be populated.
- actionBarDrawerToggle?.syncState()
- }
-
override fun onCreateContextMenu(contextMenu: ContextMenu, view: View, contextMenuInfo: ContextMenu.ContextMenuInfo?) {
// Get the hit test result.
val hitTestResult = currentWebView!!.hitTestResult
// Add an open in new tab entry.
contextMenu.add(R.string.open_in_new_tab).setOnMenuItemClickListener {
// Load the link URL in a new tab and move to it.
- addNewTab(linkUrl, true)
+ addNewPage(linkUrl, adjacent = true, moveToTab = true)
// Consume the event.
true
// Add an open in background entry.
contextMenu.add(R.string.open_in_background).setOnMenuItemClickListener {
// Load the link URL in a new tab but do not move to it.
- addNewTab(linkUrl, false)
+ addNewPage(linkUrl, adjacent = true, moveToTab = false)
// Consume the event.
true
contextMenu.add(R.string.save_url).setOnMenuItemClickListener {
// Check the download preference.
if (downloadWithExternalApp) // Download with an external app.
- downloadUrlWithExternalApp(linkUrl)
+ saveWithExternalApp(linkUrl)
else // Handle the download inside of Privacy Browser. The dialog will be displayed once the file size and the content disposition have been acquired.
PrepareSaveDialogCoroutine.prepareSaveDialog(this, supportFragmentManager, linkUrl, currentWebView!!.settings.userAgentString, currentWebView!!.acceptCookies)
true
}
+ // Add a Share URL entry.
+ contextMenu.add(R.string.share_url).setOnMenuItemClickListener {
+ // Create the share intent.
+ val shareUrlIntent = Intent(Intent.ACTION_SEND)
+
+ // Add the URL to the intent.
+ shareUrlIntent.putExtra(Intent.EXTRA_TEXT, linkUrl)
+
+ // Set the MIME type.
+ shareUrlIntent.type = "text/plain"
+
+ // Set the intent to open in a new task.
+ shareUrlIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
+
+ //Make it so.
+ startActivity(Intent.createChooser(shareUrlIntent, getString(R.string.share_url)))
+
+ // Consume the event.
+ true
+ }
+
// Add an empty cancel entry, which by default closes the context menu.
contextMenu.add(R.string.cancel)
}
// Add an open in new tab entry.
contextMenu.add(R.string.open_image_in_new_tab).setOnMenuItemClickListener {
// Load the image in a new tab.
- addNewTab(imageUrl, true)
+ addNewPage(imageUrl, adjacent = true, moveToTab = true)
// Consume the event.
true
contextMenu.add(R.string.save_image).setOnMenuItemClickListener {
// Check the download preference.
if (downloadWithExternalApp) { // Download with an external app.
- downloadUrlWithExternalApp(imageUrl)
+ saveWithExternalApp(imageUrl)
} else { // Handle the download inside of Privacy Browser. The dialog will be displayed once the file size and the content disposition have been acquired.
PrepareSaveDialogCoroutine.prepareSaveDialog(this, supportFragmentManager, imageUrl, currentWebView!!.settings.userAgentString, currentWebView!!.acceptCookies)
}
true
}
+ // Add a Share URL entry.
+ contextMenu.add(R.string.share_url).setOnMenuItemClickListener {
+ // Create the share intent.
+ val shareUrlIntent = Intent(Intent.ACTION_SEND)
+
+ // Add the URL to the intent.
+ shareUrlIntent.putExtra(Intent.EXTRA_TEXT, imageUrl)
+
+ // Set the MIME type.
+ shareUrlIntent.type = "text/plain"
+
+ // Set the intent to open in a new task.
+ shareUrlIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
+
+ //Make it so.
+ startActivity(Intent.createChooser(shareUrlIntent, getString(R.string.share_url)))
+
+ // Consume the event.
+ true
+ }
+
// Add an empty cancel entry, which by default closes the context menu.
contextMenu.add(R.string.cancel)
}
// Add an open in new tab entry.
contextMenu.add(R.string.open_in_new_tab).setOnMenuItemClickListener {
// Load the link URL in a new tab and move to it.
- addNewTab(linkUrl, true)
+ addNewPage(linkUrl, adjacent = true, moveToTab = true)
// Consume the event.
true
// Add an open in background entry.
contextMenu.add(R.string.open_in_background).setOnMenuItemClickListener {
// Lod the link URL in a new tab but do not move to it.
- addNewTab(linkUrl, false)
+ addNewPage(linkUrl, adjacent = true, moveToTab = false)
// Consume the event.
true
// Add an open image in new tab entry.
contextMenu.add(R.string.open_image_in_new_tab).setOnMenuItemClickListener {
// Load the image in a new tab and move to it.
- addNewTab(imageUrl, true)
+ addNewPage(imageUrl, adjacent = true, moveToTab = true)
// Consume the event.
true
contextMenu.add(R.string.save_image).setOnMenuItemClickListener {
// Check the download preference.
if (downloadWithExternalApp) // Download with an external app.
- downloadUrlWithExternalApp(imageUrl)
+ saveWithExternalApp(imageUrl)
else // Handle the download inside of Privacy Browser. The dialog will be displayed once the file size and the content disposition have been acquired.
PrepareSaveDialogCoroutine.prepareSaveDialog(this, supportFragmentManager, imageUrl, currentWebView!!.settings.userAgentString, currentWebView!!.acceptCookies)
true
}
+ // Add a Share Image entry.
+ contextMenu.add(R.string.share_image).setOnMenuItemClickListener {
+ // Create the share intent.
+ val shareUrlIntent = Intent(Intent.ACTION_SEND)
+
+ // Add the URL to the intent.
+ shareUrlIntent.putExtra(Intent.EXTRA_TEXT, imageUrl)
+
+ // Set the MIME type.
+ shareUrlIntent.type = "text/plain"
+
+ // Set the intent to open in a new task.
+ shareUrlIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
+
+ //Make it so.
+ startActivity(Intent.createChooser(shareUrlIntent, getString(R.string.share_url)))
+
+ // Consume the event.
+ true
+ }
+
// Add a copy URL entry.
contextMenu.add(R.string.copy_url).setOnMenuItemClickListener {
// Save the link URL in a clip data.
contextMenu.add(R.string.save_url).setOnMenuItemClickListener {
// Check the download preference.
if (downloadWithExternalApp) // Download with an external app.
- downloadUrlWithExternalApp(linkUrl)
+ saveWithExternalApp(linkUrl)
else // Handle the download inside of Privacy Browser. The dialog will be displayed once the file size and the content disposition have been acquired.
PrepareSaveDialogCoroutine.prepareSaveDialog(this, supportFragmentManager, linkUrl, currentWebView!!.settings.userAgentString, currentWebView!!.acceptCookies)
true
}
+ // Add a Share URL entry.
+ contextMenu.add(R.string.share_url).setOnMenuItemClickListener {
+ // Create the share intent.
+ val shareUrlIntent = Intent(Intent.ACTION_SEND)
+
+ // Add the URL to the intent.
+ shareUrlIntent.putExtra(Intent.EXTRA_TEXT, linkUrl)
+
+ // Set the MIME type.
+ shareUrlIntent.type = "text/plain"
+
+ // Set the intent to open in a new task.
+ shareUrlIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
+
+ //Make it so.
+ startActivity(Intent.createChooser(shareUrlIntent, getString(R.string.share_url)))
+
+ // Consume the event.
+ true
+ }
+
// Add an empty cancel entry, which by default closes the context menu.
contextMenu.add(R.string.cancel)
}
}
}
- override fun onCreateBookmark(dialogFragment: DialogFragment, favoriteIconBitmap: Bitmap) {
- // Get the dialog.
- val dialog = dialogFragment.dialog!!
+ // The view parameter cannot be removed because it is called from the layout onClick.
+ fun addTab(@Suppress("UNUSED_PARAMETER")view: View?) {
+ // Add a new tab with a blank URL.
+ addNewPage(urlString = "", adjacent = true, moveToTab = true)
+ }
- // Get the views from the dialog fragment.
- val createBookmarkNameEditText = dialog.findViewById<EditText>(R.id.create_bookmark_name_edittext)
- val createBookmarkUrlEditText = dialog.findViewById<EditText>(R.id.create_bookmark_url_edittext)
+ private fun addNewPage(urlString: String, adjacent: Boolean, moveToTab: Boolean) {
+ // Clear the focus from the URL edit text, so that it will be populated with the information from the new tab.
+ urlEditText.clearFocus()
- // Extract the strings from the edit texts.
- val bookmarkNameString = createBookmarkNameEditText.text.toString()
- val bookmarkUrlString = createBookmarkUrlEditText.text.toString()
+ // Add the new tab after the tab layout has quiesced.
+ // Otherwise, there can be problems when restoring a large number of tabs and processing a new intent at the same time. <https://redmine.stoutner.com/issues/1136>
+ tabLayout.post {
+ // Get the new tab position.
+ val newTabPosition = if (adjacent) // The new tab position is immediately to the right of the current tab position.
+ tabLayout.selectedTabPosition + 1
+ else // The new tab position is at the end. The tab positions are 0 indexed, so the new page number will match the current count.
+ tabLayout.tabCount
- // Create a favorite icon byte array output stream.
- val favoriteIconByteArrayOutputStream = ByteArrayOutputStream()
+ // Add the new WebView page.
+ webViewStateAdapter!!.addPage(newTabPosition, urlString)
- // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
- favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream)
+ // Add the new tab.
+ addNewTab(newTabPosition, moveToTab)
+ }
+ }
- // Convert the favorite icon byte array stream to a byte array.
- val favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray()
+ private fun addNewTab(newTabPosition: Int, moveToTab: Boolean) {
+ // Check to see if the new page is ready.
+ if (webViewStateAdapter!!.itemCount >= tabLayout.tabCount) { // The new page is ready.
+ // Create a new tab.
+ val newTab = tabLayout.newTab()
- // Display the new bookmark below the current items in the (0 indexed) list.
- val newBookmarkDisplayOrder = bookmarksListView.count
+ // Set a custom view on the new tab.
+ newTab.setCustomView(R.layout.tab_custom_view)
- // Create the bookmark.
- bookmarksDatabaseHelper!!.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray)
+ // Add the new tab.
+ tabLayout.addTab(newTab, newTabPosition, moveToTab)
- // Update the bookmarks cursor with the current contents of this folder.
- bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolder)
+ // Select the new tab if it is the first one. For some odd reason, Android doesn't select the first tab if it is the only one, which causes problems with the new tab position logic above.
+ if (newTabPosition == 0)
+ tabLayout.selectTab(newTab)
- // Update the list view.
- bookmarksCursorAdapter.changeCursor(bookmarksCursor)
-
- // Scroll to the new bookmark.
- bookmarksListView.setSelection(newBookmarkDisplayOrder)
- }
+ // Scroll to the new tab position if moving to the new tab.
+ if (moveToTab)
+ tabLayout.post {
+ tabLayout.setScrollPosition(newTabPosition, 0F, false, false)
+ }
- override fun onCreateBookmarkFolder(dialogFragment: DialogFragment, favoriteIconBitmap: Bitmap) {
- // Get the dialog.
- val dialog = dialogFragment.dialog!!
+ // Show the app bar if it is at the bottom of the screen and the new tab is taking focus.
+ if (bottomAppBar && moveToTab && appBarLayout.translationY != 0f) {
+ // Animate the bottom app bar onto the screen.
+ objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", 0f)
- // Get handles for the views in the dialog fragment.
- val folderNameEditText = dialog.findViewById<EditText>(R.id.folder_name_edittext)
- val defaultIconRadioButton = dialog.findViewById<RadioButton>(R.id.default_icon_radiobutton)
- val defaultIconImageView = dialog.findViewById<ImageView>(R.id.default_icon_imageview)
+ // Make it so.
+ objectAnimator.start()
+ }
+ } else { // The new page is not ready.
+ // Create a new tab handler.
+ val newTabHandler = Handler(Looper.getMainLooper())
- // Get new folder name string.
- val folderNameString = folderNameEditText.text.toString()
+ // Create a new tab runnable.
+ val newTabRunnable = Runnable {
+ // Create the new tab.
+ addNewTab(newTabPosition, moveToTab)
+ }
- // Set the folder icon bitmap according to the dialog.
- val folderIconBitmap: Bitmap = if (defaultIconRadioButton.isChecked) { // Use the default folder icon.
- // Get the default folder icon drawable.
- val folderIconDrawable = defaultIconImageView.drawable
-
- // Convert the folder icon drawable to a bitmap drawable.
- val folderIconBitmapDrawable = folderIconDrawable as BitmapDrawable
-
- // Convert the folder icon bitmap drawable to a bitmap.
- folderIconBitmapDrawable.bitmap
- } else { // Use the WebView favorite icon.
- // Copy the favorite icon bitmap to the folder icon bitmap.
- favoriteIconBitmap
+ // Try adding the new tab again after 50 milliseconds.
+ newTabHandler.postDelayed(newTabRunnable, 50)
}
+ }
- // Create a folder icon byte array output stream.
- val folderIconByteArrayOutputStream = ByteArrayOutputStream()
+ private fun applyAppSettings() {
+ // Store the default preferences used in `applyDomainSettings()`. These are done here so that expensive preference requests are not done each time a domain is loaded.
+ defaultJavaScript = sharedPreferences.getBoolean(getString(R.string.javascript_key), false)
+ defaultCookies = sharedPreferences.getBoolean(getString(R.string.cookies_key), false)
+ defaultDomStorage = sharedPreferences.getBoolean(getString(R.string.dom_storage_key), false)
+ defaultEasyList = sharedPreferences.getBoolean(getString(R.string.easylist_key), true)
+ defaultEasyPrivacy = sharedPreferences.getBoolean(getString(R.string.easyprivacy_key), true)
+ defaultFanboysAnnoyanceList = sharedPreferences.getBoolean(getString(R.string.fanboys_annoyance_list_key), true)
+ defaultFanboysSocialBlockingList = sharedPreferences.getBoolean(getString(R.string.fanboys_social_blocking_list_key), true)
+ defaultUltraList = sharedPreferences.getBoolean(getString(R.string.ultralist_key), true)
+ defaultUltraPrivacy = sharedPreferences.getBoolean(getString(R.string.ultraprivacy_key), true)
+ defaultBlockAllThirdPartyRequests = sharedPreferences.getBoolean(getString(R.string.block_all_third_party_requests_key), false)
+ defaultFontSizeString = sharedPreferences.getString(getString(R.string.font_size_key), getString(R.string.font_size_default_value))!!
+ defaultUserAgentName = sharedPreferences.getString(getString(R.string.user_agent_key), getString(R.string.user_agent_default_value))!!
+ defaultSwipeToRefresh = sharedPreferences.getBoolean(getString(R.string.swipe_to_refresh_key), true)
+ defaultWebViewTheme = sharedPreferences.getString(getString(R.string.webview_theme_key), getString(R.string.webview_theme_default_value))!!
+ defaultWideViewport = sharedPreferences.getBoolean(getString(R.string.wide_viewport_key), true)
+ defaultDisplayWebpageImages = sharedPreferences.getBoolean(getString(R.string.display_webpage_images_key), true)
+
+ // Get the string arrays. These are done here so that expensive resource requests are not made each time a domain is loaded.
+ webViewThemeEntryValuesStringArray = resources.getStringArray(R.array.webview_theme_entry_values)
+ userAgentDataArray = resources.getStringArray(R.array.user_agent_data)
+ userAgentNamesArray = resources.getStringArray(R.array.user_agent_names)
+ val downloadProviderEntryValuesStringArray = resources.getStringArray(R.array.download_provider_entry_values)
+
+ // Get the user agent array adapters. These are done here so that expensive resource requests are not made each time a domain is loaded.
+ userAgentDataArrayAdapter = ArrayAdapter.createFromResource(this, R.array.user_agent_data, R.layout.spinner_item)
+ userAgentNamesArrayAdapter = ArrayAdapter.createFromResource(this, R.array.user_agent_names, R.layout.spinner_item)
- // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
- folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream)
+ // Store the values from the shared preferences in variables.
+ incognitoModeEnabled = sharedPreferences.getBoolean(getString(R.string.incognito_mode_key), false)
+ sanitizeTrackingQueries = sharedPreferences.getBoolean(getString(R.string.tracking_queries_key), true)
+ sanitizeAmpRedirects = sharedPreferences.getBoolean(getString(R.string.amp_redirects_key), true)
+ proxyMode = sharedPreferences.getString(getString(R.string.proxy_key), getString(R.string.proxy_default_value))!!
+ fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean(getString(R.string.full_screen_browsing_mode_key), false)
+ hideAppBar = sharedPreferences.getBoolean(getString(R.string.hide_app_bar_key), true)
+ val downloadProvider = sharedPreferences.getString(getString(R.string.download_provider_key), getString(R.string.download_provider_default_value))!!
+ scrollAppBar = sharedPreferences.getBoolean(getString(R.string.scroll_app_bar_key), false)
- // Convert the folder icon byte array stream to a byte array.
- val folderIconByteArray = folderIconByteArrayOutputStream.toByteArray()
+ // Determine if downloading should be handled by an external app.
+ downloadWithExternalApp = (downloadProvider == downloadProviderEntryValuesStringArray[2])
- // Move all the bookmarks down one in the display order.
- for (i in 0 until bookmarksListView.count) {
- // Get the bookmark database id.
- val databaseId = bookmarksListView.getItemIdAtPosition(i).toInt()
+ // Apply the saved proxy mode if the app has been restarted.
+ if (savedProxyMode != null) {
+ // Apply the saved proxy mode.
+ proxyMode = savedProxyMode!!
- // Move the bookmark down one slot.
- bookmarksDatabaseHelper!!.updateDisplayOrder(databaseId, i + 1)
+ // Reset the saved proxy mode.
+ savedProxyMode = null
}
- // Create the folder, which will be placed at the top of the list view.
- bookmarksDatabaseHelper!!.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray)
-
- // Update the bookmarks cursor with the current contents of this folder.
- bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolder)
-
- // Update the list view.
- bookmarksCursorAdapter.changeCursor(bookmarksCursor)
+ // Get the search string.
+ val searchString = sharedPreferences.getString(getString(R.string.search_key), getString(R.string.search_default_value))!!
- // Scroll to the new folder.
- bookmarksListView.setSelection(0)
- }
+ // Set the search string, using the custom search URL if specified.
+ searchURL = if (searchString == getString(R.string.custom_url_item))
+ sharedPreferences.getString(getString(R.string.search_custom_url_key), getString(R.string.search_custom_url_default_value))!!
+ else
+ searchString
- private fun loadUrlFromTextBox() {
- // Get the text from URL text box and convert it to a string. trim() removes white spaces from the beginning and end of the string.
- var unformattedUrlString = urlEditText.text.toString().trim { it <= ' ' }
+ // Apply the proxy.
+ applyProxy(false)
- // Create the formatted URL string.
- var urlString = ""
+ // Adjust the layout and scrolling parameters according to the position of the app bar.
+ if (bottomAppBar) { // The app bar is on the bottom.
+ // Adjust the UI.
+ if (scrollAppBar || (inFullScreenBrowsingMode && hideAppBar)) { // The app bar scrolls or full screen browsing mode is engaged with the app bar hidden.
+ // Reset the WebView padding to fill the available space.
+ swipeRefreshLayout.setPadding(0, 0, 0, 0)
+ } else { // The app bar doesn't scroll or full screen browsing mode is not engaged with the app bar hidden.
+ // Move the WebView above the app bar layout.
+ swipeRefreshLayout.setPadding(0, 0, 0, appBarHeight)
- // Check to see if the unformatted URL string is a valid URL. Otherwise, convert it into a search.
- if (unformattedUrlString.startsWith("content://")) { // This is a content URL.
- // Load the entire content URL.
- urlString = unformattedUrlString
- } else if (Patterns.WEB_URL.matcher(unformattedUrlString).matches() || unformattedUrlString.startsWith("http://") || unformattedUrlString.startsWith("https://") ||
- unformattedUrlString.startsWith("file://")) { // This is a standard URL.
+ // Show the app bar if it is scrolled off the screen.
+ if (appBarLayout.translationY != 0f) {
+ // Animate the bottom app bar onto the screen.
+ objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", 0f)
- // Add `https://` at the beginning if there is no protocol. Otherwise the app will segfault.
- if (!unformattedUrlString.startsWith("http") && !unformattedUrlString.startsWith("file://"))
- unformattedUrlString = "https://$unformattedUrlString"
+ // Make it so.
+ objectAnimator.start()
+ }
+ }
+ } else { // The app bar is on the top.
+ // Get the current layout parameters. Using coordinator layout parameters allows the `setBehavior()` command and using app bar layout parameters allows the `setScrollFlags()` command.
+ val swipeRefreshLayoutParams = swipeRefreshLayout.layoutParams as CoordinatorLayout.LayoutParams
+ val toolbarLayoutParams = toolbar.layoutParams as AppBarLayout.LayoutParams
+ val findOnPageLayoutParams = findOnPageLinearLayout.layoutParams as AppBarLayout.LayoutParams
+ val tabsLayoutParams = tabsLinearLayout.layoutParams as AppBarLayout.LayoutParams
- // Initialize the unformatted URL.
- var unformattedUrl: URL? = null
+ // Add the scrolling behavior to the layout parameters.
+ if (scrollAppBar) {
+ // Enable scrolling of the app bar.
+ swipeRefreshLayoutParams.behavior = AppBarLayout.ScrollingViewBehavior()
+ toolbarLayoutParams.scrollFlags = AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL or AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS or AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP
+ findOnPageLayoutParams.scrollFlags = AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL or AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS or AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP
+ tabsLayoutParams.scrollFlags = AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL or AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS or AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP
+ } else {
+ // Disable scrolling of the app bar.
+ swipeRefreshLayoutParams.behavior = null
+ toolbarLayoutParams.scrollFlags = 0
+ findOnPageLayoutParams.scrollFlags = 0
+ tabsLayoutParams.scrollFlags = 0
- // Convert the unformatted URL string to a URL.
- try {
- unformattedUrl = URL(unformattedUrlString)
- } catch (exception: MalformedURLException) {
- exception.printStackTrace()
+ // Expand the app bar if it is currently collapsed.
+ appBarLayout.setExpanded(true)
}
- // Get the components of the URL.
- val scheme = unformattedUrl?.protocol
- val authority = unformattedUrl?.authority
- val path = unformattedUrl?.path
- val query = unformattedUrl?.query
- val fragment = unformattedUrl?.ref
+ // Set the app bar scrolling for each WebView.
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
+ // Get the WebView tab fragment.
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
- // Create a URI.
- val uri = Uri.Builder()
+ // Get the fragment view.
+ val fragmentView = webViewTabFragment.view
- // Build the URI from the components of the URL.
- uri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment)
+ // Only modify the WebViews if they exist.
+ if (fragmentView != null) {
+ // Get the nested scroll WebView from the tab fragment.
+ val nestedScrollWebView = fragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
- // Decode the URI as a UTF-8 string in.
- try {
- urlString = URLDecoder.decode(uri.build().toString(), "UTF-8")
- } catch (exception: UnsupportedEncodingException) {
- // Do nothing. The formatted URL string will remain blank.
- }
- } else if (unformattedUrlString.isNotEmpty()) { // This is not a URL, but rather a search string.
- // Sanitize the search input.
- val encodedSearchString = try {
- URLEncoder.encode(unformattedUrlString, "UTF-8")
- } catch (exception: UnsupportedEncodingException) {
- ""
+ // Set the app bar scrolling.
+ nestedScrollWebView.isNestedScrollingEnabled = scrollAppBar
+ }
}
-
- // Add the base search URL.
- urlString = searchURL + encodedSearchString
}
- // Clear the focus from the URL edit text. Otherwise, proximate typing in the box will retain the colorized formatting instead of being reset during refocus.
- urlEditText.clearFocus()
+ // Update the full screen browsing mode settings.
+ if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
+ // Update the visibility of the app bar, which might have changed in the settings.
+ if (hideAppBar) {
+ // Hide the tab linear layout.
+ tabsLinearLayout.visibility = View.GONE
- // Make it so.
- loadUrl(currentWebView!!, urlString)
- }
+ // Hide the app bar.
+ appBar.hide()
+ } else {
+ // Show the tab linear layout.
+ tabsLinearLayout.visibility = View.VISIBLE
- private fun loadUrl(nestedScrollWebView: NestedScrollWebView, url: String) {
- // Sanitize the URL.
- val urlString = sanitizeUrl(url)
+ // Show the app bar.
+ appBar.show()
+ }
- // Apply the domain settings and load the URL.
- applyDomainSettings(nestedScrollWebView, urlString, resetTab = true, reloadWebsite = false, loadUrl = true)
- }
+ /* Hide the system bars.
+ * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
+ * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
+ * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
+ * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
+ */
- // The view parameter cannot be removed because it is called from the layout onClick.
- fun findPreviousOnPage(@Suppress("UNUSED_PARAMETER")view: View?) {
- // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards.
- currentWebView!!.findNext(false)
- }
+ // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
+ @Suppress("DEPRECATION")
+ rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
+ } else { // Privacy Browser is not in full screen browsing mode.
+ // Reset the full screen tracker, which could be true if Privacy Browser was in full screen mode before entering settings and full screen browsing was disabled.
+ inFullScreenBrowsingMode = false
- // The view parameter cannot be removed because it is called from the layout onClick.
- fun findNextOnPage(@Suppress("UNUSED_PARAMETER")view: View?) {
- // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
- currentWebView!!.findNext(true)
+ // Show the tab linear layout.
+ tabsLinearLayout.visibility = View.VISIBLE
+
+ // Show the app bar.
+ appBar.show()
+
+ // Remove the `SYSTEM_UI` flags from the root frame layout. The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
+ @Suppress("DEPRECATION")
+ rootFrameLayout.systemUiVisibility = 0
+ }
}
- // The view parameter cannot be removed because it is called from the layout onClick.
- fun closeFindOnPage(@Suppress("UNUSED_PARAMETER")view: View?) {
- // Delete the contents of the find on page edit text.
- findOnPageEditText.text = null
+ // `reloadWebsite` is used if returning from the Domains activity. Otherwise JavaScript might not function correctly if it is newly enabled.
+ @SuppressLint("SetJavaScriptEnabled")
+ private fun applyDomainSettings(nestedScrollWebView: NestedScrollWebView, url: String?, resetTab: Boolean, reloadWebsite: Boolean, loadUrl: Boolean) {
+ // Store the current URL.
+ nestedScrollWebView.currentUrl = url!!
- // Clear the highlighted phrases if the WebView is not null.
- currentWebView?.clearMatches()
+ // Parse the URL into a URI.
+ val uri = Uri.parse(url)
- // Hide the find on page linear layout.
- findOnPageLinearLayout.visibility = View.GONE
+ // Extract the domain from the URI.
+ var newHostName = uri.host
- // Show the toolbar.
- toolbar.visibility = View.VISIBLE
+ // Strings don't like to be null.
+ if (newHostName == null)
+ newHostName = ""
- // Get a handle for the input method manager.
- val inputMethodManager = (getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager)
+ // Apply the domain settings if a new domain is being loaded or if the new domain is blank. This allows the user to set temporary settings for JavaScript, cookies, DOM storage, etc.
+ if ((nestedScrollWebView.currentDomainName != newHostName) || (newHostName == "")) { // A new domain is being loaded.
+ // Set the new host name as the current domain name.
+ nestedScrollWebView.currentDomainName = newHostName
- // Hide the keyboard.
- inputMethodManager.hideSoftInputFromWindow(toolbar.windowToken, 0)
- }
+ // Reset the ignoring of pinned domain information.
+ nestedScrollWebView.ignorePinnedDomainInformation = false
- override fun onApplyNewFontSize(dialogFragment: DialogFragment) {
- // Get the dialog.
- val dialog = dialogFragment.dialog!!
+ // Clear any pinned SSL certificate or IP addresses.
+ nestedScrollWebView.clearPinnedSslCertificate()
+ nestedScrollWebView.pinnedIpAddresses = ""
- // Get a handle for the font size edit text.
- val fontSizeEditText = dialog.findViewById<EditText>(R.id.font_size_edittext)
+ // Reset the tab if specified.
+ if (resetTab) {
+ // Initialize the favorite icon.
+ nestedScrollWebView.resetFavoriteIcon()
- // Initialize the new font size variable with the current font size.
- var newFontSize = currentWebView!!.settings.textZoom
+ // Get the current page position.
+ val currentPagePosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
- // Get the font size from the edit text.
- try {
- newFontSize = fontSizeEditText.text.toString().toInt()
- } catch (exception: Exception) {
- // If the edit text does not contain a valid font size do nothing.
- }
-
- // Apply the new font size.
- currentWebView!!.settings.textZoom = newFontSize
- }
-
- override fun onOpen(dialogFragment: DialogFragment) {
- // Get the dialog.
- val dialog = dialogFragment.dialog!!
-
- // Get handles for the views.
- val fileNameEditText = dialog.findViewById<EditText>(R.id.file_name_edittext)
- val mhtCheckBox = dialog.findViewById<CheckBox>(R.id.mht_checkbox)
+ // Get the corresponding tab.
+ val tab = tabLayout.getTabAt(currentPagePosition)
- // Get the file path string.
- val openFilePath = fileNameEditText.text.toString()
+ // Update the tab if it isn't null, which sometimes happens when restarting from the background.
+ if (tab != null) {
+ // Get the tab custom view.
+ val tabCustomView = tab.customView!!
- // Apply the domain settings. This resets the favorite icon and removes any domain settings.
- applyDomainSettings(currentWebView!!, openFilePath, resetTab = true, reloadWebsite = false, loadUrl = false)
+ // Get the tab views.
+ val tabFavoriteIconImageView = tabCustomView.findViewById<ImageView>(R.id.favorite_icon_imageview)
+ val tabTitleTextView = tabCustomView.findViewById<TextView>(R.id.title_textview)
- // Open the file according to the type.
- if (mhtCheckBox.isChecked) { // Force opening of an MHT file.
- try {
- // Get the MHT file input stream.
- val mhtFileInputStream = contentResolver.openInputStream(Uri.parse(openFilePath))
+ // Store the current values in case they need to be restored.
+ nestedScrollWebView.previousFavoriteIconDrawable = tabFavoriteIconImageView.drawable
+ nestedScrollWebView.previousWebpageTitle = tabTitleTextView.text.toString()
- // Create a temporary MHT file.
- val temporaryMhtFile = File.createTempFile(TEMPORARY_MHT_FILE, ".mht", cacheDir)
+ // Set the default favorite icon as the favorite icon for this tab.
+ tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(nestedScrollWebView.getFavoriteIcon(), 128, 128, true))
- // Get a file output stream for the temporary MHT file.
- val temporaryMhtFileOutputStream = FileOutputStream(temporaryMhtFile)
+ // Set the loading title text.
+ tabTitleTextView.setText(R.string.loading)
+ }
+ }
- // Create a transfer byte array.
- val transferByteArray = ByteArray(1024)
+ // Initialize the domain name in database variable.
+ var domainNameInDatabase: String? = null
- // Create an integer to track the number of bytes read.
- var bytesRead: Int
+ // Check the hostname against the domain settings set.
+ if (domainsSettingsSet.contains(newHostName)) { // The hostname is contained in the domain settings set.
+ // Record the domain name in the database.
+ domainNameInDatabase = newHostName
- // Copy the temporary MHT file input stream to the MHT output stream.
- while (mhtFileInputStream!!.read(transferByteArray).also { bytesRead = it } > 0)
- temporaryMhtFileOutputStream.write(transferByteArray, 0, bytesRead)
+ // Set the domain settings applied tracker to true.
+ nestedScrollWebView.domainSettingsApplied = true
+ } else { // The hostname is not contained in the domain settings set.
+ // Set the domain settings applied tracker to false.
+ nestedScrollWebView.domainSettingsApplied = false
+ }
- // Flush the temporary MHT file output stream.
- temporaryMhtFileOutputStream.flush()
+ // Check all the subdomains of the host name against wildcard domains in the domain cursor.
+ while (!nestedScrollWebView.domainSettingsApplied && newHostName!!.contains(".")) { // Stop checking if domain settings are already applied or there are no more `.` in the hostname.
+ if (domainsSettingsSet.contains("*.$newHostName")) { // Check the host name prepended by `*.`.
+ // Set the domain settings applied tracker to true.
+ nestedScrollWebView.domainSettingsApplied = true
- // Close the streams.
- temporaryMhtFileOutputStream.close()
- mhtFileInputStream.close()
+ // Store the applied domain names as it appears in the database.
+ domainNameInDatabase = "*.$newHostName"
+ }
- // Load the temporary MHT file.
- currentWebView!!.loadUrl(temporaryMhtFile.toString())
- } catch (exception: Exception) {
- // Display a snackbar.
- Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
+ // Strip out the lowest subdomain of of the host name.
+ newHostName = newHostName.substring(newHostName.indexOf(".") + 1)
}
- } else { // Let the WebView handle opening of the file.
- // Open the file.
- currentWebView!!.loadUrl(openFilePath)
- }
- }
- private fun downloadUrlWithExternalApp(url: String) {
- // Create a download intent. Not specifying the action type will display the maximum number of options.
- val downloadIntent = Intent()
+ // Apply either the domain settings or the default settings.
+ if (nestedScrollWebView.domainSettingsApplied) { // The url has custom domain settings.
+ // Get a cursor for the current host.
+ val currentDomainSettingsCursor = domainsDatabaseHelper!!.getCursorForDomainName(domainNameInDatabase!!)
- // Set the URI and the mime type.
- downloadIntent.setDataAndType(Uri.parse(url), "text/html")
+ // Move to the first position.
+ currentDomainSettingsCursor.moveToFirst()
- // Flag the intent to open in a new task.
- downloadIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // Get the settings from the cursor.
+ nestedScrollWebView.domainSettingsDatabaseId = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(ID))
+ val javaScriptInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(ENABLE_JAVASCRIPT))
+ val cookiesInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(COOKIES))
+ val domStorageInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(ENABLE_DOM_STORAGE))
+ val easyListInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(ENABLE_EASYLIST))
+ val easyPrivacyInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(ENABLE_EASYPRIVACY))
+ val fanboysAnnoyanceListInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(ENABLE_FANBOYS_ANNOYANCE_LIST))
+ val fanboysSocialBlockingListInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST))
+ val ultraListInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(com.stoutner.privacybrowser.helpers.ULTRALIST))
+ val ultraPrivacyInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(ENABLE_ULTRAPRIVACY))
+ val blockAllThirdPartyRequestsInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(com.stoutner.privacybrowser.helpers.BLOCK_ALL_THIRD_PARTY_REQUESTS))
+ val userAgentName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(com.stoutner.privacybrowser.helpers.USER_AGENT))
+ val fontSize = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(FONT_SIZE))
+ val swipeToRefreshInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(SWIPE_TO_REFRESH))
+ val webViewThemeInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(WEBVIEW_THEME))
+ val wideViewportInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(WIDE_VIEWPORT))
+ val displayWebpageImagesInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DISPLAY_IMAGES))
+ val pinnedSslCertificate = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(PINNED_SSL_CERTIFICATE)) == 1)
+ val pinnedSslIssuedToCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(SSL_ISSUED_TO_COMMON_NAME))
+ val pinnedSslIssuedToOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(SSL_ISSUED_TO_ORGANIZATION))
+ val pinnedSslIssuedToUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(SSL_ISSUED_TO_ORGANIZATIONAL_UNIT))
+ val pinnedSslIssuedByCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(SSL_ISSUED_BY_COMMON_NAME))
+ val pinnedSslIssuedByOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(SSL_ISSUED_BY_ORGANIZATION))
+ val pinnedSslIssuedByUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(SSL_ISSUED_BY_ORGANIZATIONAL_UNIT))
+ val pinnedSslStartDate = Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndexOrThrow(com.stoutner.privacybrowser.helpers.SSL_START_DATE)))
+ val pinnedSslEndDate = Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndexOrThrow(com.stoutner.privacybrowser.helpers.SSL_END_DATE)))
+ val pinnedIpAddresses = (currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(PINNED_IP_ADDRESSES)) == 1)
+ val pinnedHostIpAddresses = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(IP_ADDRESSES))
- // Show the chooser.
- startActivity(Intent.createChooser(downloadIntent, getString(R.string.download_with_external_app)))
- }
+ // Close the current host domain settings cursor.
+ currentDomainSettingsCursor.close()
- override fun onSaveUrl(originalUrlString: String, fileNameString: String, dialogFragment: DialogFragment) {
- // Store the URL. This will be used in the save URL activity result launcher.
- saveUrlString = if (originalUrlString.startsWith("data:")) {
- // Save the original URL.
- originalUrlString
- } else {
- // Get the dialog.
- val dialog = dialogFragment.dialog!!
+ // Set the JavaScript status.
+ when (javaScriptInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.settings.javaScriptEnabled = defaultJavaScript
+ ENABLED -> nestedScrollWebView.settings.javaScriptEnabled = true
+ DISABLED -> nestedScrollWebView.settings.javaScriptEnabled = false
+ }
- // Get a handle for the dialog URL edit text.
- val dialogUrlEditText = dialog.findViewById<EditText>(R.id.url_edittext)
+ // Store the cookies status.
+ when (cookiesInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.acceptCookies = defaultCookies
+ ENABLED -> nestedScrollWebView.acceptCookies = true
+ DISABLED -> nestedScrollWebView.acceptCookies = false
+ }
- // Get the URL from the edit text, which may have been modified.
- dialogUrlEditText.text.toString()
- }
+ // Apply the cookies status.
+ cookieManager.setAcceptCookie(nestedScrollWebView.acceptCookies)
- // Open the file picker.
- saveUrlActivityResultLauncher.launch(fileNameString)
- }
+ // Set the DOM storage status.
+ when (domStorageInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.settings.domStorageEnabled = defaultDomStorage
+ ENABLED -> nestedScrollWebView.settings.domStorageEnabled = true
+ DISABLED -> nestedScrollWebView.settings.domStorageEnabled = false
+ }
- // Remove the warning that `OnTouchListener()` needs to override `performClick()`, as the only purpose of setting the `OnTouchListener()` is to make it do nothing.
- @SuppressLint("ClickableViewAccessibility")
- private fun initializeApp() {
- // Get a handle for the input method.
- val inputMethodManager = (getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager)
+ // Set the EasyList status.
+ when (easyListInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.easyListEnabled = defaultEasyList
+ ENABLED -> nestedScrollWebView.easyListEnabled = true
+ DISABLED -> nestedScrollWebView.easyListEnabled = false
+ }
- // Initialize the color spans for highlighting the URLs.
- initialGrayColorSpan = ForegroundColorSpan(getColor(R.color.gray_500))
- finalGrayColorSpan = ForegroundColorSpan(getColor(R.color.gray_500))
- redColorSpan = ForegroundColorSpan(getColor(R.color.red_text))
+ // Set the EasyPrivacy status.
+ when (easyPrivacyInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.easyPrivacyEnabled = defaultEasyPrivacy
+ ENABLED -> nestedScrollWebView.easyPrivacyEnabled = true
+ DISABLED -> nestedScrollWebView.easyPrivacyEnabled = false
+ }
- // Remove the formatting from the URL edit text when the user is editing the text.
- urlEditText.onFocusChangeListener = View.OnFocusChangeListener { _: View?, hasFocus: Boolean ->
- if (hasFocus) { // The user is editing the URL text box.
- // Remove the syntax highlighting.
- urlEditText.text.removeSpan(redColorSpan)
- urlEditText.text.removeSpan(initialGrayColorSpan)
- urlEditText.text.removeSpan(finalGrayColorSpan)
- } else { // The user has stopped editing the URL text box.
- // Move to the beginning of the string.
- urlEditText.setSelection(0)
+ // Set the Fanboy's Annoyance List status.
+ when (fanboysAnnoyanceListInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.fanboysAnnoyanceListEnabled = defaultFanboysAnnoyanceList
+ ENABLED -> nestedScrollWebView.fanboysAnnoyanceListEnabled = true
+ DISABLED -> nestedScrollWebView.fanboysAnnoyanceListEnabled = false
+ }
- // Reapply the syntax highlighting.
- UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
- }
- }
+ // Set the Fanboy's Social Blocking List status.
+ when (fanboysSocialBlockingListInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.fanboysSocialBlockingListEnabled = defaultFanboysSocialBlockingList
+ ENABLED -> nestedScrollWebView.fanboysSocialBlockingListEnabled = true
+ DISABLED -> nestedScrollWebView.fanboysSocialBlockingListEnabled = false
+ }
- // Set the go button on the keyboard to load the URL in url text box.
- urlEditText.setOnKeyListener { _: View?, keyCode: Int, keyEvent: KeyEvent ->
- // If the event is a key-down event on the `enter` button, load the URL.
- if ((keyEvent.action == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) { // The enter key was pressed.
- // Load the URL.
- loadUrlFromTextBox()
+ // Set the UltraList status.
+ when (ultraListInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.ultraListEnabled = defaultUltraList
+ ENABLED -> nestedScrollWebView.ultraListEnabled = true
+ DISABLED -> nestedScrollWebView.ultraListEnabled = false
+ }
- // Consume the event.
- return@setOnKeyListener true
- } else { // Some other key was pressed.
- // Do not consume the event.
- return@setOnKeyListener false
- }
- }
+ // Set the UltraPrivacy status.
+ when (ultraPrivacyInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.ultraPrivacyEnabled = defaultUltraPrivacy
+ ENABLED -> nestedScrollWebView.ultraPrivacyEnabled = true
+ DISABLED -> nestedScrollWebView.ultraPrivacyEnabled = false
+ }
- // Create an Orbot status broadcast receiver.
- orbotStatusBroadcastReceiver = object : BroadcastReceiver() {
- override fun onReceive(context: Context, intent: Intent) {
- // Get the content of the status message.
- orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS")!!
+ // Set the block all third-party requests status.
+ when (blockAllThirdPartyRequestsInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.blockAllThirdPartyRequests = defaultBlockAllThirdPartyRequests
+ ENABLED -> nestedScrollWebView.blockAllThirdPartyRequests = true
+ DISABLED -> nestedScrollWebView.blockAllThirdPartyRequests = false
+ }
- // If Privacy Browser is waiting on the proxy, load the website now that Orbot is connected.
- if ((orbotStatus == ProxyHelper.ORBOT_STATUS_ON) && waitingForProxy) {
- // Reset the waiting for proxy status.
- waitingForProxy = false
+ // Set the user agent.
+ if (userAgentName == getString(R.string.system_default_user_agent)) { // Use the system default user agent.
+ // Set the user agent according to the system default.
+ when (val defaultUserAgentArrayPosition = userAgentNamesArrayAdapter.getPosition(defaultUserAgentName)) {
+ UNRECOGNIZED_USER_AGENT -> // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
+ nestedScrollWebView.settings.userAgentString = defaultUserAgentName
- // Get a list of the current fragments.
- val fragmentList = supportFragmentManager.fragments
+ SETTINGS_WEBVIEW_DEFAULT_USER_AGENT -> // Set the user agent to `""`, which uses the default value.
+ nestedScrollWebView.settings.userAgentString = ""
- // Check each fragment to see if it is a waiting for proxy dialog. Sometimes more than one is displayed.
- for (i in fragmentList.indices) {
- // Get the fragment tag.
- val fragmentTag = fragmentList[i].tag
+ SETTINGS_CUSTOM_USER_AGENT -> // Set the default custom user agent.
+ nestedScrollWebView.settings.userAgentString = sharedPreferences.getString(getString(R.string.custom_user_agent_key), getString(R.string.custom_user_agent_default_value))
- // Check to see if it is the waiting for proxy dialog.
- if (fragmentTag != null && fragmentTag == getString(R.string.waiting_for_proxy_dialog)) {
- // Dismiss the waiting for proxy dialog.
- (fragmentList[i] as DialogFragment).dismiss()
- }
+ else -> // Get the user agent string from the user agent data array
+ nestedScrollWebView.settings.userAgentString = userAgentDataArray[defaultUserAgentArrayPosition]
}
+ } else { // Set the user agent according to the stored name.
+ // Set the user agent.
+ when (val userAgentArrayPosition = userAgentNamesArrayAdapter.getPosition(userAgentName)) {
+ // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
+ UNRECOGNIZED_USER_AGENT ->
+ nestedScrollWebView.settings.userAgentString = userAgentName
- // Reload existing URLs and load any URLs that are waiting for the proxy.
- for (i in 0 until webViewPagerAdapter!!.count) {
- // Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
-
- // Get the fragment view.
- val fragmentView = webViewTabFragment.view
+ // Set the user agent to `""`, which uses the default value.
+ SETTINGS_WEBVIEW_DEFAULT_USER_AGENT ->
+ nestedScrollWebView.settings.userAgentString = ""
- // Only process the WebViews if they exist.
- if (fragmentView != null) {
- // Get the nested scroll WebView from the tab fragment.
- val nestedScrollWebView = fragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
+ // Get the user agent string from the user agent data array.
+ else ->
+ nestedScrollWebView.settings.userAgentString = userAgentDataArray[userAgentArrayPosition]
+ }
+ }
- // Get the waiting for proxy URL string.
- val waitingForProxyUrlString = nestedScrollWebView.waitingForProxyUrlString
+ // Apply the font size.
+ try { // Try the specified font size to see if it is valid.
+ if (fontSize == 0) { // Apply the default font size.
+ // Set the font size from the value in the app settings.
+ nestedScrollWebView.settings.textZoom = defaultFontSizeString.toInt()
+ } else { // Apply the font size from domain settings.
+ nestedScrollWebView.settings.textZoom = fontSize
+ }
+ } catch (exception: Exception) { // The specified font size is invalid
+ // Set the font size to be 100%
+ nestedScrollWebView.settings.textZoom = 100
+ }
- // Load the pending URL if it exists.
- if (waitingForProxyUrlString.isNotEmpty()) { // A URL is waiting to be loaded.
- // Load the URL.
- loadUrl(nestedScrollWebView, waitingForProxyUrlString)
+ // Set swipe to refresh.
+ when (swipeToRefreshInt) {
+ SYSTEM_DEFAULT -> {
+ // Store the swipe to refresh status in the nested scroll WebView.
+ nestedScrollWebView.swipeToRefresh = defaultSwipeToRefresh
- // Reset the waiting for proxy URL string.
- nestedScrollWebView.waitingForProxyUrlString = ""
- } else { // No URL is waiting to be loaded.
- // Reload the existing URL.
- nestedScrollWebView.reload()
+ // Update the swipe refresh layout.
+ if (defaultSwipeToRefresh) { // Swipe to refresh is enabled.
+ // Update the status of the swipe refresh layout if the current WebView is not null (crash reports indicate that in some unexpected way it sometimes is null).
+ if (currentWebView != null) {
+ // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
+ swipeRefreshLayout.isEnabled = (currentWebView!!.scrollY == 0)
}
+ } else { // Swipe to refresh is disabled.
+ // Disable the swipe refresh layout.
+ swipeRefreshLayout.isEnabled = false
}
}
- }
- }
- }
- // Register the Orbot status broadcast receiver.
- registerReceiver(orbotStatusBroadcastReceiver, IntentFilter("org.torproject.android.intent.action.STATUS"))
+ ENABLED -> {
+ // Store the swipe to refresh status in the nested scroll WebView.
+ nestedScrollWebView.swipeToRefresh = true
- // Get handles for views that need to be modified.
- val bookmarksHeaderLinearLayout = findViewById<LinearLayout>(R.id.bookmarks_header_linearlayout)
- val launchBookmarksActivityFab = findViewById<FloatingActionButton>(R.id.launch_bookmarks_activity_fab)
- val createBookmarkFolderFab = findViewById<FloatingActionButton>(R.id.create_bookmark_folder_fab)
- val createBookmarkFab = findViewById<FloatingActionButton>(R.id.create_bookmark_fab)
+ // Update the status of the swipe refresh layout if the current WebView is not null (crash reports indicate that in some unexpected way it sometimes is null).
+ if (currentWebView != null) {
+ // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
+ swipeRefreshLayout.isEnabled = (currentWebView!!.scrollY == 0)
+ }
+ }
- // Update the WebView pager every time a tab is modified.
- webViewPager.addOnPageChangeListener(object : ViewPager.OnPageChangeListener {
- override fun onPageScrolled(position: Int, positionOffset: Float, positionOffsetPixels: Int) {}
-
- override fun onPageSelected(position: Int) {
- // Close the find on page bar if it is open.
- closeFindOnPage(null)
-
- // Set the current WebView.
- setCurrentWebView(position)
-
- // Select the corresponding tab if it does not match the currently selected page. This will happen if the page was scrolled by creating a new tab.
- if (tabLayout.selectedTabPosition != position) {
- // Wait until the new tab has been created.
- tabLayout.post {
- // Get a handle for the tab.
- val tab = tabLayout.getTabAt(position)!!
+ DISABLED -> {
+ // Store the swipe to refresh status in the nested scroll WebView.
+ nestedScrollWebView.swipeToRefresh = false
- // Select the tab.
- tab.select()
+ // Disable swipe to refresh.
+ swipeRefreshLayout.isEnabled = false
}
}
- }
- override fun onPageScrollStateChanged(state: Int) {}
- })
+ // Set the WebView theme if algorithmic darkening is supported.
+ if (WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING)) {
+ // Set the WebView theme.
+ when (webViewThemeInt) {
+ SYSTEM_DEFAULT -> // Set the WebView theme.
+ when (defaultWebViewTheme) {
+ webViewThemeEntryValuesStringArray[1] -> // The light theme is selected. Turn off algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
- // Handle tab selections.
- tabLayout.addOnTabSelectedListener(object : TabLayout.OnTabSelectedListener {
- override fun onTabSelected(tab: TabLayout.Tab) {
- // Select the same page in the view pager.
- webViewPager.currentItem = tab.position
- }
+ webViewThemeEntryValuesStringArray[2] -> // The dark theme is selected. Turn on algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
- override fun onTabUnselected(tab: TabLayout.Tab) {}
+ else -> { // The system default theme is selected.
+ // Get the current system theme status.
+ val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
- override fun onTabReselected(tab: TabLayout.Tab) {
- // Instantiate the View SSL Certificate dialog.
- val viewSslCertificateDialogFragment: DialogFragment = ViewSslCertificateDialog.displayDialog(currentWebView!!.webViewFragmentId, currentWebView!!.getFavoriteIcon())
+ // Set the algorithmic darkening according to the current system theme status.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, currentThemeStatus == Configuration.UI_MODE_NIGHT_YES)
+ }
+ }
- // Display the View SSL Certificate dialog.
- viewSslCertificateDialogFragment.show(supportFragmentManager, getString(R.string.view_ssl_certificate))
- }
- })
+ LIGHT_THEME -> // Turn off algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
- // Set a touch listener on the bookmarks header linear layout so that touches don't pass through to the button underneath.
- bookmarksHeaderLinearLayout.setOnTouchListener { _: View?, _: MotionEvent? -> true }
+ DARK_THEME -> // Turn on algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
+ }
+ }
- // Set the launch bookmarks activity floating action button to launch the bookmarks activity.
- launchBookmarksActivityFab.setOnClickListener {
- // Get a copy of the favorite icon bitmap.
- val currentFavoriteIconBitmap = currentWebView!!.getFavoriteIcon()
+ // Set the wide viewport status.
+ when (wideViewportInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.settings.useWideViewPort = defaultWideViewport
+ ENABLED -> nestedScrollWebView.settings.useWideViewPort = true
+ DISABLED -> nestedScrollWebView.settings.useWideViewPort = false
+ }
- // Create a favorite icon byte array output stream.
- val currentFavoriteIconByteArrayOutputStream = ByteArrayOutputStream()
+ // Set the display webpage images status.
+ when (displayWebpageImagesInt) {
+ SYSTEM_DEFAULT -> nestedScrollWebView.settings.loadsImagesAutomatically = defaultDisplayWebpageImages
+ ENABLED -> nestedScrollWebView.settings.loadsImagesAutomatically = true
+ DISABLED -> nestedScrollWebView.settings.loadsImagesAutomatically = false
+ }
- // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
- currentFavoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, currentFavoriteIconByteArrayOutputStream)
+ // If there is a pinned SSL certificate, store it in the WebView.
+ if (pinnedSslCertificate)
+ nestedScrollWebView.setPinnedSslCertificate(pinnedSslIssuedToCName, pinnedSslIssuedToOName, pinnedSslIssuedToUName, pinnedSslIssuedByCName, pinnedSslIssuedByOName, pinnedSslIssuedByUName,
+ pinnedSslStartDate, pinnedSslEndDate)
- // Convert the favorite icon byte array stream to a byte array.
- val currentFavoriteIconByteArray = currentFavoriteIconByteArrayOutputStream.toByteArray()
+ // If there is a pinned IP address, store it in the WebView.
+ if (pinnedIpAddresses)
+ nestedScrollWebView.pinnedIpAddresses = pinnedHostIpAddresses
- // Create an intent to launch the bookmarks activity.
- val bookmarksIntent = Intent(applicationContext, BookmarksActivity::class.java)
+ // Set a background on the URL relative layout to indicate that custom domain settings are being used.
+ urlRelativeLayout.background = AppCompatResources.getDrawable(this, R.drawable.domain_settings_url_background)
+ } else { // The new URL does not have custom domain settings. Load the defaults.
+ // Store the values from the shared preferences.
+ nestedScrollWebView.settings.javaScriptEnabled = defaultJavaScript
+ nestedScrollWebView.acceptCookies = defaultCookies
+ nestedScrollWebView.settings.domStorageEnabled = defaultDomStorage
+ nestedScrollWebView.easyListEnabled = defaultEasyList
+ nestedScrollWebView.easyPrivacyEnabled = defaultEasyPrivacy
+ nestedScrollWebView.fanboysAnnoyanceListEnabled = defaultFanboysAnnoyanceList
+ nestedScrollWebView.fanboysSocialBlockingListEnabled = defaultFanboysSocialBlockingList
+ nestedScrollWebView.ultraListEnabled = defaultUltraList
+ nestedScrollWebView.ultraPrivacyEnabled = defaultUltraPrivacy
+ nestedScrollWebView.blockAllThirdPartyRequests = defaultBlockAllThirdPartyRequests
- // Add the extra information to the intent.
- bookmarksIntent.putExtra(CURRENT_FOLDER, currentBookmarksFolder)
- bookmarksIntent.putExtra(CURRENT_TITLE, currentWebView!!.title)
- bookmarksIntent.putExtra(CURRENT_URL, currentWebView!!.url)
- bookmarksIntent.putExtra(CURRENT_FAVORITE_ICON_BYTE_ARRAY, currentFavoriteIconByteArray)
+ // Apply the default cookie setting.
+ cookieManager.setAcceptCookie(nestedScrollWebView.acceptCookies)
- // Make it so.
- startActivity(bookmarksIntent)
- }
+ // Apply the default font size setting.
+ try {
+ // Try to set the font size from the value in the app settings.
+ nestedScrollWebView.settings.textZoom = defaultFontSizeString.toInt()
+ } catch (exception: Exception) {
+ // If the app settings value is invalid, set the font size to 100%.
+ nestedScrollWebView.settings.textZoom = 100
+ }
- // Set the create new bookmark folder floating action button to display an alert dialog.
- createBookmarkFolderFab.setOnClickListener {
- // Create a create bookmark folder dialog.
- val createBookmarkFolderDialog: DialogFragment = CreateBookmarkFolderDialog.createBookmarkFolder(currentWebView!!.getFavoriteIcon())
+ // Store the swipe to refresh status in the nested scroll WebView.
+ nestedScrollWebView.swipeToRefresh = defaultSwipeToRefresh
- // Show the create bookmark folder dialog.
- createBookmarkFolderDialog.show(supportFragmentManager, getString(R.string.create_folder))
- }
+ // Update the swipe refresh layout.
+ if (defaultSwipeToRefresh) { // Swipe to refresh is enabled.
+ // Update the status of the swipe refresh layout if the current WebView is not null (crash reports indicate that in some unexpected way it sometimes is null).
+ if (currentWebView != null) {
+ // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
+ swipeRefreshLayout.isEnabled = currentWebView!!.scrollY == 0
+ }
+ } else { // Swipe to refresh is disabled.
+ // Disable the swipe refresh layout.
+ swipeRefreshLayout.isEnabled = false
+ }
- // Set the create new bookmark floating action button to display an alert dialog.
- createBookmarkFab.setOnClickListener {
- // Instantiate the create bookmark dialog.
- val createBookmarkDialog: DialogFragment = CreateBookmarkDialog.createBookmark(currentWebView!!.url!!, currentWebView!!.title!!, currentWebView!!.getFavoriteIcon())
+ // Reset the domain settings database ID.
+ nestedScrollWebView.domainSettingsDatabaseId = -1
- // Display the create bookmark dialog.
- createBookmarkDialog.show(supportFragmentManager, getString(R.string.create_bookmark))
- }
+ // Set the user agent.
+ when (val userAgentArrayPosition = userAgentNamesArrayAdapter.getPosition(defaultUserAgentName)) {
+ UNRECOGNIZED_USER_AGENT -> // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
+ nestedScrollWebView.settings.userAgentString = defaultUserAgentName
- // Search for the string on the page whenever a character changes in the find on page edit text.
- findOnPageEditText.addTextChangedListener(object : TextWatcher {
- override fun beforeTextChanged(s: CharSequence, start: Int, count: Int, after: Int) {}
+ SETTINGS_WEBVIEW_DEFAULT_USER_AGENT -> // Set the user agent to `""`, which uses the default value.
+ nestedScrollWebView.settings.userAgentString = ""
- override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {}
+ SETTINGS_CUSTOM_USER_AGENT -> // Set the default custom user agent.
+ nestedScrollWebView.settings.userAgentString = sharedPreferences.getString(getString(R.string.custom_user_agent_key), getString(R.string.custom_user_agent_default_value))
- override fun afterTextChanged(s: Editable) {
- // Search for the text in the WebView if it is not null. Sometimes on resume after a period of non-use the WebView will be null.
- currentWebView?.findAllAsync(findOnPageEditText.text.toString())
- }
- })
+ else -> // Get the user agent string from the user agent data array
+ nestedScrollWebView.settings.userAgentString = userAgentDataArray[userAgentArrayPosition]
+ }
- // Set the `check mark` button for the find on page edit text keyboard to close the soft keyboard.
- findOnPageEditText.setOnKeyListener { _: View?, keyCode: Int, keyEvent: KeyEvent ->
- if ((keyEvent.action == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) { // The `enter` key was pressed.
- // Hide the soft keyboard.
- inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
+ // Set the WebView theme if algorithmic darkening is supported.
+ if (WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING)) {
+ // Set the WebView theme.
+ when (defaultWebViewTheme) {
+ webViewThemeEntryValuesStringArray[1] -> // The light theme is selected. Turn off algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
- // Consume the event.
- return@setOnKeyListener true
- } else { // A different key was pressed.
- // Do not consume the event.
- return@setOnKeyListener false
- }
- }
+ webViewThemeEntryValuesStringArray[2] -> // The dark theme is selected. Turn on algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
- // Implement swipe to refresh.
- swipeRefreshLayout.setOnRefreshListener {
- // Reload the website.
- currentWebView!!.reload()
- }
+ else -> { // The system default theme is selected. Get the current system theme status.
+ // Get the current theme status.
+ val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
- // Store the default progress view offsets.
- defaultProgressViewStartOffset = swipeRefreshLayout.progressViewStartOffset
- defaultProgressViewEndOffset = swipeRefreshLayout.progressViewEndOffset
+ // Set the algorithmic darkening according to the current system theme status.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, currentThemeStatus == Configuration.UI_MODE_NIGHT_YES)
+ }
+ }
+ }
- // Set the refresh color scheme according to the theme.
- swipeRefreshLayout.setColorSchemeResources(R.color.blue_text)
+ // Set the viewport.
+ nestedScrollWebView.settings.useWideViewPort = defaultWideViewport
- // Initialize a color background typed value.
- val colorBackgroundTypedValue = TypedValue()
+ // Set the loading of webpage images.
+ nestedScrollWebView.settings.loadsImagesAutomatically = defaultDisplayWebpageImages
- // Get the color background from the theme.
- theme.resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true)
+ // Set a transparent background on the URL relative layout.
+ urlRelativeLayout.background = AppCompatResources.getDrawable(this, R.color.transparent)
+ }
- // Get the color background int from the typed value.
- val colorBackgroundInt = colorBackgroundTypedValue.data
+ // Update the privacy icons.
+ updatePrivacyIcons(true)
+ }
- // Set the swipe refresh background color.
- swipeRefreshLayout.setProgressBackgroundColorSchemeColor(colorBackgroundInt)
+ // Reload the website if returning from the Domains activity.
+ if (reloadWebsite)
+ nestedScrollWebView.reload()
- // Set the drawer titles, which identify the drawer layouts in accessibility mode.
- drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer))
- drawerLayout.setDrawerTitle(GravityCompat.END, getString(R.string.bookmarks))
+ // Disable the wide viewport if the source is being viewed.
+ if (url.startsWith("view-source:"))
+ nestedScrollWebView.settings.useWideViewPort = false
- // Load the bookmarks folder.
- loadBookmarksFolder()
+ // Load the URL if directed. This makes sure that the domain settings are properly loaded before the URL. By using `loadUrl()`, instead of `loadUrlFromBase()`, the Referer header will never be sent.
+ if (loadUrl)
+ nestedScrollWebView.loadUrl(url)
+ }
- // Handle clicks on bookmarks.
- bookmarksListView.onItemClickListener = AdapterView.OnItemClickListener { _: AdapterView<*>?, _: View?, _: Int, id: Long ->
- // Convert the id from long to int to match the format of the bookmarks database.
- val databaseId = id.toInt()
+ private fun applyProxy(reloadWebViews: Boolean) {
+ // Set the proxy according to the mode.
+ proxyHelper.setProxy(applicationContext, appBarLayout, proxyMode)
- // Get the bookmark cursor for this ID.
- val bookmarkCursor = bookmarksDatabaseHelper!!.getBookmark(databaseId)
+ // Reset the waiting for proxy tracker.
+ waitingForProxy = false
- // Move the bookmark cursor to the first row.
- bookmarkCursor.moveToFirst()
+ // Set the proxy.
+ when (proxyMode) {
+ ProxyHelper.NONE -> {
+ // Initialize a color background typed value.
+ val colorBackgroundTypedValue = TypedValue()
- // Act upon the bookmark according to the type.
- if (bookmarkCursor.getInt(bookmarkCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.IS_FOLDER)) == 1) { // The selected bookmark is a folder.
- // Store the folder name.
- currentBookmarksFolder = bookmarkCursor.getString(bookmarkCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_NAME))
+ // Get the color background from the theme.
+ theme.resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true)
- // Load the new folder.
- loadBookmarksFolder()
- } else { // The selected bookmark is not a folder.
- // Load the bookmark URL.
- loadUrl(currentWebView!!, bookmarkCursor.getString(bookmarkCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_URL)))
+ // Get the color background int from the typed value.
+ val colorBackgroundInt = colorBackgroundTypedValue.data
- // Close the bookmarks drawer if it is not pinned.
- if (!bookmarksDrawerPinned)
- drawerLayout.closeDrawer(GravityCompat.END)
+ // Set the default app bar layout background.
+ appBarLayout.setBackgroundColor(colorBackgroundInt)
}
- // Close the cursor.
- bookmarkCursor.close()
- }
+ ProxyHelper.TOR -> {
+ // Set the app bar background to indicate proxying is enabled.
+ appBarLayout.setBackgroundResource(R.color.blue_background)
- // Handle long-presses on bookmarks.
- bookmarksListView.onItemLongClickListener = AdapterView.OnItemLongClickListener { _: AdapterView<*>?, _: View?, _: Int, id: Long ->
- // Convert the database ID from `long` to `int`.
- val databaseId = id.toInt()
+ // Check to see if Orbot is installed.
+ try {
+ // Get the package manager.
+ val packageManager = packageManager
- // Run the commands associated with the type.
- if (bookmarksDatabaseHelper!!.isFolder(databaseId)) { // The bookmark is a folder.
- // Get a cursor of all the bookmarks in the folder.
- val bookmarksCursor = bookmarksDatabaseHelper!!.getFolderBookmarks(databaseId)
+ // Check to see if Orbot is in the list. This will throw an error and drop to the catch section if it isn't installed.
+ packageManager.getPackageInfo("org.torproject.android", 0)
- // Move to the first entry in the cursor.
- bookmarksCursor.moveToFirst()
+ // Check to see if the proxy is ready.
+ if (orbotStatus != ProxyHelper.ORBOT_STATUS_ON) { // Orbot is not ready.
+ // Set the waiting for proxy status.
+ waitingForProxy = true
- // Open each bookmark
- for (i in 0 until bookmarksCursor.count) {
- // Load the bookmark in a new tab, moving to the tab for the first bookmark if the drawer is not pinned.
- addNewTab(bookmarksCursor.getString(bookmarksCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_URL)), !bookmarksDrawerPinned && (i == 0))
+ // Show the waiting for proxy dialog if it isn't already displayed.
+ if (supportFragmentManager.findFragmentByTag(getString(R.string.waiting_for_proxy_dialog)) == null) {
+ // Get a handle for the waiting for proxy alert dialog.
+ val waitingForProxyDialogFragment = WaitingForProxyDialog()
- // Move to the next bookmark.
- bookmarksCursor.moveToNext()
- }
+ // Try to show the dialog. Sometimes the window is not yet active if returning from Settings.
+ try {
+ // Show the waiting for proxy alert dialog.
+ waitingForProxyDialogFragment.show(supportFragmentManager, getString(R.string.waiting_for_proxy_dialog))
+ } catch (waitingForTorException: Exception) {
+ // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
+ pendingDialogsArrayList.add(PendingDialogDataClass(waitingForProxyDialogFragment, getString(R.string.waiting_for_proxy_dialog)))
+ }
+ }
+ }
+ } catch (exception: PackageManager.NameNotFoundException) { // Orbot is not installed.
+ // Show the Orbot not installed dialog if it is not already displayed.
+ if (supportFragmentManager.findFragmentByTag(getString(R.string.proxy_not_installed_dialog)) == null) {
+ // Get a handle for the Orbot not installed alert dialog.
+ val orbotNotInstalledDialogFragment = ProxyNotInstalledDialog.displayDialog(proxyMode)
- // Close the cursor.
- bookmarksCursor.close()
- } else { // The bookmark is not a folder.
- // Get the bookmark cursor for this ID.
- val bookmarkCursor = bookmarksDatabaseHelper!!.getBookmark(databaseId)
+ // Try to show the dialog. Sometimes the window is not yet active if returning from Settings.
+ try {
+ // Display the Orbot not installed alert dialog.
+ orbotNotInstalledDialogFragment.show(supportFragmentManager, getString(R.string.proxy_not_installed_dialog))
+ } catch (orbotNotInstalledException: Exception) {
+ // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
+ pendingDialogsArrayList.add(PendingDialogDataClass(orbotNotInstalledDialogFragment, getString(R.string.proxy_not_installed_dialog)))
+ }
+ }
+ }
+ }
- // Move the bookmark cursor to the first row.
- bookmarkCursor.moveToFirst()
+ ProxyHelper.I2P -> {
+ // Set the app bar background to indicate proxying is enabled.
+ appBarLayout.setBackgroundResource(R.color.blue_background)
- // Load the bookmark in a new tab and move to the tab if the drawer is not pinned.
- addNewTab(bookmarkCursor.getString(bookmarkCursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_URL)), !bookmarksDrawerPinned)
+ // Check to see if I2P is installed.
+ try {
+ // Check to see if the F-Droid flavor is installed. This will throw an error and drop to the catch section if it isn't installed.
+ packageManager.getPackageInfo("net.i2p.android.router", 0)
+ } catch (fdroidException: PackageManager.NameNotFoundException) { // The F-Droid flavor is not installed.
+ try {
+ // Check to see if the Google Play flavor is installed. This will throw an error and drop to the catch section if it isn't installed.
+ packageManager.getPackageInfo("net.i2p.android", 0)
+ } catch (googlePlayException: PackageManager.NameNotFoundException) { // The Google Play flavor is not installed.
+ // Sow the I2P not installed dialog if it is not already displayed.
+ if (supportFragmentManager.findFragmentByTag(getString(R.string.proxy_not_installed_dialog)) == null) {
+ // Get a handle for the waiting for proxy alert dialog.
+ val i2pNotInstalledDialogFragment = ProxyNotInstalledDialog.displayDialog(proxyMode)
- // Close the cursor.
- bookmarkCursor.close()
+ // Try to show the dialog. Sometimes the window is not yet active if returning from Settings.
+ try {
+ // Display the I2P not installed alert dialog.
+ i2pNotInstalledDialogFragment.show(supportFragmentManager, getString(R.string.proxy_not_installed_dialog))
+ } catch (i2pNotInstalledException: Exception) {
+ // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
+ pendingDialogsArrayList.add(PendingDialogDataClass(i2pNotInstalledDialogFragment, getString(R.string.proxy_not_installed_dialog)))
+ }
+ }
+ }
+ }
}
- // Close the bookmarks drawer if it is not pinned.
- if (!bookmarksDrawerPinned)
- drawerLayout.closeDrawer(GravityCompat.END)
-
- // Consume the event.
- true
+ ProxyHelper.CUSTOM ->
+ // Set the app bar background to indicate proxying is enabled.
+ appBarLayout.setBackgroundResource(R.color.blue_background)
}
- // The drawer listener is used to update the navigation menu.
- drawerLayout.addDrawerListener(object : DrawerLayout.DrawerListener {
- override fun onDrawerSlide(drawerView: View, slideOffset: Float) {}
+ // Reload the WebViews if requested and not waiting for the proxy.
+ if (reloadWebViews && !waitingForProxy) {
+ // Reload the WebViews.
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
+ // Get the WebView tab fragment.
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
- override fun onDrawerOpened(drawerView: View) {}
+ // Get the fragment view.
+ val fragmentView = webViewTabFragment.view
- override fun onDrawerClosed(drawerView: View) {
- // Reset the drawer icon when the drawer is closed. Otherwise, it remains an arrow if the drawer is open when the app is restarted.
- actionBarDrawerToggle!!.syncState()
- }
+ // Only reload the WebViews if they exist.
+ if (fragmentView != null) {
+ // Get the nested scroll WebView from the tab fragment.
+ val nestedScrollWebView = fragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
- override fun onDrawerStateChanged(newState: Int) {
- if (newState == DrawerLayout.STATE_SETTLING || newState == DrawerLayout.STATE_DRAGGING) { // A drawer is opening or closing.
- // Update the navigation menu items if the WebView is not null.
- if (currentWebView != null) {
- navigationBackMenuItem.isEnabled = currentWebView!!.canGoBack()
- navigationForwardMenuItem.isEnabled = currentWebView!!.canGoForward()
- navigationHistoryMenuItem.isEnabled = currentWebView!!.canGoBack() || currentWebView!!.canGoForward()
- navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + currentWebView!!.getRequestsCount(BLOCKED_REQUESTS)
+ // Reload the WebView.
+ nestedScrollWebView.reload()
+ }
+ }
+ }
+ }
- // Hide the keyboard (if displayed).
- inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
- }
+ // The view parameter cannot be removed because it is called from the layout onClick.
+ fun bookmarksBack(@Suppress("UNUSED_PARAMETER")view: View?) {
+ if (currentBookmarksFolderId == HOME_FOLDER_ID) { // The home folder is displayed.
+ // close the bookmarks drawer.
+ drawerLayout.closeDrawer(GravityCompat.END)
+ } else { // A subfolder is displayed.
+ // Set the former parent folder as the current folder.
+ currentBookmarksFolderId = bookmarksDatabaseHelper!!.getParentFolderId(currentBookmarksFolderId)
- // Clear the focus from from the URL text box. This removes any text selection markers and context menus, which otherwise draw above the open drawers.
- urlEditText.clearFocus()
+ // Load the new folder.
+ loadBookmarksFolder()
+ }
+ }
- // Clear the focus from from the WebView if it is not null, which can happen if a user opens a drawer while the browser is being resumed.
- // Clearing the focus from the WebView removes any text selection markers and context menus, which otherwise draw above the open drawers.
- currentWebView?.clearFocus()
- }
- }
- })
+ private fun calculateSettingsInt(settingCurrentlyEnabled: Boolean, settingEnabledByDefault: Boolean): Int {
+ return if (settingCurrentlyEnabled == settingEnabledByDefault) // The current system default is used.
+ SYSTEM_DEFAULT
+ else if (settingCurrentlyEnabled) // The setting is enabled, which is different from the system default.
+ ENABLED
+ else // The setting is disabled, which is different from the system default.
+ DISABLED
+ }
- // Inflate a bare WebView to get the default user agent. It is not used to render content on the screen.
- @SuppressLint("InflateParams") val webViewLayout = layoutInflater.inflate(R.layout.bare_webview, null, false)
+ private fun clearAndExit() {
+ // Close the bookmarks cursor if it exists.
+ bookmarksCursor?.close()
- // Get a handle for the WebView.
- val bareWebView = webViewLayout.findViewById<WebView>(R.id.bare_webview)
+ // Close the databases helpers if they exist.
+ bookmarksDatabaseHelper?.close()
+ domainsDatabaseHelper?.close()
- // Store the default user agent.
- webViewDefaultUserAgent = bareWebView.settings.userAgentString
+ // Get the status of the clear everything preference.
+ val clearEverything = sharedPreferences.getBoolean(getString(R.string.clear_everything_key), true)
- // Destroy the bare WebView.
- bareWebView.destroy()
- }
+ // Get a handle for the runtime.
+ val runtime = Runtime.getRuntime()
- private fun applyAppSettings() {
- // Store the values from the shared preferences in variables.
- incognitoModeEnabled = sharedPreferences.getBoolean(getString(R.string.incognito_mode_key), false)
- sanitizeTrackingQueries = sharedPreferences.getBoolean(getString(R.string.tracking_queries_key), true)
- sanitizeAmpRedirects = sharedPreferences.getBoolean(getString(R.string.amp_redirects_key), true)
- proxyMode = sharedPreferences.getString(getString(R.string.proxy_key), getString(R.string.proxy_default_value))!!
- fullScreenBrowsingModeEnabled = sharedPreferences.getBoolean(getString(R.string.full_screen_browsing_mode_key), false)
- hideAppBar = sharedPreferences.getBoolean(getString(R.string.hide_app_bar_key), true)
- downloadWithExternalApp = sharedPreferences.getBoolean(getString(R.string.download_with_external_app_key), false)
- scrollAppBar = sharedPreferences.getBoolean(getString(R.string.scroll_app_bar_key), true)
+ // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
+ // which links to `/data/data/com.stoutner.privacybrowser.standard`.
+ val privateDataDirectoryString = applicationInfo.dataDir
- // Apply the saved proxy mode if the app has been restarted.
- if (savedProxyMode != null) {
- // Apply the saved proxy mode.
- proxyMode = savedProxyMode!!
+ // Clear cookies.
+ if (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_cookies_key), true)) {
+ // Ass the cookie manager to delete all the cookies.
+ cookieManager.removeAllCookies(null)
- // Reset the saved proxy mode.
- savedProxyMode = null
- }
+ // Ask the cookie manager to flush the cookie database.
+ cookieManager.flush()
- // Get the search string.
- val searchString = sharedPreferences.getString(getString(R.string.search_key), getString(R.string.search_default_value))!!
+ // Manually delete the cookies database, as the cookie manager sometimes will not flush its changes to disk before system exit is run.
+ try {
+ // Two commands must be used because `Runtime.exec()` does not like `*`.
+ val deleteCookiesProcess = runtime.exec("rm -f $privateDataDirectoryString/app_webview/Cookies")
+ val deleteCookiesJournalProcess = runtime.exec("rm -f $privateDataDirectoryString/app_webview/Cookies-journal")
- // Set the search string, using the custom search URL if specified.
- searchURL = if (searchString == getString(R.string.custom_url_item))
- sharedPreferences.getString(getString(R.string.search_custom_url_key), getString(R.string.search_custom_url_default_value))!!
- else
- searchString
+ // Wait until the processes have finished.
+ deleteCookiesProcess.waitFor()
+ deleteCookiesJournalProcess.waitFor()
+ } catch (exception: Exception) {
+ // Do nothing if an error is thrown.
+ }
+ }
- // Apply the proxy.
- applyProxy(false)
+ // Clear DOM storage.
+ if (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_dom_storage_key), true)) {
+ // Ask web storage to clear the DOM storage.
+ WebStorage.getInstance().deleteAllData()
- // Adjust the layout and scrolling parameters according to the position of the app bar.
- if (bottomAppBar) { // The app bar is on the bottom.
- // Adjust the UI.
- if (scrollAppBar || (inFullScreenBrowsingMode && hideAppBar)) { // The app bar scrolls or full screen browsing mode is engaged with the app bar hidden.
- // Reset the WebView padding to fill the available space.
- swipeRefreshLayout.setPadding(0, 0, 0, 0)
- } else { // The app bar doesn't scroll or full screen browsing mode is not engaged with the app bar hidden.
- // Move the WebView above the app bar layout.
- swipeRefreshLayout.setPadding(0, 0, 0, appBarHeight)
+ // Manually delete the DOM storage files and directories, as web storage sometimes will not flush its changes to disk before system exit is run.
+ try {
+ // A string array must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
+ val deleteLocalStorageProcess = runtime.exec(arrayOf("rm", "-rf", "$privateDataDirectoryString/app_webview/Local Storage/"))
- // Show the app bar if it is scrolled off the screen.
- if (appBarLayout.translationY != 0f) {
- // Animate the bottom app bar onto the screen.
- objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", 0f)
+ // Multiple commands must be used because `Runtime.exec()` does not like `*`.
+ val deleteIndexProcess = runtime.exec("rm -rf $privateDataDirectoryString/app_webview/IndexedDB")
+ val deleteQuotaManagerProcess = runtime.exec("rm -f $privateDataDirectoryString/app_webview/QuotaManager")
+ val deleteQuotaManagerJournalProcess = runtime.exec("rm -f $privateDataDirectoryString/app_webview/QuotaManager-journal")
+ val deleteDatabaseProcess = runtime.exec("rm -rf $privateDataDirectoryString/app_webview/databases")
- // Make it so.
- objectAnimator.start()
- }
+ // Wait until the processes have finished.
+ deleteLocalStorageProcess.waitFor()
+ deleteIndexProcess.waitFor()
+ deleteQuotaManagerProcess.waitFor()
+ deleteQuotaManagerJournalProcess.waitFor()
+ deleteDatabaseProcess.waitFor()
+ } catch (exception: Exception) {
+ // Do nothing if an error is thrown.
}
- } else { // The app bar is on the top.
- // Get the current layout parameters. Using coordinator layout parameters allows the `setBehavior()` command and using app bar layout parameters allows the `setScrollFlags()` command.
- val swipeRefreshLayoutParams = swipeRefreshLayout.layoutParams as CoordinatorLayout.LayoutParams
- val toolbarLayoutParams = toolbar.layoutParams as AppBarLayout.LayoutParams
- val findOnPageLayoutParams = findOnPageLinearLayout.layoutParams as AppBarLayout.LayoutParams
- val tabsLayoutParams = tabsLinearLayout.layoutParams as AppBarLayout.LayoutParams
+ }
- // Add the scrolling behavior to the layout parameters.
- if (scrollAppBar) {
- // Enable scrolling of the app bar.
- swipeRefreshLayoutParams.behavior = AppBarLayout.ScrollingViewBehavior()
- toolbarLayoutParams.scrollFlags = AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL or AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS or AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP
- findOnPageLayoutParams.scrollFlags = AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL or AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS or AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP
- tabsLayoutParams.scrollFlags = AppBarLayout.LayoutParams.SCROLL_FLAG_SCROLL or AppBarLayout.LayoutParams.SCROLL_FLAG_ENTER_ALWAYS or AppBarLayout.LayoutParams.SCROLL_FLAG_SNAP
- } else {
- // Disable scrolling of the app bar.
- swipeRefreshLayoutParams.behavior = null
- toolbarLayoutParams.scrollFlags = 0
- findOnPageLayoutParams.scrollFlags = 0
- tabsLayoutParams.scrollFlags = 0
+ // Clear the logcat.
+ if (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_logcat_key), true)) {
+ try {
+ // Clear the logcat. `-c` clears the logcat. `-b all` clears all the buffers (instead of just crash, main, and system).
+ val process = Runtime.getRuntime().exec("logcat -b all -c")
- // Expand the app bar if it is currently collapsed.
- appBarLayout.setExpanded(true)
+ // Wait for the process to finish.
+ process.waitFor()
+ } catch (exception: IOException) {
+ // Do nothing.
+ } catch (exception: InterruptedException) {
+ // Do nothing.
}
+ }
- // Set the app bar scrolling for each WebView.
- for (i in 0 until webViewPagerAdapter!!.count) {
+ // Clear the cache.
+ if (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_cache_key), true)) {
+ // Clear the cache from each WebView.
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
// Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
- // Get the fragment view.
- val fragmentView = webViewTabFragment.view
+ // Get the WebView fragment view.
+ val webViewFragmentView = webViewTabFragment.view
- // Only modify the WebViews if they exist.
- if (fragmentView != null) {
+ // Only clear the cache if the WebView exists.
+ if (webViewFragmentView != null) {
// Get the nested scroll WebView from the tab fragment.
- val nestedScrollWebView = fragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
+ val nestedScrollWebView = webViewFragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
- // Set the app bar scrolling.
- nestedScrollWebView.isNestedScrollingEnabled = scrollAppBar
+ // Clear the cache for this WebView.
+ nestedScrollWebView.clearCache(true)
}
}
- }
- // Update the full screen browsing mode settings.
- if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
- // Update the visibility of the app bar, which might have changed in the settings.
- if (hideAppBar) {
- // Hide the tab linear layout.
- tabsLinearLayout.visibility = View.GONE
+ // Manually delete the cache directories.
+ try {
+ // Delete the main cache directory.
+ val deleteCacheProcess = runtime.exec("rm -rf $privateDataDirectoryString/cache")
- // Hide the app bar.
- appBar.hide()
- } else {
- // Show the tab linear layout.
- tabsLinearLayout.visibility = View.VISIBLE
+ // Delete the secondary `Service Worker` cache directory.
+ // A string array must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
+ val deleteServiceWorkerProcess = runtime.exec(arrayOf("rm", "-rf", "$privateDataDirectoryString/app_webview/Default/Service Worker/"))
- // Show the app bar.
- appBar.show()
+ // Wait until the processes have finished.
+ deleteCacheProcess.waitFor()
+ deleteServiceWorkerProcess.waitFor()
+ } catch (exception: Exception) {
+ // Do nothing if an error is thrown.
}
+ }
- /* Hide the system bars.
- * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
- * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
- * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
- * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
- */
+ // Wipe out each WebView.
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
+ // Get the WebView tab fragment.
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
- // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
- @Suppress("DEPRECATION")
- rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
- } else { // Privacy Browser is not in full screen browsing mode.
- // Reset the full screen tracker, which could be true if Privacy Browser was in full screen mode before entering settings and full screen browsing was disabled.
- inFullScreenBrowsingMode = false
+ // Get the WebView frame layout.
+ val webViewFrameLayout = webViewTabFragment.view as FrameLayout?
- // Show the tab linear layout.
- tabsLinearLayout.visibility = View.VISIBLE
+ // Only wipe out the WebView if it exists.
+ if (webViewFrameLayout != null) {
+ // Get the nested scroll WebView from the tab fragment.
+ val nestedScrollWebView = webViewFrameLayout.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
- // Show the app bar.
- appBar.show()
+ // Clear SSL certificate preferences for this WebView.
+ nestedScrollWebView.clearSslPreferences()
- // Remove the `SYSTEM_UI` flags from the root frame layout. The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
- @Suppress("DEPRECATION")
- rootFrameLayout.systemUiVisibility = 0
+ // Clear the back/forward history for this WebView.
+ nestedScrollWebView.clearHistory()
+
+ // Remove all the views from the frame layout.
+ webViewFrameLayout.removeAllViews()
+
+ // Destroy the internal state of the WebView.
+ nestedScrollWebView.destroy()
+ }
}
- }
- override fun navigateHistory(url: String, steps: Int) {
- // Apply the domain settings.
- applyDomainSettings(currentWebView!!, url, resetTab = false, reloadWebsite = false, loadUrl = false)
+ // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
+ // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
+ if (clearEverything) {
+ try {
+ // Delete the folder.
+ val deleteAppWebviewProcess = runtime.exec("rm -rf $privateDataDirectoryString/app_webview")
- // Load the history entry.
- currentWebView!!.goBackOrForward(steps)
+ // Wait until the process has finished.
+ deleteAppWebviewProcess.waitFor()
+ } catch (exception: Exception) {
+ // Do nothing if an error is thrown.
+ }
+ }
+
+ // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
+ finishAndRemoveTask()
+
+ // Remove the terminated program from RAM. The status code is `0`.
+ exitProcess(0)
}
- override fun pinnedErrorGoBack() {
- // Get the current web back forward list.
- val webBackForwardList = currentWebView!!.copyBackForwardList()
+ // The view parameter cannot be removed because it is called from the layout onClick.
+ fun closeFindOnPage(@Suppress("UNUSED_PARAMETER")view: View?) {
+ // Delete the contents of the find on page edit text.
+ findOnPageEditText.text = null
- // Get the previous entry URL.
- val previousUrl = webBackForwardList.getItemAtIndex(webBackForwardList.currentIndex - 1).url
+ // Clear the highlighted phrases if the WebView is not null.
+ currentWebView?.clearMatches()
- // Apply the domain settings.
- applyDomainSettings(currentWebView!!, previousUrl, resetTab = false, reloadWebsite = false, loadUrl = false)
+ // Hide the find on page linear layout.
+ findOnPageLinearLayout.visibility = View.GONE
+
+ // Show the toolbar.
+ toolbar.visibility = View.VISIBLE
- // Go back.
- currentWebView!!.goBack()
+ // Hide the keyboard.
+ inputMethodManager.hideSoftInputFromWindow(toolbar.windowToken, 0)
}
- // `reloadWebsite` is used if returning from the Domains activity. Otherwise JavaScript might not function correctly if it is newly enabled.
- @SuppressLint("SetJavaScriptEnabled")
- private fun applyDomainSettings(nestedScrollWebView: NestedScrollWebView, url: String?, resetTab: Boolean, reloadWebsite: Boolean, loadUrl: Boolean) {
- // Store the current URL.
- nestedScrollWebView.currentUrl = url!!
+ // The view parameter cannot be removed because it is called from the layout onClick.
+ fun closeTab(@Suppress("UNUSED_PARAMETER")view: View?) {
+ // Run the command according to the number of tabs.
+ if (tabLayout.tabCount > 1) { // There is more than one tab open.
+ // Get the current tab number.
+ val currentTabNumber = tabLayout.selectedTabPosition
+
+ // Delete the current tab.
+ tabLayout.removeTabAt(currentTabNumber)
+
+ // Delete the current page. If the selected page number did not change during the delete (because the newly selected tab has has same number as the previously deleted tab), it will return true,
+ // meaning that the current WebView must be reset. Otherwise it will happen automatically as the selected tab number changes.
+ if (webViewStateAdapter!!.deletePage(currentTabNumber, webViewViewPager2))
+ setCurrentWebView(currentTabNumber)
+ } else { // There is only one tab open.
+ clearAndExit()
+ }
+ }
- // Parse the URL into a URI.
- val uri = Uri.parse(url)
+ override fun createBookmark(dialogFragment: DialogFragment) {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
- // Extract the domain from the URI.
- var newHostName = uri.host
+ // Get the views from the dialog fragment.
+ val webpageFavoriteIconRadioButton = dialog.findViewById<RadioButton>(R.id.webpage_favorite_icon_radiobutton)
+ val webpageFavoriteIconImageView = dialog.findViewById<ImageView>(R.id.webpage_favorite_icon_imageview)
+ val customIconImageView = dialog.findViewById<ImageView>(R.id.custom_icon_imageview)
+ val bookmarkNameEditText = dialog.findViewById<EditText>(R.id.bookmark_name_edittext)
+ val bookmarkUrlEditText = dialog.findViewById<EditText>(R.id.bookmark_url_edittext)
- // Strings don't like to be null.
- if (newHostName == null)
- newHostName = ""
+ // Extract the strings from the edit texts.
+ val bookmarkNameString = bookmarkNameEditText.text.toString()
+ val bookmarkUrlString = bookmarkUrlEditText.text.toString()
- // Apply the domain settings if a new domain is being loaded or if the new domain is blank. This allows the user to set temporary settings for JavaScript, cookies, DOM storage, etc.
- if (nestedScrollWebView.currentDomainName != newHostName || newHostName == "") {
- // Set the new host name as the current domain name.
- nestedScrollWebView.currentDomainName = newHostName
+ // Get the selected favorite icon drawable.
+ val favoriteIconDrawable = if (webpageFavoriteIconRadioButton.isChecked) // Use the webpage favorite icon.
+ webpageFavoriteIconImageView.drawable
+ else // Use the custom icon.
+ customIconImageView.drawable
- // Reset the ignoring of pinned domain information.
- nestedScrollWebView.ignorePinnedDomainInformation = false
+ // Cast the favorite icon bitmap to a bitmap drawable
+ val favoriteIconBitmapDrawable = favoriteIconDrawable as BitmapDrawable
- // Clear any pinned SSL certificate or IP addresses.
- nestedScrollWebView.clearPinnedSslCertificate()
- nestedScrollWebView.pinnedIpAddresses = ""
+ // Convert the favorite icon bitmap drawable to a bitmap.
+ val favoriteIconBitmap = favoriteIconBitmapDrawable.bitmap
- // Reset the favorite icon if specified.
- if (resetTab) {
- // Initialize the favorite icon.
- nestedScrollWebView.initializeFavoriteIcon()
+ // Create a favorite icon byte array output stream.
+ val favoriteIconByteArrayOutputStream = ByteArrayOutputStream()
- // Get the current page position.
- val currentPagePosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
+ favoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, favoriteIconByteArrayOutputStream)
- // Get the corresponding tab.
- val tab = tabLayout.getTabAt(currentPagePosition)
+ // Convert the favorite icon byte array stream to a byte array.
+ val favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray()
- // Update the tab if it isn't null, which sometimes happens when restarting from the background.
- if (tab != null) {
- // Get the tab custom view.
- val tabCustomView = tab.customView!!
+ // Display the new bookmark below the current items in the (0 indexed) list.
+ val newBookmarkDisplayOrder = bookmarksListView.count
- // Get the tab views.
- val tabFavoriteIconImageView = tabCustomView.findViewById<ImageView>(R.id.favorite_icon_imageview)
- val tabTitleTextView = tabCustomView.findViewById<TextView>(R.id.title_textview)
+ // Create the bookmark.
+ bookmarksDatabaseHelper!!.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolderId, newBookmarkDisplayOrder, favoriteIconByteArray)
- // Set the default favorite icon as the favorite icon for this tab.
- tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(nestedScrollWebView.getFavoriteIcon(), 64, 64, true))
+ // Update the bookmarks cursor with the current contents of this folder.
+ bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolderId)
- // Set the loading title text.
- tabTitleTextView.setText(R.string.loading)
- }
- }
+ // Update the list view.
+ bookmarksCursorAdapter.changeCursor(bookmarksCursor)
- // Get a full domain name cursor.
- val domainNameCursor = domainsDatabaseHelper!!.domainNameCursorOrderedByDomain
+ // Scroll to the new bookmark.
+ bookmarksListView.setSelection(newBookmarkDisplayOrder)
+ }
- // Initialize the domain settings set.
- val domainSettingsSet: MutableSet<String> = HashSet()
+ override fun createBookmarkFolder(dialogFragment: DialogFragment) {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
- // Get the domain name column index.
- val domainNameColumnIndex = domainNameCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.DOMAIN_NAME)
+ // Get handles for the views in the dialog fragment.
+ val defaultFolderIconRadioButton = dialog.findViewById<RadioButton>(R.id.default_folder_icon_radiobutton)
+ val defaultFolderIconImageView = dialog.findViewById<ImageView>(R.id.default_folder_icon_imageview)
+ val webpageFavoriteIconRadioButton = dialog.findViewById<RadioButton>(R.id.webpage_favorite_icon_radiobutton)
+ val webpageFavoriteIconImageView = dialog.findViewById<ImageView>(R.id.webpage_favorite_icon_imageview)
+ val customIconImageView = dialog.findViewById<ImageView>(R.id.custom_icon_imageview)
+ val folderNameEditText = dialog.findViewById<EditText>(R.id.folder_name_edittext)
- // Populate the domain settings set.
- for (i in 0 until domainNameCursor.count) {
- // Move the domains cursor to the current row.
- domainNameCursor.moveToPosition(i)
+ // Get new folder name string.
+ val folderNameString = folderNameEditText.text.toString()
- // Store the domain name in the domain settings set.
- domainSettingsSet.add(domainNameCursor.getString(domainNameColumnIndex))
- }
+ // Set the folder icon bitmap according to the dialog.
+ val folderIconDrawable = if (defaultFolderIconRadioButton.isChecked) // Use the default folder icon.
+ defaultFolderIconImageView.drawable
+ else if (webpageFavoriteIconRadioButton.isChecked) // Use the webpage favorite icon.
+ webpageFavoriteIconImageView.drawable
+ else // Use the custom icon.
+ customIconImageView.drawable
- // Close the domain name cursor.
- domainNameCursor.close()
+ // Cast the folder icon bitmap to a bitmap drawable.
+ val folderIconBitmapDrawable = folderIconDrawable as BitmapDrawable
- // Initialize the domain name in database variable.
- var domainNameInDatabase: String? = null
+ // Convert the folder icon bitmap drawable to a bitmap.
+ val folderIconBitmap = folderIconBitmapDrawable.bitmap
- // Check the hostname against the domain settings set.
- if (domainSettingsSet.contains(newHostName)) { // The hostname is contained in the domain settings set.
- // Record the domain name in the database.
- domainNameInDatabase = newHostName
+ // Create a folder icon byte array output stream.
+ val folderIconByteArrayOutputStream = ByteArrayOutputStream()
- // Set the domain settings applied tracker to true.
- nestedScrollWebView.domainSettingsApplied = true
- } else { // The hostname is not contained in the domain settings set.
- // Set the domain settings applied tracker to false.
- nestedScrollWebView.domainSettingsApplied = false
- }
+ // Convert the folder icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
+ folderIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, folderIconByteArrayOutputStream)
- // Check all the subdomains of the host name against wildcard domains in the domain cursor.
- while (!nestedScrollWebView.domainSettingsApplied && newHostName!!.contains(".")) { // Stop checking if domain settings are already applied or there are no more `.` in the hostname.
- if (domainSettingsSet.contains("*.$newHostName")) { // Check the host name prepended by `*.`.
- // Set the domain settings applied tracker to true.
- nestedScrollWebView.domainSettingsApplied = true
+ // Convert the folder icon byte array stream to a byte array.
+ val folderIconByteArray = folderIconByteArrayOutputStream.toByteArray()
- // Store the applied domain names as it appears in the database.
- domainNameInDatabase = "*.$newHostName"
- }
+ // Move all the bookmarks down one in the display order.
+ for (i in 0 until bookmarksListView.count) {
+ // Get the bookmark database id.
+ val databaseId = bookmarksListView.getItemIdAtPosition(i).toInt()
- // Strip out the lowest subdomain of of the host name.
- newHostName = newHostName.substring(newHostName.indexOf(".") + 1)
- }
+ // Move the bookmark down one slot.
+ bookmarksDatabaseHelper!!.updateDisplayOrder(databaseId, displayOrder = i + 1)
+ }
- // Store the general preference information.
- val defaultFontSizeString = sharedPreferences.getString(getString(R.string.font_size_key), getString(R.string.font_size_default_value))
- val defaultUserAgentName = sharedPreferences.getString(getString(R.string.user_agent_key), getString(R.string.user_agent_default_value))
- val defaultSwipeToRefresh = sharedPreferences.getBoolean(getString(R.string.swipe_to_refresh_key), true)
- val webViewTheme = sharedPreferences.getString(getString(R.string.webview_theme_key), getString(R.string.webview_theme_default_value))
- val wideViewport = sharedPreferences.getBoolean(getString(R.string.wide_viewport_key), true)
- val displayWebpageImages = sharedPreferences.getBoolean(getString(R.string.display_webpage_images_key), true)
+ // Create the folder, which will be placed at the top of the list view.
+ bookmarksDatabaseHelper!!.createFolder(folderNameString, currentBookmarksFolderId, displayOrder = 0, folderIconByteArray)
- // Get the WebView theme entry values string array.
- val webViewThemeEntryValuesStringArray = resources.getStringArray(R.array.webview_theme_entry_values)
+ // Update the bookmarks cursor with the current contents of this folder.
+ bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolderId)
- // Initialize the user agent array adapter and string array.
- val userAgentNamesArray = ArrayAdapter.createFromResource(this, R.array.user_agent_names, R.layout.spinner_item)
- val userAgentDataArray = resources.getStringArray(R.array.user_agent_data)
+ // Update the list view.
+ bookmarksCursorAdapter.changeCursor(bookmarksCursor)
- // Apply either the domain settings for the default settings.
- if (nestedScrollWebView.domainSettingsApplied) { // The url has custom domain settings.
- // Get a cursor for the current host.
- val currentDomainSettingsCursor = domainsDatabaseHelper!!.getCursorForDomainName(domainNameInDatabase!!)
+ // Scroll to the new folder.
+ bookmarksListView.setSelection(0)
+ }
- // Move to the first position.
- currentDomainSettingsCursor.moveToFirst()
+ private fun exitFullScreenVideo() {
+ // Re-enable the screen timeout.
+ fullScreenVideoFrameLayout.keepScreenOn = false
- // Get the settings from the cursor.
- nestedScrollWebView.domainSettingsDatabaseId = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ID))
- nestedScrollWebView.settings.javaScriptEnabled = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_JAVASCRIPT)) == 1
- nestedScrollWebView.acceptCookies = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.COOKIES)) == 1
- nestedScrollWebView.settings.domStorageEnabled = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_DOM_STORAGE)) == 1
- // Form data can be removed once the minimum API >= 26.
- val saveFormData = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_FORM_DATA)) == 1
- nestedScrollWebView.easyListEnabled = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_EASYLIST)) == 1
- nestedScrollWebView.easyPrivacyEnabled = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_EASYPRIVACY)) == 1
- nestedScrollWebView.fanboysAnnoyanceListEnabled = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_FANBOYS_ANNOYANCE_LIST)) == 1
- nestedScrollWebView.fanboysSocialBlockingListEnabled =
- currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_FANBOYS_SOCIAL_BLOCKING_LIST)) == 1
- nestedScrollWebView.ultraListEnabled = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ULTRALIST)) == 1
- nestedScrollWebView.ultraPrivacyEnabled = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.ENABLE_ULTRAPRIVACY)) == 1
- nestedScrollWebView.blockAllThirdPartyRequests = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.BLOCK_ALL_THIRD_PARTY_REQUESTS)) == 1
- val userAgentName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.USER_AGENT))
- val fontSize = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.FONT_SIZE))
- val swipeToRefreshInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SWIPE_TO_REFRESH))
- val webViewThemeInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.WEBVIEW_THEME))
- val wideViewportInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.WIDE_VIEWPORT))
- val displayWebpageImagesInt = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.DISPLAY_IMAGES))
- val pinnedSslCertificate = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.PINNED_SSL_CERTIFICATE)) == 1
- val pinnedSslIssuedToCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_TO_COMMON_NAME))
- val pinnedSslIssuedToOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATION))
- val pinnedSslIssuedToUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_TO_ORGANIZATIONAL_UNIT))
- val pinnedSslIssuedByCName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_BY_COMMON_NAME))
- val pinnedSslIssuedByOName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATION))
- val pinnedSslIssuedByUName = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_ISSUED_BY_ORGANIZATIONAL_UNIT))
- val pinnedSslStartDate = Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_START_DATE)))
- val pinnedSslEndDate = Date(currentDomainSettingsCursor.getLong(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.SSL_END_DATE)))
- val pinnedIpAddresses = currentDomainSettingsCursor.getInt(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.PINNED_IP_ADDRESSES)) == 1
- val pinnedHostIpAddresses = currentDomainSettingsCursor.getString(currentDomainSettingsCursor.getColumnIndexOrThrow(DomainsDatabaseHelper.IP_ADDRESSES))
+ // Unset the full screen video flag.
+ displayingFullScreenVideo = false
- // Close the current host domain settings cursor.
- currentDomainSettingsCursor.close()
+ // Remove all the views from the full screen video frame layout.
+ fullScreenVideoFrameLayout.removeAllViews()
- // If there is a pinned SSL certificate, store it in the WebView.
- if (pinnedSslCertificate)
- nestedScrollWebView.setPinnedSslCertificate(pinnedSslIssuedToCName, pinnedSslIssuedToOName, pinnedSslIssuedToUName, pinnedSslIssuedByCName, pinnedSslIssuedByOName, pinnedSslIssuedByUName,
- pinnedSslStartDate, pinnedSslEndDate)
+ // Hide the full screen video frame layout.
+ fullScreenVideoFrameLayout.visibility = View.GONE
- // If there is a pinned IP address, store it in the WebView.
- if (pinnedIpAddresses)
- nestedScrollWebView.pinnedIpAddresses = pinnedHostIpAddresses
+ // Enable the sliding drawers.
+ drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED)
- // Apply the cookie domain settings.
- cookieManager.setAcceptCookie(nestedScrollWebView.acceptCookies)
+ // Show the coordinator layout.
+ coordinatorLayout.visibility = View.VISIBLE
- // Apply the form data setting if the API < 26.
- @Suppress("DEPRECATION")
- if (Build.VERSION.SDK_INT < 26)
- nestedScrollWebView.settings.saveFormData = saveFormData
+ // Apply the appropriate full screen mode flags.
+ if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
+ // Hide the app bar if specified.
+ if (hideAppBar) {
+ // Hide the tab linear layout.
+ tabsLinearLayout.visibility = View.GONE
- // Apply the font size.
- try { // Try the specified font size to see if it is valid.
- if (fontSize == 0) { // Apply the default font size.
- // Set the font size from the value in the app settings.
- nestedScrollWebView.settings.textZoom = defaultFontSizeString!!.toInt()
- } else { // Apply the font size from domain settings.
- nestedScrollWebView.settings.textZoom = fontSize
- }
- } catch (exception: Exception) { // The specified font size is invalid
- // Set the font size to be 100%
- nestedScrollWebView.settings.textZoom = 100
- }
-
- // Set the user agent.
- if (userAgentName == getString(R.string.system_default_user_agent)) { // Use the system default user agent.
- // Set the user agent according to the system default.
- when (val defaultUserAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName)) {
- // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
- UNRECOGNIZED_USER_AGENT -> nestedScrollWebView.settings.userAgentString = defaultUserAgentName
-
- // Set the user agent to `""`, which uses the default value.
- SETTINGS_WEBVIEW_DEFAULT_USER_AGENT -> nestedScrollWebView.settings.userAgentString = ""
-
- // Set the default custom user agent.
- SETTINGS_CUSTOM_USER_AGENT -> nestedScrollWebView.settings.userAgentString =
- sharedPreferences.getString(getString(R.string.custom_user_agent_key), getString(R.string.custom_user_agent_default_value))
+ // Hide the app bar.
+ appBar.hide()
+ }
- // Get the user agent string from the user agent data array
- else -> nestedScrollWebView.settings.userAgentString = userAgentDataArray[defaultUserAgentArrayPosition]
- }
- } else { // Set the user agent according to the stored name.
- // Set the user agent.
- when (val userAgentArrayPosition = userAgentNamesArray.getPosition(userAgentName)) {
- // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
- UNRECOGNIZED_USER_AGENT ->
- nestedScrollWebView.settings.userAgentString = userAgentName
+ /* Hide the system bars.
+ * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
+ * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
+ * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
+ * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
+ */
- // Set the user agent to `""`, which uses the default value.
- SETTINGS_WEBVIEW_DEFAULT_USER_AGENT ->
- nestedScrollWebView.settings.userAgentString = ""
+ // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
+ @Suppress("DEPRECATION")
+ rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
+ } else { // Switch to normal viewing mode.
+ // Remove the `SYSTEM_UI` flags from the root frame layout. The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
+ @Suppress("DEPRECATION")
+ rootFrameLayout.systemUiVisibility = 0
+ }
+ }
- // Get the user agent string from the user agent data array.
- else ->
- nestedScrollWebView.settings.userAgentString = userAgentDataArray[userAgentArrayPosition]
- }
- }
+ // The view parameter cannot be removed because it is called from the layout onClick.
+ fun findNextOnPage(@Suppress("UNUSED_PARAMETER")view: View?) {
+ // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
+ currentWebView!!.findNext(true)
+ }
- // Set swipe to refresh.
- when (swipeToRefreshInt) {
- DomainsDatabaseHelper.SYSTEM_DEFAULT -> {
- // Store the swipe to refresh status in the nested scroll WebView.
- nestedScrollWebView.swipeToRefresh = defaultSwipeToRefresh
+ // The view parameter cannot be removed because it is called from the layout onClick.
+ fun findPreviousOnPage(@Suppress("UNUSED_PARAMETER")view: View?) {
+ // Go to the previous highlighted phrase on the page. `false` goes backwards instead of forwards.
+ currentWebView!!.findNext(false)
+ }
- // Update the swipe refresh layout.
- if (defaultSwipeToRefresh) { // Swipe to refresh is enabled.
- // Update the status of the swipe refresh layout if the current WebView is not null (crash reports indicate that in some unexpected way it sometimes is null).
- if (currentWebView != null) {
- // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
- swipeRefreshLayout.isEnabled = (currentWebView!!.scrollY == 0)
- }
- } else { // Swipe to refresh is disabled.
- // Disable the swipe refresh layout.
- swipeRefreshLayout.isEnabled = false
- }
- }
+ override fun finishedPopulatingFilterLists(combinedFilterLists: ArrayList<ArrayList<List<Array<String>>>>) {
+ // Store the filter lists.
+ easyList = combinedFilterLists[0]
+ easyPrivacy = combinedFilterLists[1]
+ fanboysAnnoyanceList = combinedFilterLists[2]
+ fanboysSocialList = combinedFilterLists[3]
+ ultraList = combinedFilterLists[4]
+ ultraPrivacy = combinedFilterLists[5]
- DomainsDatabaseHelper.ENABLED -> {
- // Store the swipe to refresh status in the nested scroll WebView.
- nestedScrollWebView.swipeToRefresh = true
+ // Check to see if the activity has been restarted with a saved state.
+ if ((savedStateArrayList == null) || (savedStateArrayList!!.size == 0)) { // The activity has not been restarted or it was restarted on start to change the theme.
+ // Add the first tab.
+ addNewPage(urlString = "", adjacent = false, moveToTab = false)
+ } else { // The activity has been restarted with a saved state.
+ // Restore each tab.
+ for (i in savedStateArrayList!!.indices) {
+ // Add a new tab.
+ tabLayout.addTab(tabLayout.newTab())
- // Update the status of the swipe refresh layout if the current WebView is not null (crash reports indicate that in some unexpected way it sometimes is null).
- if (currentWebView != null) {
- // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
- swipeRefreshLayout.isEnabled = (currentWebView!!.scrollY == 0)
- }
- }
+ // Get the new tab.
+ val newTab = tabLayout.getTabAt(i)!!
- DomainsDatabaseHelper.DISABLED -> {
- // Store the swipe to refresh status in the nested scroll WebView.
- nestedScrollWebView.swipeToRefresh = false
+ // Set a custom view on the new tab.
+ newTab.setCustomView(R.layout.tab_custom_view)
- // Disable swipe to refresh.
- swipeRefreshLayout.isEnabled = false
- }
- }
+ // Add the new page.
+ webViewStateAdapter!!.restorePage(savedStateArrayList!![i], savedNestedScrollWebViewStateArrayList!![i])
+ }
- // Set the WebView theme if device is running API >= 29 and algorithmic darkening is supported.
- if ((Build.VERSION.SDK_INT >= 29) && WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING)) {
- // Set the WebView theme.
- when (webViewThemeInt) {
- // Set the WebView theme.
- DomainsDatabaseHelper.SYSTEM_DEFAULT ->
- when (webViewTheme) {
- // The light theme is selected. Turn off algorithmic darkening.
- webViewThemeEntryValuesStringArray[1] -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
+ // Reset the saved state variables.
+ savedStateArrayList = null
+ savedNestedScrollWebViewStateArrayList = null
- // The dark theme is selected. Turn on algorithmic darkening.
- webViewThemeEntryValuesStringArray[2] -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
+ // Get the intent that started the app.
+ val intent = intent
- // The system default theme is selected.
- else -> {
- // Get the current system theme status.
- val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
+ // Reset the intent. This prevents a duplicate tab from being created on restart.
+ setIntent(Intent())
- // Set the algorithmic darkening according to the current system theme status.
- WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, currentThemeStatus == Configuration.UI_MODE_NIGHT_YES)
- }
- }
+ // Get the information from the intent.
+ val intentAction = intent.action
+ val intentUriData = intent.data
+ val intentStringExtra = intent.getStringExtra(Intent.EXTRA_TEXT)
- // Turn off algorithmic darkening.
- DomainsDatabaseHelper.LIGHT_THEME -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
+ // Determine if this is a web search.
+ val isWebSearch = (intentAction != null) && (intentAction == Intent.ACTION_WEB_SEARCH)
- // Turn on algorithmic darkening.
- DomainsDatabaseHelper.DARK_THEME -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
+ // Only process the URI if it contains data or it is a web search. If the user pressed the desktop icon after the app was already running the URI will be null.
+ if ((intentUriData != null) || (intentStringExtra != null) || isWebSearch) { // A new tab is being loaded.
+ // Get the URL string.
+ val urlString = if (isWebSearch) { // The intent is a web search.
+ // Sanitize the search input.
+ val encodedSearchString: String = try {
+ URLEncoder.encode(intent.getStringExtra(SearchManager.QUERY), "UTF-8")
+ } catch (exception: UnsupportedEncodingException) {
+ ""
}
- }
-
- // Set the wide viewport status.
- when (wideViewportInt) {
- DomainsDatabaseHelper.SYSTEM_DEFAULT -> nestedScrollWebView.settings.useWideViewPort = wideViewport
- DomainsDatabaseHelper.ENABLED -> nestedScrollWebView.settings.useWideViewPort = true
- DomainsDatabaseHelper.DISABLED -> nestedScrollWebView.settings.useWideViewPort = false
- }
- // Set the display webpage images status.
- when (displayWebpageImagesInt) {
- DomainsDatabaseHelper.SYSTEM_DEFAULT -> nestedScrollWebView.settings.loadsImagesAutomatically = displayWebpageImages
- DomainsDatabaseHelper.ENABLED -> nestedScrollWebView.settings.loadsImagesAutomatically = true
- DomainsDatabaseHelper.DISABLED -> nestedScrollWebView.settings.loadsImagesAutomatically = false
+ // Add the base search URL.
+ searchURL + encodedSearchString
+ } else { // The intent contains a URL formatted as a URI or a URL in the string extra.
+ // Get the URL string.
+ intentUriData?.toString() ?: intentStringExtra!!
}
- // Set a background on the URL relative layout to indicate that custom domain settings are being used.
- urlRelativeLayout.background = AppCompatResources.getDrawable(this, R.drawable.domain_settings_url_background)
- } else { // The new URL does not have custom domain settings. Load the defaults.
- // Store the values from the shared preferences.
- nestedScrollWebView.settings.javaScriptEnabled = sharedPreferences.getBoolean(getString(R.string.javascript_key), false)
- nestedScrollWebView.acceptCookies = sharedPreferences.getBoolean(getString(R.string.cookies_key), false)
- nestedScrollWebView.settings.domStorageEnabled = sharedPreferences.getBoolean(getString(R.string.dom_storage_key), false)
- val saveFormData = sharedPreferences.getBoolean(getString(R.string.save_form_data_key), false) // Form data can be removed once the minimum API >= 26.
- nestedScrollWebView.easyListEnabled = sharedPreferences.getBoolean(getString(R.string.easylist_key), true)
- nestedScrollWebView.easyPrivacyEnabled = sharedPreferences.getBoolean(getString(R.string.easyprivacy_key), true)
- nestedScrollWebView.fanboysAnnoyanceListEnabled = sharedPreferences.getBoolean(getString(R.string.fanboys_annoyance_list_key), true)
- nestedScrollWebView.fanboysSocialBlockingListEnabled = sharedPreferences.getBoolean(getString(R.string.fanboys_social_blocking_list_key), true)
- nestedScrollWebView.ultraListEnabled = sharedPreferences.getBoolean(getString(R.string.ultralist_key), true)
- nestedScrollWebView.ultraPrivacyEnabled = sharedPreferences.getBoolean(getString(R.string.ultraprivacy_key), true)
- nestedScrollWebView.blockAllThirdPartyRequests = sharedPreferences.getBoolean(getString(R.string.block_all_third_party_requests_key), false)
-
- // Apply the default cookie setting.
- cookieManager.setAcceptCookie(nestedScrollWebView.acceptCookies)
+ // Add a new tab if specified in the preferences.
+ if (sharedPreferences.getBoolean(getString(R.string.open_intents_in_new_tab_key), true)) { // Load the URL in a new tab.
+ // Set the loading new intent flag.
+ loadingNewIntent = true
- // Apply the default font size setting.
- try {
- // Try to set the font size from the value in the app settings.
- nestedScrollWebView.settings.textZoom = defaultFontSizeString!!.toInt()
- } catch (exception: Exception) {
- // If the app settings value is invalid, set the font size to 100%.
- nestedScrollWebView.settings.textZoom = 100
+ // Add a new tab.
+ addNewPage(urlString, adjacent = false, moveToTab = true)
+ } else { // Load the URL in the current tab.
+ // Make it so.
+ loadUrl(currentWebView!!, urlString)
}
+ } else { // A new tab is not being loaded.
+ // Restore the selected tab position.
+ if (savedTabPosition == 0) { // The first tab is selected.
+ // Set the first page as the current WebView.
+ setCurrentWebView(0)
+ } else { // The first tab is not selected.
+ // Select the tab when the layout has finished populating.
+ tabLayout.post {
+ // Get a handle for the tab.
+ val tab = tabLayout.getTabAt(savedTabPosition)!!
- // Apply the form data setting if the API < 26.
- if (Build.VERSION.SDK_INT < 26)
- @Suppress("DEPRECATION")
- nestedScrollWebView.settings.saveFormData = saveFormData
-
- // Store the swipe to refresh status in the nested scroll WebView.
- nestedScrollWebView.swipeToRefresh = defaultSwipeToRefresh
-
- // Update the swipe refresh layout.
- if (defaultSwipeToRefresh) { // Swipe to refresh is enabled.
- // Update the status of the swipe refresh layout if the current WebView is not null (crash reports indicate that in some unexpected way it sometimes is null).
- if (currentWebView != null) {
- // Only enable the swipe refresh layout if the WebView is scrolled to the top. It is updated every time the scroll changes.
- swipeRefreshLayout.isEnabled = currentWebView!!.scrollY == 0
+ // Select the tab.
+ tab.select()
}
- } else { // Swipe to refresh is disabled.
- // Disable the swipe refresh layout.
- swipeRefreshLayout.isEnabled = false
}
+ }
+ }
+ }
- // Reset the domain settings database ID.
- nestedScrollWebView.domainSettingsDatabaseId = -1
+ // Remove the warning that `OnTouchListener()` needs to override `performClick()`, as the only purpose of setting the `OnTouchListener()` is to make it do nothing.
+ @SuppressLint("ClickableViewAccessibility")
+ private fun initializeApp() {
+ // Get a handle for the input method.
+ inputMethodManager = (getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager)
- // Set the user agent.
- when (val userAgentArrayPosition = userAgentNamesArray.getPosition(defaultUserAgentName)) {
- // This is probably because it was set in an older version of Privacy Browser before the switch to persistent user agent names.
- UNRECOGNIZED_USER_AGENT -> nestedScrollWebView.settings.userAgentString = defaultUserAgentName
+ // Initialize the color spans for highlighting the URLs.
+ initialGrayColorSpan = ForegroundColorSpan(getColor(R.color.gray_500))
+ finalGrayColorSpan = ForegroundColorSpan(getColor(R.color.gray_500))
+ redColorSpan = ForegroundColorSpan(getColor(R.color.red_text))
+
+ // Remove the formatting from the URL edit text when the user is editing the text.
+ urlEditText.onFocusChangeListener = View.OnFocusChangeListener { _: View?, hasFocus: Boolean ->
+ if (hasFocus) { // The user is editing the URL text box.
+ // Remove the syntax highlighting.
+ urlEditText.text.removeSpan(redColorSpan)
+ urlEditText.text.removeSpan(initialGrayColorSpan)
+ urlEditText.text.removeSpan(finalGrayColorSpan)
+ } else { // The user has stopped editing the URL text box.
+ // Move to the beginning of the string.
+ urlEditText.setSelection(0)
- // Set the user agent to `""`, which uses the default value.
- SETTINGS_WEBVIEW_DEFAULT_USER_AGENT -> nestedScrollWebView.settings.userAgentString = ""
+ // Reapply the syntax highlighting.
+ UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
+ }
+ }
- // Set the default custom user agent.
- SETTINGS_CUSTOM_USER_AGENT -> nestedScrollWebView.settings.userAgentString =
- sharedPreferences.getString(getString(R.string.custom_user_agent_key), getString(R.string.custom_user_agent_default_value))
+ // Set the go button on the keyboard to load the URL in url text box.
+ urlEditText.setOnKeyListener { _: View?, keyCode: Int, keyEvent: KeyEvent ->
+ // If the event is a key-down event on the `enter` button, load the URL.
+ if ((keyEvent.action == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) { // The enter key was pressed.
+ // Load the URL.
+ loadUrlFromTextBox()
- // Get the user agent string from the user agent data array
- else -> nestedScrollWebView.settings.userAgentString = userAgentDataArray[userAgentArrayPosition]
- }
+ // Consume the event.
+ return@setOnKeyListener true
+ } else { // Some other key was pressed.
+ // Do not consume the event.
+ return@setOnKeyListener false
+ }
+ }
- // Set the WebView theme if the device is running API >= 29 and algorithmic darkening is supported.
- if ((Build.VERSION.SDK_INT >= 29) && WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING)) {
- // Set the WebView theme.
- when (webViewTheme) {
- // The light theme is selected. Turn off algorithmic darkening.
- webViewThemeEntryValuesStringArray[1] -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
+ // Create an Orbot status broadcast receiver.
+ orbotStatusBroadcastReceiver = object : BroadcastReceiver() {
+ override fun onReceive(context: Context, intent: Intent) {
+ // Get the content of the status message.
+ orbotStatus = intent.getStringExtra("org.torproject.android.intent.extra.STATUS")!!
- // The dark theme is selected. Turn on algorithmic darkening.
- webViewThemeEntryValuesStringArray[2] -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
+ // If Privacy Browser is waiting on the proxy, load the website now that Orbot is connected.
+ if ((orbotStatus == ProxyHelper.ORBOT_STATUS_ON) && waitingForProxy) {
+ // Reset the waiting for proxy status.
+ waitingForProxy = false
- // The system default theme is selected. Get the current system theme status.
- else -> {
- // Get the current theme status.
- val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
+ // Get a list of the current fragments.
+ val fragmentList = supportFragmentManager.fragments
- // Set the algorithmic darkening according to the current system theme status.
- WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, currentThemeStatus == Configuration.UI_MODE_NIGHT_YES)
+ // Check each fragment to see if it is a waiting for proxy dialog. Sometimes more than one is displayed.
+ for (i in fragmentList.indices) {
+ // Get the fragment tag.
+ val fragmentTag = fragmentList[i].tag
+
+ // Check to see if it is the waiting for proxy dialog.
+ if (fragmentTag != null && fragmentTag == getString(R.string.waiting_for_proxy_dialog)) {
+ // Dismiss the waiting for proxy dialog.
+ (fragmentList[i] as DialogFragment).dismiss()
}
}
- }
- // Set the viewport.
- nestedScrollWebView.settings.useWideViewPort = wideViewport
+ // Reload existing URLs and load any URLs that are waiting for the proxy.
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
+ // Get the WebView tab fragment.
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
- // Set the loading of webpage images.
- nestedScrollWebView.settings.loadsImagesAutomatically = displayWebpageImages
+ // Get the fragment view.
+ val fragmentView = webViewTabFragment.view
- // Set a transparent background on the URL relative layout.
- urlRelativeLayout.background = AppCompatResources.getDrawable(this, R.color.transparent)
- }
-
- // Update the privacy icons.
- updatePrivacyIcons(true)
- }
-
- // Reload the website if returning from the Domains activity.
- if (reloadWebsite)
- nestedScrollWebView.reload()
-
- // Load the URL if directed. This makes sure that the domain settings are properly loaded before the URL. By using `loadUrl()`, instead of `loadUrlFromBase()`, the Referer header will never be sent.
- if (loadUrl)
- nestedScrollWebView.loadUrl(url)
- }
-
- private fun applyProxy(reloadWebViews: Boolean) {
- // Set the proxy according to the mode.
- proxyHelper.setProxy(applicationContext, appBarLayout, proxyMode)
-
- // Reset the waiting for proxy tracker.
- waitingForProxy = false
-
- // Set the proxy.
- when (proxyMode) {
- ProxyHelper.NONE -> {
- // Initialize a color background typed value.
- val colorBackgroundTypedValue = TypedValue()
+ // Only process the WebViews if they exist.
+ if (fragmentView != null) {
+ // Get the nested scroll WebView from the tab fragment.
+ val nestedScrollWebView = fragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
- // Get the color background from the theme.
- theme.resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true)
+ // Get the waiting for proxy URL string.
+ val waitingForProxyUrlString = nestedScrollWebView.waitingForProxyUrlString
- // Get the color background int from the typed value.
- val colorBackgroundInt = colorBackgroundTypedValue.data
+ // Load the pending URL if it exists.
+ if (waitingForProxyUrlString.isNotEmpty()) { // A URL is waiting to be loaded.
+ // Load the URL.
+ loadUrl(nestedScrollWebView, waitingForProxyUrlString)
- // Set the default app bar layout background.
- appBarLayout.setBackgroundColor(colorBackgroundInt)
+ // Reset the waiting for proxy URL string.
+ nestedScrollWebView.waitingForProxyUrlString = ""
+ } else { // No URL is waiting to be loaded.
+ // Reload the existing URL.
+ nestedScrollWebView.reload()
+ }
+ }
+ }
+ }
}
+ }
- ProxyHelper.TOR -> {
- // Set the app bar background to indicate proxying is enabled.
- appBarLayout.setBackgroundResource(R.color.proxy_appbar_background)
-
- // Check to see if Orbot is installed.
- try {
- // Get the package manager.
- val packageManager = packageManager
-
- // Check to see if Orbot is in the list. This will throw an error and drop to the catch section if it isn't installed. The deprecated method must be used until the minimum API >= 33.
- @Suppress("DEPRECATION")
- packageManager.getPackageInfo("org.torproject.android", 0)
+ // Register the Orbot status broadcast receiver. `ContextCompat` must be used until the minimum API >= 34.
+ ContextCompat.registerReceiver(this, orbotStatusBroadcastReceiver, IntentFilter("org.torproject.android.intent.action.STATUS"), ContextCompat.RECEIVER_EXPORTED)
- // Check to see if the proxy is ready.
- if (orbotStatus != ProxyHelper.ORBOT_STATUS_ON) { // Orbot is not ready.
- // Set the waiting for proxy status.
- waitingForProxy = true
+ // Get handles for views that need to be modified.
+ val bookmarksHeaderLinearLayout = findViewById<LinearLayout>(R.id.bookmarks_header_linearlayout)
+ val launchBookmarksActivityFab = findViewById<FloatingActionButton>(R.id.launch_bookmarks_activity_fab)
+ val createBookmarkFolderFab = findViewById<FloatingActionButton>(R.id.create_bookmark_folder_fab)
+ val createBookmarkFab = findViewById<FloatingActionButton>(R.id.create_bookmark_fab)
- // Show the waiting for proxy dialog if it isn't already displayed.
- if (supportFragmentManager.findFragmentByTag(getString(R.string.waiting_for_proxy_dialog)) == null) {
- // Get a handle for the waiting for proxy alert dialog.
- val waitingForProxyDialogFragment = WaitingForProxyDialog()
+ // Handle tab selections.
+ tabLayout.addOnTabSelectedListener(object : TabLayout.OnTabSelectedListener {
+ override fun onTabSelected(tab: TabLayout.Tab) {
+ // Close the find on page bar if it is open.
+ closeFindOnPage(null)
- // Try to show the dialog. Sometimes the window is not yet active if returning from Settings.
- try {
- // Show the waiting for proxy alert dialog.
- waitingForProxyDialogFragment.show(supportFragmentManager, getString(R.string.waiting_for_proxy_dialog))
- } catch (waitingForTorException: Exception) {
- // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
- pendingDialogsArrayList.add(PendingDialogDataClass(waitingForProxyDialogFragment, getString(R.string.waiting_for_proxy_dialog)))
- }
- }
- }
- } catch (exception: PackageManager.NameNotFoundException) { // Orbot is not installed.
- // Show the Orbot not installed dialog if it is not already displayed.
- if (supportFragmentManager.findFragmentByTag(getString(R.string.proxy_not_installed_dialog)) == null) {
- // Get a handle for the Orbot not installed alert dialog.
- val orbotNotInstalledDialogFragment = ProxyNotInstalledDialog.displayDialog(proxyMode)
+ // Update the view pager when it has quiesced. Otherwise, if a page launched by a new intent on restart has not yet been created, the view pager will not be updated to match the tab layout.
+ webViewViewPager2.post {
+ // Select the same page in the view pager.
+ webViewViewPager2.currentItem = tab.position
- // Try to show the dialog. Sometimes the window is not yet active if returning from Settings.
- try {
- // Display the Orbot not installed alert dialog.
- orbotNotInstalledDialogFragment.show(supportFragmentManager, getString(R.string.proxy_not_installed_dialog))
- } catch (orbotNotInstalledException: Exception) {
- // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
- pendingDialogsArrayList.add(PendingDialogDataClass(orbotNotInstalledDialogFragment, getString(R.string.proxy_not_installed_dialog)))
- }
+ // Set the current WebView after the tab layout has quiesced (otherwise, sometimes the wong WebView might be used). See <https://redmine.stoutner.com/issues/1136>
+ tabLayout.post {
+ setCurrentWebView(tab.position)
}
}
}
- ProxyHelper.I2P -> {
- // Set the app bar background to indicate proxying is enabled.
- appBarLayout.setBackgroundResource(R.color.proxy_appbar_background)
-
- // Check to see if I2P is installed.
- try {
- // Check to see if the F-Droid flavor is installed. This will throw an error and drop to the catch section if it isn't installed.
- // The deprecated method must be used until the minimum API >= 33.
- @Suppress("DEPRECATION")
- packageManager.getPackageInfo("net.i2p.android.router", 0)
- } catch (fdroidException: PackageManager.NameNotFoundException) { // The F-Droid flavor is not installed.
- try {
- // Check to see if the Google Play flavor is installed. This will throw an error and drop to the catch section if it isn't installed.
- // The deprecated method must be used until the minimum API >= 33.
- @Suppress("DEPRECATION")
- packageManager.getPackageInfo("net.i2p.android", 0)
- } catch (googlePlayException: PackageManager.NameNotFoundException) { // The Google Play flavor is not installed.
- // Sow the I2P not installed dialog if it is not already displayed.
- if (supportFragmentManager.findFragmentByTag(getString(R.string.proxy_not_installed_dialog)) == null) {
- // Get a handle for the waiting for proxy alert dialog.
- val i2pNotInstalledDialogFragment = ProxyNotInstalledDialog.displayDialog(proxyMode)
+ override fun onTabUnselected(tab: TabLayout.Tab) {}
- // Try to show the dialog. Sometimes the window is not yet active if returning from Settings.
- try {
- // Display the I2P not installed alert dialog.
- i2pNotInstalledDialogFragment.show(supportFragmentManager, getString(R.string.proxy_not_installed_dialog))
- } catch (i2pNotInstalledException: Exception) {
- // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
- pendingDialogsArrayList.add(PendingDialogDataClass(i2pNotInstalledDialogFragment, getString(R.string.proxy_not_installed_dialog)))
- }
- }
- }
+ override fun onTabReselected(tab: TabLayout.Tab) {
+ // Only display the view SSL certificate dialog if the current WebView is not null.
+ // This can happen if the tab is programmatically reselected while the app is being restarted and is not yet populated.
+ if (currentWebView != null) {
+ // Instantiate the View SSL Certificate dialog.
+ val viewSslCertificateDialogFragment: DialogFragment = ViewSslCertificateDialog.displayDialog(currentWebView!!.webViewFragmentId, currentWebView!!.getFavoriteIcon())
+
+ // Display the View SSL Certificate dialog.
+ viewSslCertificateDialogFragment.show(supportFragmentManager, getString(R.string.view_ssl_certificate))
}
}
+ })
- ProxyHelper.CUSTOM ->
- // Set the app bar background to indicate proxying is enabled.
- appBarLayout.setBackgroundResource(R.color.proxy_appbar_background)
- }
-
- // Reload the WebViews if requested and not waiting for the proxy.
- if (reloadWebViews && !waitingForProxy) {
- // Reload the WebViews.
- for (i in 0 until webViewPagerAdapter!!.count) {
- // Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
+ // Set a touch listener on the bookmarks header linear layout so that touches don't pass through to the button underneath.
+ bookmarksHeaderLinearLayout.setOnTouchListener { _: View?, _: MotionEvent? -> true }
- // Get the fragment view.
- val fragmentView = webViewTabFragment.view
+ // Set the launch bookmarks activity floating action button to launch the bookmarks activity.
+ launchBookmarksActivityFab.setOnClickListener {
+ // Get a copy of the favorite icon bitmap.
+ val currentFavoriteIconBitmap = currentWebView!!.getFavoriteIcon()
- // Only reload the WebViews if they exist.
- if (fragmentView != null) {
- // Get the nested scroll WebView from the tab fragment.
- val nestedScrollWebView = fragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
+ // Create a favorite icon byte array output stream.
+ val currentFavoriteIconByteArrayOutputStream = ByteArrayOutputStream()
- // Reload the WebView.
- nestedScrollWebView.reload()
- }
- }
- }
- }
+ // Convert the favorite icon bitmap to a byte array. `0` is for lossless compression (the only option for a PNG).
+ currentFavoriteIconBitmap.compress(Bitmap.CompressFormat.PNG, 0, currentFavoriteIconByteArrayOutputStream)
- private fun updatePrivacyIcons(runInvalidateOptionsMenu: Boolean) {
- // Only update the privacy icons if the options menu and the current WebView have already been populated.
- if ((optionsMenu != null) && (currentWebView != null)) {
- // Update the privacy icon.
- if (currentWebView!!.settings.javaScriptEnabled) // JavaScript is enabled.
- optionsPrivacyMenuItem.setIcon(R.drawable.javascript_enabled)
- else if (currentWebView!!.acceptCookies) // JavaScript is disabled but cookies are enabled.
- optionsPrivacyMenuItem.setIcon(R.drawable.warning)
- else // All the dangerous features are disabled.
- optionsPrivacyMenuItem.setIcon(R.drawable.privacy_mode)
+ // Convert the favorite icon byte array stream to a byte array.
+ val currentFavoriteIconByteArray = currentFavoriteIconByteArrayOutputStream.toByteArray()
- // Update the cookies icon.
- if (currentWebView!!.acceptCookies)
- optionsCookiesMenuItem.setIcon(R.drawable.cookies_enabled)
- else
- optionsCookiesMenuItem.setIcon(R.drawable.cookies_disabled)
+ // Create an intent to launch the bookmarks activity.
+ val bookmarksIntent = Intent(applicationContext, BookmarksActivity::class.java)
- // Update the refresh icon.
- if (optionsRefreshMenuItem.title == getString(R.string.refresh)) // The refresh icon is displayed.
- optionsRefreshMenuItem.setIcon(R.drawable.refresh_enabled)
- else // The stop icon is displayed.
- optionsRefreshMenuItem.setIcon(R.drawable.close_blue)
+ // Add the extra information to the intent.
+ bookmarksIntent.putExtra(CURRENT_FOLDER_ID, currentBookmarksFolderId)
+ bookmarksIntent.putExtra(CURRENT_TITLE, currentWebView!!.title)
+ bookmarksIntent.putExtra(CURRENT_URL, currentWebView!!.url)
+ bookmarksIntent.putExtra(CURRENT_FAVORITE_ICON_BYTE_ARRAY, currentFavoriteIconByteArray)
- // `invalidateOptionsMenu()` calls `onPrepareOptionsMenu()` and redraws the icons in the app bar.
- if (runInvalidateOptionsMenu)
- invalidateOptionsMenu()
+ // Make it so.
+ startActivity(bookmarksIntent)
}
- }
- private fun loadBookmarksFolder() {
- // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
- bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolder)
+ // Set the create new bookmark folder floating action button to display an alert dialog.
+ createBookmarkFolderFab.setOnClickListener {
+ // Create a create bookmark folder dialog.
+ val createBookmarkFolderDialog: DialogFragment = CreateBookmarkFolderDialog.createBookmarkFolder(currentWebView!!.getFavoriteIcon())
- // Populate the bookmarks cursor adapter.
- bookmarksCursorAdapter = object : CursorAdapter(this, bookmarksCursor, false) {
- override fun newView(context: Context, cursor: Cursor, parent: ViewGroup): View {
- // Inflate the individual item layout.
- return layoutInflater.inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false)
- }
+ // Show the create bookmark folder dialog.
+ createBookmarkFolderDialog.show(supportFragmentManager, getString(R.string.create_folder))
+ }
- override fun bindView(view: View, context: Context, cursor: Cursor) {
- // Get handles for the views.
- val bookmarkFavoriteIcon = view.findViewById<ImageView>(R.id.bookmark_favorite_icon)
- val bookmarkNameTextView = view.findViewById<TextView>(R.id.bookmark_name)
+ // Set the create new bookmark floating action button to display an alert dialog.
+ createBookmarkFab.setOnClickListener {
+ // Instantiate the create bookmark dialog.
+ val createBookmarkDialog: DialogFragment = CreateBookmarkDialog.createBookmark(currentWebView!!.url!!, currentWebView!!.title!!, currentWebView!!.getFavoriteIcon())
- // Get the favorite icon byte array from the cursor.
- val favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.FAVORITE_ICON))
+ // Display the create bookmark dialog.
+ createBookmarkDialog.show(supportFragmentManager, getString(R.string.create_bookmark))
+ }
- // Convert the byte array to a bitmap beginning at the first byte and ending at the last.
- val favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.size)
+ // Search for the string on the page whenever a character changes in the find on page edit text.
+ findOnPageEditText.addTextChangedListener(object : TextWatcher {
+ override fun beforeTextChanged(charSequence: CharSequence, start: Int, count: Int, after: Int) {
+ // Do nothing.
+ }
- // Display the bitmap in the bookmark favorite icon.
- bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap)
+ override fun onTextChanged(charSequence: CharSequence, start: Int, before: Int, count: Int) {
+ // Do nothing.
+ }
- // Display the bookmark name from the cursor in the bookmark name text view.
- bookmarkNameTextView.text = cursor.getString(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_NAME))
+ override fun afterTextChanged(editable: Editable) {
+ // Search for the text in the WebView if it is not null. Sometimes on resume after a period of non-use the WebView will be null.
+ currentWebView?.findAllAsync(findOnPageEditText.text.toString())
+ }
+ })
- // Make the font bold for folders.
- if (cursor.getInt(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.IS_FOLDER)) == 1)
- bookmarkNameTextView.typeface = Typeface.DEFAULT_BOLD
- else // Reset the font to default for normal bookmarks.
- bookmarkNameTextView.typeface = Typeface.DEFAULT
+ // Set the `check mark` button for the find on page edit text keyboard to close the soft keyboard.
+ findOnPageEditText.setOnKeyListener { _: View?, keyCode: Int, keyEvent: KeyEvent ->
+ if ((keyEvent.action == KeyEvent.ACTION_DOWN) && (keyCode == KeyEvent.KEYCODE_ENTER)) { // The `enter` key was pressed.
+ // Hide the soft keyboard.
+ inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
+
+ // Consume the event.
+ return@setOnKeyListener true
+ } else { // A different key was pressed.
+ // Do not consume the event.
+ return@setOnKeyListener false
}
}
- // Populate the list view with the adapter.
- bookmarksListView.adapter = bookmarksCursorAdapter
+ // Implement swipe to refresh.
+ swipeRefreshLayout.setOnRefreshListener {
+ // Reload the website.
+ currentWebView!!.reload()
+ }
- // Set the bookmarks drawer title.
- if (currentBookmarksFolder.isEmpty())
- bookmarksTitleTextView.setText(R.string.bookmarks)
- else
- bookmarksTitleTextView.text = currentBookmarksFolder
- }
+ // Store the default progress view offsets.
+ defaultProgressViewStartOffset = swipeRefreshLayout.progressViewStartOffset
+ defaultProgressViewEndOffset = swipeRefreshLayout.progressViewEndOffset
- private fun openWithApp(url: String) {
- // Create an open with app intent with `ACTION_VIEW`.
- val openWithAppIntent = Intent(Intent.ACTION_VIEW)
+ // Set the refresh color scheme according to the theme.
+ swipeRefreshLayout.setColorSchemeResources(R.color.blue_text)
- // Set the URI but not the MIME type. This should open all available apps.
- openWithAppIntent.data = Uri.parse(url)
+ // Initialize a color background typed value.
+ val colorBackgroundTypedValue = TypedValue()
- // Flag the intent to open in a new task.
- openWithAppIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // Get the color background from the theme.
+ theme.resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true)
- // Try the intent.
- try {
- // Show the chooser.
- startActivity(openWithAppIntent)
- } catch (exception: ActivityNotFoundException) { // There are no apps available to open the URL.
- // Show a snackbar with the error.
- Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
- }
- }
+ // Get the color background int from the typed value.
+ val colorBackgroundInt = colorBackgroundTypedValue.data
- private fun openWithBrowser(url: String) {
+ // Set the swipe refresh background color.
+ swipeRefreshLayout.setProgressBackgroundColorSchemeColor(colorBackgroundInt)
- // Create an open with browser intent with `ACTION_VIEW`.
- val openWithBrowserIntent = Intent(Intent.ACTION_VIEW)
+ // Set the drawer titles, which identify the drawer layouts in accessibility mode.
+ drawerLayout.setDrawerTitle(GravityCompat.START, getString(R.string.navigation_drawer))
+ drawerLayout.setDrawerTitle(GravityCompat.END, getString(R.string.bookmarks))
- // Set the URI and the MIME type. `"text/html"` should load browser options.
- openWithBrowserIntent.setDataAndType(Uri.parse(url), "text/html")
+ // Load the bookmarks folder.
+ loadBookmarksFolder()
- // Flag the intent to open in a new task.
- openWithBrowserIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // Handle clicks on bookmarks.
+ bookmarksListView.onItemClickListener = AdapterView.OnItemClickListener { _: AdapterView<*>?, _: View?, _: Int, id: Long ->
+ // Convert the id from long to int to match the format of the bookmarks database.
+ val databaseId = id.toInt()
- // Try the intent.
- try {
- // Show the chooser.
- startActivity(openWithBrowserIntent)
- } catch (exception: ActivityNotFoundException) { // There are no browsers available to open the URL.
- // Show a snackbar with the error.
- Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
- }
- }
+ // Get the bookmark cursor for this ID.
+ val bookmarkCursor = bookmarksDatabaseHelper!!.getBookmark(databaseId)
- private fun sanitizeUrl(urlString: String): String {
- // Initialize a sanitized URL string.
- var sanitizedUrlString = urlString
+ // Move the bookmark cursor to the first row.
+ bookmarkCursor.moveToFirst()
- // Sanitize tracking queries.
- if (sanitizeTrackingQueries)
- sanitizedUrlString = SanitizeUrlHelper.sanitizeTrackingQueries(sanitizedUrlString)
+ // Act upon the bookmark according to the type.
+ if (bookmarkCursor.getInt(bookmarkCursor.getColumnIndexOrThrow(IS_FOLDER)) == 1) { // The selected bookmark is a folder.
+ // Store the folder ID.
+ currentBookmarksFolderId = bookmarkCursor.getLong(bookmarkCursor.getColumnIndexOrThrow(FOLDER_ID))
- // Sanitize AMP redirects.
- if (sanitizeAmpRedirects)
- sanitizedUrlString = SanitizeUrlHelper.sanitizeAmpRedirects(sanitizedUrlString)
+ // Load the new folder.
+ loadBookmarksFolder()
+ } else { // The selected bookmark is not a folder.
+ // Load the bookmark URL.
+ loadUrl(currentWebView!!, bookmarkCursor.getString(bookmarkCursor.getColumnIndexOrThrow(BOOKMARK_URL)))
- // Return the sanitized URL string.
- return sanitizedUrlString
- }
+ // Close the bookmarks drawer if it is not pinned.
+ if (!bookmarksDrawerPinned)
+ drawerLayout.closeDrawer(GravityCompat.END)
+ }
- override fun finishedPopulatingBlocklists(combinedBlocklists: ArrayList<ArrayList<List<Array<String>>>>) {
- // Store the blocklists.
- easyList = combinedBlocklists[0]
- easyPrivacy = combinedBlocklists[1]
- fanboysAnnoyanceList = combinedBlocklists[2]
- fanboysSocialList = combinedBlocklists[3]
- ultraList = combinedBlocklists[4]
- ultraPrivacy = combinedBlocklists[5]
+ // Close the cursor.
+ bookmarkCursor.close()
+ }
- // Check to see if the activity has been restarted with a saved state.
- if ((savedStateArrayList == null) || (savedStateArrayList!!.size == 0)) { // The activity has not been restarted or it was restarted on start to change the theme.
- // Add the first tab.
- addNewTab("", true)
- } else { // The activity has been restarted.
- // Restore each tab.
- for (i in savedStateArrayList!!.indices) {
- // Add a new tab.
- tabLayout.addTab(tabLayout.newTab())
+ // Handle long-presses on bookmarks.
+ bookmarksListView.onItemLongClickListener = AdapterView.OnItemLongClickListener { _: AdapterView<*>?, _: View?, _: Int, id: Long ->
+ // Convert the database ID from `long` to `int`.
+ val databaseId = id.toInt()
- // Get the new tab.
- val newTab = tabLayout.getTabAt(i)!!
+ // Run the commands associated with the type.
+ if (bookmarksDatabaseHelper!!.isFolder(databaseId)) { // The bookmark is a folder.
+ // Get the folder ID.
+ val folderId = bookmarksDatabaseHelper!!.getFolderId(databaseId)
- // Set a custom view on the new tab.
- newTab.setCustomView(R.layout.tab_custom_view)
+ // Get a cursor of all the bookmarks in the folder.
+ val bookmarksCursor = bookmarksDatabaseHelper!!.getFolderBookmarks(folderId)
- // Add the new page.
- webViewPagerAdapter!!.restorePage(savedStateArrayList!![i], savedNestedScrollWebViewStateArrayList!![i])
- }
+ // Move to the first entry in the cursor.
+ bookmarksCursor.moveToFirst()
- // Reset the saved state variables.
- savedStateArrayList = null
- savedNestedScrollWebViewStateArrayList = null
+ // Open each bookmark
+ for (i in 0 until bookmarksCursor.count) {
+ // Load the bookmark in a new tab, moving to the tab for the first bookmark if the drawer is not pinned.
+ addNewPage(bookmarksCursor.getString(bookmarksCursor.getColumnIndexOrThrow(BOOKMARK_URL)), adjacent = false, moveToTab = !bookmarksDrawerPinned && (i == 0))
- // Restore the selected tab position.
- if (savedTabPosition == 0) { // The first tab is selected.
- // Set the first page as the current WebView.
- setCurrentWebView(0)
- } else { // The first tab is not selected.
- // Move to the selected tab.
- webViewPager.currentItem = savedTabPosition
- }
+ // Move to the next bookmark.
+ bookmarksCursor.moveToNext()
+ }
- // Get the intent that started the app.
- val intent = intent
+ // Close the cursor.
+ bookmarksCursor.close()
+ } else { // The bookmark is not a folder.
+ // Get the bookmark cursor for this ID.
+ val bookmarkCursor = bookmarksDatabaseHelper!!.getBookmark(databaseId)
- // Reset the intent. This prevents a duplicate tab from being created on restart.
- setIntent(Intent())
+ // Move the bookmark cursor to the first row.
+ bookmarkCursor.moveToFirst()
- // Get the information from the intent.
- val intentAction = intent.action
- val intentUriData = intent.data
- val intentStringExtra = intent.getStringExtra(Intent.EXTRA_TEXT)
+ // Load the bookmark in a new tab and move to the tab if the drawer is not pinned.
+ addNewPage(bookmarkCursor.getString(bookmarkCursor.getColumnIndexOrThrow(BOOKMARK_URL)), adjacent = true, moveToTab = !bookmarksDrawerPinned)
- // Determine if this is a web search.
- val isWebSearch = (intentAction != null) && (intentAction == Intent.ACTION_WEB_SEARCH)
+ // Close the cursor.
+ bookmarkCursor.close()
+ }
- // Only process the URI if it contains data or it is a web search. If the user pressed the desktop icon after the app was already running the URI will be null.
- if ((intentUriData != null) || (intentStringExtra != null) || isWebSearch) {
- // Get the URL string.
- val urlString = if (isWebSearch) { // The intent is a web search.
- // Sanitize the search input.
- val encodedSearchString: String = try {
- URLEncoder.encode(intent.getStringExtra(SearchManager.QUERY), "UTF-8")
- } catch (exception: UnsupportedEncodingException) {
- ""
- }
+ // Close the bookmarks drawer if it is not pinned.
+ if (!bookmarksDrawerPinned)
+ drawerLayout.closeDrawer(GravityCompat.END)
- // Add the base search URL.
- searchURL + encodedSearchString
- } else { // The intent contains a URL formatted as a URI or a URL in the string extra.
- // Get the URL string.
- intentUriData?.toString() ?: intentStringExtra!!
- }
+ // Consume the event.
+ true
+ }
- // Add a new tab if specified in the preferences.
- if (sharedPreferences.getBoolean(getString(R.string.open_intents_in_new_tab_key), true)) { // Load the URL in a new tab.
- // Set the loading new intent flag.
- loadingNewIntent = true
+ // The drawer listener is used to update the navigation menu.
+ drawerLayout.addDrawerListener(object : DrawerLayout.DrawerListener {
+ override fun onDrawerSlide(drawerView: View, slideOffset: Float) {}
- // Add a new tab.
- addNewTab(urlString, true)
- } else { // Load the URL in the current tab.
- // Make it so.
- loadUrl(currentWebView!!, urlString)
- }
- }
- }
- }
+ override fun onDrawerOpened(drawerView: View) {}
- // The view parameter cannot be removed because it is called from the layout onClick.
- fun addTab(@Suppress("UNUSED_PARAMETER")view: View?) {
- // Add a new tab with a blank URL.
- addNewTab("", true)
- }
+ override fun onDrawerClosed(drawerView: View) {}
- private fun addNewTab(urlString: String, moveToTab: Boolean) {
- // Clear the focus from the URL edit text, so that it will be populated with the information from the new tab.
- urlEditText.clearFocus()
+ override fun onDrawerStateChanged(newState: Int) {
+ if (newState == DrawerLayout.STATE_SETTLING || newState == DrawerLayout.STATE_DRAGGING) { // A drawer is opening or closing.
+ // Update the navigation menu items if the WebView is not null.
+ if (currentWebView != null) {
+ // Set the enabled status of the menu items.
+ navigationBackMenuItem.isEnabled = currentWebView!!.canGoBack()
+ navigationForwardMenuItem.isEnabled = currentWebView!!.canGoForward()
+ navigationScrollToBottomMenuItem.isEnabled = (currentWebView!!.canScrollVertically(-1) || currentWebView!!.canScrollVertically(1))
+ navigationHistoryMenuItem.isEnabled = currentWebView!!.canGoBack() || currentWebView!!.canGoForward()
- // Get the new page number. The page numbers are 0 indexed, so the new page number will match the current count.
- val newTabNumber = tabLayout.tabCount
+ // Update the scroll menu item.
+ if (currentWebView!!.scrollY == 0) { // The WebView is scrolled to the top.
+ // Set the title.
+ navigationScrollToBottomMenuItem.title = getString(R.string.scroll_to_bottom)
- // Add a new tab.
- tabLayout.addTab(tabLayout.newTab())
+ // Set the icon.
+ navigationScrollToBottomMenuItem.icon = AppCompatResources.getDrawable(applicationContext, R.drawable.move_down_enabled)
+ } else { // The WebView is not scrolled to the top.
+ // Set the title.
+ navigationScrollToBottomMenuItem.title = getString(R.string.scroll_to_top)
- // Get the new tab.
- val newTab = tabLayout.getTabAt(newTabNumber)!!
+ // Set the icon.
+ navigationScrollToBottomMenuItem.icon = AppCompatResources.getDrawable(applicationContext, R.drawable.move_up_enabled)
+ }
- // Set a custom view on the new tab.
- newTab.setCustomView(R.layout.tab_custom_view)
+ // Display the number of blocked requests.
+ navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + currentWebView!!.getRequestsCount(BLOCKED_REQUESTS)
- // Add the new WebView page.
- webViewPagerAdapter!!.addPage(newTabNumber, webViewPager, urlString, moveToTab)
+ // Hide the keyboard (if displayed).
+ inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
+ }
- // Show the app bar if it is at the bottom of the screen and the new tab is taking focus.
- if (bottomAppBar && moveToTab && appBarLayout.translationY != 0f) {
- // Animate the bottom app bar onto the screen.
- objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", 0f)
+ // Clear the focus from from the URL text box. This removes any text selection markers and context menus, which otherwise draw above the open drawers.
+ urlEditText.clearFocus()
- // Make it so.
- objectAnimator.start()
- }
- }
+ // Clear the focus from from the WebView if it is not null, which can happen if a user opens a drawer while the browser is being resumed.
+ // Clearing the focus from the WebView removes any text selection markers and context menus, which otherwise draw above the open drawers.
+ currentWebView?.clearFocus()
- // The view parameter cannot be removed because it is called from the layout onClick.
- fun closeTab(@Suppress("UNUSED_PARAMETER")view: View?) {
- // Run the command according to the number of tabs.
- if (tabLayout.tabCount > 1) // There is more than one tab open.
- closeCurrentTab()
- else // There is only one tab open.
- clearAndExit()
- }
+ if (bottomAppBar && navigationDrawerFirstView) {
+ // Reset the navigation drawer first view flag.
+ navigationDrawerFirstView = false
- private fun closeCurrentTab() {
- // Get the current tab number.
- val currentTabNumber = tabLayout.selectedTabPosition
+ // Get a handle for the navigation recycler view.
+ val navigationRecyclerView = navigationView.getChildAt(0) as RecyclerView
- // Delete the current tab.
- tabLayout.removeTabAt(currentTabNumber)
+ // Get the navigation linear layout manager.
+ val navigationLinearLayoutManager = navigationRecyclerView.layoutManager as LinearLayoutManager
- // Delete the current page. If the selected page number did not change during the delete (because the newly selected tab has has same number as the previously deleted tab), it will return true,
- // meaning that the current WebView must be reset. Otherwise it will happen automatically as the selected tab number changes.
- if (webViewPagerAdapter!!.deletePage(currentTabNumber, webViewPager))
- setCurrentWebView(currentTabNumber)
- }
+ // Scroll the navigation drawer to the bottom.
+ navigationLinearLayoutManager.scrollToPositionWithOffset(13, 0)
+ }
+ }
+ }
+ })
- private fun exitFullScreenVideo() {
- // Re-enable the screen timeout.
- fullScreenVideoFrameLayout.keepScreenOn = false
+ // Inflate a bare WebView to get the default user agent. It is not used to render content on the screen.
+ @SuppressLint("InflateParams") val webViewLayout = layoutInflater.inflate(R.layout.bare_webview, null, false)
- // Unset the full screen video flag.
- displayingFullScreenVideo = false
+ // Get a handle for the WebView.
+ val bareWebView = webViewLayout.findViewById<WebView>(R.id.bare_webview)
- // Remove all the views from the full screen video frame layout.
- fullScreenVideoFrameLayout.removeAllViews()
+ // Store the default user agent.
+ webViewDefaultUserAgent = bareWebView.settings.userAgentString
- // Hide the full screen video frame layout.
- fullScreenVideoFrameLayout.visibility = View.GONE
+ // Destroy the bare WebView.
+ bareWebView.destroy()
- // Enable the sliding drawers.
- drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED)
+ // Update the domains settings set.
+ updateDomainsSettingsSet()
- // Show the coordinator layout.
- coordinatorLayout.visibility = View.VISIBLE
+ // Instantiate the check filter list helper.
+ checkFilterListHelper = CheckFilterListHelper()
+ }
- // Apply the appropriate full screen mode flags.
- if (fullScreenBrowsingModeEnabled && inFullScreenBrowsingMode) { // Privacy Browser is currently in full screen browsing mode.
- // Hide the app bar if specified.
- if (hideAppBar) {
- // Hide the tab linear layout.
- tabsLinearLayout.visibility = View.GONE
+ @SuppressLint("ClickableViewAccessibility")
+ override fun initializeWebView(nestedScrollWebView: NestedScrollWebView, pagePosition: Int, progressBar: ProgressBar, urlString: String, restoringState: Boolean) {
+ // Get the WebView theme.
+ val webViewTheme = sharedPreferences.getString(getString(R.string.webview_theme_key), getString(R.string.webview_theme_default_value))
- // Hide the app bar.
- appBar.hide()
- }
+ // Get the WebView theme entry values string array.
+ val webViewThemeEntryValuesStringArray = resources.getStringArray(R.array.webview_theme_entry_values)
- /* Hide the system bars.
- * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
- * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
- * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
- * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
- */
+ // Set the WebView theme if algorithmic darkening is supported.
+ if (WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING)) {
+ // Set the WebView them. A switch statement cannot be used because the WebView theme entry values string array is not a compile time constant.
+ if (webViewTheme == webViewThemeEntryValuesStringArray[1]) { // The light theme is selected.
+ // Turn off algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
- // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
- @Suppress("DEPRECATION")
- rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
- } else { // Switch to normal viewing mode.
- // Remove the `SYSTEM_UI` flags from the root frame layout. The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
- @Suppress("DEPRECATION")
- rootFrameLayout.systemUiVisibility = 0
+ // Make the WebView visible. The WebView was created invisible in `webview_framelayout` to prevent a white background splash in night mode.
+ // If the system is currently in night mode, showing the WebView will be handled in `onProgressChanged()`.
+ nestedScrollWebView.visibility = View.VISIBLE
+ } else if (webViewTheme == webViewThemeEntryValuesStringArray[2]) { // The dark theme is selected.
+ // Turn on algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
+ } else { // The system default theme is selected.
+ // Get the current theme status.
+ val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
+
+ // Set the algorithmic darkening according to the current system theme status.
+ if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) { // The system is in day mode.
+ // Turn off algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
+
+ // Make the WebView visible. The WebView was created invisible in `webview_framelayout` to prevent a white background splash in night mode.
+ // If the system is currently in night mode, showing the WebView will be handled in `onProgressChanged()`.
+ nestedScrollWebView.visibility = View.VISIBLE
+ } else { // The system is in night mode.
+ // Turn on algorithmic darkening.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
+ }
+ }
}
- }
- private fun clearAndExit() {
- // Close the cursor and databases. TODO: Also domains cursor.
- bookmarksCursor?.close()
- bookmarksDatabaseHelper?.close()
- domainsDatabaseHelper?.close()
+ // Set the app bar scrolling.
+ nestedScrollWebView.isNestedScrollingEnabled = scrollAppBar
+
+ // Allow pinch to zoom.
+ nestedScrollWebView.settings.builtInZoomControls = true
+
+ // Hide zoom controls.
+ nestedScrollWebView.settings.displayZoomControls = false
+
+ // Don't allow mixed content (HTTP and HTTPS) on the same website.
+ nestedScrollWebView.settings.mixedContentMode = WebSettings.MIXED_CONTENT_NEVER_ALLOW
+
+ // Set the WebView to load in overview mode (zoomed out to the maximum width).
+ nestedScrollWebView.settings.loadWithOverviewMode = true
+
+ // Explicitly disable geolocation.
+ nestedScrollWebView.settings.setGeolocationEnabled(false)
+
+ // Allow loading of file:// URLs. This is necessary for opening MHT web archives, which are copied into a temporary cache location.
+ nestedScrollWebView.settings.allowFileAccess = true
+
+ // Create a double-tap gesture detector to toggle full-screen mode.
+ val doubleTapGestureDetector = GestureDetector(this, object : GestureDetector.SimpleOnGestureListener() {
+ // Override `onDoubleTap()`. All other events are handled using the default settings.
+ override fun onDoubleTap(motionEvent: MotionEvent): Boolean {
+ return if (fullScreenBrowsingModeEnabled) { // Only process the double-tap if full screen browsing mode is enabled.
+ // Toggle the full screen browsing mode tracker.
+ inFullScreenBrowsingMode = !inFullScreenBrowsingMode
+
+ // Toggle the full screen browsing mode.
+ if (inFullScreenBrowsingMode) { // Switch to full screen mode.
+ // Hide the app bar if specified.
+ if (hideAppBar) { // App bar hiding is enabled.
+ // Close the find on page bar if it is visible.
+ closeFindOnPage(null)
+
+ // Hide the tab linear layout.
+ tabsLinearLayout.visibility = View.GONE
+
+ // Hide the app bar.
+ appBar.hide()
+
+ // Set layout and scrolling parameters according to the position of the app bar.
+ if (bottomAppBar) { // The app bar is at the bottom.
+ // Reset the WebView padding to fill the available space.
+ swipeRefreshLayout.setPadding(0, 0, 0, 0)
+ } else { // The app bar is at the top.
+ // Check to see if the app bar is normally scrolled.
+ if (scrollAppBar) { // The app bar is scrolled when it is displayed.
+ // Get the swipe refresh layout parameters.
+ val swipeRefreshLayoutParams = swipeRefreshLayout.layoutParams as CoordinatorLayout.LayoutParams
+
+ // Remove the off-screen scrolling layout.
+ swipeRefreshLayoutParams.behavior = null
+ } else { // The app bar is not scrolled when it is displayed.
+ // Remove the padding from the top of the swipe refresh layout.
+ swipeRefreshLayout.setPadding(0, 0, 0, 0)
+
+ // The swipe refresh circle must be moved above the now removed status bar location.
+ swipeRefreshLayout.setProgressViewOffset(false, -200, defaultProgressViewEndOffset)
+ }
+ }
+ } else { // App bar hiding is not enabled.
+ // Adjust the UI for the bottom app bar.
+ if (bottomAppBar) {
+ // Adjust the UI according to the scrolling of the app bar.
+ if (scrollAppBar) {
+ // Reset the WebView padding to fill the available space.
+ swipeRefreshLayout.setPadding(0, 0, 0, 0)
+ } else {
+ // Move the WebView above the app bar layout.
+ swipeRefreshLayout.setPadding(0, 0, 0, appBarHeight)
+ }
+ }
+ }
+
+ /* Hide the system bars.
+ * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
+ * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
+ * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
+ * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
+ */
+
+ // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
+ @Suppress("DEPRECATION")
+ rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
+ } else { // Switch to normal viewing mode.
+ // Show the app bar if it was hidden.
+ if (hideAppBar) {
+ // Show the tab linear layout.
+ tabsLinearLayout.visibility = View.VISIBLE
+
+ // Show the app bar.
+ appBar.show()
+ }
+
+ // Set layout and scrolling parameters according to the position of the app bar.
+ if (bottomAppBar) { // The app bar is at the bottom.
+ // Adjust the UI.
+ if (scrollAppBar) {
+ // Reset the WebView padding to fill the available space.
+ swipeRefreshLayout.setPadding(0, 0, 0, 0)
+ } else {
+ // Move the WebView above the app bar layout.
+ swipeRefreshLayout.setPadding(0, 0, 0, appBarHeight)
+ }
+ } else { // The app bar is at the top.
+ // Check to see if the app bar is normally scrolled.
+ if (scrollAppBar) { // The app bar is scrolled when it is displayed.
+ // Get the swipe refresh layout parameters.
+ val swipeRefreshLayoutParams = swipeRefreshLayout.layoutParams as CoordinatorLayout.LayoutParams
+
+ // Add the off-screen scrolling layout.
+ swipeRefreshLayoutParams.behavior = AppBarLayout.ScrollingViewBehavior()
+ } else { // The app bar is not scrolled when it is displayed.
+ // The swipe refresh layout must be manually moved below the app bar layout.
+ swipeRefreshLayout.setPadding(0, appBarHeight, 0, 0)
+
+ // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
+ swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10 + appBarHeight, defaultProgressViewEndOffset + appBarHeight)
+ }
+ }
+
+ // Remove the `SYSTEM_UI` flags from the root frame layout. The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
+ @Suppress("DEPRECATION")
+ rootFrameLayout.systemUiVisibility = 0
+ }
+
+ // Consume the double-tap.
+ true
+ } else { // Do not consume the double-tap because full screen browsing mode is disabled.
+ // Return false.
+ false
+ }
+ }
+
+ override fun onFling(motionEvent1: MotionEvent?, motionEvent2: MotionEvent, velocityX: Float, velocityY: Float): Boolean {
+ // Scroll the bottom app bar if enabled.
+ if (bottomAppBar && scrollAppBar && !objectAnimator.isRunning && (motionEvent1 != null)) {
+ // Calculate the Y change.
+ val motionY = motionEvent2.y - motionEvent1.y
+
+ // Scroll the app bar if the change is greater than 50 pixels.
+ if (motionY > 50) {
+ // Animate the bottom app bar onto the screen.
+ objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", 0f)
+ } else if (motionY < -50) {
+ // Animate the bottom app bar off the screen.
+ objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", appBarLayout.height.toFloat())
+ }
+
+ // Make it so.
+ objectAnimator.start()
+ }
+
+ // Do not consume the event.
+ return false
+ }
+ })
+
+ // Pass all touch events on the WebView through the double-tap gesture detector.
+ nestedScrollWebView.setOnTouchListener { view: View, motionEvent: MotionEvent? ->
+ // Call `performClick()` on the view, which is required for accessibility.
+ view.performClick()
+
+ // Check for double-taps.
+ doubleTapGestureDetector.onTouchEvent(motionEvent!!)
+ }
+
+ // Register the WebView for a context menu. This is used to see link targets and download images.
+ registerForContextMenu(nestedScrollWebView)
+
+ // Allow the downloading of files.
+ nestedScrollWebView.setDownloadListener { downloadUrlString: String, userAgent: String, contentDisposition: String, mimetype: String, contentLength: Long ->
+ // Use the specified download provider.
+ if (downloadWithExternalApp) { // Download with an external app.
+ // Download with an external app.
+ saveWithExternalApp(downloadUrlString)
+ } else { // Download with Privacy Browser or Android's download manager.
+ // Process the content length if it contains data.
+ val formattedFileSizeString = if (contentLength > 0) { // The content length is greater than 0.
+ // Format the content length as a string.
+ NumberFormat.getInstance().format(contentLength) + " " + getString(R.string.bytes)
+ } else { // The content length is not greater than 0.
+ // Set the formatted file size string to be `unknown size`.
+ getString(R.string.unknown_size)
+ }
+
+ // Get the file name from the content disposition.
+ val fileNameString = UrlHelper.getFileName(this, contentDisposition, mimetype, downloadUrlString)
+
+ // Instantiate the save dialog according.
+ val saveDialogFragment = SaveDialog.saveUrl(downloadUrlString, fileNameString, formattedFileSizeString, userAgent, nestedScrollWebView.acceptCookies)
+
+ // Try to show the dialog. The download listener continues to function even when the WebView is paused. Attempting to display a dialog in that state leads to a crash.
+ try {
+ // Show the save dialog.
+ saveDialogFragment.show(supportFragmentManager, getString(R.string.save_dialog))
+ } catch (exception: Exception) { // The dialog could not be shown.
+ // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
+ pendingDialogsArrayList.add(PendingDialogDataClass(saveDialogFragment, getString(R.string.save_dialog)))
+ }
+ }
+
+ // Get the current page position.
+ val currentPagePosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+
+ // Get the corresponding tab.
+ val tab = tabLayout.getTabAt(currentPagePosition)!!
+
+ // Get the tab custom view.
+ val tabCustomView = tab.customView!!
+
+ // Get the tab views.
+ val tabFavoriteIconImageView = tabCustomView.findViewById<ImageView>(R.id.favorite_icon_imageview)
+ val tabTitleTextView = tabCustomView.findViewById<TextView>(R.id.title_textview)
+
+ // Restore the previous webpage favorite icon and title if the title is currently set to `Loading...`.
+ if (tabTitleTextView.text.toString() == getString(R.string.loading)) {
+ // Restore the previous webpage title text.
+ tabTitleTextView.text = nestedScrollWebView.previousWebpageTitle
+
+ // Restore the previous webpage favorite icon if it is not null.
+ if (nestedScrollWebView.previousFavoriteIconDrawable != null)
+ tabFavoriteIconImageView.setImageDrawable(nestedScrollWebView.previousFavoriteIconDrawable)
+ }
+ }
+
+ // Update the find on page count.
+ nestedScrollWebView.setFindListener { activeMatchOrdinal, numberOfMatches, isDoneCounting ->
+ if (isDoneCounting && (numberOfMatches == 0)) { // There are no matches.
+ // Set the find on page count text view to be `0/0`.
+ findOnPageCountTextView.setText(R.string.zero_of_zero)
+ } else if (isDoneCounting) { // There are matches.
+ // The active match ordinal is zero-based.
+ val activeMatch = activeMatchOrdinal + 1
+
+ // Build the match string.
+ val matchString = "$activeMatch/$numberOfMatches"
+
+ // Update the find on page count text view.
+ findOnPageCountTextView.text = matchString
+ }
+ }
+
+ // Process scroll changes.
+ nestedScrollWebView.setOnScrollChangeListener { _: View?, _: Int, _: Int, _: Int, _: Int ->
+ // Set the swipe to refresh status.
+ if (nestedScrollWebView.swipeToRefresh) // Only enable swipe to refresh if the WebView is scrolled to the top.
+ swipeRefreshLayout.isEnabled = nestedScrollWebView.scrollY == 0
+ else // Disable swipe to refresh.
+ swipeRefreshLayout.isEnabled = false
+
+ // Reinforce the system UI visibility flags if in full screen browsing mode.
+ // This hides the status and navigation bars, which are displayed if other elements are shown, like dialog boxes, the options menu, or the keyboard.
+ if (inFullScreenBrowsingMode) {
+ /* Hide the system bars.
+ * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
+ * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
+ * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
+ * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
+ */
+
+ // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
+ @Suppress("DEPRECATION")
+ rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
+ }
+ }
+
+ // Set the web chrome client.
+ nestedScrollWebView.webChromeClient = object : WebChromeClient() {
+ // Update the progress bar when a page is loading.
+ override fun onProgressChanged(view: WebView, progress: Int) {
+ // Update the progress bar.
+ progressBar.progress = progress
+
+ // Set the visibility of the progress bar.
+ if (progress < 100) {
+ // Show the progress bar.
+ progressBar.visibility = View.VISIBLE
+ } else {
+ // Hide the progress bar.
+ progressBar.visibility = View.GONE
+
+ //Stop the swipe to refresh indicator if it is running
+ swipeRefreshLayout.isRefreshing = false
- // Get the status of the clear everything preference.
- val clearEverything = sharedPreferences.getBoolean(getString(R.string.clear_everything_key), true)
+ // Make the current WebView visible. If this is a new tab, the current WebView would have been created invisible in `webview_framelayout` to prevent a white background splash in night mode.
+ nestedScrollWebView.visibility = View.VISIBLE
+ }
+ }
- // Get a handle for the runtime.
- val runtime = Runtime.getRuntime()
+ // Set the favorite icon when it changes.
+ override fun onReceivedIcon(view: WebView, icon: Bitmap) {
+ // Only update the favorite icon if the website has finished loading and the new favorite icon height is greater than the current favorite icon height.
+ // This prevents low resolution icons from replacing high resolution one.
+ // The check for the visibility of the progress bar can possibly be removed once https://redmine.stoutner.com/issues/747 is fixed.
+ if ((progressBar.visibility == View.GONE) && (icon.height > nestedScrollWebView.getFavoriteIconHeight())) {
+ // Store the new favorite icon.
+ nestedScrollWebView.setFavoriteIcon(icon)
- // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
- // which links to `/data/data/com.stoutner.privacybrowser.standard`.
- val privateDataDirectoryString = applicationInfo.dataDir
+ // Get the current page position.
+ val currentPosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
- // Clear cookies.
- if (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_cookies_key), true)) {
- // Ass the cookie manager to delete all the cookies.
- cookieManager.removeAllCookies(null)
+ // Get the current tab.
+ val tab = tabLayout.getTabAt(currentPosition)
- // Ask the cookie manager to flush the cookie database.
- cookieManager.flush()
+ // Check to see if the tab has been populated.
+ if (tab != null) {
+ // Get the custom view from the tab.
+ val tabView = tab.customView
- // Manually delete the cookies database, as the cookie manager sometimes will not flush its changes to disk before system exit is run.
- try {
- // Two commands must be used because `Runtime.exec()` does not like `*`.
- val deleteCookiesProcess = runtime.exec("rm -f $privateDataDirectoryString/app_webview/Cookies")
- val deleteCookiesJournalProcess = runtime.exec("rm -f $privateDataDirectoryString/app_webview/Cookies-journal")
+ // Check to see if the custom tab view has been populated.
+ if (tabView != null) {
+ // Get the favorite icon image view from the tab.
+ val tabFavoriteIconImageView = tabView.findViewById<ImageView>(R.id.favorite_icon_imageview)
- // Wait until the processes have finished.
- deleteCookiesProcess.waitFor()
- deleteCookiesJournalProcess.waitFor()
- } catch (exception: Exception) {
- // Do nothing if an error is thrown.
+ // Display the favorite icon in the tab.
+ tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 128, 128, true))
+ }
+ }
+ }
}
- }
- // Clear DOM storage.
- if (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_dom_storage_key), true)) {
- // Ask web storage to clear the DOM storage.
- WebStorage.getInstance().deleteAllData()
+ // Save a copy of the title when it changes.
+ override fun onReceivedTitle(view: WebView, title: String) {
+ // Get the current page position.
+ val currentPosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
- // Manually delete the DOM storage files and directories, as web storage sometimes will not flush its changes to disk before system exit is run.
- try {
- // A string array must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
- val deleteLocalStorageProcess = runtime.exec(arrayOf("rm", "-rf", "$privateDataDirectoryString/app_webview/Local Storage/"))
+ // Get the current tab.
+ val tab = tabLayout.getTabAt(currentPosition)
- // Multiple commands must be used because `Runtime.exec()` does not like `*`.
- val deleteIndexProcess = runtime.exec("rm -rf $privateDataDirectoryString/app_webview/IndexedDB")
- val deleteQuotaManagerProcess = runtime.exec("rm -f $privateDataDirectoryString/app_webview/QuotaManager")
- val deleteQuotaManagerJournalProcess = runtime.exec("rm -f $privateDataDirectoryString/app_webview/QuotaManager-journal")
- val deleteDatabaseProcess = runtime.exec("rm -rf $privateDataDirectoryString/app_webview/databases")
+ // Only populate the title text view if the tab has been fully created.
+ if (tab != null) {
+ // Get the custom view from the tab.
+ val tabView = tab.customView
- // Wait until the processes have finished.
- deleteLocalStorageProcess.waitFor()
- deleteIndexProcess.waitFor()
- deleteQuotaManagerProcess.waitFor()
- deleteQuotaManagerJournalProcess.waitFor()
- deleteDatabaseProcess.waitFor()
- } catch (exception: Exception) {
- // Do nothing if an error is thrown.
+ // Only populate the title text view if the tab view has been fully populated.
+ if (tabView != null) {
+ // Get the title text view from the tab.
+ val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
+
+ // Set the title according to the URL.
+ if (title == "about:blank") {
+ // Set the title to indicate a new tab.
+ tabTitleTextView.setText(R.string.new_tab)
+ } else {
+ // Set the title as the tab text.
+ tabTitleTextView.text = title
+ }
+ }
+ }
}
- }
- // Clear form data if the API < 26.
- if (Build.VERSION.SDK_INT < 26 && (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_form_data_key), true))) {
- // Ask the WebView database to clear the form data.
- @Suppress("DEPRECATION")
- WebViewDatabase.getInstance(this).clearFormData()
+ // Enter full screen video.
+ override fun onShowCustomView(video: View, callback: CustomViewCallback) {
+ // Set the full screen video flag.
+ displayingFullScreenVideo = true
- // Manually delete the form data database, as the WebView database sometimes will not flush its changes to disk before system exit is run.
- try {
- // A string array must be used because the database contains a space and `Runtime.exec` will not otherwise escape the string correctly.
- val deleteWebDataProcess = runtime.exec(arrayOf("rm", "-f", "$privateDataDirectoryString/app_webview/Web Data"))
- val deleteWebDataJournalProcess = runtime.exec(arrayOf("rm", "-f", "$privateDataDirectoryString/app_webview/Web Data-journal"))
+ // Hide the keyboard.
+ inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.windowToken, 0)
- // Wait until the processes have finished.
- deleteWebDataProcess.waitFor()
- deleteWebDataJournalProcess.waitFor()
- } catch (exception: Exception) {
- // Do nothing if an error is thrown.
- }
- }
+ // Hide the coordinator layout.
+ coordinatorLayout.visibility = View.GONE
- // Clear the logcat.
- if (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_logcat_key), true)) {
- try {
- // Clear the logcat. `-c` clears the logcat. `-b all` clears all the buffers (instead of just crash, main, and system).
- val process = Runtime.getRuntime().exec("logcat -b all -c")
+ /* Hide the system bars.
+ * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
+ * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
+ * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
+ * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
+ */
- // Wait for the process to finish.
- process.waitFor()
- } catch (exception: IOException) {
- // Do nothing.
- } catch (exception: InterruptedException) {
- // Do nothing.
- }
- }
+ // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
+ @Suppress("DEPRECATION")
+ rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
- // Clear the cache.
- if (clearEverything || sharedPreferences.getBoolean(getString(R.string.clear_cache_key), true)) {
- // Clear the cache from each WebView.
- for (i in 0 until webViewPagerAdapter!!.count) {
- // Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
+ // Disable the sliding drawers.
+ drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED)
- // Get the WebView fragment view.
- val webViewFragmentView = webViewTabFragment.view
+ // Add the video view to the full screen video frame layout.
+ fullScreenVideoFrameLayout.addView(video)
- // Only clear the cache if the WebView exists.
- if (webViewFragmentView != null) {
- // Get the nested scroll WebView from the tab fragment.
- val nestedScrollWebView = webViewFragmentView.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
+ // Show the full screen video frame layout.
+ fullScreenVideoFrameLayout.visibility = View.VISIBLE
- // Clear the cache for this WebView.
- nestedScrollWebView.clearCache(true)
- }
+ // Disable the screen timeout while the video is playing. YouTube does this automatically, but not all other videos do.
+ fullScreenVideoFrameLayout.keepScreenOn = true
}
- // Manually delete the cache directories.
- try {
- // Delete the main cache directory.
- val deleteCacheProcess = runtime.exec("rm -rf $privateDataDirectoryString/cache")
-
- // Delete the secondary `Service Worker` cache directory.
- // A string array must be used because the directory contains a space and `Runtime.exec` will otherwise not escape the string correctly.
- val deleteServiceWorkerProcess = runtime.exec(arrayOf("rm", "-rf", "$privateDataDirectoryString/app_webview/Default/Service Worker/"))
-
- // Wait until the processes have finished.
- deleteCacheProcess.waitFor()
- deleteServiceWorkerProcess.waitFor()
- } catch (exception: Exception) {
- // Do nothing if an error is thrown.
+ // Exit full screen video.
+ override fun onHideCustomView() {
+ // Exit the full screen video.
+ exitFullScreenVideo()
}
- }
- // Wipe out each WebView.
- for (i in 0 until webViewPagerAdapter!!.count) {
- // Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
+ // Upload files.
+ override fun onShowFileChooser(webView: WebView, filePathCallback: ValueCallback<Array<Uri>>, fileChooserParams: FileChooserParams): Boolean {
+ // Store the file path callback.
+ fileChooserCallback = filePathCallback
- // Get the WebView frame layout.
- val webViewFrameLayout = webViewTabFragment.view as FrameLayout?
+ // Create an intent to open a chooser based on the file chooser parameters.
+ val fileChooserIntent = fileChooserParams.createIntent()
- // Only wipe out the WebView if it exists.
- if (webViewFrameLayout != null) {
- // Get the nested scroll WebView from the tab fragment.
- val nestedScrollWebView = webViewFrameLayout.findViewById<NestedScrollWebView>(R.id.nestedscroll_webview)
+ // Check to see if the file chooser intent resolves to an installed package.
+ if (fileChooserIntent.resolveActivity(packageManager) != null) { // The file chooser intent is fine.
+ // Launch the file chooser intent.
+ browseFileUploadActivityResultLauncher.launch(fileChooserIntent)
+ } else { // The file chooser intent will cause a crash.
+ // Create a generic intent to open a chooser.
+ val genericFileChooserIntent = Intent(Intent.ACTION_GET_CONTENT)
- // Clear SSL certificate preferences for this WebView.
- nestedScrollWebView.clearSslPreferences()
+ // Request an openable file.
+ genericFileChooserIntent.addCategory(Intent.CATEGORY_OPENABLE)
- // Clear the back/forward history for this WebView.
- nestedScrollWebView.clearHistory()
+ // Set the file type to everything.
+ genericFileChooserIntent.type = "*/*"
- // Remove all the views from the frame layout.
- webViewFrameLayout.removeAllViews()
+ // Launch the generic file chooser intent.
+ browseFileUploadActivityResultLauncher.launch(genericFileChooserIntent)
+ }
- // Destroy the internal state of the WebView.
- nestedScrollWebView.destroy()
+ // Handle the event.
+ return true
}
}
+ nestedScrollWebView.webViewClient = object : WebViewClient() {
+ // `shouldOverrideUrlLoading` makes this WebView the default handler for URLs inside the app, so that links are not kicked out to other apps.
+ override fun shouldOverrideUrlLoading(view: WebView, webResourceRequest: WebResourceRequest): Boolean {
+ // Get the URL from the web resource request.
+ var requestUrlString = webResourceRequest.url.toString()
- // Manually delete the `app_webview` folder, which contains the cookies, DOM storage, form data, and `Service Worker` cache.
- // See `https://code.google.com/p/android/issues/detail?id=233826&thanks=233826&ts=1486670530`.
- if (clearEverything) {
- try {
- // Delete the folder.
- val deleteAppWebviewProcess = runtime.exec("rm -rf $privateDataDirectoryString/app_webview")
+ // Sanitize the url.
+ requestUrlString = sanitizeUrl(requestUrlString)
- // Wait until the process has finished.
- deleteAppWebviewProcess.waitFor()
- } catch (exception: Exception) {
- // Do nothing if an error is thrown.
- }
- }
+ // Handle the URL according to the type.
+ return if (requestUrlString.startsWith("http")) { // Load the URL in Privacy Browser.
+ // Load the URL. By using `loadUrl()`, instead of `loadUrlFromBase()`, the Referer header will never be sent.
+ loadUrl(nestedScrollWebView, requestUrlString)
- // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
- finishAndRemoveTask()
+ // Returning true indicates that Privacy Browser is manually handling the loading of the URL.
+ // Custom headers cannot be added if false is returned and the WebView handles the loading of the URL.
+ true
+ } else if (requestUrlString.startsWith("mailto:")) { // Load the email address in an external email program.
+ // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
+ val emailIntent = Intent(Intent.ACTION_SENDTO)
+
+ // Parse the url and set it as the data for the intent.
+ emailIntent.data = Uri.parse(requestUrlString)
+
+ // Open the email program in a new task instead of as part of Privacy Browser.
+ emailIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // Remove the terminated program from RAM. The status code is `0`.
- exitProcess(0)
- }
+ try {
+ // Make it so.
+ startActivity(emailIntent)
+ } catch (exception: ActivityNotFoundException) {
+ // Display a snackbar.
+ Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
+ }
- // The view parameter cannot be removed because it is called from the layout onClick.
- fun bookmarksBack(@Suppress("UNUSED_PARAMETER")view: View?) {
- if (currentBookmarksFolder.isEmpty()) { // The home folder is displayed.
- // close the bookmarks drawer.
- drawerLayout.closeDrawer(GravityCompat.END)
- } else { // A subfolder is displayed.
- // Set the former parent folder as the current folder.
- currentBookmarksFolder = bookmarksDatabaseHelper!!.getParentFolderName(currentBookmarksFolder)
+ // Returning true indicates Privacy Browser is handling the URL by creating an intent.
+ true
+ } else if (requestUrlString.startsWith("tel:")) { // Load the phone number in the dialer.
+ // Create a dial intent.
+ val dialIntent = Intent(Intent.ACTION_DIAL)
- // Load the new folder.
- loadBookmarksFolder()
- }
- }
+ // Add the phone number to the intent.
+ dialIntent.data = Uri.parse(requestUrlString)
- // The view parameter cannot be removed because it is called from the layout onClick.
- fun toggleBookmarksDrawerPinned(@Suppress("UNUSED_PARAMETER")view: View?) {
- // Toggle the bookmarks drawer pinned tracker.
- bookmarksDrawerPinned = !bookmarksDrawerPinned
+ // Open the dialer in a new task instead of as part of Privacy Browser.
+ dialIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // Update the bookmarks drawer pinned image view.
- updateBookmarksDrawerPinnedImageView()
- }
+ try {
+ // Make it so.
+ startActivity(dialIntent)
+ } catch (exception: ActivityNotFoundException) {
+ // Display a snackbar.
+ Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
+ }
- private fun updateBookmarksDrawerPinnedImageView() {
- // Set the current icon.
- if (bookmarksDrawerPinned)
- bookmarksDrawerPinnedImageView.setImageResource(R.drawable.pin_selected)
- else
- bookmarksDrawerPinnedImageView.setImageResource(R.drawable.pin)
- }
+ // Returning true indicates Privacy Browser is handling the URL by creating an intent.
+ true
+ } else { // Load a system chooser to select an app that can handle the URL.
+ // Create a generic intent to open an app.
+ val genericIntent = Intent(Intent.ACTION_VIEW)
- private fun setCurrentWebView(pageNumber: Int) {
- // Stop the swipe to refresh indicator if it is running
- swipeRefreshLayout.isRefreshing = false
+ // Add the URL to the intent.
+ genericIntent.data = Uri.parse(requestUrlString)
- // Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(pageNumber)
+ // List all apps that can handle the URL instead of just opening the first one.
+ genericIntent.addCategory(Intent.CATEGORY_BROWSABLE)
- // Get the fragment view.
- val webViewFragmentView = webViewTabFragment.view
+ // Open the app in a new task instead of as part of Privacy Browser.
+ genericIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // Set the current WebView if the fragment view is not null.
- if (webViewFragmentView != null) { // The fragment has been populated.
- // Store the current WebView.
- currentWebView = webViewFragmentView.findViewById(R.id.nestedscroll_webview)
+ try {
+ // Make it so.
+ startActivity(genericIntent)
+ } catch (exception: ActivityNotFoundException) {
+ // Display a snackbar.
+ Snackbar.make(nestedScrollWebView, getString(R.string.unrecognized_url, requestUrlString), Snackbar.LENGTH_SHORT).show()
+ }
- // Update the status of swipe to refresh.
- if (currentWebView!!.swipeToRefresh) { // Swipe to refresh is enabled.
- // Enable the swipe refresh layout if the WebView is scrolled all the way to the top. It is updated every time the scroll changes.
- swipeRefreshLayout.isEnabled = (currentWebView!!.scrollY == 0)
- } else { // Swipe to refresh is disabled.
- // Disable the swipe refresh layout.
- swipeRefreshLayout.isEnabled = false
+ // Returning true indicates Privacy Browser is handling the URL by creating an intent.
+ true
+ }
}
- // Set the cookie status.
- cookieManager.setAcceptCookie(currentWebView!!.acceptCookies)
+ // Check requests against the block lists.
+ override fun shouldInterceptRequest(view: WebView, webResourceRequest: WebResourceRequest): WebResourceResponse? {
+ // Get the URL.
+ val requestUrlString = webResourceRequest.url.toString()
- // Update the privacy icons. `true` redraws the icons in the app bar.
- updatePrivacyIcons(true)
+ // Check to see if the resource request is for the main URL.
+ if (requestUrlString == nestedScrollWebView.currentUrl) {
+ // `return null` loads the resource request, which should never be blocked if it is the main URL.
+ return null
+ }
- // Get a handle for the input method manager.
- val inputMethodManager = (getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager)
+ // Wait until the filter lists have been populated. When Privacy Browser is being resumed after having the process killed in the background it will try to load the URLs immediately.
+ while (ultraPrivacy == null) {
+ try {
+ // Check to see if the filter lists have been populated after 100 ms.
+ Thread.sleep(100)
+ } catch (exception: InterruptedException) {
+ // Do nothing.
+ }
+ }
- // Get the current URL.
- val urlString = currentWebView!!.url
+ // Create an empty web resource response to be used if the resource request is blocked.
+ val emptyWebResourceResponse = WebResourceResponse("text/plain", "utf8", ByteArrayInputStream("".toByteArray()))
- // Update the URL edit text if not loading a new intent. Otherwise, this will be handled by `onPageStarted()` (if called) and `onPageFinished()`.
- if (!loadingNewIntent) { // A new intent is not being loaded.
- if ((urlString == null) || (urlString == "about:blank")) { // The WebView is blank.
- // Display the hint in the URL edit text.
- urlEditText.setText("")
+ // Initialize the variables.
+ var allowListResultStringArray: Array<String>? = null
+ var isThirdPartyRequest = false
- // Request focus for the URL text box.
- urlEditText.requestFocus()
+ // Get the current URL. `.getUrl()` throws an error because operations on the WebView cannot be made from this thread.
+ var currentBaseDomain = nestedScrollWebView.currentDomainName
- // Display the keyboard.
- inputMethodManager.showSoftInput(urlEditText, 0)
- } else { // The WebView has a loaded URL.
- // Clear the focus from the URL text box.
- urlEditText.clearFocus()
+ // Store a copy of the current domain for use in later requests.
+ val currentDomain = currentBaseDomain
- // Hide the soft keyboard.
- inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
+ // Get the request host name.
+ var requestBaseDomain = webResourceRequest.url.host
- // Display the current URL in the URL text box.
- urlEditText.setText(urlString)
+ // Only check for third-party requests if the current base domain is not empty and the request domain is not null.
+ if (currentBaseDomain.isNotEmpty() && (requestBaseDomain != null)) {
+ // Determine the current base domain.
+ while (currentBaseDomain.indexOf(".", currentBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
+ // Remove the first subdomain.
+ currentBaseDomain = currentBaseDomain.substring(currentBaseDomain.indexOf(".") + 1)
+ }
- // Highlight the URL syntax.
- UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
+ // Determine the request base domain.
+ while (requestBaseDomain!!.indexOf(".", requestBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
+ // Remove the first subdomain.
+ requestBaseDomain = requestBaseDomain.substring(requestBaseDomain.indexOf(".") + 1)
+ }
+
+ // Update the third party request tracker.
+ isThirdPartyRequest = currentBaseDomain != requestBaseDomain
}
- } else { // A new intent is being loaded.
- // Reset the loading new intent flag.
- loadingNewIntent = false
- }
- // Set the background to indicate the domain settings status.
- if (currentWebView!!.domainSettingsApplied) {
- // Set a background on the URL relative layout to indicate that custom domain settings are being used.
- urlRelativeLayout.background = AppCompatResources.getDrawable(this, R.drawable.domain_settings_url_background)
- } else {
- // Remove any background on the URL relative layout.
- urlRelativeLayout.background = AppCompatResources.getDrawable(this, R.color.transparent)
- }
- } else if (pageNumber == savedTabPosition) { // The app is being restored but the saved tab position fragment has not been populated yet. Try again in 100 milliseconds.
- // Create a handler to set the current WebView.
- val setCurrentWebViewHandler = Handler(Looper.getMainLooper())
+ // Get the current WebView page position.
+ val webViewPagePosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
- // Create a runnable to set the current WebView.
- val setCurrentWebWebRunnable = Runnable {
- // Set the current WebView.
- setCurrentWebView(pageNumber)
- }
+ // Determine if the WebView is currently displayed.
+ val webViewDisplayed = (webViewPagePosition == tabLayout.selectedTabPosition)
- // Try setting the current WebView again after 100 milliseconds.
- setCurrentWebViewHandler.postDelayed(setCurrentWebWebRunnable, 100)
- }
- }
+ // Block third-party requests if enabled.
+ if (isThirdPartyRequest && nestedScrollWebView.blockAllThirdPartyRequests) {
+ // Add the result to the resource requests.
+ nestedScrollWebView.addResourceRequest(arrayOf(REQUEST_THIRD_PARTY, requestUrlString))
- @SuppressLint("ClickableViewAccessibility")
- override fun initializeWebView(nestedScrollWebView: NestedScrollWebView, pageNumber: Int, progressBar: ProgressBar, urlString: String, restoringState: Boolean) {
- // Get the WebView theme.
- val webViewTheme = sharedPreferences.getString(getString(R.string.webview_theme_key), getString(R.string.webview_theme_default_value))
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(THIRD_PARTY_REQUESTS)
- // Get the WebView theme entry values string array.
- val webViewThemeEntryValuesStringArray = resources.getStringArray(R.array.webview_theme_entry_values)
+ // Update the titles of the filter lists menu items if the WebView is currently displayed.
+ if (webViewDisplayed) {
+ // Updating the UI must be run from the UI thread.
+ runOnUiThread {
+ // Update the menu item titles.
+ navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- // Set the WebView theme if device is running API >= 29 and algorithmic darkening is supported.
- if (Build.VERSION.SDK_INT >= 29 && WebViewFeature.isFeatureSupported(WebViewFeature.ALGORITHMIC_DARKENING)) {
- // Set the WebView them. A switch statement cannot be used because the WebView theme entry values string array is not a compile time constant.
- if (webViewTheme == webViewThemeEntryValuesStringArray[1]) { // The light theme is selected.
- // Turn off algorithmic darkening.
- WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
+ // Update the options menu if it has been populated.
+ if (optionsMenu != null) {
+ optionsFilterListsMenuItem.title = getString(R.string.filterlists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ optionsBlockAllThirdPartyRequestsMenuItem.title =
+ nestedScrollWebView.getRequestsCount(THIRD_PARTY_REQUESTS).toString() + " - " + getString(R.string.block_all_third_party_requests)
+ }
+ }
+ }
- // Make the WebView visible. The WebView was created invisible in `webview_framelayout` to prevent a white background splash in night mode.
- // If the system is currently in night mode, showing the WebView will be handled in `onProgressChanged()`.
- nestedScrollWebView.visibility = View.VISIBLE
- } else if (webViewTheme == webViewThemeEntryValuesStringArray[2]) { // The dark theme is selected.
- // Turn on algorithmic darkening.
- WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
- } else { // The system default theme is selected.
- // Get the current theme status.
- val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
+ // The resource request was blocked. Return an empty web resource response.
+ return emptyWebResourceResponse
+ }
- // Set the algorithmic darkening according to the current system theme status.
- if (currentThemeStatus == Configuration.UI_MODE_NIGHT_NO) { // The system is in day mode.
- // Turn off algorithmic darkening.
- WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
+ // Check UltraList if it is enabled.
+ if (nestedScrollWebView.ultraListEnabled) {
+ // Check the URL against UltraList.
+ val ultraListResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, ultraList)
- // Make the WebView visible. The WebView was created invisible in `webview_framelayout` to prevent a white background splash in night mode.
- // If the system is currently in night mode, showing the WebView will be handled in `onProgressChanged()`.
- nestedScrollWebView.visibility = View.VISIBLE
- } else { // The system is in night mode.
- // Turn on algorithmic darkening.
- WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
- }
- }
- }
+ // Process the UltraList results.
+ if (ultraListResults[0] == REQUEST_BLOCKED) { // The resource request matched UltraList's block list.
+ // Add the result to the resource requests.
+ nestedScrollWebView.addResourceRequest(arrayOf(ultraListResults[0], ultraListResults[1], ultraListResults[2], ultraListResults[3], ultraListResults[4], ultraListResults[5]))
- // Get a handle for the input method manager.
- val inputMethodManager = getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(com.stoutner.privacybrowser.views.ULTRALIST)
- // Instantiate the blocklist helper. TODO. Make a class instance.
- val blocklistHelper = BlocklistHelper()
+ // Update the titles of the filter lists menu items if the WebView is currently displayed.
+ if (webViewDisplayed) {
+ // Updating the UI must be run from the UI thread.
+ runOnUiThread {
+ // Update the menu item titles.
+ navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- // Set the app bar scrolling.
- nestedScrollWebView.isNestedScrollingEnabled = scrollAppBar
+ // Update the options menu if it has been populated.
+ if (optionsMenu != null) {
+ optionsFilterListsMenuItem.title = getString(R.string.filterlists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ optionsUltraListMenuItem.title = nestedScrollWebView.getRequestsCount(com.stoutner.privacybrowser.views.ULTRALIST).toString() + " - " + getString(R.string.ultralist)
+ }
+ }
+ }
- // Allow pinch to zoom.
- nestedScrollWebView.settings.builtInZoomControls = true
+ // The resource request was blocked. Return an empty web resource response.
+ return emptyWebResourceResponse
+ } else if (ultraListResults[0] == REQUEST_ALLOWED) { // The resource request matched UltraList's allow list.
+ // Add an allow list entry to the resource requests array.
+ nestedScrollWebView.addResourceRequest(arrayOf(ultraListResults[0], ultraListResults[1], ultraListResults[2], ultraListResults[3], ultraListResults[4], ultraListResults[5]))
- // Hide zoom controls.
- nestedScrollWebView.settings.displayZoomControls = false
+ // The resource request has been allowed by UltraList. `return null` loads the requested resource.
+ return null
+ }
+ }
+
+ // Check UltraPrivacy if it is enabled.
+ if (nestedScrollWebView.ultraPrivacyEnabled) {
+ // Check the URL against UltraPrivacy.
+ val ultraPrivacyResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, ultraPrivacy!!)
- // Don't allow mixed content (HTTP and HTTPS) on the same website.
- nestedScrollWebView.settings.mixedContentMode = WebSettings.MIXED_CONTENT_NEVER_ALLOW
+ // Process the UltraPrivacy results.
+ if (ultraPrivacyResults[0] == REQUEST_BLOCKED) { // The resource request matched UltraPrivacy's block list.
+ // Add the result to the resource requests.
+ nestedScrollWebView.addResourceRequest(arrayOf(ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
+ ultraPrivacyResults[5]))
- // Set the WebView to load in overview mode (zoomed out to the maximum width).
- nestedScrollWebView.settings.loadWithOverviewMode = true
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(ULTRAPRIVACY)
- // Explicitly disable geolocation.
- nestedScrollWebView.settings.setGeolocationEnabled(false)
+ // Update the titles of the filter lists menu items if the WebView is currently displayed.
+ if (webViewDisplayed) {
+ // Updating the UI must be run from the UI thread.
+ runOnUiThread {
+ // Update the menu item titles.
+ navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- // Allow loading of file:// URLs. This is necessary for opening MHT web archives, which are copied into a temporary cache location.
- nestedScrollWebView.settings.allowFileAccess = true
+ // Update the options menu if it has been populated.
+ if (optionsMenu != null) {
+ optionsFilterListsMenuItem.title = getString(R.string.filterlists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ optionsUltraPrivacyMenuItem.title = nestedScrollWebView.getRequestsCount(ULTRAPRIVACY).toString() + " - " + getString(R.string.ultraprivacy)
+ }
+ }
+ }
- // Create a double-tap gesture detector to toggle full-screen mode.
- val doubleTapGestureDetector = GestureDetector(this, object : GestureDetector.SimpleOnGestureListener() {
- // Override `onDoubleTap()`. All other events are handled using the default settings.
- override fun onDoubleTap(motionEvent: MotionEvent): Boolean {
- return if (fullScreenBrowsingModeEnabled) { // Only process the double-tap if full screen browsing mode is enabled.
- // Toggle the full screen browsing mode tracker.
- inFullScreenBrowsingMode = !inFullScreenBrowsingMode
+ // The resource request was blocked. Return an empty web resource response.
+ return emptyWebResourceResponse
+ } else if (ultraPrivacyResults[0] == REQUEST_ALLOWED) { // The resource request matched UltraPrivacy's allow list.
+ // Add an allow list entry to the resource requests array.
+ nestedScrollWebView.addResourceRequest(arrayOf(ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
+ ultraPrivacyResults[5]))
- // Toggle the full screen browsing mode.
- if (inFullScreenBrowsingMode) { // Switch to full screen mode.
- // Hide the app bar if specified.
- if (hideAppBar) { // App bar hiding is enabled.
- // Close the find on page bar if it is visible.
- closeFindOnPage(null)
+ // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
+ return null
+ }
+ }
- // Hide the tab linear layout.
- tabsLinearLayout.visibility = View.GONE
+ // Check EasyList if it is enabled.
+ if (nestedScrollWebView.easyListEnabled) {
+ // Check the URL against EasyList.
+ val easyListResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, easyList)
- // Hide the app bar.
- appBar.hide()
+ // Process the EasyList results.
+ if (easyListResults[0] == REQUEST_BLOCKED) { // The resource request matched EasyList's block list.
+ // Add the result to the resource requests.
+ nestedScrollWebView.addResourceRequest(arrayOf(easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5]))
- // Set layout and scrolling parameters according to the position of the app bar.
- if (bottomAppBar) { // The app bar is at the bottom.
- // Reset the WebView padding to fill the available space.
- swipeRefreshLayout.setPadding(0, 0, 0, 0)
- } else { // The app bar is at the top.
- // Check to see if the app bar is normally scrolled.
- if (scrollAppBar) { // The app bar is scrolled when it is displayed.
- // Get the swipe refresh layout parameters.
- val swipeRefreshLayoutParams = swipeRefreshLayout.layoutParams as CoordinatorLayout.LayoutParams
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(EASYLIST)
- // Remove the off-screen scrolling layout.
- swipeRefreshLayoutParams.behavior = null
- } else { // The app bar is not scrolled when it is displayed.
- // Remove the padding from the top of the swipe refresh layout.
- swipeRefreshLayout.setPadding(0, 0, 0, 0)
+ // Update the titles of the filter lists menu items if the WebView is currently displayed.
+ if (webViewDisplayed) {
+ // Updating the UI must be run from the UI thread.
+ runOnUiThread {
+ // Update the menu item titles.
+ navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- // The swipe refresh circle must be moved above the now removed status bar location.
- swipeRefreshLayout.setProgressViewOffset(false, -200, defaultProgressViewEndOffset)
- }
- }
- } else { // App bar hiding is not enabled.
- // Adjust the UI for the bottom app bar.
- if (bottomAppBar) {
- // Adjust the UI according to the scrolling of the app bar.
- if (scrollAppBar) {
- // Reset the WebView padding to fill the available space.
- swipeRefreshLayout.setPadding(0, 0, 0, 0)
- } else {
- // Move the WebView above the app bar layout.
- swipeRefreshLayout.setPadding(0, 0, 0, appBarHeight)
+ // Update the options menu if it has been populated.
+ if (optionsMenu != null) {
+ optionsFilterListsMenuItem.title = getString(R.string.filterlists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ optionsEasyListMenuItem.title = nestedScrollWebView.getRequestsCount(EASYLIST).toString() + " - " + getString(R.string.easylist)
}
}
}
- /* Hide the system bars.
- * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
- * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
- * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
- * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
- */
+ // The resource request was blocked. Return an empty web resource response.
+ return emptyWebResourceResponse
+ } else if (easyListResults[0] == REQUEST_ALLOWED) { // The resource request matched EasyList's allow list.
+ // Update the allow list result string array tracker.
+ allowListResultStringArray = arrayOf(easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5])
+ }
+ }
- // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
- @Suppress("DEPRECATION")
- rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or
- View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
- } else { // Switch to normal viewing mode.
- // Show the app bar if it was hidden.
- if (hideAppBar) {
- // Show the tab linear layout.
- tabsLinearLayout.visibility = View.VISIBLE
+ // Check EasyPrivacy if it is enabled.
+ if (nestedScrollWebView.easyPrivacyEnabled) {
+ // Check the URL against EasyPrivacy.
+ val easyPrivacyResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, easyPrivacy)
- // Show the app bar.
- appBar.show()
- }
+ // Process the EasyPrivacy results.
+ if (easyPrivacyResults[0] == REQUEST_BLOCKED) { // The resource request matched EasyPrivacy's block list.
+ // Add the result to the resource requests.
+ nestedScrollWebView.addResourceRequest(arrayOf(easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4], easyPrivacyResults[5]))
- // Set layout and scrolling parameters according to the position of the app bar.
- if (bottomAppBar) { // The app bar is at the bottom.
- // Adjust the UI.
- if (scrollAppBar) {
- // Reset the WebView padding to fill the available space.
- swipeRefreshLayout.setPadding(0, 0, 0, 0)
- } else {
- // Move the WebView above the app bar layout.
- swipeRefreshLayout.setPadding(0, 0, 0, appBarHeight)
- }
- } else { // The app bar is at the top.
- // Check to see if the app bar is normally scrolled.
- if (scrollAppBar) { // The app bar is scrolled when it is displayed.
- // Get the swipe refresh layout parameters.
- val swipeRefreshLayoutParams = swipeRefreshLayout.layoutParams as CoordinatorLayout.LayoutParams
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(EASYPRIVACY)
- // Add the off-screen scrolling layout.
- swipeRefreshLayoutParams.behavior = AppBarLayout.ScrollingViewBehavior()
- } else { // The app bar is not scrolled when it is displayed.
- // The swipe refresh layout must be manually moved below the app bar layout.
- swipeRefreshLayout.setPadding(0, appBarHeight, 0, 0)
+ // Update the titles of the filter lists menu items if the WebView is currently displayed.
+ if (webViewDisplayed) {
+ // Updating the UI must be run from the UI thread.
+ runOnUiThread {
+ // Update the menu item titles.
+ navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
- swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10 + appBarHeight, defaultProgressViewEndOffset + appBarHeight)
+ // Update the options menu if it has been populated.
+ if (optionsMenu != null) {
+ optionsFilterListsMenuItem.title = getString(R.string.filterlists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ optionsEasyPrivacyMenuItem.title = nestedScrollWebView.getRequestsCount(EASYPRIVACY).toString() + " - " + getString(R.string.easyprivacy)
+ }
}
}
- // Remove the `SYSTEM_UI` flags from the root frame layout. The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
- @Suppress("DEPRECATION")
- rootFrameLayout.systemUiVisibility = 0
+ // The resource request was blocked. Return an empty web resource response.
+ return emptyWebResourceResponse
+ } else if (easyPrivacyResults[0] == REQUEST_ALLOWED) { // The resource request matched EasyPrivacy's allow list.
+ // Update the allow list result string array tracker.
+ allowListResultStringArray = arrayOf(easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4], easyPrivacyResults[5])
}
-
- // Consume the double-tap.
- true
- } else { // Do not consume the double-tap because full screen browsing mode is disabled.
- // Return false.
- false
}
- }
- override fun onFling(motionEvent1: MotionEvent, motionEvent2: MotionEvent, velocityX: Float, velocityY: Float): Boolean {
- // Scroll the bottom app bar if enabled.
- if (bottomAppBar && scrollAppBar && !objectAnimator.isRunning) {
- // Calculate the Y change.
- val motionY = motionEvent2.y - motionEvent1.y
+ // Check Fanboy’s Annoyance List if it is enabled.
+ if (nestedScrollWebView.fanboysAnnoyanceListEnabled) {
+ // Check the URL against Fanboy's Annoyance List.
+ val fanboysAnnoyanceListResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, fanboysAnnoyanceList)
- // Scroll the app bar if the change is greater than 50 pixels.
- if (motionY > 50) {
- // Animate the bottom app bar onto the screen.
- objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", 0f)
- } else if (motionY < -50) {
- // Animate the bottom app bar off the screen.
- objectAnimator = ObjectAnimator.ofFloat(appBarLayout, "translationY", appBarLayout.height.toFloat())
- }
+ // Process the Fanboy's Annoyance List results.
+ if (fanboysAnnoyanceListResults[0] == REQUEST_BLOCKED) { // The resource request matched Fanboy's Annoyance List's block list.
+ // Add the result to the resource requests.
+ nestedScrollWebView.addResourceRequest(arrayOf(fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
+ fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5]))
- // Make it so.
- objectAnimator.start()
- }
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(FANBOYS_ANNOYANCE_LIST)
- // Do not consume the event.
- return false
- }
- })
+ // Update the titles of the filter lists menu items if the WebView is currently displayed.
+ if (webViewDisplayed) {
+ // Updating the UI must be run from the UI thread.
+ runOnUiThread {
+ // Update the menu item titles.
+ navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- // Pass all touch events on the WebView through the double-tap gesture detector.
- nestedScrollWebView.setOnTouchListener { view: View, motionEvent: MotionEvent? ->
- // Call `performClick()` on the view, which is required for accessibility.
- view.performClick()
+ // Update the options menu if it has been populated.
+ if (optionsMenu != null) {
+ optionsFilterListsMenuItem.title = getString(R.string.filterlists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ optionsFanboysAnnoyanceListMenuItem.title = nestedScrollWebView.getRequestsCount(FANBOYS_ANNOYANCE_LIST).toString() + " - " + getString(R.string.fanboys_annoyance_list)
+ }
+ }
+ }
- // Check for double-taps.
- doubleTapGestureDetector.onTouchEvent(motionEvent!!)
- }
+ // The resource request was blocked. Return an empty web resource response.
+ return emptyWebResourceResponse
+ } else if (fanboysAnnoyanceListResults[0] == REQUEST_ALLOWED) { // The resource request matched Fanboy's Annoyance List's allow list.
+ // Update the allow list result string array tracker.
+ allowListResultStringArray = arrayOf(fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
+ fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5])
+ }
+ } else if (nestedScrollWebView.fanboysSocialBlockingListEnabled) { // Only check Fanboy’s Social Blocking List if Fanboy’s Annoyance List is disabled.
+ // Check the URL against Fanboy's Annoyance List.
+ val fanboysSocialListResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, fanboysSocialList)
- // Register the WebView for a context menu. This is used to see link targets and download images.
- registerForContextMenu(nestedScrollWebView)
+ // Process the Fanboy's Social Blocking List results.
+ if (fanboysSocialListResults[0] == REQUEST_BLOCKED) { // The resource request matched Fanboy's Social Blocking List's block list.
+ // Add the result to the resource requests.
+ nestedScrollWebView.addResourceRequest(arrayOf(fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3],
+ fanboysSocialListResults[4], fanboysSocialListResults[5]))
- // Allow the downloading of files.
- nestedScrollWebView.setDownloadListener { downloadUrlString: String?, userAgent: String?, contentDisposition: String?, mimetype: String?, contentLength: Long ->
- // Check the download preference.
- if (downloadWithExternalApp) { // Download with an external app.
- downloadUrlWithExternalApp(downloadUrlString!!)
- } else { // Handle the download inside of Privacy Browser.
- // Define a formatted file size string.
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(FANBOYS_SOCIAL_BLOCKING_LIST)
- // Process the content length if it contains data.
- val formattedFileSizeString = if (contentLength > 0) { // The content length is greater than 0.
- // Format the content length as a string.
- NumberFormat.getInstance().format(contentLength) + " " + getString(R.string.bytes)
- } else { // The content length is not greater than 0.
- // Set the formatted file size string to be `unknown size`.
- getString(R.string.unknown_size)
+ // Update the titles of the filter lists menu items if the WebView is currently displayed.
+ if (webViewDisplayed) {
+ // Updating the UI must be run from the UI thread.
+ runOnUiThread {
+ // Update the menu item titles.
+ navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+
+ // Update the options menu if it has been populated.
+ if (optionsMenu != null) {
+ optionsFilterListsMenuItem.title = getString(R.string.filterlists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ optionsFanboysSocialBlockingListMenuItem.title =
+ nestedScrollWebView.getRequestsCount(FANBOYS_SOCIAL_BLOCKING_LIST).toString() + " - " + getString(R.string.fanboys_social_blocking_list)
+ }
+ }
+ }
+
+ // The resource request was blocked. Return an empty web resource response.
+ return emptyWebResourceResponse
+ } else if (fanboysSocialListResults[0] == REQUEST_ALLOWED) { // The resource request matched Fanboy's Social Blocking List's allow list.
+ // Update the allow list result string array tracker.
+ allowListResultStringArray = arrayOf(fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3], fanboysSocialListResults[4],
+ fanboysSocialListResults[5])
+ }
}
- // Get the file name from the content disposition.
- val fileNameString = UrlHelper.getFileName(this, contentDisposition, mimetype, downloadUrlString!!)
+ // Add the request to the log because it hasn't been processed by any of the previous checks.
+ if (allowListResultStringArray != null) { // The request was processed by an allow list.
+ nestedScrollWebView.addResourceRequest(allowListResultStringArray)
+ } else { // The request didn't match any filter list entry. Log it as a default request.
+ nestedScrollWebView.addResourceRequest(arrayOf(REQUEST_DEFAULT, requestUrlString))
+ }
- // Instantiate the save dialog.
- val saveDialogFragment = SaveDialog.saveUrl(downloadUrlString, fileNameString, formattedFileSizeString, userAgent!!, nestedScrollWebView.acceptCookies)
+ // The resource request has not been blocked. `return null` loads the requested resource.
+ return null
+ }
- // Try to show the dialog. The download listener continues to function even when the WebView is paused. Attempting to display a dialog in that state leads to a crash.
+ // Handle HTTP authentication requests.
+ override fun onReceivedHttpAuthRequest(view: WebView, handler: HttpAuthHandler, host: String, realm: String) {
+ // Store the handler.
+ nestedScrollWebView.httpAuthHandler = handler
+
+ // Instantiate an HTTP authentication dialog.
+ val httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm, nestedScrollWebView.webViewFragmentId)
+
+ // Try to show the dialog. WebView can receive an HTTP authentication request even after the app has been paused. Attempting to display a dialog in that state leads to a crash.
try {
- // Show the save dialog.
- saveDialogFragment.show(supportFragmentManager, getString(R.string.save_dialog))
+ // Show the HTTP authentication dialog.
+ httpAuthenticationDialogFragment.show(supportFragmentManager, getString(R.string.http_authentication))
} catch (exception: Exception) { // The dialog could not be shown.
// Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
- pendingDialogsArrayList.add(PendingDialogDataClass(saveDialogFragment, getString(R.string.save_dialog)))
+ pendingDialogsArrayList.add(PendingDialogDataClass(httpAuthenticationDialogFragment, getString(R.string.http_authentication)))
}
}
- }
- // Update the find on page count.
- nestedScrollWebView.setFindListener { activeMatchOrdinal, numberOfMatches, isDoneCounting ->
- if (isDoneCounting && (numberOfMatches == 0)) { // There are no matches.
- // Set the find on page count text view to be `0/0`.
- findOnPageCountTextView.setText(R.string.zero_of_zero)
- } else if (isDoneCounting) { // There are matches.
- // The active match ordinal is zero-based.
- val activeMatch = activeMatchOrdinal + 1
+ override fun onPageStarted(webView: WebView, url: String, favicon: Bitmap?) {
+ // Get the app bar layout height. This can't be done in `applyAppSettings()` because the app bar is not yet populated there.
+ // This should only be populated if it is greater than 0 because otherwise it will be reset to 0 if the app bar is hidden in full screen browsing mode.
+ if (appBarLayout.height > 0)
+ appBarHeight = appBarLayout.height
- // Build the match string.
- val matchString = "$activeMatch/$numberOfMatches"
+ // Set the padding and layout settings according to the position of the app bar.
+ if (bottomAppBar) { // The app bar is on the bottom.
+ // Adjust the UI.
+ if (scrollAppBar || (inFullScreenBrowsingMode && hideAppBar)) { // The app bar scrolls or full screen browsing mode is engaged with the app bar hidden.
+ // Reset the WebView padding to fill the available space.
+ swipeRefreshLayout.setPadding(0, 0, 0, 0)
+ } else { // The app bar doesn't scroll or full screen browsing mode is not engaged with the app bar hidden.
+ // Move the WebView above the app bar layout.
+ swipeRefreshLayout.setPadding(0, 0, 0, appBarHeight)
+ }
+ } else { // The app bar is on the top.
+ // Set the top padding of the swipe refresh layout according to the app bar scrolling preference. This can't be done in `appAppSettings()` because the app bar is not yet populated there.
+ if (scrollAppBar || (inFullScreenBrowsingMode && hideAppBar)) { // The app bar scrolls or full screen browsing mode is engaged with the app bar hidden.
+ // No padding is needed because it will automatically be placed below the app bar layout due to the scrolling layout behavior.
+ swipeRefreshLayout.setPadding(0, 0, 0, 0)
- // Update the find on page count text view.
- findOnPageCountTextView.text = matchString
- }
- }
+ // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
+ swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10, defaultProgressViewEndOffset)
+ } else { // The app bar doesn't scroll or full screen browsing mode is not engaged with the app bar hidden.
+ // The swipe refresh layout must be manually moved below the app bar layout.
+ swipeRefreshLayout.setPadding(0, appBarHeight, 0, 0)
- // Process scroll changes.
- nestedScrollWebView.setOnScrollChangeListener { _: View?, _: Int, _: Int, _: Int, _: Int ->
- // Set the swipe to refresh status.
- if (nestedScrollWebView.swipeToRefresh) // Only enable swipe to refresh if the WebView is scrolled to the top.
- swipeRefreshLayout.isEnabled = nestedScrollWebView.scrollY == 0
- else // Disable swipe to refresh.
- swipeRefreshLayout.isEnabled = false
+ // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
+ swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10 + appBarHeight, defaultProgressViewEndOffset + appBarHeight)
+ }
+ }
- // Reinforce the system UI visibility flags if in full screen browsing mode.
- // This hides the status and navigation bars, which are displayed if other elements are shown, like dialog boxes, the options menu, or the keyboard.
- if (inFullScreenBrowsingMode) {
- /* Hide the system bars.
- * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
- * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
- * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
- * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
- */
+ // Reset the list of resource requests.
+ nestedScrollWebView.clearResourceRequests()
- // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
- @Suppress("DEPRECATION")
- rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
- }
- }
+ // Reset the requests counters.
+ nestedScrollWebView.resetRequestsCounters()
- // Set the web chrome client.
- nestedScrollWebView.webChromeClient = object : WebChromeClient() {
- // Update the progress bar when a page is loading.
- override fun onProgressChanged(view: WebView, progress: Int) {
- // Update the progress bar.
- progressBar.progress = progress
+ // Get the current page position.
+ val currentPagePosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
- // Set the visibility of the progress bar.
- if (progress < 100) {
- // Show the progress bar.
- progressBar.visibility = View.VISIBLE
- } else {
- // Hide the progress bar.
- progressBar.visibility = View.GONE
+ // Update the URL text bar if the page is currently selected and the URL edit text is not currently being edited.
+ if ((tabLayout.selectedTabPosition == currentPagePosition) && !urlEditText.hasFocus()) {
+ // Display the formatted URL text. The nested scroll WebView current URL preserves any initial `view-source:`, and opposed to the method URL variable.
+ urlEditText.setText(nestedScrollWebView.currentUrl)
- //Stop the swipe to refresh indicator if it is running
- swipeRefreshLayout.isRefreshing = false
+ // Highlight the URL syntax.
+ UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
- // Make the current WebView visible. If this is a new tab, the current WebView would have been created invisible in `webview_framelayout` to prevent a white background splash in night mode.
- nestedScrollWebView.visibility = View.VISIBLE
+ // Hide the keyboard.
+ inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.windowToken, 0)
}
- }
- // Set the favorite icon when it changes.
- override fun onReceivedIcon(view: WebView, icon: Bitmap) {
- // Only update the favorite icon if the website has finished loading and the new favorite icon height is greater than the current favorite icon height.
- // This prevents low resolution icons from replacing high resolution one.
- // The check for the visibility of the progress bar can possibly be removed once https://redmine.stoutner.com/issues/747 is fixed.
- if ((progressBar.visibility == View.GONE) && (icon.height > nestedScrollWebView.getFavoriteIconHeight())) {
- // Store the new favorite icon.
- nestedScrollWebView.setFavoriteIcon(icon)
+ // Reset the list of host IP addresses.
+ nestedScrollWebView.currentIpAddresses = ""
- // Get the current page position.
- val currentPosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ // Get a URI for the current URL.
+ val currentUri = Uri.parse(url)
- // Get the current tab.
- val tab = tabLayout.getTabAt(currentPosition)
+ // Get the current domain name.
+ val currentDomainName = currentUri.host
- // Check to see if the tab has been populated.
- if (tab != null) {
- // Get the custom view from the tab.
- val tabView = tab.customView
+ // Get the IP addresses for the current domain.
+ if (!currentDomainName.isNullOrEmpty())
+ GetHostIpAddressesCoroutine.checkPinnedMismatch(currentDomainName, nestedScrollWebView, supportFragmentManager, getString(R.string.pinned_mismatch))
- // Check to see if the custom tab view has been populated.
- if (tabView != null) {
- // Get the favorite icon image view from the tab.
- val tabFavoriteIconImageView = tabView.findViewById<ImageView>(R.id.favorite_icon_imageview)
+ // Replace Refresh with Stop if the options menu has been created and the WebView is currently displayed. (The first WebView typically begins loading before the menu items are instantiated.)
+ if ((optionsMenu != null) && (webView == currentWebView)) {
+ // Set the title.
+ optionsRefreshMenuItem.setTitle(R.string.stop)
- // Display the favorite icon in the tab.
- tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true))
- }
- }
+ // Set the icon if it is displayed in the AppBar.
+ if (displayAdditionalAppBarIcons)
+ optionsRefreshMenuItem.setIcon(R.drawable.close_blue)
}
}
- // Save a copy of the title when it changes.
- override fun onReceivedTitle(view: WebView, title: String) {
- // Get the current page position.
- val currentPosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ override fun onPageFinished(webView: WebView, url: String) {
+ // Flush any cookies to persistent storage. The cookie manager has become very lazy about flushing cookies in recent versions.
+ if (nestedScrollWebView.acceptCookies)
+ cookieManager.flush()
- // Get the current tab.
- val tab = tabLayout.getTabAt(currentPosition)
+ // Update the Refresh menu item if the options menu has been created and the WebView is currently displayed.
+ if (optionsMenu != null && (webView == currentWebView)) {
+ // Reset the Refresh title.
+ optionsRefreshMenuItem.setTitle(R.string.refresh)
- // Only populate the title text view if the tab has been fully created.
- if (tab != null) {
- // Get the custom view from the tab.
- val tabView = tab.customView
+ // Reset the icon if it is displayed in the app bar.
+ if (displayAdditionalAppBarIcons)
+ optionsRefreshMenuItem.setIcon(R.drawable.refresh_enabled)
+ }
- // Only populate the title text view if the tab view has been fully populated.
- if (tabView != null) {
- // Get the title text view from the tab.
- val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
+ // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
+ // which links to `/data/data/com.stoutner.privacybrowser.standard`.
+ val privateDataDirectoryString = applicationInfo.dataDir
- // Set the title according to the URL.
- if (title == "about:blank") {
- // Set the title to indicate a new tab.
- tabTitleTextView.setText(R.string.new_tab)
- } else {
- // Set the title as the tab text.
- tabTitleTextView.text = title
- }
+ // Clear the cache, history, and logcat if Incognito Mode is enabled.
+ if (incognitoModeEnabled) {
+ // Clear the cache. `true` includes disk files.
+ nestedScrollWebView.clearCache(true)
+
+ // Clear the back/forward history.
+ nestedScrollWebView.clearHistory()
+
+ // Manually delete cache folders.
+ try {
+ // Delete the main cache directory.
+ Runtime.getRuntime().exec("rm -rf $privateDataDirectoryString/cache")
+ } catch (exception: IOException) {
+ // Do nothing if an error is thrown.
+ }
+
+ // Clear the logcat.
+ try {
+ // Clear the logcat. `-c` clears the logcat. `-b all` clears all the buffers (instead of just crash, main, and system).
+ Runtime.getRuntime().exec("logcat -b all -c")
+ } catch (exception: IOException) {
+ // Do nothing.
}
}
- }
- // Enter full screen video.
- override fun onShowCustomView(video: View, callback: CustomViewCallback) {
- // Set the full screen video flag.
- displayingFullScreenVideo = true
+ // Clear the `Service Worker` directory.
+ try {
+ // A string array must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
+ Runtime.getRuntime().exec(arrayOf("rm", "-rf", "$privateDataDirectoryString/app_webview/Default/Service Worker/"))
+ } catch (exception: IOException) {
+ // Do nothing.
+ }
- // Hide the keyboard.
- inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.windowToken, 0)
+ // Get the current page position.
+ val currentPagePosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
- // Hide the coordinator layout.
- coordinatorLayout.visibility = View.GONE
+ // Get the current URL from the nested scroll WebView. This is more accurate than using the URL passed into the method, which is sometimes not the final one.
+ val currentUrl = nestedScrollWebView.url
- /* Hide the system bars.
- * SYSTEM_UI_FLAG_FULLSCREEN hides the status bar at the top of the screen.
- * SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN makes the root frame layout fill the area that is normally reserved for the status bar.
- * SYSTEM_UI_FLAG_HIDE_NAVIGATION hides the navigation bar on the bottom or right of the screen.
- * SYSTEM_UI_FLAG_IMMERSIVE_STICKY makes the status and navigation bars translucent and automatically re-hides them after they are shown.
- */
+ // Get the current tab.
+ val tab = tabLayout.getTabAt(currentPagePosition)
- // The deprecated command can be switched to `WindowInsetsController` once the minimum API >= 30.
- @Suppress("DEPRECATION")
- rootFrameLayout.systemUiVisibility = View.SYSTEM_UI_FLAG_FULLSCREEN or View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
+ // Update the URL text bar if the page is currently selected and the user is not currently typing in the URL edit text.
+ // Crash records show that, in some crazy way, it is possible for the current URL to be blank at this point.
+ // Probably some sort of race condition when Privacy Browser is being resumed.
+ if ((tabLayout.selectedTabPosition == currentPagePosition) && !urlEditText.hasFocus() && (currentUrl != null)) {
+ // Check to see if the URL is `about:blank`.
+ if (currentUrl == "about:blank") { // The WebView is blank.
+ // Display the hint in the URL edit text.
+ urlEditText.setText("")
- // Disable the sliding drawers.
- drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED)
+ // Request focus for the URL text box.
+ urlEditText.requestFocus()
- // Add the video view to the full screen video frame layout.
- fullScreenVideoFrameLayout.addView(video)
+ // Display the keyboard.
+ inputMethodManager.showSoftInput(urlEditText, 0)
- // Show the full screen video frame layout.
- fullScreenVideoFrameLayout.visibility = View.VISIBLE
+ // Apply the domain settings. This clears any settings from the previous domain.
+ applyDomainSettings(nestedScrollWebView, "", resetTab = true, reloadWebsite = false, loadUrl = false)
- // Disable the screen timeout while the video is playing. YouTube does this automatically, but not all other videos do.
- fullScreenVideoFrameLayout.keepScreenOn = true
- }
+ // Only populate the title text view if the tab has been fully created.
+ if (tab != null) {
+ // Get the custom view from the tab.
+ val tabView = tab.customView!!
- // Exit full screen video.
- override fun onHideCustomView() {
- // Exit the full screen video.
- exitFullScreenVideo()
- }
+ // Get the title text view from the tab.
+ val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
- // Upload files.
- override fun onShowFileChooser(webView: WebView, filePathCallback: ValueCallback<Array<Uri>>, fileChooserParams: FileChooserParams): Boolean {
- // Store the file path callback.
- fileChooserCallback = filePathCallback
+ // Set the title as the tab text.
+ tabTitleTextView.setText(R.string.new_tab)
+ }
+ } else { // The WebView has loaded a webpage.
+ // Update the URL edit text if it is not currently being edited.
+ if (!urlEditText.hasFocus()) {
+ // Sanitize the current URL. This removes unwanted URL elements that were added by redirects, so that they won't be included if the URL is shared.
+ val sanitizedUrl = sanitizeUrl(currentUrl)
- // Create an intent to open a chooser based on the file chooser parameters.
- val fileChooserIntent = fileChooserParams.createIntent()
+ // Display the final URL. Getting the URL from the WebView instead of using the one provided by `onPageFinished()` makes websites like YouTube function correctly.
+ urlEditText.setText(sanitizedUrl)
- // Check to see if the file chooser intent resolves to an installed package.
- if (fileChooserIntent.resolveActivity(packageManager) != null) { // The file chooser intent is fine.
- // Launch the file chooser intent.
- browseFileUploadActivityResultLauncher.launch(fileChooserIntent)
- } else { // The file chooser intent will cause a crash.
- // Create a generic intent to open a chooser.
- val genericFileChooserIntent = Intent(Intent.ACTION_GET_CONTENT)
+ // Highlight the URL syntax.
+ UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
+ }
- // Request an openable file.
- genericFileChooserIntent.addCategory(Intent.CATEGORY_OPENABLE)
+ // Only populate the title text view if the tab has been fully created.
+ if (tab != null) {
+ // Get the custom view from the tab.
+ val tabView = tab.customView!!
- // Set the file type to everything.
- genericFileChooserIntent.type = "*/*"
+ // Get the title text view from the tab.
+ val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
- // Launch the generic file chooser intent.
- browseFileUploadActivityResultLauncher.launch(genericFileChooserIntent)
+ // Set the title as the tab text. Sometimes `onReceivedTitle()` is not called, especially when navigating history.
+ tabTitleTextView.text = nestedScrollWebView.title
+ }
+ }
}
-
- // Handle the event.
- return true
}
- }
- nestedScrollWebView.webViewClient = object : WebViewClient() {
- // `shouldOverrideUrlLoading` makes this WebView the default handler for URLs inside the app, so that links are not kicked out to other apps.
- override fun shouldOverrideUrlLoading(view: WebView, webResourceRequest: WebResourceRequest): Boolean {
- // Get the URL from the web resource request.
- var requestUrlString = webResourceRequest.url.toString()
- // Sanitize the url.
- requestUrlString = sanitizeUrl(requestUrlString)
+ // Handle SSL Certificate errors. Suppress the lint warning that ignoring the error might be dangerous.
+ @SuppressLint("WebViewClientOnReceivedSslError")
+ override fun onReceivedSslError(view: WebView, handler: SslErrorHandler, error: SslError) {
+ // Get the current website SSL certificate.
+ val currentWebsiteSslCertificate = error.certificate
- // Handle the URL according to the type.
- return if (requestUrlString.startsWith("http")) { // Load the URL in Privacy Browser.
- // Load the URL. By using `loadUrl()`, instead of `loadUrlFromBase()`, the Referer header will never be sent.
- loadUrl(nestedScrollWebView, requestUrlString)
+ // Extract the individual pieces of information from the current website SSL certificate.
+ val currentWebsiteIssuedToCName = currentWebsiteSslCertificate.issuedTo.cName
+ val currentWebsiteIssuedToOName = currentWebsiteSslCertificate.issuedTo.oName
+ val currentWebsiteIssuedToUName = currentWebsiteSslCertificate.issuedTo.uName
+ val currentWebsiteIssuedByCName = currentWebsiteSslCertificate.issuedBy.cName
+ val currentWebsiteIssuedByOName = currentWebsiteSslCertificate.issuedBy.oName
+ val currentWebsiteIssuedByUName = currentWebsiteSslCertificate.issuedBy.uName
+ val currentWebsiteSslStartDate = currentWebsiteSslCertificate.validNotBeforeDate
+ val currentWebsiteSslEndDate = currentWebsiteSslCertificate.validNotAfterDate
- // Returning true indicates that Privacy Browser is manually handling the loading of the URL.
- // Custom headers cannot be added if false is returned and the WebView handles the loading of the URL.
- true
- } else if (requestUrlString.startsWith("mailto:")) { // Load the email address in an external email program.
- // Use `ACTION_SENDTO` instead of `ACTION_SEND` so that only email programs are launched.
- val emailIntent = Intent(Intent.ACTION_SENDTO)
+ // Get the pinned SSL certificate.
+ val (pinnedSslCertificateStringArray, pinnedSslCertificateDateArray) = nestedScrollWebView.getPinnedSslCertificate()
- // Parse the url and set it as the data for the intent.
- emailIntent.data = Uri.parse(requestUrlString)
+ // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
+ if (nestedScrollWebView.hasPinnedSslCertificate() &&
+ (currentWebsiteIssuedToCName == pinnedSslCertificateStringArray[0]) &&
+ (currentWebsiteIssuedToOName == pinnedSslCertificateStringArray[1]) &&
+ (currentWebsiteIssuedToUName == pinnedSslCertificateStringArray[2]) &&
+ (currentWebsiteIssuedByCName == pinnedSslCertificateStringArray[3]) &&
+ (currentWebsiteIssuedByOName == pinnedSslCertificateStringArray[4]) &&
+ (currentWebsiteIssuedByUName == pinnedSslCertificateStringArray[5]) &&
+ (currentWebsiteSslStartDate == pinnedSslCertificateDateArray[0]) &&
+ (currentWebsiteSslEndDate == pinnedSslCertificateDateArray[1])) {
- // Open the email program in a new task instead of as part of Privacy Browser.
- emailIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // 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.
+ // Store the SSL error handler.
+ nestedScrollWebView.sslErrorHandler = handler
+
+ // Instantiate an SSL certificate error alert dialog.
+ val sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error, nestedScrollWebView.webViewFragmentId)
+ // Try to show the dialog. The SSL error handler continues to function even when the app has been stopped. Attempting to display a dialog in that state leads to a crash.
try {
- // Make it so.
- startActivity(emailIntent)
- } catch (exception: ActivityNotFoundException) {
- // Display a snackbar.
- Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
+ // Show the SSL certificate error dialog.
+ sslCertificateErrorDialogFragment.show(supportFragmentManager, getString(R.string.ssl_certificate_error))
+ } catch (exception: Exception) {
+ // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
+ pendingDialogsArrayList.add(PendingDialogDataClass(sslCertificateErrorDialogFragment, getString(R.string.ssl_certificate_error)))
}
+ }
+ }
+ }
- // Returning true indicates Privacy Browser is handling the URL by creating an intent.
- true
- } else if (requestUrlString.startsWith("tel:")) { // Load the phone number in the dialer.
- // Create a dial intent.
- val dialIntent = Intent(Intent.ACTION_DIAL)
-
- // Add the phone number to the intent.
- dialIntent.data = Uri.parse(requestUrlString)
+ // Check to see if the state is being restored.
+ if (restoringState) { // The state is being restored.
+ // Resume the nested scroll WebView JavaScript timers.
+ nestedScrollWebView.resumeTimers()
+ } else if (pagePosition == 0) { // The first page is being loaded.
+ // Set this nested scroll WebView as the current WebView.
+ currentWebView = nestedScrollWebView
- // Open the dialer in a new task instead of as part of Privacy Browser.
- dialIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // Get the intent that started the app.
+ val launchingIntent = intent
- try {
- // Make it so.
- startActivity(dialIntent)
- } catch (exception: ActivityNotFoundException) {
- // Display a snackbar.
- Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
- }
+ // Reset the intent. This prevents a duplicate tab from being created on restart.
+ intent = Intent()
- // Returning true indicates Privacy Browser is handling the URL by creating an intent.
- true
- } else { // Load a system chooser to select an app that can handle the URL.
- // Create a generic intent to open an app.
- val genericIntent = Intent(Intent.ACTION_VIEW)
+ // Get the information from the intent.
+ val launchingIntentAction = launchingIntent.action
+ val launchingIntentUriData = launchingIntent.data
+ val launchingIntentStringExtra = launchingIntent.getStringExtra(Intent.EXTRA_TEXT)
- // Add the URL to the intent.
- genericIntent.data = Uri.parse(requestUrlString)
+ // Parse the launching intent URL. Suppress the suggestions of using elvis expressions as they make the logic very difficult to follow.
+ @Suppress("IfThenToElvis") val urlToLoadString = if ((launchingIntentAction != null) && (launchingIntentAction == Intent.ACTION_WEB_SEARCH)) { // The intent contains a search string.
+ // Sanitize the search input and convert it to a search.
+ val encodedSearchString = try {
+ URLEncoder.encode(launchingIntent.getStringExtra(SearchManager.QUERY), "UTF-8")
+ } catch (exception: UnsupportedEncodingException) {
+ ""
+ }
- // List all apps that can handle the URL instead of just opening the first one.
- genericIntent.addCategory(Intent.CATEGORY_BROWSABLE)
+ // Add the search URL to the encodedSearchString
+ searchURL + encodedSearchString
+ } else if (launchingIntentUriData != null) { // The launching intent contains a URL formatted as a URI.
+ // Get the URL from the URI.
+ launchingIntentUriData.toString()
+ } else if (launchingIntentStringExtra != null) { // The launching intent contains text that might be a URL.
+ // Get the URL from the string extra.
+ launchingIntentStringExtra
+ } else if (urlString != "") { // The activity has been restarted.
+ // Load the saved URL.
+ urlString
+ } else { // The is no saved URL and there is no URL in the intent.
+ // Load the homepage.
+ sharedPreferences.getString("homepage", getString(R.string.homepage_default_value))
+ }
- // Open the app in a new task instead of as part of Privacy Browser.
- genericIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // Load the website if not waiting for the proxy.
+ if (waitingForProxy) { // Store the URL to be loaded in the Nested Scroll WebView.
+ nestedScrollWebView.waitingForProxyUrlString = urlToLoadString!!
+ } else { // Load the URL.
+ loadUrl(nestedScrollWebView, urlToLoadString!!)
+ }
+ } else { // This is not the first tab.
+ // Load the URL.
+ loadUrl(nestedScrollWebView, urlString)
- try {
- // Make it so.
- startActivity(genericIntent)
- } catch (exception: ActivityNotFoundException) {
- // Display a snackbar.
- Snackbar.make(nestedScrollWebView, getString(R.string.unrecognized_url, requestUrlString), Snackbar.LENGTH_SHORT).show()
- }
+ // Set the focus and display the keyboard if the URL is blank.
+ if (urlString == "") {
+ // Request focus for the URL text box.
+ urlEditText.requestFocus()
- // Returning true indicates Privacy Browser is handling the URL by creating an intent.
- true
+ // Display the keyboard once the tab layout has settled.
+ tabLayout.post {
+ inputMethodManager.showSoftInput(urlEditText, 0)
}
}
+ }
+ }
- // Check requests against the block lists.
- override fun shouldInterceptRequest(view: WebView, webResourceRequest: WebResourceRequest): WebResourceResponse? {
- // Get the URL.
- val requestUrlString = webResourceRequest.url.toString()
+ private fun loadBookmarksFolder() {
+ // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
+ bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolderId)
- // Check to see if the resource request is for the main URL.
- if (requestUrlString == nestedScrollWebView.currentUrl) {
- // `return null` loads the resource request, which should never be blocked if it is the main URL.
- return null
- }
+ // Populate the bookmarks cursor adapter.
+ bookmarksCursorAdapter = object : CursorAdapter(this, bookmarksCursor, false) {
+ override fun newView(context: Context, cursor: Cursor, parent: ViewGroup): View {
+ // Inflate the individual item layout.
+ return layoutInflater.inflate(R.layout.bookmarks_drawer_item_linearlayout, parent, false)
+ }
- // Wait until the blocklists have been populated. When Privacy Browser is being resumed after having the process killed in the background it will try to load the URLs immediately.
- while (ultraPrivacy == null) {
- try {
- // Check to see if the blocklists have been populated after 100 ms.
- Thread.sleep(100)
- } catch (exception: InterruptedException) {
- // Do nothing.
- }
- }
+ override fun bindView(view: View, context: Context, cursor: Cursor) {
+ // Get handles for the views.
+ val bookmarkFavoriteIcon = view.findViewById<ImageView>(R.id.bookmark_favorite_icon)
+ val bookmarkNameTextView = view.findViewById<TextView>(R.id.bookmark_name)
- // Create an empty web resource response to be used if the resource request is blocked.
- val emptyWebResourceResponse = WebResourceResponse("text/plain", "utf8", ByteArrayInputStream("".toByteArray()))
+ // Get the favorite icon byte array from the cursor.
+ val favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndexOrThrow(FAVORITE_ICON))
- // Initialize the variables.
- var whitelistResultStringArray: Array<String>? = null
- var isThirdPartyRequest = false
+ // Convert the byte array to a bitmap beginning at the first byte and ending at the last.
+ val favoriteIconBitmap = BitmapFactory.decodeByteArray(favoriteIconByteArray, 0, favoriteIconByteArray.size)
+
+ // Display the bitmap in the bookmark favorite icon.
+ bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap)
- // Get the current URL. `.getUrl()` throws an error because operations on the WebView cannot be made from this thread.
- var currentBaseDomain = nestedScrollWebView.currentDomainName
+ // Display the bookmark name from the cursor in the bookmark name text view.
+ bookmarkNameTextView.text = cursor.getString(cursor.getColumnIndexOrThrow(BOOKMARK_NAME))
- // Store a copy of the current domain for use in later requests.
- val currentDomain = currentBaseDomain
+ // Make the font bold for folders.
+ if (cursor.getInt(cursor.getColumnIndexOrThrow(IS_FOLDER)) == 1)
+ bookmarkNameTextView.typeface = Typeface.DEFAULT_BOLD
+ else // Reset the font to default for normal bookmarks.
+ bookmarkNameTextView.typeface = Typeface.DEFAULT
+ }
+ }
- // Get the request host name.
- var requestBaseDomain = webResourceRequest.url.host
+ // Populate the list view with the adapter.
+ bookmarksListView.adapter = bookmarksCursorAdapter
- // Only check for third-party requests if the current base domain is not empty and the request domain is not null.
- if (currentBaseDomain.isNotEmpty() && (requestBaseDomain != null)) {
- // Determine the current base domain.
- while (currentBaseDomain.indexOf(".", currentBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
- // Remove the first subdomain.
- currentBaseDomain = currentBaseDomain.substring(currentBaseDomain.indexOf(".") + 1)
- }
+ // Set the bookmarks drawer title.
+ if (currentBookmarksFolderId == HOME_FOLDER_ID) // The current bookmarks folder is the home folder.
+ bookmarksTitleTextView.setText(R.string.bookmarks)
+ else
+ bookmarksTitleTextView.text = bookmarksDatabaseHelper!!.getFolderName(currentBookmarksFolderId)
+ }
- // Determine the request base domain.
- while (requestBaseDomain!!.indexOf(".", requestBaseDomain.indexOf(".") + 1) > 0) { // There is at least one subdomain.
- // Remove the first subdomain.
- requestBaseDomain = requestBaseDomain.substring(requestBaseDomain.indexOf(".") + 1)
- }
+ private fun loadUrl(nestedScrollWebView: NestedScrollWebView, url: String) {
+ // Sanitize the URL.
+ val urlString = sanitizeUrl(url)
- // Update the third party request tracker.
- isThirdPartyRequest = currentBaseDomain != requestBaseDomain
- }
+ // Apply the domain settings and load the URL.
+ applyDomainSettings(nestedScrollWebView, urlString, resetTab = true, reloadWebsite = false, loadUrl = true)
+ }
- // Get the current WebView page position.
- val webViewPagePosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ private fun loadUrlFromTextBox() {
+ // Get the text from URL text box and convert it to a string. trim() removes white spaces from the beginning and end of the string.
+ var unformattedUrlString = urlEditText.text.toString().trim { it <= ' ' }
- // Determine if the WebView is currently displayed.
- val webViewDisplayed = webViewPagePosition == tabLayout.selectedTabPosition
+ // Create the formatted URL string.
+ var urlString = ""
- // Block third-party requests if enabled.
- if (isThirdPartyRequest && nestedScrollWebView.blockAllThirdPartyRequests) {
- // Add the result to the resource requests.
- nestedScrollWebView.addResourceRequest(arrayOf(BlocklistHelper.REQUEST_THIRD_PARTY, requestUrlString))
+ // Check to see if the unformatted URL string is a valid URL. Otherwise, convert it into a search.
+ if (unformattedUrlString.startsWith("content://") || unformattedUrlString.startsWith("view-source:")) { // This is a content or source URL.
+ // Load the entire content URL.
+ urlString = unformattedUrlString
+ } else if (Patterns.WEB_URL.matcher(unformattedUrlString).matches() || unformattedUrlString.startsWith("http://") || unformattedUrlString.startsWith("https://") ||
+ unformattedUrlString.startsWith("file://")) { // This is a standard URL.
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(THIRD_PARTY_REQUESTS)
+ // Add `https://` at the beginning if there is no protocol. Otherwise the app will segfault.
+ if (!unformattedUrlString.startsWith("http") && !unformattedUrlString.startsWith("file://"))
+ unformattedUrlString = "https://$unformattedUrlString"
- // Update the titles of the blocklist menu items if the WebView is currently displayed.
- if (webViewDisplayed) {
- // Updating the UI must be run from the UI thread.
- runOnUiThread {
- // Update the menu item titles.
- navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ // Initialize the unformatted URL.
+ var unformattedUrl: URL? = null
- // Update the options menu if it has been populated.
- if (optionsMenu != null) {
- optionsBlocklistsMenuItem.title = getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- optionsBlockAllThirdPartyRequestsMenuItem.title =
- nestedScrollWebView.getRequestsCount(THIRD_PARTY_REQUESTS).toString() + " - " + getString(R.string.block_all_third_party_requests)
- }
- }
- }
+ // Convert the unformatted URL string to a URL.
+ try {
+ unformattedUrl = URL(unformattedUrlString)
+ } catch (exception: MalformedURLException) {
+ exception.printStackTrace()
+ }
- // The resource request was blocked. Return an empty web resource response.
- return emptyWebResourceResponse
- }
+ // Get the components of the URL.
+ val scheme = unformattedUrl?.protocol
+ val authority = unformattedUrl?.authority
+ val path = unformattedUrl?.path
+ val query = unformattedUrl?.query
+ val fragment = unformattedUrl?.ref
- // Check UltraList if it is enabled.
- if (nestedScrollWebView.ultraListEnabled) {
- // Check the URL against UltraList.
- val ultraListResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, ultraList)
+ // Create a URI.
+ val uri = Uri.Builder()
- // Process the UltraList results.
- if (ultraListResults[0] == BlocklistHelper.REQUEST_BLOCKED) { // The resource request matched UltraList's blacklist.
- // Add the result to the resource requests.
- nestedScrollWebView.addResourceRequest(arrayOf(ultraListResults[0], ultraListResults[1], ultraListResults[2], ultraListResults[3], ultraListResults[4], ultraListResults[5]))
+ // Build the URI from the components of the URL.
+ uri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment)
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(ULTRALIST)
+ // Decode the URI as a UTF-8 string in.
+ try {
+ urlString = URLDecoder.decode(uri.build().toString(), "UTF-8")
+ } catch (exception: UnsupportedEncodingException) {
+ // Do nothing. The formatted URL string will remain blank.
+ }
+ } else if (unformattedUrlString.isNotEmpty()) { // This is not a URL, but rather a search string.
+ // Sanitize the search input.
+ val encodedSearchString = try {
+ URLEncoder.encode(unformattedUrlString, "UTF-8")
+ } catch (exception: UnsupportedEncodingException) {
+ ""
+ }
- // Update the titles of the blocklist menu items if the WebView is currently displayed.
- if (webViewDisplayed) {
- // Updating the UI must be run from the UI thread.
- runOnUiThread {
- // Update the menu item titles.
- navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ // Add the base search URL.
+ urlString = searchURL + encodedSearchString
+ }
- // Update the options menu if it has been populated.
- if (optionsMenu != null) {
- optionsBlocklistsMenuItem.title = getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- optionsUltraListMenuItem.title = nestedScrollWebView.getRequestsCount(ULTRALIST).toString() + " - " + getString(R.string.ultralist)
- }
- }
- }
+ // Clear the focus from the URL edit text. Otherwise, proximate typing in the box will retain the colorized formatting instead of being reset during refocus.
+ urlEditText.clearFocus()
- // The resource request was blocked. Return an empty web resource response.
- return emptyWebResourceResponse
- } else if (ultraListResults[0] == BlocklistHelper.REQUEST_ALLOWED) { // The resource request matched UltraList's whitelist.
- // Add a whitelist entry to the resource requests array.
- nestedScrollWebView.addResourceRequest(arrayOf(ultraListResults[0], ultraListResults[1], ultraListResults[2], ultraListResults[3], ultraListResults[4], ultraListResults[5]))
+ // Make it so.
+ loadUrl(currentWebView!!, urlString)
+ }
- // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
- return null
- }
- }
+ override fun navigateHistory(steps: Int) {
+ // Get the current web back forward list.
+ val webBackForwardList = currentWebView!!.copyBackForwardList()
- // Check UltraPrivacy if it is enabled.
- if (nestedScrollWebView.ultraPrivacyEnabled) {
- // Check the URL against UltraPrivacy.
- val ultraPrivacyResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, ultraPrivacy!!)
+ // Calculate the target index.
+ val targetIndex = webBackForwardList.currentIndex + steps
- // Process the UltraPrivacy results.
- if (ultraPrivacyResults[0] == BlocklistHelper.REQUEST_BLOCKED) { // The resource request matched UltraPrivacy's blacklist.
- // Add the result to the resource requests.
- nestedScrollWebView.addResourceRequest(arrayOf(ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
- ultraPrivacyResults[5]))
+ // Get the previous entry data.
+ val previousUrl = webBackForwardList.getItemAtIndex(targetIndex).url
+ val previousFavoriteIcon = webBackForwardList.getItemAtIndex(targetIndex).favicon
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(ULTRAPRIVACY)
+ // Apply the domain settings.
+ applyDomainSettings(currentWebView!!, previousUrl, resetTab = false, reloadWebsite = false, loadUrl = false)
- // Update the titles of the blocklist menu items if the WebView is currently displayed.
- if (webViewDisplayed) {
- // Updating the UI must be run from the UI thread.
- runOnUiThread {
- // Update the menu item titles.
- navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ // Get the current tab.
+ val tab = tabLayout.getTabAt(tabLayout.selectedTabPosition)!!
- // Update the options menu if it has been populated.
- if (optionsMenu != null) {
- optionsBlocklistsMenuItem.title = getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- optionsUltraPrivacyMenuItem.title = nestedScrollWebView.getRequestsCount(ULTRAPRIVACY).toString() + " - " + getString(R.string.ultraprivacy)
- }
- }
- }
+ // Get the custom view from the tab.
+ val tabView = tab.customView!!
- // The resource request was blocked. Return an empty web resource response.
- return emptyWebResourceResponse
- } else if (ultraPrivacyResults[0] == BlocklistHelper.REQUEST_ALLOWED) { // The resource request matched UltraPrivacy's whitelist.
- // Add a whitelist entry to the resource requests array.
- nestedScrollWebView.addResourceRequest(arrayOf(ultraPrivacyResults[0], ultraPrivacyResults[1], ultraPrivacyResults[2], ultraPrivacyResults[3], ultraPrivacyResults[4],
- ultraPrivacyResults[5]))
+ // Get the favorite icon image view from the tab.
+ val tabFavoriteIconImageView = tabView.findViewById<ImageView>(R.id.favorite_icon_imageview)
- // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
- return null
- }
- }
+ // Store the previous favorite icon.
+ if (previousFavoriteIcon == null)
+ currentWebView!!.setFavoriteIcon(defaultFavoriteIconBitmap)
+ else
+ currentWebView!!.setFavoriteIcon(previousFavoriteIcon)
- // Check EasyList if it is enabled.
- if (nestedScrollWebView.easyListEnabled) {
- // Check the URL against EasyList.
- val easyListResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, easyList)
+ // Display the previous favorite icon in the tab.
+ tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(currentWebView!!.getFavoriteIcon(), 128, 128, true))
- // Process the EasyList results.
- if (easyListResults[0] == BlocklistHelper.REQUEST_BLOCKED) { // The resource request matched EasyList's blacklist.
- // Add the result to the resource requests.
- nestedScrollWebView.addResourceRequest(arrayOf(easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5]))
+ // Load the history entry.
+ currentWebView!!.goBackOrForward(steps)
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(EASYLIST)
+ // Create a handler to update the URL edit box.
+ val urlEditTextUpdateHandler = Handler(Looper.getMainLooper())
- // Update the titles of the blocklist menu items if the WebView is currently displayed.
- if (webViewDisplayed) {
- // Updating the UI must be run from the UI thread.
- runOnUiThread {
- // Update the menu item titles.
- navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ // Create a runnable to update the URL edit box.
+ val urlEditTextUpdateRunnable = Runnable {
+ // Update the URL edit text.
+ urlEditText.setText(currentWebView!!.url)
- // Update the options menu if it has been populated.
- if (optionsMenu != null) {
- optionsBlocklistsMenuItem.title = getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- optionsEasyListMenuItem.title = nestedScrollWebView.getRequestsCount(EASYLIST).toString() + " - " + getString(R.string.easylist)
- }
- }
- }
+ // Disable the wide viewport if the source is being viewed.
+ if (currentWebView!!.url!!.startsWith("view-source:"))
+ currentWebView!!.settings.useWideViewPort = false
+ }
- // The resource request was blocked. Return an empty web resource response.
- return emptyWebResourceResponse
- } else if (easyListResults[0] == BlocklistHelper.REQUEST_ALLOWED) { // The resource request matched EasyList's whitelist.
- // Update the whitelist result string array tracker.
- whitelistResultStringArray = arrayOf(easyListResults[0], easyListResults[1], easyListResults[2], easyListResults[3], easyListResults[4], easyListResults[5])
- }
- }
+ // Update the URL edit text after 50 milliseconds, so that the WebView has enough time to navigate to the new URL.
+ urlEditTextUpdateHandler.postDelayed(urlEditTextUpdateRunnable, 50)
+ }
- // Check EasyPrivacy if it is enabled.
- if (nestedScrollWebView.easyPrivacyEnabled) {
- // Check the URL against EasyPrivacy.
- val easyPrivacyResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, easyPrivacy)
+ override fun openFile(dialogFragment: DialogFragment) {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
- // Process the EasyPrivacy results.
- if (easyPrivacyResults[0] == BlocklistHelper.REQUEST_BLOCKED) { // The resource request matched EasyPrivacy's blacklist.
- // Add the result to the resource requests.
- nestedScrollWebView.addResourceRequest(arrayOf(easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4], easyPrivacyResults[5]))
+ // Get handles for the views.
+ val fileNameEditText = dialog.findViewById<EditText>(R.id.file_name_edittext)
+ val mhtCheckBox = dialog.findViewById<CheckBox>(R.id.mht_checkbox)
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(EASYPRIVACY)
+ // Get the file path string.
+ val openFilePath = fileNameEditText.text.toString()
- // Update the titles of the blocklist menu items if the WebView is currently displayed.
- if (webViewDisplayed) {
- // Updating the UI must be run from the UI thread.
- runOnUiThread {
- // Update the menu item titles.
- navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ // Apply the domain settings. This resets the favorite icon and removes any domain settings.
+ applyDomainSettings(currentWebView!!, openFilePath, resetTab = true, reloadWebsite = false, loadUrl = false)
- // Update the options menu if it has been populated.
- if (optionsMenu != null) {
- optionsBlocklistsMenuItem.title = getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- optionsEasyPrivacyMenuItem.title = nestedScrollWebView.getRequestsCount(EASYPRIVACY).toString() + " - " + getString(R.string.easyprivacy)
- }
- }
- }
+ // Open the file according to the type.
+ if (mhtCheckBox.isChecked) { // Force opening of an MHT file.
+ try {
+ // Get the MHT file input stream.
+ val mhtFileInputStream = contentResolver.openInputStream(Uri.parse(openFilePath))
- // The resource request was blocked. Return an empty web resource response.
- return emptyWebResourceResponse
- } else if (easyPrivacyResults[0] == BlocklistHelper.REQUEST_ALLOWED) { // The resource request matched EasyPrivacy's whitelist.
- // Update the whitelist result string array tracker.
- whitelistResultStringArray = arrayOf(easyPrivacyResults[0], easyPrivacyResults[1], easyPrivacyResults[2], easyPrivacyResults[3], easyPrivacyResults[4], easyPrivacyResults[5])
- }
- }
+ // Create a temporary MHT file.
+ val temporaryMhtFile = File.createTempFile(TEMPORARY_MHT_FILE, ".mht", cacheDir)
- // Check Fanboy’s Annoyance List if it is enabled.
- if (nestedScrollWebView.fanboysAnnoyanceListEnabled) {
- // Check the URL against Fanboy's Annoyance List.
- val fanboysAnnoyanceListResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, fanboysAnnoyanceList)
+ // Get a file output stream for the temporary MHT file.
+ val temporaryMhtFileOutputStream = FileOutputStream(temporaryMhtFile)
- // Process the Fanboy's Annoyance List results.
- if (fanboysAnnoyanceListResults[0] == BlocklistHelper.REQUEST_BLOCKED) { // The resource request matched Fanboy's Annoyance List's blacklist.
- // Add the result to the resource requests.
- nestedScrollWebView.addResourceRequest(arrayOf(fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
- fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5]))
+ // Create a transfer byte array.
+ val transferByteArray = ByteArray(1024)
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(FANBOYS_ANNOYANCE_LIST)
+ // Create an integer to track the number of bytes read.
+ var bytesRead: Int
- // Update the titles of the blocklist menu items if the WebView is currently displayed.
- if (webViewDisplayed) {
- // Updating the UI must be run from the UI thread.
- runOnUiThread {
- // Update the menu item titles.
- navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ // Copy the temporary MHT file input stream to the MHT output stream.
+ while (mhtFileInputStream!!.read(transferByteArray).also { bytesRead = it } > 0)
+ temporaryMhtFileOutputStream.write(transferByteArray, 0, bytesRead)
- // Update the options menu if it has been populated.
- if (optionsMenu != null) {
- optionsBlocklistsMenuItem.title = getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- optionsFanboysAnnoyanceListMenuItem.title = nestedScrollWebView.getRequestsCount(FANBOYS_ANNOYANCE_LIST).toString() + " - " + getString(R.string.fanboys_annoyance_list)
- }
- }
- }
+ // Flush the temporary MHT file output stream.
+ temporaryMhtFileOutputStream.flush()
- // The resource request was blocked. Return an empty web resource response.
- return emptyWebResourceResponse
- } else if (fanboysAnnoyanceListResults[0] == BlocklistHelper.REQUEST_ALLOWED) { // The resource request matched Fanboy's Annoyance List's whitelist.
- // Update the whitelist result string array tracker.
- whitelistResultStringArray = arrayOf(fanboysAnnoyanceListResults[0], fanboysAnnoyanceListResults[1], fanboysAnnoyanceListResults[2], fanboysAnnoyanceListResults[3],
- fanboysAnnoyanceListResults[4], fanboysAnnoyanceListResults[5])
- }
- } else if (nestedScrollWebView.fanboysSocialBlockingListEnabled) { // Only check Fanboy’s Social Blocking List if Fanboy’s Annoyance List is disabled.
- // Check the URL against Fanboy's Annoyance List.
- val fanboysSocialListResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, fanboysSocialList)
+ // Close the streams.
+ temporaryMhtFileOutputStream.close()
+ mhtFileInputStream.close()
- // Process the Fanboy's Social Blocking List results.
- if (fanboysSocialListResults[0] == BlocklistHelper.REQUEST_BLOCKED) { // The resource request matched Fanboy's Social Blocking List's blacklist.
- // Add the result to the resource requests.
- nestedScrollWebView.addResourceRequest(arrayOf(fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3],
- fanboysSocialListResults[4], fanboysSocialListResults[5]))
+ // Load the temporary MHT file.
+ currentWebView!!.loadUrl(temporaryMhtFile.toString())
+ } catch (exception: Exception) {
+ // Display a snackbar.
+ Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
+ }
+ } else { // Let the WebView handle opening of the file.
+ // Open the file.
+ currentWebView!!.loadUrl(openFilePath)
+ }
+ }
+ // The view parameter cannot be removed because it is called from the layout onClick.
+ fun openNavigationDrawer(@Suppress("UNUSED_PARAMETER")view: View) {
+ // Open the navigation drawer.
+ drawerLayout.openDrawer(GravityCompat.START)
+ }
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(FANBOYS_SOCIAL_BLOCKING_LIST)
+ private fun openWithApp(url: String) {
+ // Create an open with app intent with `ACTION_VIEW`.
+ val openWithAppIntent = Intent(Intent.ACTION_VIEW)
- // Update the titles of the blocklist menu items if the WebView is currently displayed.
- if (webViewDisplayed) {
- // Updating the UI must be run from the UI thread.
- runOnUiThread {
- // Update the menu item titles.
- navigationRequestsMenuItem.title = getString(R.string.requests) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
+ // Set the URI but not the MIME type. This should open all available apps.
+ openWithAppIntent.data = Uri.parse(url)
- // Update the options menu if it has been populated.
- if (optionsMenu != null) {
- optionsBlocklistsMenuItem.title = getString(R.string.blocklists) + " - " + nestedScrollWebView.getRequestsCount(BLOCKED_REQUESTS)
- optionsFanboysSocialBlockingListMenuItem.title =
- nestedScrollWebView.getRequestsCount(FANBOYS_SOCIAL_BLOCKING_LIST).toString() + " - " + getString(R.string.fanboys_social_blocking_list)
- }
- }
- }
+ // Flag the intent to open in a new task.
+ openWithAppIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // The resource request was blocked. Return an empty web resource response.
- return emptyWebResourceResponse
- } else if (fanboysSocialListResults[0] == BlocklistHelper.REQUEST_ALLOWED) { // The resource request matched Fanboy's Social Blocking List's whitelist.
- // Update the whitelist result string array tracker.
- whitelistResultStringArray = arrayOf(fanboysSocialListResults[0], fanboysSocialListResults[1], fanboysSocialListResults[2], fanboysSocialListResults[3], fanboysSocialListResults[4],
- fanboysSocialListResults[5])
- }
- }
+ // Try the intent.
+ try {
+ // Show the chooser.
+ startActivity(openWithAppIntent)
+ } catch (exception: ActivityNotFoundException) { // There are no apps available to open the URL.
+ // Show a snackbar with the error.
+ Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
+ }
+ }
- // Add the request to the log because it hasn't been processed by any of the previous checks.
- if (whitelistResultStringArray != null) { // The request was processed by a whitelist.
- nestedScrollWebView.addResourceRequest(whitelistResultStringArray)
- } else { // The request didn't match any blocklist entry. Log it as a default request.
- nestedScrollWebView.addResourceRequest(arrayOf(BlocklistHelper.REQUEST_DEFAULT, requestUrlString))
- }
+ private fun openWithBrowser(url: String) {
- // The resource request has not been blocked. `return null` loads the requested resource.
- return null
- }
+ // Create an open with browser intent with `ACTION_VIEW`.
+ val openWithBrowserIntent = Intent(Intent.ACTION_VIEW)
- // Handle HTTP authentication requests.
- override fun onReceivedHttpAuthRequest(view: WebView, handler: HttpAuthHandler, host: String, realm: String) {
- // Store the handler.
- nestedScrollWebView.httpAuthHandler = handler
+ // Set the URI and the MIME type. `"text/html"` should load browser options.
+ openWithBrowserIntent.setDataAndType(Uri.parse(url), "text/html")
- // Instantiate an HTTP authentication dialog.
- val httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm, nestedScrollWebView.webViewFragmentId)
+ // Flag the intent to open in a new task.
+ openWithBrowserIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // Show the HTTP authentication dialog.
- httpAuthenticationDialogFragment.show(supportFragmentManager, getString(R.string.http_authentication))
- }
+ // Try the intent.
+ try {
+ // Show the chooser.
+ startActivity(openWithBrowserIntent)
+ } catch (exception: ActivityNotFoundException) { // There are no browsers available to open the URL.
+ // Show a snackbar with the error.
+ Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
+ }
+ }
- override fun onPageStarted(webView: WebView, url: String, favicon: Bitmap?) {
- // Get the app bar layout height. This can't be done in `applyAppSettings()` because the app bar is not yet populated there.
- // This should only be populated if it is greater than 0 because otherwise it will be reset to 0 if the app bar is hidden in full screen browsing mode.
- if (appBarLayout.height > 0)
- appBarHeight = appBarLayout.height
+ override fun pinnedErrorGoBack() {
+ // Navigate back one page.
+ navigateHistory(-1)
+ }
- // Set the padding and layout settings according to the position of the app bar.
- if (bottomAppBar) { // The app bar is on the bottom.
- // Adjust the UI.
- if (scrollAppBar || (inFullScreenBrowsingMode && hideAppBar)) { // The app bar scrolls or full screen browsing mode is engaged with the app bar hidden.
- // Reset the WebView padding to fill the available space.
- swipeRefreshLayout.setPadding(0, 0, 0, 0)
- } else { // The app bar doesn't scroll or full screen browsing mode is not engaged with the app bar hidden.
- // Move the WebView above the app bar layout.
- swipeRefreshLayout.setPadding(0, 0, 0, appBarHeight)
- }
- } else { // The app bar is on the top.
- // Set the top padding of the swipe refresh layout according to the app bar scrolling preference. This can't be done in `appAppSettings()` because the app bar is not yet populated there.
- if (scrollAppBar || (inFullScreenBrowsingMode && hideAppBar)) { // The app bar scrolls or full screen browsing mode is engaged with the app bar hidden.
- // No padding is needed because it will automatically be placed below the app bar layout due to the scrolling layout behavior.
- swipeRefreshLayout.setPadding(0, 0, 0, 0)
+ private fun sanitizeUrl(urlString: String): String {
+ // Initialize a sanitized URL string.
+ var sanitizedUrlString = urlString
- // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
- swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10, defaultProgressViewEndOffset)
- } else { // The app bar doesn't scroll or full screen browsing mode is not engaged with the app bar hidden.
- // The swipe refresh layout must be manually moved below the app bar layout.
- swipeRefreshLayout.setPadding(0, appBarHeight, 0, 0)
+ // Sanitize tracking queries.
+ if (sanitizeTrackingQueries)
+ sanitizedUrlString = SanitizeUrlHelper.sanitizeTrackingQueries(sanitizedUrlString)
- // The swipe to refresh circle doesn't always hide itself completely unless it is moved up 10 pixels.
- swipeRefreshLayout.setProgressViewOffset(false, defaultProgressViewStartOffset - 10 + appBarHeight, defaultProgressViewEndOffset + appBarHeight)
- }
- }
+ // Sanitize AMP redirects.
+ if (sanitizeAmpRedirects)
+ sanitizedUrlString = SanitizeUrlHelper.sanitizeAmpRedirects(sanitizedUrlString)
- // Reset the list of resource requests.
- nestedScrollWebView.clearResourceRequests()
+ // Return the sanitized URL string.
+ return sanitizedUrlString
+ }
- // Reset the requests counters.
- nestedScrollWebView.resetRequestsCounters()
+ override fun saveWithAndroidDownloadManager(dialogFragment: DialogFragment) {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
- // Get the current page position.
- val currentPagePosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ // Get handles for the dialog views.
+ val dialogUrlEditText = dialog.findViewById<EditText>(R.id.url_edittext)
+ val downloadDirectoryRadioGroup = dialog.findViewById<RadioGroup>(R.id.download_directory_radiogroup)
+ val dialogFileNameEditText = dialog.findViewById<EditText>(R.id.file_name_edittext)
- // Update the URL text bar if the page is currently selected and the URL edit text is not currently being edited.
- if ((tabLayout.selectedTabPosition == currentPagePosition) && !urlEditText.hasFocus()) {
- // Display the formatted URL text.
- urlEditText.setText(url)
+ // Get the string from the edit texts, which may have been modified by the user.
+ val saveUrlString = dialogUrlEditText.text.toString()
+ val fileNameString = dialogFileNameEditText.text.toString()
- // Highlight the URL syntax.
- UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
+ // Get a handle for the system download service.
+ val downloadManager = getSystemService(DOWNLOAD_SERVICE) as DownloadManager
- // Hide the keyboard.
- inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.windowToken, 0)
- }
+ // Parse the URL.
+ val downloadRequest = DownloadManager.Request(Uri.parse(saveUrlString))
- // Reset the list of host IP addresses.
- nestedScrollWebView.currentIpAddresses = ""
+ // Pass cookies to download manager if cookies are enabled. This is required to download files from websites that require a login.
+ // Code contributed 2017 Hendrik Knackstedt. Copyright assigned to Soren Stoutner <soren@stoutner.com>.
+ if (cookieManager.acceptCookie()) {
+ // Get the cookies for the URL.
+ val cookiesString = cookieManager.getCookie(saveUrlString)
- // Get a URI for the current URL.
- val currentUri = Uri.parse(url)
+ // Add the cookies to the download request. In the HTTP request header, cookies are named `Cookie`.
+ downloadRequest.addRequestHeader("Cookie", cookiesString)
+ }
- // Get the current domain name.
- val currentDomainName = currentUri.host
+ // Get the download directory.
+ val downloadDirectory = when (downloadDirectoryRadioGroup.checkedRadioButtonId) {
+ R.id.downloads_radiobutton -> Environment.DIRECTORY_DOWNLOADS
+ R.id.documents_radiobutton -> Environment.DIRECTORY_DOCUMENTS
+ R.id.pictures_radiobutton -> Environment.DIRECTORY_PICTURES
+ else -> Environment.DIRECTORY_MUSIC
+ }
- // Get the IP addresses for the current domain.
- if ((currentDomainName != null) && currentDomainName.isNotEmpty())
- GetHostIpAddressesCoroutine.checkPinnedMismatch(currentDomainName, nestedScrollWebView, supportFragmentManager, getString(R.string.pinned_mismatch))
+ // Set the download destination.
+ downloadRequest.setDestinationInExternalPublicDir(downloadDirectory, fileNameString)
- // Replace Refresh with Stop if the options menu has been created and the WebView is currently displayed. (The first WebView typically begins loading before the menu items are instantiated.)
- if ((optionsMenu != null) && (webView == currentWebView)) {
- // Set the title.
- optionsRefreshMenuItem.setTitle(R.string.stop)
+ // Allow media scanner to index the download if it is a media file. This is automatic for API >= 29.
+ @Suppress("DEPRECATION")
+ if (Build.VERSION.SDK_INT <= 28)
+ downloadRequest.allowScanningByMediaScanner()
- // Set the icon if it is displayed in the AppBar.
- if (displayAdditionalAppBarIcons)
- optionsRefreshMenuItem.setIcon(R.drawable.close_blue)
- }
- }
+ // Add the URL as the description for the download.
+ downloadRequest.setDescription(saveUrlString)
- override fun onPageFinished(webView: WebView, url: String) {
- // Flush any cookies to persistent storage. The cookie manager has become very lazy about flushing cookies in recent versions.
- if (nestedScrollWebView.acceptCookies)
- cookieManager.flush()
+ // Show the download notification after the download is completed.
+ downloadRequest.setNotificationVisibility(DownloadManager.Request.VISIBILITY_VISIBLE_NOTIFY_COMPLETED)
- // Update the Refresh menu item if the options menu has been created and the WebView is currently displayed.
- if (optionsMenu != null && (webView == currentWebView)) {
- // Reset the Refresh title.
- optionsRefreshMenuItem.setTitle(R.string.refresh)
+ // Initiate the download.
+ downloadManager.enqueue(downloadRequest)
+ }
- // Reset the icon if it is displayed in the app bar.
- if (displayAdditionalAppBarIcons)
- optionsRefreshMenuItem.setIcon(R.drawable.refresh_enabled)
- }
+ private fun saveWithExternalApp(url: String) {
+ // Create a download intent. Not specifying the action type will display the maximum number of options.
+ val downloadIntent = Intent()
- // Get the application's private data directory, which will be something like `/data/user/0/com.stoutner.privacybrowser.standard`,
- // which links to `/data/data/com.stoutner.privacybrowser.standard`.
- val privateDataDirectoryString = applicationInfo.dataDir
+ // Set the URI and the mime type.
+ downloadIntent.setDataAndType(Uri.parse(url), "text/html")
- // Clear the cache, history, and logcat if Incognito Mode is enabled.
- if (incognitoModeEnabled) {
- // Clear the cache. `true` includes disk files.
- nestedScrollWebView.clearCache(true)
+ // Flag the intent to open in a new task.
+ downloadIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // Clear the back/forward history.
- nestedScrollWebView.clearHistory()
+ // Show the chooser.
+ startActivity(Intent.createChooser(downloadIntent, getString(R.string.download_with_external_app)))
+ }
- // Manually delete cache folders.
- try {
- // Delete the main cache directory.
- Runtime.getRuntime().exec("rm -rf $privateDataDirectoryString/cache")
- } catch (exception: IOException) {
- // Do nothing if an error is thrown.
- }
+ override fun saveWithPrivacyBrowser(originalUrlString: String, fileNameString: String, dialogFragment: DialogFragment) {
+ // Store the URL. This will be used in the save URL activity result launcher.
+ saveUrlString = if (originalUrlString.startsWith("data:")) {
+ // Save the original URL.
+ originalUrlString
+ } else {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
- // Clear the logcat.
- try {
- // Clear the logcat. `-c` clears the logcat. `-b all` clears all the buffers (instead of just crash, main, and system).
- Runtime.getRuntime().exec("logcat -b all -c")
- } catch (exception: IOException) {
- // Do nothing.
- }
- }
+ // Get a handle for the dialog URL edit text.
+ val dialogUrlEditText = dialog.findViewById<EditText>(R.id.url_edittext)
- // Clear the `Service Worker` directory.
- try {
- // A string array must be used because the directory contains a space and `Runtime.exec` will not escape the string correctly otherwise.
- Runtime.getRuntime().exec(arrayOf("rm", "-rf", "$privateDataDirectoryString/app_webview/Default/Service Worker/"))
- } catch (exception: IOException) {
- // Do nothing.
- }
+ // Get the URL from the edit text, which may have been modified by the user.
+ dialogUrlEditText.text.toString()
+ }
- // Get the current page position.
- val currentPagePosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ // Open the file picker.
+ saveUrlActivityResultLauncher.launch(fileNameString)
+ }
- // Get the current URL from the nested scroll WebView. This is more accurate than using the URL passed into the method, which is sometimes not the final one.
- val currentUrl = nestedScrollWebView.url
+ private fun setCurrentWebView(pageNumber: Int) {
+ // Stop the swipe to refresh indicator if it is running
+ swipeRefreshLayout.isRefreshing = false
- // Get the current tab.
- val tab = tabLayout.getTabAt(currentPagePosition)
+ // Try to set the current WebView. This will fail if the WebView has not yet been populated.
+ try {
+ // Get the WebView tab fragment.
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(pageNumber)
- // Update the URL text bar if the page is currently selected and the user is not currently typing in the URL edit text.
- // Crash records show that, in some crazy way, it is possible for the current URL to be blank at this point.
- // Probably some sort of race condition when Privacy Browser is being resumed.
- if ((tabLayout.selectedTabPosition == currentPagePosition) && !urlEditText.hasFocus() && (currentUrl != null)) {
- // Check to see if the URL is `about:blank`.
- if (currentUrl == "about:blank") { // The WebView is blank.
- // Display the hint in the URL edit text.
- urlEditText.setText("")
+ // Get the fragment view.
+ val webViewFragmentView = webViewTabFragment.view
- // Request focus for the URL text box.
- urlEditText.requestFocus()
+ // Store the current WebView.
+ currentWebView = webViewFragmentView!!.findViewById(R.id.nestedscroll_webview)
- // Display the keyboard.
- inputMethodManager.showSoftInput(urlEditText, 0)
+ // Update the status of swipe to refresh.
+ if (currentWebView!!.swipeToRefresh) { // Swipe to refresh is enabled.
+ // Enable the swipe refresh layout if the WebView is scrolled all the way to the top. It is updated every time the scroll changes.
+ swipeRefreshLayout.isEnabled = (currentWebView!!.scrollY == 0)
+ } else { // Swipe to refresh is disabled.
+ // Disable the swipe refresh layout.
+ swipeRefreshLayout.isEnabled = false
+ }
- // Apply the domain settings. This clears any settings from the previous domain.
- applyDomainSettings(nestedScrollWebView, "", resetTab = true, reloadWebsite = false, loadUrl = false)
+ // Set the cookie status.
+ cookieManager.setAcceptCookie(currentWebView!!.acceptCookies)
- // Only populate the title text view if the tab has been fully created.
- if (tab != null) {
- // Get the custom view from the tab.
- val tabView = tab.customView!!
+ // Update the privacy icons. `true` redraws the icons in the app bar.
+ updatePrivacyIcons(true)
- // Get the title text view from the tab.
- val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
+ // Get the current URL.
+ val urlString = currentWebView!!.url
- // Set the title as the tab text.
- tabTitleTextView.setText(R.string.new_tab)
- }
- } else { // The WebView has loaded a webpage.
- // Update the URL edit text if it is not currently being edited.
- if (!urlEditText.hasFocus()) {
- // Sanitize the current URL. This removes unwanted URL elements that were added by redirects, so that they won't be included if the URL is shared.
- val sanitizedUrl = sanitizeUrl(currentUrl)
+ // Update the URL edit text if not loading a new intent. Otherwise, this will be handled by `onPageStarted()` (if called) and `onPageFinished()`.
+ if (!loadingNewIntent) { // A new intent is not being loaded.
+ if ((urlString == null) || (urlString == "about:blank")) { // The WebView is blank.
+ // Display the hint in the URL edit text.
+ urlEditText.setText("")
- // Display the final URL. Getting the URL from the WebView instead of using the one provided by `onPageFinished()` makes websites like YouTube function correctly.
- urlEditText.setText(sanitizedUrl)
+ // Request focus for the URL text box.
+ urlEditText.requestFocus()
- // Highlight the URL syntax.
- UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
- }
+ // Display the keyboard.
+ inputMethodManager.showSoftInput(urlEditText, 0)
+ } else { // The WebView has a loaded URL.
+ // Clear the focus from the URL text box.
+ urlEditText.clearFocus()
- // Only populate the title text view if the tab has been fully created.
- if (tab != null) {
- // Get the custom view from the tab.
- val tabView = tab.customView!!
+ // Hide the soft keyboard.
+ inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
- // Get the title text view from the tab.
- val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
+ // Display the current URL in the URL text box.
+ urlEditText.setText(urlString)
- // Set the title as the tab text. Sometimes `onReceivedTitle()` is not called, especially when navigating history.
- tabTitleTextView.text = nestedScrollWebView.title
- }
- }
+ // Highlight the URL syntax.
+ UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
}
+ } else { // A new intent is being loaded.
+ // Reset the loading new intent flag.
+ loadingNewIntent = false
}
- // Handle SSL Certificate errors. Suppress the lint warning that ignoring the error might be dangerous.
- @SuppressLint("WebViewClientOnReceivedSslError")
- override fun onReceivedSslError(view: WebView, handler: SslErrorHandler, error: SslError) {
- // Get the current website SSL certificate.
- val currentWebsiteSslCertificate = error.certificate
+ // Set the background to indicate the domain settings status.
+ if (currentWebView!!.domainSettingsApplied) {
+ // Set a background on the URL relative layout to indicate that custom domain settings are being used.
+ urlRelativeLayout.background = AppCompatResources.getDrawable(this, R.drawable.domain_settings_url_background)
+ } else {
+ // Remove any background on the URL relative layout.
+ urlRelativeLayout.background = AppCompatResources.getDrawable(this, R.color.transparent)
+ }
+ } catch (exception: Exception) { // Try again in 10 milliseconds if the WebView has not yet been populated.
+ // Create a handler to set the current WebView.
+ val setCurrentWebViewHandler = Handler(Looper.getMainLooper())
- // Extract the individual pieces of information from the current website SSL certificate.
- val currentWebsiteIssuedToCName = currentWebsiteSslCertificate.issuedTo.cName
- val currentWebsiteIssuedToOName = currentWebsiteSslCertificate.issuedTo.oName
- val currentWebsiteIssuedToUName = currentWebsiteSslCertificate.issuedTo.uName
- val currentWebsiteIssuedByCName = currentWebsiteSslCertificate.issuedBy.cName
- val currentWebsiteIssuedByOName = currentWebsiteSslCertificate.issuedBy.oName
- val currentWebsiteIssuedByUName = currentWebsiteSslCertificate.issuedBy.uName
- val currentWebsiteSslStartDate = currentWebsiteSslCertificate.validNotBeforeDate
- val currentWebsiteSslEndDate = currentWebsiteSslCertificate.validNotAfterDate
+ // Create a runnable to set the current WebView.
+ val setCurrentWebWebRunnable = Runnable {
+ // Set the current WebView.
+ setCurrentWebView(pageNumber)
+ }
- // Get the pinned SSL certificate.
- val (pinnedSslCertificateStringArray, pinnedSslCertificateDateArray) = nestedScrollWebView.getPinnedSslCertificate()
+ // Try setting the current WebView again after 10 milliseconds.
+ setCurrentWebViewHandler.postDelayed(setCurrentWebWebRunnable, 10)
+ }
+ }
- // Proceed to the website if the current SSL website certificate matches the pinned domain certificate.
- if (nestedScrollWebView.hasPinnedSslCertificate() &&
- (currentWebsiteIssuedToCName == pinnedSslCertificateStringArray[0]) &&
- (currentWebsiteIssuedToOName == pinnedSslCertificateStringArray[1]) &&
- (currentWebsiteIssuedToUName == pinnedSslCertificateStringArray[2]) &&
- (currentWebsiteIssuedByCName == pinnedSslCertificateStringArray[3]) &&
- (currentWebsiteIssuedByOName == pinnedSslCertificateStringArray[4]) &&
- (currentWebsiteIssuedByUName == pinnedSslCertificateStringArray[5]) &&
- (currentWebsiteSslStartDate == pinnedSslCertificateDateArray[0]) &&
- (currentWebsiteSslEndDate == pinnedSslCertificateDateArray[1])) {
+ // The view parameter cannot be removed because it is called from the layout onClick.
+ fun toggleBookmarksDrawerPinned(@Suppress("UNUSED_PARAMETER")view: View?) {
+ // Toggle the bookmarks drawer pinned tracker.
+ bookmarksDrawerPinned = !bookmarksDrawerPinned
- // 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.
- // Store the SSL error handler.
- nestedScrollWebView.sslErrorHandler = handler
+ // Update the bookmarks drawer pinned image view.
+ updateBookmarksDrawerPinnedImageView()
+ }
- // Instantiate an SSL certificate error alert dialog.
- val sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error, nestedScrollWebView.webViewFragmentId)
+ private fun updateBookmarksDrawerPinnedImageView() {
+ // Set the current icon.
+ if (bookmarksDrawerPinned)
+ bookmarksDrawerPinnedImageView.setImageResource(R.drawable.pin_selected)
+ else
+ bookmarksDrawerPinnedImageView.setImageResource(R.drawable.pin)
+ }
- // Try to show the dialog. The SSL error handler continues to function even when the WebView is paused. Attempting to display a dialog in that state leads to a crash.
- try {
- // Show the SSL certificate error dialog.
- sslCertificateErrorDialogFragment.show(supportFragmentManager, getString(R.string.ssl_certificate_error))
- } catch (exception: Exception) {
- // Add the dialog to the pending dialog array list. It will be displayed in `onStart()`.
- pendingDialogsArrayList.add(PendingDialogDataClass(sslCertificateErrorDialogFragment, getString(R.string.ssl_certificate_error)))
- }
- }
- }
- }
+ private fun updateDomainsSettingsSet() {
+ // Reset the domains settings set.
+ domainsSettingsSet = HashSet()
- // Check to see if the state is being restored.
- if (restoringState) { // The state is being restored.
- // Resume the nested scroll WebView JavaScript timers.
- nestedScrollWebView.resumeTimers()
- } else if (pageNumber == 0) { // The first page is being loaded.
- // Set this nested scroll WebView as the current WebView.
- currentWebView = nestedScrollWebView
+ // Get a domains cursor.
+ val domainsCursor = domainsDatabaseHelper!!.domainNameCursorOrderedByDomain
- // Get the intent that started the app.
- val launchingIntent = intent
+ // Get the current count of domains.
+ val domainsCount = domainsCursor.count
- // Reset the intent. This prevents a duplicate tab from being created on restart.
- intent = Intent()
+ // Get the domain name column index.
+ val domainNameColumnIndex = domainsCursor.getColumnIndexOrThrow(DOMAIN_NAME)
- // Get the information from the intent.
- val launchingIntentAction = launchingIntent.action
- val launchingIntentUriData = launchingIntent.data
- val launchingIntentStringExtra = launchingIntent.getStringExtra(Intent.EXTRA_TEXT)
+ // Populate the domain settings set.
+ for (i in 0 until domainsCount) {
+ // Move the domains cursor to the current row.
+ domainsCursor.moveToPosition(i)
- // Parse the launching intent URL. Suppress the suggestions of using elvis expressions as they make the logic very difficult to follow.
- @Suppress("IfThenToElvis") val urlToLoadString = if ((launchingIntentAction != null) && (launchingIntentAction == Intent.ACTION_WEB_SEARCH)) { // The intent contains a search string.
- // Sanitize the search input and convert it to a search.
- val encodedSearchString = try {
- URLEncoder.encode(launchingIntent.getStringExtra(SearchManager.QUERY), "UTF-8")
- } catch (exception: UnsupportedEncodingException) {
- ""
- }
+ // Store the domain name in the domain settings set.
+ domainsSettingsSet.add(domainsCursor.getString(domainNameColumnIndex))
+ }
- // Add the search URL to the encodedSearchString
- searchURL + encodedSearchString
- } else if (launchingIntentUriData != null) { // The launching intent contains a URL formatted as a URI.
- // Get the URL from the URI.
- launchingIntentUriData.toString()
- } else if (launchingIntentStringExtra != null) { // The launching intent contains text that might be a URL.
- // Get the URL from the string extra.
- launchingIntentStringExtra
- } else if (urlString != "") { // The activity has been restarted.
- // Load the saved URL.
- urlString
- } else { // The is no saved URL and there is no URL in the intent.
- // Load the homepage.
- sharedPreferences.getString("homepage", getString(R.string.homepage_default_value))
- }
+ // Close the domains cursor.
+ domainsCursor.close()
+ }
- // Load the website if not waiting for the proxy.
- if (waitingForProxy) { // Store the URL to be loaded in the Nested Scroll WebView.
- nestedScrollWebView.waitingForProxyUrlString = urlToLoadString!!
- } else { // Load the URL.
- loadUrl(nestedScrollWebView, urlToLoadString!!)
- }
+ override fun updateFontSize(dialogFragment: DialogFragment) {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
- // Reset the intent. This prevents a duplicate tab from being created on a subsequent restart if loading an link from a new intent on restart.
- // For example, this prevents a duplicate tab if a link is loaded from the Guide after changing the theme in the guide and then changing the theme again in the main activity.
- intent = Intent()
- } else { // This is not the first tab.
- // Load the URL.
- loadUrl(nestedScrollWebView, urlString)
+ // Get a handle for the font size edit text.
+ val fontSizeEditText = dialog.findViewById<EditText>(R.id.font_size_edittext)
- // Set the focus and display the keyboard if the URL is blank.
- if (urlString == "") {
- // Request focus for the URL text box.
- urlEditText.requestFocus()
+ // Initialize the new font size variable with the current font size.
+ var newFontSize = currentWebView!!.settings.textZoom
- // Create a display keyboard handler.
- val displayKeyboardHandler = Handler(Looper.getMainLooper())
+ // Get the font size from the edit text.
+ try {
+ newFontSize = fontSizeEditText.text.toString().toInt()
+ } catch (exception: Exception) {
+ // If the edit text does not contain a valid font size do nothing.
+ }
- // Create a display keyboard runnable.
- val displayKeyboardRunnable = Runnable {
- // Display the keyboard.
- inputMethodManager.showSoftInput(urlEditText, 0)
- }
+ // Apply the new font size.
+ currentWebView!!.settings.textZoom = newFontSize
+ }
- // Display the keyboard after 100 milliseconds, which leaves enough time for the tab to transition.
- displayKeyboardHandler.postDelayed(displayKeyboardRunnable, 100)
- }
+ private fun updatePrivacyIcons(runInvalidateOptionsMenu: Boolean) {
+ // Only update the privacy icons if the options menu and the current WebView have already been populated.
+ if ((optionsMenu != null) && (currentWebView != null)) {
+ // Update the privacy icon.
+ if (currentWebView!!.settings.javaScriptEnabled) // JavaScript is enabled.
+ optionsPrivacyMenuItem.setIcon(R.drawable.javascript_enabled)
+ else if (currentWebView!!.acceptCookies) // JavaScript is disabled but cookies are enabled.
+ optionsPrivacyMenuItem.setIcon(R.drawable.warning)
+ else // All the dangerous features are disabled.
+ optionsPrivacyMenuItem.setIcon(R.drawable.privacy_mode)
+
+ // Update the cookies icon.
+ if (currentWebView!!.acceptCookies)
+ optionsCookiesMenuItem.setIcon(R.drawable.cookies_enabled)
+ else
+ optionsCookiesMenuItem.setIcon(R.drawable.cookies_disabled)
+
+ // Update the refresh icon.
+ if (optionsRefreshMenuItem.title == getString(R.string.refresh)) // The refresh icon is displayed.
+ optionsRefreshMenuItem.setIcon(R.drawable.refresh_enabled)
+ else // The stop icon is displayed.
+ optionsRefreshMenuItem.setIcon(R.drawable.close_blue)
+
+ // `invalidateOptionsMenu()` calls `onPrepareOptionsMenu()` and redraws the icons in the app bar.
+ if (runInvalidateOptionsMenu)
+ invalidateOptionsMenu()
}
}
}
projects / PrivacyBrowserAndroid.git / blobdiff