import androidx.fragment.app.DialogFragment
import androidx.preference.PreferenceManager
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.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.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
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 {
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
// Declare the class variables.
private lateinit var appBar: ActionBar
- private lateinit var blocklistHelper: BlocklistHelper
+ private lateinit var checkFilterListHelper: CheckFilterListHelper
private lateinit var bookmarksCursorAdapter: CursorAdapter
private lateinit var bookmarksListView: ListView
private lateinit var bookmarksDrawerPinnedImageView: ImageView
private lateinit var navigationRequestsMenuItem: MenuItem
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 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 tabsLinearLayout: LinearLayout
private lateinit var toolbar: Toolbar
private lateinit var webViewDefaultUserAgent: String
- private lateinit var webViewPager: ViewPager
+ private lateinit var webViewViewPager2: ViewPager2
private lateinit var ultraList: ArrayList<List<Array<String>>>
private lateinit var urlEditText: EditText
private lateinit var urlRelativeLayout: RelativeLayout
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.
}
}
- // 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)
// 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)
+ webViewViewPager2 = findViewById(R.id.webview_viewpager2)
val navigationView = findViewById<NavigationView>(R.id.navigationview)
bookmarksListView = findViewById(R.id.bookmarks_drawer_listview)
bookmarksTitleTextView = findViewById(R.id.bookmarks_title_textview)
// 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)
// Set the pager adapter on the web view pager.
- webViewPager.adapter = webViewPagerAdapter
+ 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()
// 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()
+ } 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)
}
}
+ 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 onNewIntent(intent: Intent) {
// Run the default commands.
super.onNewIntent(intent)
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) {
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)
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)
+ // Initialize 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)
// 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()
+ Snackbar.make(webViewViewPager2, R.string.dom_storage_enabled, Snackbar.LENGTH_SHORT).show()
else
- Snackbar.make(webViewPager, R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show()
+ Snackbar.make(webViewViewPager2, R.string.dom_storage_disabled, Snackbar.LENGTH_SHORT).show()
// Reload the current WebView.
currentWebView!!.reload()
// 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.form_data_enabled, Snackbar.LENGTH_SHORT).show()
else
- Snackbar.make(webViewPager, R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show()
+ Snackbar.make(webViewViewPager2, R.string.form_data_disabled, Snackbar.LENGTH_SHORT).show()
// Update the privacy icon.
updatePrivacyIcons(true)
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) {
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)
+ Snackbar.make(webViewViewPager2, 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) {
// 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
}
}
- override fun onCreateBookmark(dialogFragment: DialogFragment, favoriteIconBitmap: Bitmap) {
- // Get the dialog.
- val dialog = dialogFragment.dialog!!
-
- // 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)
-
- // Extract the strings from the edit texts.
- val bookmarkNameString = createBookmarkNameEditText.text.toString()
- val bookmarkUrlString = createBookmarkUrlEditText.text.toString()
+ // 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)
+ }
- // Create a favorite icon byte array output stream.
- val favoriteIconByteArrayOutputStream = ByteArrayOutputStream()
+ 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()
- // 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 new page number. The page numbers are 0 indexed, so the new page number will match the current count.
+ val newTabNumber = tabLayout.tabCount
- // Convert the favorite icon byte array stream to a byte array.
- val favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray()
+ // Add a new tab.
+ tabLayout.addTab(tabLayout.newTab())
- // Display the new bookmark below the current items in the (0 indexed) list.
- val newBookmarkDisplayOrder = bookmarksListView.count
+ // Get the new tab.
+ val newTab = tabLayout.getTabAt(newTabNumber)!!
- // Create the bookmark.
- bookmarksDatabaseHelper!!.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray)
+ // Set a custom view on the new tab.
+ newTab.setCustomView(R.layout.tab_custom_view)
- // Update the bookmarks cursor with the current contents of this folder.
- bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolder)
+ // Add the new WebView page.
+ webViewStateAdapter!!.addPage(newTabNumber, webViewViewPager2, urlString, moveToTab)
- // Update the list view.
- bookmarksCursorAdapter.changeCursor(bookmarksCursor)
+ // 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)
- // Scroll to the new bookmark.
- bookmarksListView.setSelection(newBookmarkDisplayOrder)
+ // Make it so.
+ objectAnimator.start()
+ }
}
- override fun onCreateBookmarkFolder(dialogFragment: DialogFragment, favoriteIconBitmap: Bitmap) {
- // Get the dialog.
- val dialog = dialogFragment.dialog!!
+ 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 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)
+ // Apply the saved proxy mode if the app has been restarted.
+ if (savedProxyMode != null) {
+ // Apply the saved proxy mode.
+ proxyMode = savedProxyMode!!
- // Get new folder name string.
- val folderNameString = folderNameEditText.text.toString()
+ // Reset the saved proxy mode.
+ savedProxyMode = null
+ }
- // 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
+ // Get the search string.
+ val searchString = sharedPreferences.getString(getString(R.string.search_key), getString(R.string.search_default_value))!!
- // Convert the folder icon drawable to a bitmap drawable.
- val folderIconBitmapDrawable = folderIconDrawable as BitmapDrawable
+ // 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
- // 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
- }
+ // Apply the proxy.
+ applyProxy(false)
- // Create a folder icon byte array output stream.
- val folderIconByteArrayOutputStream = ByteArrayOutputStream()
+ // 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)
- // 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)
+ // 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)
- // Convert the folder icon byte array stream to a byte array.
- val folderIconByteArray = folderIconByteArrayOutputStream.toByteArray()
+ // 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
- // 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()
+ // 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
- // Move the bookmark down one slot.
- bookmarksDatabaseHelper!!.updateDisplayOrder(databaseId, i + 1)
- }
+ // Expand the app bar if it is currently collapsed.
+ appBarLayout.setExpanded(true)
+ }
- // Create the folder, which will be placed at the top of the list view.
- bookmarksDatabaseHelper!!.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray)
+ // 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)
- // Update the bookmarks cursor with the current contents of this folder.
- bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolder)
+ // Get the fragment view.
+ val fragmentView = webViewTabFragment.view
- // Update the list view.
- bookmarksCursorAdapter.changeCursor(bookmarksCursor)
+ // 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)
- // Scroll to the new folder.
- bookmarksListView.setSelection(0)
- }
+ // Set the app bar scrolling.
+ nestedScrollWebView.isNestedScrollingEnabled = scrollAppBar
+ }
+ }
+ }
- 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 <= ' ' }
-
- // Create the formatted URL string.
- var urlString = ""
-
- // 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.
-
- // 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 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
- // Initialize the unformatted URL.
- var unformattedUrl: URL? = null
+ // Hide the app bar.
+ appBar.hide()
+ } else {
+ // Show the tab linear layout.
+ tabsLinearLayout.visibility = View.VISIBLE
- // Convert the unformatted URL string to a URL.
- try {
- unformattedUrl = URL(unformattedUrlString)
- } catch (exception: MalformedURLException) {
- exception.printStackTrace()
+ // Show the app bar.
+ appBar.show()
}
- // 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
+ /* 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.
+ */
- // Create a URI.
- val uri = Uri.Builder()
+ // 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
- // Build the URI from the components of the URL.
- uri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment)
+ // Show the tab linear layout.
+ tabsLinearLayout.visibility = View.VISIBLE
- // 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) {
- ""
- }
+ // Show the app bar.
+ appBar.show()
- // Add the base search URL.
- urlString = searchURL + encodedSearchString
+ // 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 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()
-
- // Make it so.
- loadUrl(currentWebView!!, urlString)
- }
-
- private fun loadUrl(nestedScrollWebView: NestedScrollWebView, url: String) {
- // Sanitize the URL.
- val urlString = sanitizeUrl(url)
-
- // Apply the domain settings and load the URL.
- applyDomainSettings(nestedScrollWebView, urlString, resetTab = true, reloadWebsite = false, loadUrl = true)
}
- // 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)
- }
+ // `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 findNextOnPage(@Suppress("UNUSED_PARAMETER")view: View?) {
- // Go to the next highlighted phrase on the page. `true` goes forwards instead of backwards.
- currentWebView!!.findNext(true)
- }
+ // Parse the URL into a URI.
+ val uri = Uri.parse(url)
- // 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
+ // Extract the domain from the URI.
+ var newHostName = uri.host
- // Clear the highlighted phrases if the WebView is not null.
- currentWebView?.clearMatches()
+ // Strings don't like to be null.
+ if (newHostName == null)
+ newHostName = ""
- // Hide the find on page linear layout.
- findOnPageLinearLayout.visibility = View.GONE
+ // 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
- // Show the toolbar.
- toolbar.visibility = View.VISIBLE
+ // Reset the ignoring of pinned domain information.
+ nestedScrollWebView.ignorePinnedDomainInformation = false
- // Get a handle for the input method manager.
- val inputMethodManager = (getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager)
+ // Clear any pinned SSL certificate or IP addresses.
+ nestedScrollWebView.clearPinnedSslCertificate()
+ nestedScrollWebView.pinnedIpAddresses = ""
- // Hide the keyboard.
- inputMethodManager.hideSoftInputFromWindow(toolbar.windowToken, 0)
- }
+ // Reset the favorite icon if specified.
+ if (resetTab) {
+ // Initialize the favorite icon.
+ nestedScrollWebView.initializeFavoriteIcon()
- override fun onApplyNewFontSize(dialogFragment: DialogFragment) {
- // Get the dialog.
- val dialog = dialogFragment.dialog!!
+ // Get the current page position.
+ val currentPagePosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
- // Get a handle for the font size edit text.
- val fontSizeEditText = dialog.findViewById<EditText>(R.id.font_size_edittext)
+ // Get the corresponding tab.
+ val tab = tabLayout.getTabAt(currentPagePosition)
- // Initialize the new font size variable with the current font size.
- var newFontSize = currentWebView!!.settings.textZoom
+ // 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!!
- // 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.
- }
+ // Get the tab views.
+ val tabFavoriteIconImageView = tabCustomView.findViewById<ImageView>(R.id.favorite_icon_imageview)
+ val tabTitleTextView = tabCustomView.findViewById<TextView>(R.id.title_textview)
- // Apply the new font size.
- currentWebView!!.settings.textZoom = newFontSize
- }
+ // Set the default favorite icon as the favorite icon for this tab.
+ tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(nestedScrollWebView.getFavoriteIcon(), 64, 64, true))
- override fun onOpen(dialogFragment: DialogFragment) {
- // Get the dialog.
- val dialog = dialogFragment.dialog!!
+ // Set the loading title text.
+ tabTitleTextView.setText(R.string.loading)
+ }
+ }
- // Get handles for the views.
- val fileNameEditText = dialog.findViewById<EditText>(R.id.file_name_edittext)
- val mhtCheckBox = dialog.findViewById<CheckBox>(R.id.mht_checkbox)
+ // Initialize the domain name in database variable.
+ var domainNameInDatabase: String? = null
- // Get the file path string.
- val openFilePath = fileNameEditText.text.toString()
+ // 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
- // Apply the domain settings. This resets the favorite icon and removes any domain settings.
- applyDomainSettings(currentWebView!!, openFilePath, resetTab = true, reloadWebsite = false, loadUrl = false)
+ // 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
+ }
- // 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))
+ // 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
- // Create a temporary MHT file.
- val temporaryMhtFile = File.createTempFile(TEMPORARY_MHT_FILE, ".mht", cacheDir)
+ // Store the applied domain names as it appears in the database.
+ domainNameInDatabase = "*.$newHostName"
+ }
- // Get a file output stream for the temporary MHT file.
- val temporaryMhtFileOutputStream = FileOutputStream(temporaryMhtFile)
+ // Strip out the lowest subdomain of of the host name.
+ newHostName = newHostName.substring(newHostName.indexOf(".") + 1)
+ }
- // Create a transfer byte array.
- val transferByteArray = ByteArray(1024)
+ // 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 an integer to track the number of bytes read.
- var bytesRead: Int
+ // Get the WebView theme entry values string array.
+ val webViewThemeEntryValuesStringArray = resources.getStringArray(R.array.webview_theme_entry_values)
- // 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)
+ // 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)
- // Flush the temporary MHT file output stream.
- temporaryMhtFileOutputStream.flush()
+ // 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!!)
- // Close the streams.
- temporaryMhtFileOutputStream.close()
- mhtFileInputStream.close()
+ // Move to the first position.
+ currentDomainSettingsCursor.moveToFirst()
- // 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)
- }
- }
-
- private fun downloadUrlWithExternalApp(url: String) {
- // Create a download intent. Not specifying the action type will display the maximum number of options.
- val downloadIntent = Intent()
-
- // Set the URI and the mime type.
- downloadIntent.setDataAndType(Uri.parse(url), "text/html")
-
- // 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(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))
- // 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!!
+ // If there is a pinned SSL certificate, store it in the WebView.
+ if (pinnedSslCertificate)
+ nestedScrollWebView.setPinnedSslCertificate(pinnedSslIssuedToCName, pinnedSslIssuedToOName, pinnedSslIssuedToUName, pinnedSslIssuedByCName, pinnedSslIssuedByOName, pinnedSslIssuedByUName,
+ pinnedSslStartDate, pinnedSslEndDate)
- // Get a handle for the dialog URL edit text.
- val dialogUrlEditText = dialog.findViewById<EditText>(R.id.url_edittext)
+ // If there is a pinned IP address, store it in the WebView.
+ if (pinnedIpAddresses)
+ nestedScrollWebView.pinnedIpAddresses = pinnedHostIpAddresses
- // Get the URL from the edit text, which may have been modified.
- dialogUrlEditText.text.toString()
- }
+ // Apply the cookie domain settings.
+ cookieManager.setAcceptCookie(nestedScrollWebView.acceptCookies)
- // Open the file picker.
- saveUrlActivityResultLauncher.launch(fileNameString)
- }
+ // Apply the form data setting if the API < 26.
+ @Suppress("DEPRECATION")
+ if (Build.VERSION.SDK_INT < 26)
+ nestedScrollWebView.settings.saveFormData = saveFormData
- // 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)
+ // 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
+ }
- // 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 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
- // 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[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
- // Consume the event.
- return@setOnKeyListener true
- } else { // Some other key was pressed.
- // Do not consume the event.
- return@setOnKeyListener false
- }
- }
+ // Set the user agent to `""`, which uses the default value.
+ SETTINGS_WEBVIEW_DEFAULT_USER_AGENT ->
+ nestedScrollWebView.settings.userAgentString = ""
- // 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")!!
+ // Get the user agent string from the user agent data array.
+ else ->
+ nestedScrollWebView.settings.userAgentString = userAgentDataArray[userAgentArrayPosition]
+ }
+ }
- // 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 swipe to refresh.
+ when (swipeToRefreshInt) {
+ DomainsDatabaseHelper.SYSTEM_DEFAULT -> {
+ // Store the swipe to refresh status in the nested scroll WebView.
+ nestedScrollWebView.swipeToRefresh = defaultSwipeToRefresh
- // Get a list of the current fragments.
- val fragmentList = supportFragmentManager.fragments
+ // 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
+ }
+ }
- // 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
+ DomainsDatabaseHelper.ENABLED -> {
+ // Store the swipe to refresh status in the nested scroll WebView.
+ nestedScrollWebView.swipeToRefresh = true
- // 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()
+ // 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)
}
}
- // 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)
+ DomainsDatabaseHelper.DISABLED -> {
+ // Store the swipe to refresh status in the nested scroll WebView.
+ nestedScrollWebView.swipeToRefresh = false
- // Get the fragment view.
- val fragmentView = webViewTabFragment.view
+ // Disable swipe to refresh.
+ swipeRefreshLayout.isEnabled = false
+ }
+ }
- // 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)
+ // 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)
- // Get the waiting for proxy URL string.
- val waitingForProxyUrlString = nestedScrollWebView.waitingForProxyUrlString
+ // The dark theme is selected. Turn on algorithmic darkening.
+ webViewThemeEntryValuesStringArray[2] -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
- // Load the pending URL if it exists.
- if (waitingForProxyUrlString.isNotEmpty()) { // A URL is waiting to be loaded.
- // Load the URL.
- loadUrl(nestedScrollWebView, waitingForProxyUrlString)
+ // 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 waiting for proxy URL string.
- nestedScrollWebView.waitingForProxyUrlString = ""
- } else { // No URL is waiting to be loaded.
- // Reload the existing URL.
- nestedScrollWebView.reload()
+ // Set the algorithmic darkening according to the current system theme status.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, currentThemeStatus == Configuration.UI_MODE_NIGHT_YES)
+ }
}
- }
+
+ // Turn off algorithmic darkening.
+ DomainsDatabaseHelper.LIGHT_THEME -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
+
+ // Turn on algorithmic darkening.
+ DomainsDatabaseHelper.DARK_THEME -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
}
}
- }
- }
-
- // Register the Orbot status broadcast receiver.
- registerReceiver(orbotStatusBroadcastReceiver, IntentFilter("org.torproject.android.intent.action.STATUS"))
- // 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)
+ // 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
+ }
- // Update the WebView pager every time a tab is modified.
- webViewPager.addOnPageChangeListener(object : ViewPager.OnPageChangeListener {
- override fun onPageScrolled(position: Int, positionOffset: Float, positionOffsetPixels: Int) {}
+ // 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
+ }
- override fun onPageSelected(position: Int) {
- // Close the find on page bar if it is open.
- closeFindOnPage(null)
+ // 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)
- // Set the current WebView.
- setCurrentWebView(position)
+ // Apply the default cookie setting.
+ cookieManager.setAcceptCookie(nestedScrollWebView.acceptCookies)
- // 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)!!
+ // 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
+ }
- // Select the tab.
- tab.select()
+ // 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
}
+ } else { // Swipe to refresh is disabled.
+ // Disable the swipe refresh layout.
+ swipeRefreshLayout.isEnabled = false
}
- }
- override fun onPageScrollStateChanged(state: Int) {}
- })
+ // Reset the domain settings database ID.
+ nestedScrollWebView.domainSettingsDatabaseId = -1
- // 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
- }
+ // 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
- override fun onTabUnselected(tab: TabLayout.Tab) {}
+ // Set the user agent to `""`, which uses the default value.
+ SETTINGS_WEBVIEW_DEFAULT_USER_AGENT -> nestedScrollWebView.settings.userAgentString = ""
- override fun onTabReselected(tab: TabLayout.Tab) {
- // Instantiate the View SSL Certificate dialog.
- val viewSslCertificateDialogFragment: DialogFragment = ViewSslCertificateDialog.displayDialog(currentWebView!!.webViewFragmentId, currentWebView!!.getFavoriteIcon())
+ // 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))
- // Display the View SSL Certificate dialog.
- viewSslCertificateDialogFragment.show(supportFragmentManager, getString(R.string.view_ssl_certificate))
- }
- })
+ // Get the user agent string from the user agent data array
+ else -> nestedScrollWebView.settings.userAgentString = userAgentDataArray[userAgentArrayPosition]
+ }
- // 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 }
+ // 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)
- // 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()
+ // The dark theme is selected. Turn on algorithmic darkening.
+ webViewThemeEntryValuesStringArray[2] -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
- // Create a favorite icon byte array output stream.
- val currentFavoriteIconByteArrayOutputStream = ByteArrayOutputStream()
+ // 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
- // 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)
+ // Set the algorithmic darkening according to the current system theme status.
+ WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, currentThemeStatus == Configuration.UI_MODE_NIGHT_YES)
+ }
+ }
+ }
- // Convert the favorite icon byte array stream to a byte array.
- val currentFavoriteIconByteArray = currentFavoriteIconByteArrayOutputStream.toByteArray()
+ // Set the viewport.
+ nestedScrollWebView.settings.useWideViewPort = wideViewport
- // Create an intent to launch the bookmarks activity.
- val bookmarksIntent = Intent(applicationContext, BookmarksActivity::class.java)
+ // Set the loading of webpage images.
+ nestedScrollWebView.settings.loadsImagesAutomatically = displayWebpageImages
- // 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)
+ // Set a transparent background on the URL relative layout.
+ urlRelativeLayout.background = AppCompatResources.getDrawable(this, R.color.transparent)
+ }
- // Make it so.
- startActivity(bookmarksIntent)
+ // Update the privacy icons.
+ updatePrivacyIcons(true)
}
- // 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())
-
- // Show the create bookmark folder dialog.
- createBookmarkFolderDialog.show(supportFragmentManager, getString(R.string.create_folder))
- }
+ // Reload the website if returning from the Domains activity.
+ if (reloadWebsite)
+ nestedScrollWebView.reload()
- // 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())
+ // 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)
+ }
- // Display the create bookmark dialog.
- createBookmarkDialog.show(supportFragmentManager, getString(R.string.create_bookmark))
- }
+ private fun applyProxy(reloadWebViews: Boolean) {
+ // Set the proxy according to the mode.
+ proxyHelper.setProxy(applicationContext, appBarLayout, proxyMode)
- // 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) {}
+ // Reset the waiting for proxy tracker.
+ waitingForProxy = false
- override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {}
+ // Set the proxy.
+ when (proxyMode) {
+ ProxyHelper.NONE -> {
+ // Initialize a color background typed value.
+ val colorBackgroundTypedValue = TypedValue()
- 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())
- }
- })
+ // Get the color background from the theme.
+ theme.resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true)
- // 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)
+ // Get the color background int from the typed value.
+ val colorBackgroundInt = colorBackgroundTypedValue.data
- // Consume the event.
- return@setOnKeyListener true
- } else { // A different key was pressed.
- // Do not consume the event.
- return@setOnKeyListener false
+ // Set the default app bar layout background.
+ appBarLayout.setBackgroundColor(colorBackgroundInt)
}
- }
-
- // Implement swipe to refresh.
- swipeRefreshLayout.setOnRefreshListener {
- // Reload the website.
- currentWebView!!.reload()
- }
- // Store the default progress view offsets.
- defaultProgressViewStartOffset = swipeRefreshLayout.progressViewStartOffset
- defaultProgressViewEndOffset = swipeRefreshLayout.progressViewEndOffset
+ ProxyHelper.TOR -> {
+ // Set the app bar background to indicate proxying is enabled.
+ appBarLayout.setBackgroundResource(R.color.blue_background)
- // Set the refresh color scheme according to the theme.
- swipeRefreshLayout.setColorSchemeResources(R.color.blue_text)
+ // Check to see if Orbot is installed.
+ try {
+ // Get the package manager.
+ val packageManager = packageManager
- // Initialize a color background typed value.
- val colorBackgroundTypedValue = TypedValue()
+ // 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)
- // Get the color background from the theme.
- theme.resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true)
+ // 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 the color background int from the typed value.
- val colorBackgroundInt = colorBackgroundTypedValue.data
+ // 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()
- // Set the swipe refresh background color.
- swipeRefreshLayout.setProgressBackgroundColorSchemeColor(colorBackgroundInt)
+ // 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)
- // 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))
+ // 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)))
+ }
+ }
+ }
+ }
- // Load the bookmarks folder.
- loadBookmarksFolder()
+ ProxyHelper.I2P -> {
+ // Set the app bar background to indicate proxying is enabled.
+ appBarLayout.setBackgroundResource(R.color.blue_background)
- // 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()
+ // 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)
- // 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 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)))
+ }
+ }
+ }
+ }
+ }
- // Move the bookmark cursor to the first row.
- bookmarkCursor.moveToFirst()
+ ProxyHelper.CUSTOM ->
+ // Set the app bar background to indicate proxying is enabled.
+ appBarLayout.setBackgroundResource(R.color.blue_background)
+ }
- // 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))
+ // 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)
- // 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 fragment view.
+ val fragmentView = webViewTabFragment.view
- // Close the bookmarks drawer if it is not pinned.
- if (!bookmarksDrawerPinned)
- drawerLayout.closeDrawer(GravityCompat.END)
- }
+ // 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)
- // Close the cursor.
- bookmarkCursor.close()
+ // Reload the WebView.
+ nestedScrollWebView.reload()
+ }
+ }
}
+ }
- // 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()
+ // 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)
- // 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)
+ // Load the new folder.
+ loadBookmarksFolder()
+ }
+ }
- // Move to the first entry in the cursor.
- bookmarksCursor.moveToFirst()
+ private fun clearAndExit() {
+ // Close the bookmarks cursor if it exists.
+ bookmarksCursor?.close()
- // 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))
+ // Close the databases helpers if they exist.
+ bookmarksDatabaseHelper?.close()
+ domainsDatabaseHelper?.close()
- // Move to the next bookmark.
- bookmarksCursor.moveToNext()
- }
+ // Get the status of the clear everything preference.
+ val clearEverything = sharedPreferences.getBoolean(getString(R.string.clear_everything_key), true)
- // Close the cursor.
- bookmarksCursor.close()
- } else { // The bookmark is not a folder.
- // Get the bookmark cursor for this ID.
- val bookmarkCursor = bookmarksDatabaseHelper!!.getBookmark(databaseId)
+ // Get a handle for the runtime.
+ val runtime = Runtime.getRuntime()
- // Move the bookmark cursor to the first row.
- bookmarkCursor.moveToFirst()
+ // 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
- // 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)
+ // 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)
- // Close the cursor.
- bookmarkCursor.close()
- }
+ // Ask the cookie manager to flush the cookie database.
+ cookieManager.flush()
- // Close the bookmarks drawer if it is not pinned.
- if (!bookmarksDrawerPinned)
- drawerLayout.closeDrawer(GravityCompat.END)
+ // 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")
- // Consume the event.
- true
+ // Wait until the processes have finished.
+ deleteCookiesProcess.waitFor()
+ deleteCookiesJournalProcess.waitFor()
+ } catch (exception: Exception) {
+ // Do nothing if an error is thrown.
+ }
}
- // The drawer listener is used to update the navigation menu.
- drawerLayout.addDrawerListener(object : DrawerLayout.DrawerListener {
- override fun onDrawerSlide(drawerView: View, slideOffset: Float) {}
+ // 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()
- override fun onDrawerOpened(drawerView: View) {}
+ // 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/"))
- 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()
- }
+ // 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")
- 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)
+ // 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.
+ }
+ }
- // Hide the keyboard (if displayed).
- inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
- }
+ // 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()
- // 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()
+ // 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"))
- // 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()
- }
+ // Wait until the processes have finished.
+ deleteWebDataProcess.waitFor()
+ deleteWebDataJournalProcess.waitFor()
+ } catch (exception: Exception) {
+ // Do nothing if an error is thrown.
}
- })
+ }
- // 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)
+ // 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")
- // Get a handle for the WebView.
- val bareWebView = webViewLayout.findViewById<WebView>(R.id.bare_webview)
+ // Wait for the process to finish.
+ process.waitFor()
+ } catch (exception: IOException) {
+ // Do nothing.
+ } catch (exception: InterruptedException) {
+ // Do nothing.
+ }
+ }
- // Store the default user agent.
- webViewDefaultUserAgent = bareWebView.settings.userAgentString
+ // 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 = webViewStateAdapter!!.getPageFragment(i)
- // Destroy the bare WebView.
- bareWebView.destroy()
+ // Get the WebView fragment view.
+ val webViewFragmentView = webViewTabFragment.view
- // Update the domains settings set.
- updateDomainsSettingsSet()
+ // 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)
- // Instantiate the blocklist helper.
- blocklistHelper = BlocklistHelper()
- }
+ // Clear the cache for this WebView.
+ nestedScrollWebView.clearCache(true)
+ }
+ }
- 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)
+ // Manually delete the cache directories.
+ try {
+ // Delete the main cache directory.
+ val deleteCacheProcess = runtime.exec("rm -rf $privateDataDirectoryString/cache")
- // Apply the saved proxy mode if the app has been restarted.
- if (savedProxyMode != null) {
- // Apply the saved proxy mode.
- proxyMode = savedProxyMode!!
+ // 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/"))
- // Reset the saved proxy mode.
- savedProxyMode = null
+ // Wait until the processes have finished.
+ deleteCacheProcess.waitFor()
+ deleteServiceWorkerProcess.waitFor()
+ } catch (exception: Exception) {
+ // Do nothing if an error is thrown.
+ }
}
- // Get the search string.
- val searchString = sharedPreferences.getString(getString(R.string.search_key), getString(R.string.search_default_value))!!
-
- // 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
+ // Wipe out each WebView.
+ for (i in 0 until webViewStateAdapter!!.itemCount) {
+ // Get the WebView tab fragment.
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(i)
- // Apply the proxy.
- applyProxy(false)
+ // Get the WebView frame layout.
+ val webViewFrameLayout = webViewTabFragment.view as FrameLayout?
- // 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)
+ // 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 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)
+ // Clear SSL certificate preferences for this WebView.
+ nestedScrollWebView.clearSslPreferences()
- // 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
+ // Clear the back/forward history for this WebView.
+ nestedScrollWebView.clearHistory()
- // 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
+ // Remove all the views from the frame layout.
+ webViewFrameLayout.removeAllViews()
- // Expand the app bar if it is currently collapsed.
- appBarLayout.setExpanded(true)
+ // Destroy the internal state of the WebView.
+ nestedScrollWebView.destroy()
}
+ }
- // Set the app bar scrolling for each WebView.
- 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 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)
+ // 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")
- // Set the app bar scrolling.
- nestedScrollWebView.isNestedScrollingEnabled = scrollAppBar
- }
+ // Wait until the process has finished.
+ deleteAppWebviewProcess.waitFor()
+ } catch (exception: Exception) {
+ // Do nothing if an error is thrown.
}
}
- // 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
+ // Close Privacy Browser. `finishAndRemoveTask` also removes Privacy Browser from the recent app list.
+ finishAndRemoveTask()
- // Hide the app bar.
- appBar.hide()
- } else {
- // Show the tab linear layout.
- tabsLinearLayout.visibility = View.VISIBLE
+ // Remove the terminated program from RAM. The status code is `0`.
+ exitProcess(0)
+ }
- // Show the app bar.
- appBar.show()
- }
+ // 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
- /* 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.
- */
+ // Clear the highlighted phrases if the WebView is not null.
+ currentWebView?.clearMatches()
- // 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
+ // Hide the find on page linear layout.
+ findOnPageLinearLayout.visibility = View.GONE
- // Show the tab linear layout.
- tabsLinearLayout.visibility = View.VISIBLE
+ // Show the toolbar.
+ toolbar.visibility = View.VISIBLE
- // Show the app bar.
- appBar.show()
+ // Get a handle for the input method manager.
+ val inputMethodManager = (getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager)
- // 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
- }
+ // Hide the keyboard.
+ inputMethodManager.hideSoftInputFromWindow(toolbar.windowToken, 0)
}
- override fun navigateHistory(url: String, steps: Int) {
- // Apply the domain settings.
- applyDomainSettings(currentWebView!!, url, resetTab = false, reloadWebsite = false, loadUrl = false)
-
- // Load the history entry.
- currentWebView!!.goBackOrForward(steps)
+ // 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()
+ }
}
- override fun pinnedErrorGoBack() {
- // Get the current web back forward list.
- val webBackForwardList = currentWebView!!.copyBackForwardList()
-
- // Get the previous entry URL.
- val previousUrl = webBackForwardList.getItemAtIndex(webBackForwardList.currentIndex - 1).url
+ override fun createBookmark(dialogFragment: DialogFragment, favoriteIconBitmap: Bitmap) {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
- // Apply the domain settings.
- applyDomainSettings(currentWebView!!, previousUrl, resetTab = false, reloadWebsite = false, loadUrl = false)
+ // 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)
- // Go back.
- currentWebView!!.goBack()
- }
+ // Extract the strings from the edit texts.
+ val bookmarkNameString = createBookmarkNameEditText.text.toString()
+ val bookmarkUrlString = createBookmarkUrlEditText.text.toString()
- // `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!!
+ // Create a favorite icon byte array output stream.
+ val favoriteIconByteArrayOutputStream = ByteArrayOutputStream()
- // Parse the URL into a URI.
- val uri = Uri.parse(url)
+ // 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)
- // Extract the domain from the URI.
- var newHostName = uri.host
+ // Convert the favorite icon byte array stream to a byte array.
+ val favoriteIconByteArray = favoriteIconByteArrayOutputStream.toByteArray()
- // Strings don't like to be null.
- if (newHostName == null)
- newHostName = ""
+ // Display the new bookmark below the current items in the (0 indexed) list.
+ val newBookmarkDisplayOrder = bookmarksListView.count
- // 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
+ // Create the bookmark.
+ bookmarksDatabaseHelper!!.createBookmark(bookmarkNameString, bookmarkUrlString, currentBookmarksFolder, newBookmarkDisplayOrder, favoriteIconByteArray)
- // Reset the ignoring of pinned domain information.
- nestedScrollWebView.ignorePinnedDomainInformation = false
+ // Update the bookmarks cursor with the current contents of this folder.
+ bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolder)
- // Clear any pinned SSL certificate or IP addresses.
- nestedScrollWebView.clearPinnedSslCertificate()
- nestedScrollWebView.pinnedIpAddresses = ""
+ // Update the list view.
+ bookmarksCursorAdapter.changeCursor(bookmarksCursor)
- // Reset the favorite icon if specified.
- if (resetTab) {
- // Initialize the favorite icon.
- nestedScrollWebView.initializeFavoriteIcon()
+ // Scroll to the new bookmark.
+ bookmarksListView.setSelection(newBookmarkDisplayOrder)
+ }
- // Get the current page position.
- val currentPagePosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ override fun createBookmarkFolder(dialogFragment: DialogFragment, favoriteIconBitmap: Bitmap) {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
- // Get the corresponding tab.
- val tab = tabLayout.getTabAt(currentPagePosition)
+ // 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)
- // 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!!
+ // Get new folder name string.
+ val folderNameString = folderNameEditText.text.toString()
- // Get the tab views.
- val tabFavoriteIconImageView = tabCustomView.findViewById<ImageView>(R.id.favorite_icon_imageview)
- val tabTitleTextView = tabCustomView.findViewById<TextView>(R.id.title_textview)
+ // 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
- // Set the default favorite icon as the favorite icon for this tab.
- tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(nestedScrollWebView.getFavoriteIcon(), 64, 64, true))
+ // Convert the folder icon drawable to a bitmap drawable.
+ val folderIconBitmapDrawable = folderIconDrawable as BitmapDrawable
- // Set the loading title text.
- tabTitleTextView.setText(R.string.loading)
- }
- }
+ // 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
+ }
- // Initialize the domain name in database variable.
- var domainNameInDatabase: String? = null
+ // Create a folder icon byte array output stream.
+ val folderIconByteArrayOutputStream = ByteArrayOutputStream()
- // 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
+ // 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)
- // 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 byte array stream to a byte array.
+ val folderIconByteArray = folderIconByteArrayOutputStream.toByteArray()
- // 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
+ // 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()
- // Store the applied domain names as it appears in the database.
- domainNameInDatabase = "*.$newHostName"
- }
+ // Move the bookmark down one slot.
+ bookmarksDatabaseHelper!!.updateDisplayOrder(databaseId, i + 1)
+ }
- // Strip out the lowest subdomain of of the host name.
- newHostName = newHostName.substring(newHostName.indexOf(".") + 1)
- }
+ // Create the folder, which will be placed at the top of the list view.
+ bookmarksDatabaseHelper!!.createFolder(folderNameString, currentBookmarksFolder, folderIconByteArray)
- // 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)
+ // Update the bookmarks cursor with the current contents of this folder.
+ bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolder)
- // Get the WebView theme entry values string array.
- val webViewThemeEntryValuesStringArray = resources.getStringArray(R.array.webview_theme_entry_values)
+ // Update the list view.
+ bookmarksCursorAdapter.changeCursor(bookmarksCursor)
- // 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)
+ // Scroll to the new folder.
+ bookmarksListView.setSelection(0)
+ }
- // 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!!)
+ private fun downloadUrlWithExternalApp(url: String) {
+ // Create a download intent. Not specifying the action type will display the maximum number of options.
+ val downloadIntent = Intent()
- // Move to the first position.
- currentDomainSettingsCursor.moveToFirst()
+ // Set the URI and the mime type.
+ downloadIntent.setDataAndType(Uri.parse(url), "text/html")
- // 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))
+ // Flag the intent to open in a new task.
+ downloadIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // Close the current host domain settings cursor.
- currentDomainSettingsCursor.close()
+ // Show the chooser.
+ startActivity(Intent.createChooser(downloadIntent, getString(R.string.download_with_external_app)))
+ }
- // If there is a pinned SSL certificate, store it in the WebView.
- if (pinnedSslCertificate)
- nestedScrollWebView.setPinnedSslCertificate(pinnedSslIssuedToCName, pinnedSslIssuedToOName, pinnedSslIssuedToUName, pinnedSslIssuedByCName, pinnedSslIssuedByOName, pinnedSslIssuedByUName,
- pinnedSslStartDate, pinnedSslEndDate)
+ private fun exitFullScreenVideo() {
+ // Re-enable the screen timeout.
+ fullScreenVideoFrameLayout.keepScreenOn = false
- // If there is a pinned IP address, store it in the WebView.
- if (pinnedIpAddresses)
- nestedScrollWebView.pinnedIpAddresses = pinnedHostIpAddresses
+ // Unset the full screen video flag.
+ displayingFullScreenVideo = false
- // Apply the cookie domain settings.
- cookieManager.setAcceptCookie(nestedScrollWebView.acceptCookies)
+ // Remove all the views from the full screen video frame layout.
+ fullScreenVideoFrameLayout.removeAllViews()
- // Apply the form data setting if the API < 26.
- @Suppress("DEPRECATION")
- if (Build.VERSION.SDK_INT < 26)
- nestedScrollWebView.settings.saveFormData = saveFormData
+ // Hide the full screen video frame layout.
+ fullScreenVideoFrameLayout.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
- }
+ // Enable the sliding drawers.
+ drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED)
- // 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
+ // Show the coordinator layout.
+ coordinatorLayout.visibility = View.VISIBLE
- // Set the user agent to `""`, which uses the default value.
- SETTINGS_WEBVIEW_DEFAULT_USER_AGENT -> nestedScrollWebView.settings.userAgentString = ""
+ // 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
- // 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.
+ addNewTab("", false)
+ } else { // The activity has been restarted.
+ // 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)
+ // 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.
+ webViewViewPager2.currentItem = savedTabPosition
+ }
- // The system default theme is selected.
- else -> {
- // Get the current system theme status.
- val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
+ // Get the intent that started the app.
+ val intent = intent
- // Set the algorithmic darkening according to the current system theme status.
- WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, currentThemeStatus == Configuration.UI_MODE_NIGHT_YES)
- }
- }
+ // Reset the intent. This prevents a duplicate tab from being created on restart.
+ setIntent(Intent())
- // Turn off algorithmic darkening.
- DomainsDatabaseHelper.LIGHT_THEME -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, false)
+ // Get the information from the intent.
+ val intentAction = intent.action
+ val intentUriData = intent.data
+ val intentStringExtra = intent.getStringExtra(Intent.EXTRA_TEXT)
- // Turn on algorithmic darkening.
- DomainsDatabaseHelper.DARK_THEME -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
- }
- }
+ // Determine if this is a web search.
+ val isWebSearch = (intentAction != null) && (intentAction == Intent.ACTION_WEB_SEARCH)
- // 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
- }
+ // 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) {
+ ""
+ }
- // 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.
+ addNewTab(urlString, true)
+ } else { // Load the URL in the current tab.
+ // Make it so.
+ loadUrl(currentWebView!!, urlString)
}
+ }
+ }
+ }
- // 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
+ // 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)
- // 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
- }
+ // 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))
- // Reset the domain settings database ID.
- nestedScrollWebView.domainSettingsDatabaseId = -1
+ // 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.
- 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
+ // Reapply the syntax highlighting.
+ UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
+ }
+ }
- // Set the user agent to `""`, which uses the default value.
- SETTINGS_WEBVIEW_DEFAULT_USER_AGENT -> nestedScrollWebView.settings.userAgentString = ""
+ // 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 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))
+ // Consume the event.
+ return@setOnKeyListener true
+ } else { // Some other key was pressed.
+ // Do not consume the event.
+ return@setOnKeyListener false
+ }
+ }
- // Get the user agent string from the user agent data array
- else -> nestedScrollWebView.settings.userAgentString = userAgentDataArray[userAgentArrayPosition]
- }
+ // 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 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)
+ // 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 dark theme is selected. Turn on algorithmic darkening.
- webViewThemeEntryValuesStringArray[2] -> WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, true)
+ // Get a list of the current fragments.
+ val fragmentList = supportFragmentManager.fragments
- // 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
+ // 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
- // Set the algorithmic darkening according to the current system theme status.
- WebSettingsCompat.setAlgorithmicDarkeningAllowed(nestedScrollWebView.settings, currentThemeStatus == Configuration.UI_MODE_NIGHT_YES)
+ // 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)
- }
+ // 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)
- // Update the privacy icons.
- updatePrivacyIcons(true)
- }
+ // Get the waiting for proxy URL string.
+ val waitingForProxyUrlString = nestedScrollWebView.waitingForProxyUrlString
- // Reload the website if returning from the Domains activity.
- if (reloadWebsite)
- nestedScrollWebView.reload()
+ // Load the pending URL if it exists.
+ if (waitingForProxyUrlString.isNotEmpty()) { // A URL is waiting to be loaded.
+ // Load the URL.
+ loadUrl(nestedScrollWebView, waitingForProxyUrlString)
- // 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)
- }
+ // Reset the waiting for proxy URL string.
+ nestedScrollWebView.waitingForProxyUrlString = ""
+ } else { // No URL is waiting to be loaded.
+ // Reload the existing URL.
+ nestedScrollWebView.reload()
+ }
+ }
+ }
+ }
+ }
+ }
- private fun applyProxy(reloadWebViews: Boolean) {
- // Set the proxy according to the mode.
- proxyHelper.setProxy(applicationContext, appBarLayout, proxyMode)
+ // Register the Orbot status broadcast receiver.
+ registerReceiver(orbotStatusBroadcastReceiver, IntentFilter("org.torproject.android.intent.action.STATUS"))
- // Reset the waiting for proxy tracker.
- waitingForProxy = false
+ // 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)
- // Set the proxy.
- when (proxyMode) {
- ProxyHelper.NONE -> {
- // Initialize a color background typed value.
- val colorBackgroundTypedValue = TypedValue()
+ // Update the WebView pager every time a tab is modified.
+ webViewViewPager2.registerOnPageChangeCallback(object : ViewPager2.OnPageChangeCallback() {
+ override fun onPageSelected(position: Int) {
+ // Close the find on page bar if it is open.
+ closeFindOnPage(null)
- // Get the color background from the theme.
- theme.resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true)
+ // Set the current WebView.
+ setCurrentWebView(position)
- // Get the color background int from the typed value.
- val colorBackgroundInt = colorBackgroundTypedValue.data
+ // 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)!!
- // Set the default app bar layout background.
- appBarLayout.setBackgroundColor(colorBackgroundInt)
+ // Select the tab.
+ tab.select()
+ }
+ }
}
+ })
- 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)
-
- // 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
+ // Handle tab selections.
+ tabLayout.addOnTabSelectedListener(object : TabLayout.OnTabSelectedListener {
+ override fun onTabSelected(tab: TabLayout.Tab) {
+ // Select the same page in the view pager.
+ webViewViewPager2.currentItem = tab.position
+ }
- // 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()
+ override fun onTabUnselected(tab: TabLayout.Tab) {}
- // 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)
+ override fun onTabReselected(tab: TabLayout.Tab) {
+ // Instantiate the View SSL Certificate dialog.
+ val viewSslCertificateDialogFragment: DialogFragment = ViewSslCertificateDialog.displayDialog(currentWebView!!.webViewFragmentId, currentWebView!!.getFavoriteIcon())
- // 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)))
- }
- }
- }
+ // Display the View SSL Certificate dialog.
+ viewSslCertificateDialogFragment.show(supportFragmentManager, getString(R.string.view_ssl_certificate))
}
+ })
- ProxyHelper.I2P -> {
- // Set the app bar background to indicate proxying is enabled.
- appBarLayout.setBackgroundResource(R.color.proxy_appbar_background)
+ // 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 }
- // 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)
+ // 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()
- // 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)))
- }
- }
- }
- }
- }
+ // Create a favorite icon byte array output stream.
+ val currentFavoriteIconByteArrayOutputStream = ByteArrayOutputStream()
- ProxyHelper.CUSTOM ->
- // Set the app bar background to indicate proxying is enabled.
- appBarLayout.setBackgroundResource(R.color.proxy_appbar_background)
- }
+ // 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)
- // 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)
+ // Convert the favorite icon byte array stream to a byte array.
+ val currentFavoriteIconByteArray = currentFavoriteIconByteArrayOutputStream.toByteArray()
- // Get the fragment view.
- val fragmentView = webViewTabFragment.view
+ // Create an intent to launch the bookmarks activity.
+ val bookmarksIntent = Intent(applicationContext, BookmarksActivity::class.java)
- // 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)
+ // 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)
- // Reload the WebView.
- nestedScrollWebView.reload()
- }
- }
+ // Make it so.
+ startActivity(bookmarksIntent)
}
- }
- 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)
+ // 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())
- // Update the cookies icon.
- if (currentWebView!!.acceptCookies)
- optionsCookiesMenuItem.setIcon(R.drawable.cookies_enabled)
- else
- optionsCookiesMenuItem.setIcon(R.drawable.cookies_disabled)
+ // Show the create bookmark folder dialog.
+ createBookmarkFolderDialog.show(supportFragmentManager, getString(R.string.create_folder))
+ }
- // 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)
+ // 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())
- // `invalidateOptionsMenu()` calls `onPrepareOptionsMenu()` and redraws the icons in the app bar.
- if (runInvalidateOptionsMenu)
- invalidateOptionsMenu()
+ // Display the create bookmark dialog.
+ createBookmarkDialog.show(supportFragmentManager, getString(R.string.create_bookmark))
}
- }
- private fun loadBookmarksFolder() {
- // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
- bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolder)
+ // 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) {}
- // 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)
+ override fun onTextChanged(s: CharSequence, start: Int, before: Int, count: Int) {}
+
+ 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())
}
+ })
- 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 `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)
- // Get the favorite icon byte array from the cursor.
- val favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.FAVORITE_ICON))
+ // Consume the event.
+ return@setOnKeyListener true
+ } else { // A different key was pressed.
+ // Do not consume the event.
+ return@setOnKeyListener 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)
+ // Implement swipe to refresh.
+ swipeRefreshLayout.setOnRefreshListener {
+ // Reload the website.
+ currentWebView!!.reload()
+ }
- // Display the bitmap in the bookmark favorite icon.
- bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap)
+ // Store the default progress view offsets.
+ defaultProgressViewStartOffset = swipeRefreshLayout.progressViewStartOffset
+ defaultProgressViewEndOffset = swipeRefreshLayout.progressViewEndOffset
- // Display the bookmark name from the cursor in the bookmark name text view.
- bookmarkNameTextView.text = cursor.getString(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_NAME))
+ // Set the refresh color scheme according to the theme.
+ swipeRefreshLayout.setColorSchemeResources(R.color.blue_text)
- // 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
- }
- }
+ // Initialize a color background typed value.
+ val colorBackgroundTypedValue = TypedValue()
- // Populate the list view with the adapter.
- bookmarksListView.adapter = bookmarksCursorAdapter
+ // Get the color background from the theme.
+ theme.resolveAttribute(android.R.attr.colorBackground, colorBackgroundTypedValue, true)
- // Set the bookmarks drawer title.
- if (currentBookmarksFolder.isEmpty())
- bookmarksTitleTextView.setText(R.string.bookmarks)
- else
- bookmarksTitleTextView.text = currentBookmarksFolder
- }
+ // Get the color background int from the typed value.
+ val colorBackgroundInt = colorBackgroundTypedValue.data
- private fun openWithApp(url: String) {
- // Create an open with app intent with `ACTION_VIEW`.
- val openWithAppIntent = Intent(Intent.ACTION_VIEW)
+ // Set the swipe refresh background color.
+ swipeRefreshLayout.setProgressBackgroundColorSchemeColor(colorBackgroundInt)
- // Set the URI but not the MIME type. This should open all available apps.
- openWithAppIntent.data = Uri.parse(url)
+ // 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))
- // Flag the intent to open in a new task.
- openWithAppIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // Load the bookmarks folder.
+ loadBookmarksFolder()
- // 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()
- }
- }
+ // 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 openWithBrowser(url: String) {
+ // Get the bookmark cursor for this ID.
+ val bookmarkCursor = bookmarksDatabaseHelper!!.getBookmark(databaseId)
- // Create an open with browser intent with `ACTION_VIEW`.
- val openWithBrowserIntent = Intent(Intent.ACTION_VIEW)
+ // Move the bookmark cursor to the first row.
+ bookmarkCursor.moveToFirst()
- // Set the URI and the MIME type. `"text/html"` should load browser options.
- openWithBrowserIntent.setDataAndType(Uri.parse(url), "text/html")
+ // 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))
- // Flag the intent to open in a new task.
- openWithBrowserIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // 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)))
- // 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()
+ // Close the bookmarks drawer if it is not pinned.
+ if (!bookmarksDrawerPinned)
+ drawerLayout.closeDrawer(GravityCompat.END)
+ }
+
+ // Close the cursor.
+ bookmarkCursor.close()
}
- }
- private fun sanitizeUrl(urlString: String): String {
- // Initialize a sanitized URL string.
- var sanitizedUrlString = urlString
+ // 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()
- // Sanitize tracking queries.
- if (sanitizeTrackingQueries)
- sanitizedUrlString = SanitizeUrlHelper.sanitizeTrackingQueries(sanitizedUrlString)
+ // 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)
- // Sanitize AMP redirects.
- if (sanitizeAmpRedirects)
- sanitizedUrlString = SanitizeUrlHelper.sanitizeAmpRedirects(sanitizedUrlString)
+ // Move to the first entry in the cursor.
+ bookmarksCursor.moveToFirst()
- // Return the sanitized URL string.
- return sanitizedUrlString
- }
+ // 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))
- 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]
+ // Move to the next bookmark.
+ bookmarksCursor.moveToNext()
+ }
- // 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())
+ // Close the cursor.
+ bookmarksCursor.close()
+ } else { // The bookmark is not a folder.
+ // Get the bookmark cursor for this ID.
+ val bookmarkCursor = bookmarksDatabaseHelper!!.getBookmark(databaseId)
- // Get the new tab.
- val newTab = tabLayout.getTabAt(i)!!
+ // Move the bookmark cursor to the first row.
+ bookmarkCursor.moveToFirst()
- // Set a custom view on the new tab.
- newTab.setCustomView(R.layout.tab_custom_view)
+ // 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)
- // Add the new page.
- webViewPagerAdapter!!.restorePage(savedStateArrayList!![i], savedNestedScrollWebViewStateArrayList!![i])
+ // Close the cursor.
+ bookmarkCursor.close()
}
- // Reset the saved state variables.
- savedStateArrayList = null
- savedNestedScrollWebViewStateArrayList = null
+ // Close the bookmarks drawer if it is not pinned.
+ if (!bookmarksDrawerPinned)
+ drawerLayout.closeDrawer(GravityCompat.END)
- // 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
- }
+ // Consume the event.
+ true
+ }
- // Get the intent that started the app.
- val intent = intent
+ // The drawer listener is used to update the navigation menu.
+ drawerLayout.addDrawerListener(object : DrawerLayout.DrawerListener {
+ override fun onDrawerSlide(drawerView: View, slideOffset: Float) {}
- // Reset the intent. This prevents a duplicate tab from being created on restart.
- setIntent(Intent())
+ override fun onDrawerOpened(drawerView: View) {}
- // Get the information from the intent.
- val intentAction = intent.action
- val intentUriData = intent.data
- val intentStringExtra = intent.getStringExtra(Intent.EXTRA_TEXT)
+ 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()
+ }
- // Determine if this is a web search.
- val isWebSearch = (intentAction != null) && (intentAction == Intent.ACTION_WEB_SEARCH)
+ 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)
- // 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) {
- ""
+ // Hide the keyboard (if displayed).
+ inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
}
- // 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!!
- }
-
- // 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
+ // 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()
- // Add a new tab.
- addNewTab(urlString, true)
- } else { // Load the URL in the current tab.
- // Make it so.
- loadUrl(currentWebView!!, urlString)
+ // 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 addTab(@Suppress("UNUSED_PARAMETER")view: View?) {
- // Add a new tab with a blank URL.
- addNewTab("", true)
- }
+ })
- 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()
+ // 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)
- // 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
+ // Get a handle for the WebView.
+ val bareWebView = webViewLayout.findViewById<WebView>(R.id.bare_webview)
- // Add a new tab.
- tabLayout.addTab(tabLayout.newTab())
+ // Store the default user agent.
+ webViewDefaultUserAgent = bareWebView.settings.userAgentString
- // Get the new tab.
- val newTab = tabLayout.getTabAt(newTabNumber)!!
-
- // Set a custom view on the new tab.
- newTab.setCustomView(R.layout.tab_custom_view)
-
- // Add the new WebView page.
- webViewPagerAdapter!!.addPage(newTabNumber, webViewPager, urlString, moveToTab)
-
- // 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)
-
- // Make it so.
- objectAnimator.start()
- }
- }
-
- // 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()
- }
-
- private fun closeCurrentTab() {
- // Get the current tab number.
- val currentTabNumber = tabLayout.selectedTabPosition
+ // Destroy the bare WebView.
+ bareWebView.destroy()
- // Delete the current tab.
- tabLayout.removeTabAt(currentTabNumber)
+ // Update the domains settings set.
+ updateDomainsSettingsSet()
- // 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)
+ // Instantiate the check filter list helper.
+ checkFilterListHelper = CheckFilterListHelper()
}
- private fun exitFullScreenVideo() {
- // Re-enable the screen timeout.
- fullScreenVideoFrameLayout.keepScreenOn = false
-
- // Unset the full screen video flag.
- displayingFullScreenVideo = false
-
- // Remove all the views from the full screen video frame layout.
- fullScreenVideoFrameLayout.removeAllViews()
+ @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))
- // Hide the full screen video frame layout.
- fullScreenVideoFrameLayout.visibility = View.GONE
+ // Get the WebView theme entry values string array.
+ val webViewThemeEntryValuesStringArray = resources.getStringArray(R.array.webview_theme_entry_values)
- // Enable the sliding drawers.
- drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED)
+ // 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)
- // Show the coordinator layout.
- coordinatorLayout.visibility = View.VISIBLE
+ // 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
- // 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
+ // 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)
- // Hide the app bar.
- appBar.hide()
+ // 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)
+ }
}
-
- /* 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.
- // 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
}
- }
- private fun clearAndExit() {
- // Close the bookmarks cursor if it exists.
- bookmarksCursor?.close()
-
- // Close the databases helpers if they exist.
- bookmarksDatabaseHelper?.close()
- domainsDatabaseHelper?.close()
-
- // Get the status of the clear everything preference.
- val clearEverything = sharedPreferences.getBoolean(getString(R.string.clear_everything_key), true)
+ // Get a handle for the input method manager.
+ val inputMethodManager = getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager
- // Get a handle for the runtime.
- val runtime = Runtime.getRuntime()
+ // Set the app bar scrolling.
+ nestedScrollWebView.isNestedScrollingEnabled = scrollAppBar
- // 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
+ // Allow pinch to zoom.
+ nestedScrollWebView.settings.builtInZoomControls = true
- // 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)
+ // Hide zoom controls.
+ nestedScrollWebView.settings.displayZoomControls = false
- // Ask the cookie manager to flush the cookie database.
- cookieManager.flush()
+ // Don't allow mixed content (HTTP and HTTPS) on the same website.
+ nestedScrollWebView.settings.mixedContentMode = WebSettings.MIXED_CONTENT_NEVER_ALLOW
- // 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 WebView to load in overview mode (zoomed out to the maximum width).
+ nestedScrollWebView.settings.loadWithOverviewMode = true
- // Wait until the processes have finished.
- deleteCookiesProcess.waitFor()
- deleteCookiesJournalProcess.waitFor()
- } catch (exception: Exception) {
- // Do nothing if an error is thrown.
- }
- }
+ // Explicitly disable geolocation.
+ nestedScrollWebView.settings.setGeolocationEnabled(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()
+ // 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
- // 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/"))
+ // 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
- // 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")
+ // 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)
- // 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.
- }
- }
+ // Hide the tab linear layout.
+ tabsLinearLayout.visibility = View.GONE
- // 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()
+ // Hide the app bar.
+ appBar.hide()
- // 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"))
+ // 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
- // Wait until the processes have finished.
- deleteWebDataProcess.waitFor()
- deleteWebDataJournalProcess.waitFor()
- } catch (exception: Exception) {
- // Do nothing if an error is thrown.
- }
- }
+ // 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)
- // 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")
+ // 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)
+ }
+ }
+ }
- // Wait for the process to finish.
- process.waitFor()
- } catch (exception: IOException) {
- // Do nothing.
- } catch (exception: InterruptedException) {
- // Do nothing.
- }
- }
+ /* 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.
+ */
- // 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)
+ // 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
- // Get the WebView fragment view.
- val webViewFragmentView = webViewTabFragment.view
+ // Show the app bar.
+ appBar.show()
+ }
- // 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)
+ // 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
- // Clear the cache for this WebView.
- nestedScrollWebView.clearCache(true)
- }
- }
+ // 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)
- // Manually delete the cache directories.
- try {
- // Delete the main cache directory.
- val deleteCacheProcess = runtime.exec("rm -rf $privateDataDirectoryString/cache")
+ // 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)
+ }
+ }
- // 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/"))
+ // 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
+ }
- // Wait until the processes have finished.
- deleteCacheProcess.waitFor()
- deleteServiceWorkerProcess.waitFor()
- } catch (exception: Exception) {
- // Do nothing if an error is thrown.
+ // Consume the double-tap.
+ true
+ } else { // Do not consume the double-tap because full screen browsing mode is disabled.
+ // Return false.
+ false
+ }
}
- }
- // Wipe out each WebView.
- for (i in 0 until webViewPagerAdapter!!.count) {
- // Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(i)
-
- // Get the WebView frame layout.
- val webViewFrameLayout = webViewTabFragment.view as FrameLayout?
-
- // 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)
-
- // Clear SSL certificate preferences for this WebView.
- nestedScrollWebView.clearSslPreferences()
-
- // Clear the back/forward history for this WebView.
- nestedScrollWebView.clearHistory()
-
- // Remove all the views from the frame layout.
- webViewFrameLayout.removeAllViews()
+ 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
- // Destroy the internal state of the WebView.
- nestedScrollWebView.destroy()
- }
- }
+ // 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())
+ }
- // 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")
+ // Make it so.
+ objectAnimator.start()
+ }
- // Wait until the process has finished.
- deleteAppWebviewProcess.waitFor()
- } catch (exception: Exception) {
- // Do nothing if an error is thrown.
+ // Do not consume the event.
+ return false
}
- }
-
- // 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)
- }
+ })
- // 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)
+ // 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()
- // Load the new folder.
- loadBookmarksFolder()
+ // Check for double-taps.
+ doubleTapGestureDetector.onTouchEvent(motionEvent!!)
}
- }
-
- // 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
-
- // Update the bookmarks drawer pinned image view.
- updateBookmarksDrawerPinnedImageView()
- }
-
- private fun updateBookmarksDrawerPinnedImageView() {
- // Set the current icon.
- if (bookmarksDrawerPinned)
- bookmarksDrawerPinnedImageView.setImageResource(R.drawable.pin_selected)
- else
- bookmarksDrawerPinnedImageView.setImageResource(R.drawable.pin)
- }
- private fun setCurrentWebView(pageNumber: Int) {
- // Stop the swipe to refresh indicator if it is running
- swipeRefreshLayout.isRefreshing = false
+ // Register the WebView for a context menu. This is used to see link targets and download images.
+ registerForContextMenu(nestedScrollWebView)
- // Get the WebView tab fragment.
- val webViewTabFragment = webViewPagerAdapter!!.getPageFragment(pageNumber)
+ // 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.
- // Get the fragment view.
- val webViewFragmentView = webViewTabFragment.view
+ // 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)
+ }
- // 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)
+ // Get the file name from the content disposition.
+ val fileNameString = UrlHelper.getFileName(this, contentDisposition, mimetype, downloadUrlString!!)
- // 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
+ // Instantiate the save dialog.
+ 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)))
+ }
}
+ }
- // Set the cookie status.
- cookieManager.setAcceptCookie(currentWebView!!.acceptCookies)
+ // 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
- // Update the privacy icons. `true` redraws the icons in the app bar.
- updatePrivacyIcons(true)
+ // Build the match string.
+ val matchString = "$activeMatch/$numberOfMatches"
- // Get a handle for the input method manager.
- val inputMethodManager = (getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager)
+ // Update the find on page count text view.
+ findOnPageCountTextView.text = matchString
+ }
+ }
- // Get the current URL.
- val urlString = currentWebView!!.url
+ // 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
- // 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("")
+ // 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.
+ */
- // Request focus for the URL text box.
- urlEditText.requestFocus()
+ // 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
+ }
+ }
- // Display the keyboard.
- inputMethodManager.showSoftInput(urlEditText, 0)
- } else { // The WebView has a loaded URL.
- // Clear the focus from the URL text box.
- urlEditText.clearFocus()
+ // 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
- // Hide the soft keyboard.
- inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
+ // 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
- // Display the current URL in the URL text box.
- urlEditText.setText(urlString)
+ //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
}
- } 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())
+ // 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)
- // Create a runnable to set the current WebView.
- val setCurrentWebWebRunnable = Runnable {
- // Set the current WebView.
- setCurrentWebView(pageNumber)
- }
+ // Get the current page position.
+ val currentPosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
- // Try setting the current WebView again after 100 milliseconds.
- setCurrentWebViewHandler.postDelayed(setCurrentWebWebRunnable, 100)
- }
- }
+ // Get the current tab.
+ val tab = tabLayout.getTabAt(currentPosition)
- @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))
+ // 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 WebView theme entry values string array.
- val webViewThemeEntryValuesStringArray = resources.getStringArray(R.array.webview_theme_entry_values)
+ // 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)
- // 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)
+ // Display the favorite icon in the tab.
+ tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true))
+ }
+ }
+ }
+ }
- // 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
+ // 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)
- // 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)
+ // Get the current tab.
+ val tab = tabLayout.getTabAt(currentPosition)
- // 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)
+ // 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
+
+ // 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
+ }
+ }
}
}
- }
- // Get a handle for the input method manager.
- val inputMethodManager = getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager
+ // Enter full screen video.
+ override fun onShowCustomView(video: View, callback: CustomViewCallback) {
+ // Set the full screen video flag.
+ displayingFullScreenVideo = true
- // Set the app bar scrolling.
- nestedScrollWebView.isNestedScrollingEnabled = scrollAppBar
+ // Hide the keyboard.
+ inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.windowToken, 0)
- // Allow pinch to zoom.
- nestedScrollWebView.settings.builtInZoomControls = true
+ // Hide the coordinator layout.
+ coordinatorLayout.visibility = View.GONE
- // Hide zoom controls.
- nestedScrollWebView.settings.displayZoomControls = false
+ /* 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.
+ */
- // Don't allow mixed content (HTTP and HTTPS) on the same website.
- nestedScrollWebView.settings.mixedContentMode = WebSettings.MIXED_CONTENT_NEVER_ALLOW
+ // 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 WebView to load in overview mode (zoomed out to the maximum width).
- nestedScrollWebView.settings.loadWithOverviewMode = true
+ // Disable the sliding drawers.
+ drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED)
- // Explicitly disable geolocation.
- nestedScrollWebView.settings.setGeolocationEnabled(false)
+ // Add the video view to the full screen video frame layout.
+ fullScreenVideoFrameLayout.addView(video)
- // 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
+ // Show the full screen video frame layout.
+ fullScreenVideoFrameLayout.visibility = View.VISIBLE
- // 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
+ // Disable the screen timeout while the video is playing. YouTube does this automatically, but not all other videos do.
+ fullScreenVideoFrameLayout.keepScreenOn = true
+ }
- // 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)
+ // Exit full screen video.
+ override fun onHideCustomView() {
+ // Exit the full screen video.
+ exitFullScreenVideo()
+ }
- // Hide the tab linear layout.
- tabsLinearLayout.visibility = View.GONE
+ // Upload files.
+ override fun onShowFileChooser(webView: WebView, filePathCallback: ValueCallback<Array<Uri>>, fileChooserParams: FileChooserParams): Boolean {
+ // Store the file path callback.
+ fileChooserCallback = filePathCallback
- // Hide the app bar.
- appBar.hide()
+ // Create an intent to open a chooser based on the file chooser parameters.
+ val fileChooserIntent = fileChooserParams.createIntent()
- // 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
+ // 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)
- // 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)
+ // Request an openable file.
+ genericFileChooserIntent.addCategory(Intent.CATEGORY_OPENABLE)
- // 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)
- }
- }
- }
+ // Set the file type to everything.
+ genericFileChooserIntent.type = "*/*"
- /* 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.
- */
+ // Launch the generic file chooser intent.
+ browseFileUploadActivityResultLauncher.launch(genericFileChooserIntent)
+ }
- // 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
+ // 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()
- // Show the app bar.
- appBar.show()
- }
+ // Sanitize the url.
+ requestUrlString = sanitizeUrl(requestUrlString)
- // 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
+ // 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)
- // 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)
+ // 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)
- // 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)
- }
- }
+ // Parse the url and set it as the data for the intent.
+ emailIntent.data = Uri.parse(requestUrlString)
- // 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
+ // Open the email program in a new task instead of as part of Privacy Browser.
+ emailIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+
+ try {
+ // Make it so.
+ startActivity(emailIntent)
+ } catch (exception: ActivityNotFoundException) {
+ // Display a snackbar.
+ Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
}
- // Consume the double-tap.
+ // Returning true indicates Privacy Browser is handling the URL by creating an intent.
true
- } else { // Do not consume the double-tap because full screen browsing mode is disabled.
- // Return false.
- false
- }
- }
+ } else if (requestUrlString.startsWith("tel:")) { // Load the phone number in the dialer.
+ // Create a dial intent.
+ val dialIntent = Intent(Intent.ACTION_DIAL)
- 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
+ // Add the phone number to the intent.
+ dialIntent.data = Uri.parse(requestUrlString)
- // 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())
+ // Open the dialer in a new task instead of as part of Privacy Browser.
+ dialIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+
+ try {
+ // Make it so.
+ startActivity(dialIntent)
+ } catch (exception: ActivityNotFoundException) {
+ // Display a snackbar.
+ Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
}
- // Make it so.
- objectAnimator.start()
- }
+ // 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)
- // Do not consume the event.
- return false
- }
- })
+ // Add the URL to the intent.
+ genericIntent.data = Uri.parse(requestUrlString)
- // 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()
+ // List all apps that can handle the URL instead of just opening the first one.
+ genericIntent.addCategory(Intent.CATEGORY_BROWSABLE)
- // Check for double-taps.
- doubleTapGestureDetector.onTouchEvent(motionEvent!!)
- }
+ // Open the app in a new task instead of as part of Privacy Browser.
+ genericIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // Register the WebView for a context menu. This is used to see link targets and download images.
- registerForContextMenu(nestedScrollWebView)
+ 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()
+ }
- // 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.
+ // Returning true indicates Privacy Browser is handling the URL by creating an intent.
+ true
+ }
+ }
- // 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)
+ // Check requests against the block lists.
+ override fun shouldInterceptRequest(view: WebView, webResourceRequest: WebResourceRequest): WebResourceResponse? {
+ // Get the URL.
+ val requestUrlString = webResourceRequest.url.toString()
+
+ // 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 the file name from the content disposition.
- val fileNameString = UrlHelper.getFileName(this, contentDisposition, mimetype, downloadUrlString!!)
+ // 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.
+ }
+ }
- // Instantiate the save dialog.
- val saveDialogFragment = SaveDialog.saveUrl(downloadUrlString, fileNameString, formattedFileSizeString, userAgent!!, nestedScrollWebView.acceptCookies)
+ // Create an empty web resource response to be used if the resource request is blocked.
+ val emptyWebResourceResponse = WebResourceResponse("text/plain", "utf8", ByteArrayInputStream("".toByteArray()))
- // 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)))
- }
- }
- }
+ // Initialize the variables.
+ var allowListResultStringArray: Array<String>? = null
+ var isThirdPartyRequest = false
- // 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
+ // Get the current URL. `.getUrl()` throws an error because operations on the WebView cannot be made from this thread.
+ var currentBaseDomain = nestedScrollWebView.currentDomainName
- // Build the match string.
- val matchString = "$activeMatch/$numberOfMatches"
+ // Store a copy of the current domain for use in later requests.
+ val currentDomain = currentBaseDomain
- // Update the find on page count text view.
- findOnPageCountTextView.text = matchString
- }
- }
+ // Get the request host name.
+ var requestBaseDomain = webResourceRequest.url.host
- // 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
+ // 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)
+ }
- // 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.
- */
+ // 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)
+ }
- // 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 third party request tracker.
+ isThirdPartyRequest = currentBaseDomain != requestBaseDomain
+ }
- // 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 WebView page position.
+ val webViewPagePosition = 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
+ // Determine if the WebView is currently displayed.
+ val webViewDisplayed = (webViewPagePosition == tabLayout.selectedTabPosition)
- //Stop the swipe to refresh indicator if it is running
- swipeRefreshLayout.isRefreshing = false
+ // Block third-party requests if enabled.
+ if (isThirdPartyRequest && nestedScrollWebView.blockAllThirdPartyRequests) {
+ // Add the result to the resource requests.
+ nestedScrollWebView.addResourceRequest(arrayOf(REQUEST_THIRD_PARTY, requestUrlString))
- // 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
- }
- }
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(THIRD_PARTY_REQUESTS)
- // 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)
+ // 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)
- // Get the current page position.
- val currentPosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ // 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)
+ }
+ }
+ }
- // Get the current tab.
- val tab = tabLayout.getTabAt(currentPosition)
+ // The resource request was blocked. Return an empty web resource response.
+ return emptyWebResourceResponse
+ }
- // Check to see if the tab has been populated.
- if (tab != null) {
- // Get the custom view from the tab.
- val tabView = tab.customView
+ // Check UltraList if it is enabled.
+ if (nestedScrollWebView.ultraListEnabled) {
+ // Check the URL against UltraList.
+ val ultraListResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, ultraList)
- // 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)
+ // 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]))
- // Display the favorite icon in the tab.
- tabFavoriteIconImageView.setImageBitmap(Bitmap.createScaledBitmap(icon, 64, 64, true))
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(ULTRALIST)
+
+ // 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)
+ optionsUltraListMenuItem.title = nestedScrollWebView.getRequestsCount(ULTRALIST).toString() + " - " + getString(R.string.ultralist)
+ }
+ }
}
+
+ // 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]))
+
+ // The resource request has been allowed by UltraList. `return null` loads the requested resource.
+ return null
}
}
- }
- // 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)
+ // Check UltraPrivacy if it is enabled.
+ if (nestedScrollWebView.ultraPrivacyEnabled) {
+ // Check the URL against UltraPrivacy.
+ val ultraPrivacyResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, ultraPrivacy!!)
- // Get the current tab.
- val tab = tabLayout.getTabAt(currentPosition)
+ // 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]))
- // 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
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(ULTRAPRIVACY)
- // 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)
+ // 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 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
+ // 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)
+ }
+ }
}
+
+ // 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]))
+
+ // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
+ return null
}
}
- }
- // Enter full screen video.
- override fun onShowCustomView(video: View, callback: CustomViewCallback) {
- // Set the full screen video flag.
- displayingFullScreenVideo = true
+ // Check EasyList if it is enabled.
+ if (nestedScrollWebView.easyListEnabled) {
+ // Check the URL against EasyList.
+ val easyListResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, easyList)
- // Hide the keyboard.
- inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.windowToken, 0)
+ // 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]))
- // Hide the coordinator layout.
- coordinatorLayout.visibility = View.GONE
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(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.
- */
+ // 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 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 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)
+ }
+ }
+ }
- // Disable the sliding drawers.
- drawerLayout.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED)
+ // 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])
+ }
+ }
- // Add the video view to the full screen video frame layout.
- fullScreenVideoFrameLayout.addView(video)
+ // Check EasyPrivacy if it is enabled.
+ if (nestedScrollWebView.easyPrivacyEnabled) {
+ // Check the URL against EasyPrivacy.
+ val easyPrivacyResults = checkFilterListHelper.checkFilterList(currentDomain, requestUrlString, isThirdPartyRequest, easyPrivacy)
- // Show the full screen video frame layout.
- fullScreenVideoFrameLayout.visibility = View.VISIBLE
+ // 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]))
- // Disable the screen timeout while the video is playing. YouTube does this automatically, but not all other videos do.
- fullScreenVideoFrameLayout.keepScreenOn = true
- }
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(EASYPRIVACY)
- // Exit full screen video.
- override fun onHideCustomView() {
- // Exit the full screen video.
- exitFullScreenVideo()
- }
+ // 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)
- // Upload files.
- override fun onShowFileChooser(webView: WebView, filePathCallback: ValueCallback<Array<Uri>>, fileChooserParams: FileChooserParams): Boolean {
- // Store the file path callback.
- fileChooserCallback = filePathCallback
+ // 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)
+ }
+ }
+ }
- // Create an intent to open a chooser based on the file chooser parameters.
- val fileChooserIntent = fileChooserParams.createIntent()
+ // 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])
+ }
+ }
- // 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)
+ // 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)
- // Request an openable file.
- genericFileChooserIntent.addCategory(Intent.CATEGORY_OPENABLE)
+ // 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]))
- // Set the file type to everything.
- genericFileChooserIntent.type = "*/*"
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(FANBOYS_ANNOYANCE_LIST)
- // Launch the generic file chooser intent.
- browseFileUploadActivityResultLauncher.launch(genericFileChooserIntent)
- }
+ // 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)
- // 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()
+ // 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)
+ }
+ }
+ }
- // Sanitize the url.
- requestUrlString = sanitizeUrl(requestUrlString)
+ // 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)
- // 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)
+ // 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]))
- // 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)
+ // Increment the blocked requests counters.
+ nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
+ nestedScrollWebView.incrementRequestsCount(FANBOYS_SOCIAL_BLOCKING_LIST)
- // Parse the url and set it as the data for the intent.
- emailIntent.data = Uri.parse(requestUrlString)
+ // 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)
- // Open the email program in a new task instead of as part of Privacy Browser.
- emailIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // 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)
+ }
+ }
+ }
- 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 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])
}
+ }
- // 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 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))
+ }
- // Add the phone number to the intent.
- dialIntent.data = Uri.parse(requestUrlString)
+ // The resource request has not been blocked. `return null` loads the requested resource.
+ return null
+ }
- // Open the dialer in a new task instead of as part of Privacy Browser.
- dialIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // Handle HTTP authentication requests.
+ override fun onReceivedHttpAuthRequest(view: WebView, handler: HttpAuthHandler, host: String, realm: String) {
+ // Store the handler.
+ nestedScrollWebView.httpAuthHandler = handler
- try {
- // Make it so.
- startActivity(dialIntent)
- } catch (exception: ActivityNotFoundException) {
- // Display a snackbar.
- Snackbar.make(currentWebView!!, getString(R.string.error, exception), Snackbar.LENGTH_INDEFINITE).show()
- }
+ // Instantiate an HTTP authentication dialog.
+ val httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm, nestedScrollWebView.webViewFragmentId)
- // 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)
+ // Show the HTTP authentication dialog.
+ httpAuthenticationDialogFragment.show(supportFragmentManager, getString(R.string.http_authentication))
+ }
- // Add the URL to the intent.
- genericIntent.data = Uri.parse(requestUrlString)
+ 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
- // List all apps that can handle the URL instead of just opening the first one.
- genericIntent.addCategory(Intent.CATEGORY_BROWSABLE)
+ // 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)
- // Open the app in a new task instead of as part of Privacy Browser.
- genericIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
+ // 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)
- 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()
+ // 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)
}
-
- // Returning true indicates Privacy Browser is handling the URL by creating an intent.
- true
}
- }
- // Check requests against the block lists.
- override fun shouldInterceptRequest(view: WebView, webResourceRequest: WebResourceRequest): WebResourceResponse? {
- // Get the URL.
- val requestUrlString = webResourceRequest.url.toString()
+ // Reset the list of resource requests.
+ nestedScrollWebView.clearResourceRequests()
- // 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
- }
+ // Reset the requests counters.
+ nestedScrollWebView.resetRequestsCounters()
- // 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.
- }
+ // Get the current page position.
+ val currentPagePosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+
+ // 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)
+
+ // Highlight the URL syntax.
+ UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
+
+ // Hide the keyboard.
+ inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.windowToken, 0)
}
- // Create an empty web resource response to be used if the resource request is blocked.
- val emptyWebResourceResponse = WebResourceResponse("text/plain", "utf8", ByteArrayInputStream("".toByteArray()))
+ // Reset the list of host IP addresses.
+ nestedScrollWebView.currentIpAddresses = ""
- // Initialize the variables.
- var whitelistResultStringArray: Array<String>? = null
- var isThirdPartyRequest = false
+ // Get a URI for the current URL.
+ val currentUri = Uri.parse(url)
- // Get the current URL. `.getUrl()` throws an error because operations on the WebView cannot be made from this thread.
- var currentBaseDomain = nestedScrollWebView.currentDomainName
+ // Get the current domain name.
+ val currentDomainName = currentUri.host
- // Store a copy of the current domain for use in later requests.
- val currentDomain = currentBaseDomain
+ // Get the IP addresses for the current domain.
+ if (!currentDomainName.isNullOrEmpty())
+ GetHostIpAddressesCoroutine.checkPinnedMismatch(currentDomainName, nestedScrollWebView, supportFragmentManager, getString(R.string.pinned_mismatch))
- // Get the request host name.
- var requestBaseDomain = webResourceRequest.url.host
+ // 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)
- // 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 icon if it is displayed in the AppBar.
+ if (displayAdditionalAppBarIcons)
+ optionsRefreshMenuItem.setIcon(R.drawable.close_blue)
+ }
+ }
- // 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)
- }
+ 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()
- // Update the third party request tracker.
- isThirdPartyRequest = currentBaseDomain != requestBaseDomain
- }
+ // 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)
- // Get the current WebView page position.
- val webViewPagePosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ // Reset the icon if it is displayed in the app bar.
+ if (displayAdditionalAppBarIcons)
+ optionsRefreshMenuItem.setIcon(R.drawable.refresh_enabled)
+ }
- // Determine if the WebView is currently displayed.
- val webViewDisplayed = webViewPagePosition == tabLayout.selectedTabPosition
+ // 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
- // 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))
+ // Clear the cache, history, and logcat if Incognito Mode is enabled.
+ if (incognitoModeEnabled) {
+ // Clear the cache. `true` includes disk files.
+ nestedScrollWebView.clearCache(true)
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(THIRD_PARTY_REQUESTS)
+ // Clear the back/forward history.
+ nestedScrollWebView.clearHistory()
- // 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)
+ // 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.
+ }
- // 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)
- }
- }
+ // 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.
}
+ }
- // The resource request was blocked. Return an empty web resource response.
- return emptyWebResourceResponse
+ // 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.
}
- // Check UltraList if it is enabled.
- if (nestedScrollWebView.ultraListEnabled) {
- // Check the URL against UltraList.
- val ultraListResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, ultraList)
+ // Get the current page position.
+ val currentPagePosition = webViewStateAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
- // 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]))
+ // 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
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(ULTRALIST)
+ // Get the current tab.
+ val tab = tabLayout.getTabAt(currentPagePosition)
- // 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)
+ // 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("")
- // 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)
- }
- }
- }
+ // Request focus for the URL text box.
+ urlEditText.requestFocus()
- // 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]))
+ // Display the keyboard.
+ inputMethodManager.showSoftInput(urlEditText, 0)
- // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
- return null
- }
- }
+ // Apply the domain settings. This clears any settings from the previous domain.
+ applyDomainSettings(nestedScrollWebView, "", resetTab = true, reloadWebsite = false, loadUrl = false)
- // Check UltraPrivacy if it is enabled.
- if (nestedScrollWebView.ultraPrivacyEnabled) {
- // Check the URL against UltraPrivacy.
- val ultraPrivacyResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, ultraPrivacy!!)
+ // 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!!
- // 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 title text view from the tab.
+ val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(ULTRAPRIVACY)
+ // 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 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)
+ // 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)
- // 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)
- }
- }
+ // Highlight the URL syntax.
+ UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
}
- // 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]))
+ // 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!!
- // The resource request has been allowed by UltraPrivacy. `return null` loads the requested resource.
- return null
+ // Get the title text view from the tab.
+ val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
+
+ // Set the title as the tab text. Sometimes `onReceivedTitle()` is not called, especially when navigating history.
+ tabTitleTextView.text = nestedScrollWebView.title
+ }
}
}
+ }
- // Check EasyList if it is enabled.
- if (nestedScrollWebView.easyListEnabled) {
- // Check the URL against EasyList.
- val easyListResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, easyList)
+ // 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
- // 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]))
+ // 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
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(EASYLIST)
+ // Get the pinned SSL certificate.
+ val (pinnedSslCertificateStringArray, pinnedSslCertificateDateArray) = nestedScrollWebView.getPinnedSslCertificate()
- // 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)
+ // 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])) {
- // 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)
- }
- }
- }
+ // 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
- // 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])
+ // 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 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)))
}
}
+ }
+ }
- // Check EasyPrivacy if it is enabled.
- if (nestedScrollWebView.easyPrivacyEnabled) {
- // Check the URL against EasyPrivacy.
- val easyPrivacyResults = blocklistHelper.checkBlocklist(currentDomain, requestUrlString, isThirdPartyRequest, easyPrivacy)
-
- // 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]))
+ // 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
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(EASYPRIVACY)
+ // Get the intent that started the app.
+ val launchingIntent = intent
- // 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)
+ // Reset the intent. This prevents a duplicate tab from being created on restart.
+ intent = Intent()
- // 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)
- }
- }
- }
+ // Get the information from the intent.
+ val launchingIntentAction = launchingIntent.action
+ val launchingIntentUriData = launchingIntent.data
+ val launchingIntentStringExtra = launchingIntent.getStringExtra(Intent.EXTRA_TEXT)
- // 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])
- }
+ // 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) {
+ ""
}
- // 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)
+ // 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))
+ }
- // 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]))
+ // 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!!)
+ }
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(FANBOYS_ANNOYANCE_LIST)
+ // 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)
- // 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 focus and display the keyboard if the URL is blank.
+ if (urlString == "") {
+ // Request focus for the URL text box.
+ urlEditText.requestFocus()
- // 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)
- }
- }
- }
+ // Create a display keyboard handler.
+ val displayKeyboardHandler = Handler(Looper.getMainLooper())
- // 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)
+ // Create a display keyboard runnable.
+ val displayKeyboardRunnable = Runnable {
+ // Display the keyboard.
+ inputMethodManager.showSoftInput(urlEditText, 0)
+ }
- // 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]))
+ // Display the keyboard after 100 milliseconds, which leaves enough time for the tab to transition.
+ displayKeyboardHandler.postDelayed(displayKeyboardRunnable, 100)
+ }
+ }
+ }
- // Increment the blocked requests counters.
- nestedScrollWebView.incrementRequestsCount(BLOCKED_REQUESTS)
- nestedScrollWebView.incrementRequestsCount(FANBOYS_SOCIAL_BLOCKING_LIST)
+ private fun loadBookmarksFolder() {
+ // Update the bookmarks cursor with the contents of the bookmarks database for the current folder.
+ bookmarksCursor = bookmarksDatabaseHelper!!.getBookmarksByDisplayOrder(currentBookmarksFolder)
- // 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)
+ // 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)
+ }
- // 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)
- }
- }
- }
+ 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)
- // 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])
- }
- }
+ // Get the favorite icon byte array from the cursor.
+ val favoriteIconByteArray = cursor.getBlob(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.FAVORITE_ICON))
- // 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))
- }
+ // 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)
- // The resource request has not been blocked. `return null` loads the requested resource.
- return null
+ // Display the bitmap in the bookmark favorite icon.
+ bookmarkFavoriteIcon.setImageBitmap(favoriteIconBitmap)
+
+ // Display the bookmark name from the cursor in the bookmark name text view.
+ bookmarkNameTextView.text = cursor.getString(cursor.getColumnIndexOrThrow(BookmarksDatabaseHelper.BOOKMARK_NAME))
+
+ // 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
}
+ }
- // Handle HTTP authentication requests.
- override fun onReceivedHttpAuthRequest(view: WebView, handler: HttpAuthHandler, host: String, realm: String) {
- // Store the handler.
- nestedScrollWebView.httpAuthHandler = handler
+ // Populate the list view with the adapter.
+ bookmarksListView.adapter = bookmarksCursorAdapter
- // Instantiate an HTTP authentication dialog.
- val httpAuthenticationDialogFragment = HttpAuthenticationDialog.displayDialog(host, realm, nestedScrollWebView.webViewFragmentId)
+ // Set the bookmarks drawer title.
+ if (currentBookmarksFolder.isEmpty())
+ bookmarksTitleTextView.setText(R.string.bookmarks)
+ else
+ bookmarksTitleTextView.text = currentBookmarksFolder
+ }
- // Show the HTTP authentication dialog.
- httpAuthenticationDialogFragment.show(supportFragmentManager, getString(R.string.http_authentication))
- }
+ private fun loadUrl(nestedScrollWebView: NestedScrollWebView, url: String) {
+ // Sanitize the URL.
+ val urlString = sanitizeUrl(url)
- 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
+ // Apply the domain settings and load the URL.
+ applyDomainSettings(nestedScrollWebView, urlString, resetTab = true, reloadWebsite = false, loadUrl = true)
+ }
- // 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 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 <= ' ' }
- // 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)
+ // Create the formatted URL string.
+ var urlString = ""
- // 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)
- }
- }
+ // 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.
+
+ // 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"
+
+ // Initialize the unformatted URL.
+ var unformattedUrl: URL? = null
- // Reset the list of resource requests.
- nestedScrollWebView.clearResourceRequests()
+ // Convert the unformatted URL string to a URL.
+ try {
+ unformattedUrl = URL(unformattedUrlString)
+ } catch (exception: MalformedURLException) {
+ exception.printStackTrace()
+ }
- // Reset the requests counters.
- nestedScrollWebView.resetRequestsCounters()
+ // 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
- // Get the current page position.
- val currentPagePosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ // Create a URI.
+ val uri = Uri.Builder()
- // 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)
+ // Build the URI from the components of the URL.
+ uri.scheme(scheme).authority(authority).path(path).query(query).fragment(fragment)
- // Highlight the URL syntax.
- UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
+ // 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) {
+ ""
+ }
- // Hide the keyboard.
- inputMethodManager.hideSoftInputFromWindow(nestedScrollWebView.windowToken, 0)
- }
+ // Add the base search URL.
+ urlString = searchURL + encodedSearchString
+ }
- // Reset the list of host IP addresses.
- nestedScrollWebView.currentIpAddresses = ""
+ // 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()
- // Get a URI for the current URL.
- val currentUri = Uri.parse(url)
+ // Make it so.
+ loadUrl(currentWebView!!, urlString)
+ }
- // Get the current domain name.
- val currentDomainName = currentUri.host
+ override fun navigateHistory(url: String, steps: Int) {
+ // Apply the domain settings.
+ applyDomainSettings(currentWebView!!, url, resetTab = false, reloadWebsite = false, loadUrl = false)
- // Get the IP addresses for the current domain.
- if ((currentDomainName != null) && currentDomainName.isNotEmpty())
- GetHostIpAddressesCoroutine.checkPinnedMismatch(currentDomainName, nestedScrollWebView, supportFragmentManager, getString(R.string.pinned_mismatch))
+ // Load the history entry.
+ currentWebView!!.goBackOrForward(steps)
+ }
- // 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)
+ override fun openFile(dialogFragment: DialogFragment) {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
- // Set the icon if it is displayed in the AppBar.
- if (displayAdditionalAppBarIcons)
- optionsRefreshMenuItem.setIcon(R.drawable.close_blue)
- }
- }
+ // Get handles for the views.
+ val fileNameEditText = dialog.findViewById<EditText>(R.id.file_name_edittext)
+ val mhtCheckBox = dialog.findViewById<CheckBox>(R.id.mht_checkbox)
- 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 file path string.
+ val openFilePath = fileNameEditText.text.toString()
- // 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)
+ // Apply the domain settings. This resets the favorite icon and removes any domain settings.
+ applyDomainSettings(currentWebView!!, openFilePath, resetTab = true, reloadWebsite = false, loadUrl = false)
- // Reset the icon if it is displayed in the app bar.
- if (displayAdditionalAppBarIcons)
- optionsRefreshMenuItem.setIcon(R.drawable.refresh_enabled)
- }
+ // 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))
- // 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
+ // Create a temporary MHT file.
+ val temporaryMhtFile = File.createTempFile(TEMPORARY_MHT_FILE, ".mht", cacheDir)
- // Clear the cache, history, and logcat if Incognito Mode is enabled.
- if (incognitoModeEnabled) {
- // Clear the cache. `true` includes disk files.
- nestedScrollWebView.clearCache(true)
+ // Get a file output stream for the temporary MHT file.
+ val temporaryMhtFileOutputStream = FileOutputStream(temporaryMhtFile)
- // Clear the back/forward history.
- nestedScrollWebView.clearHistory()
+ // Create a transfer byte array.
+ val transferByteArray = ByteArray(1024)
- // 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.
- }
+ // Create an integer to track the number of bytes read.
+ var bytesRead: Int
- // 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.
- }
- }
+ // 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)
- // 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.
- }
+ // Flush the temporary MHT file output stream.
+ temporaryMhtFileOutputStream.flush()
- // Get the current page position.
- val currentPagePosition = webViewPagerAdapter!!.getPositionForId(nestedScrollWebView.webViewFragmentId)
+ // Close the streams.
+ temporaryMhtFileOutputStream.close()
+ mhtFileInputStream.close()
- // 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
+ // 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)
+ }
+ }
- // Get the current tab.
- val tab = tabLayout.getTabAt(currentPagePosition)
+ private fun openWithApp(url: String) {
+ // Create an open with app intent with `ACTION_VIEW`.
+ val openWithAppIntent = Intent(Intent.ACTION_VIEW)
- // 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("")
+ // Set the URI but not the MIME type. This should open all available apps.
+ openWithAppIntent.data = Uri.parse(url)
- // Request focus for the URL text box.
- urlEditText.requestFocus()
+ // Flag the intent to open in a new task.
+ openWithAppIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // Display the keyboard.
- inputMethodManager.showSoftInput(urlEditText, 0)
+ // 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()
+ }
+ }
- // Apply the domain settings. This clears any settings from the previous domain.
- applyDomainSettings(nestedScrollWebView, "", resetTab = true, reloadWebsite = false, loadUrl = false)
+ private fun openWithBrowser(url: String) {
- // 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!!
+ // Create an open with browser intent with `ACTION_VIEW`.
+ val openWithBrowserIntent = Intent(Intent.ACTION_VIEW)
- // Get the title text view from the tab.
- val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
+ // Set the URI and the MIME type. `"text/html"` should load browser options.
+ openWithBrowserIntent.setDataAndType(Uri.parse(url), "text/html")
- // 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)
+ // Flag the intent to open in a new task.
+ openWithBrowserIntent.flags = Intent.FLAG_ACTIVITY_NEW_TASK
- // 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)
+ // 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()
+ }
+ }
- // Highlight the URL syntax.
- UrlHelper.highlightSyntax(urlEditText, initialGrayColorSpan, finalGrayColorSpan, redColorSpan)
- }
+ override fun pinnedErrorGoBack() {
+ // Get the current web back forward list.
+ val webBackForwardList = currentWebView!!.copyBackForwardList()
- // 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!!
+ // Get the previous entry URL.
+ val previousUrl = webBackForwardList.getItemAtIndex(webBackForwardList.currentIndex - 1).url
- // Get the title text view from the tab.
- val tabTitleTextView = tabView.findViewById<TextView>(R.id.title_textview)
+ // Apply the domain settings.
+ applyDomainSettings(currentWebView!!, previousUrl, resetTab = false, reloadWebsite = false, loadUrl = false)
- // Set the title as the tab text. Sometimes `onReceivedTitle()` is not called, especially when navigating history.
- tabTitleTextView.text = nestedScrollWebView.title
- }
- }
- }
- }
+ // Go back.
+ currentWebView!!.goBack()
+ }
- // 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
+ private fun sanitizeUrl(urlString: String): String {
+ // Initialize a sanitized URL string.
+ var sanitizedUrlString = urlString
- // 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
+ // Sanitize tracking queries.
+ if (sanitizeTrackingQueries)
+ sanitizedUrlString = SanitizeUrlHelper.sanitizeTrackingQueries(sanitizedUrlString)
- // Get the pinned SSL certificate.
- val (pinnedSslCertificateStringArray, pinnedSslCertificateDateArray) = nestedScrollWebView.getPinnedSslCertificate()
+ // Sanitize AMP redirects.
+ if (sanitizeAmpRedirects)
+ sanitizedUrlString = SanitizeUrlHelper.sanitizeAmpRedirects(sanitizedUrlString)
- // 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])) {
+ // Return the sanitized URL string.
+ return sanitizedUrlString
+ }
- // 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
+ override fun saveUrl(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!!
- // Instantiate an SSL certificate error alert dialog.
- val sslCertificateErrorDialogFragment = SslCertificateErrorDialog.displayDialog(error, nestedScrollWebView.webViewFragmentId)
+ // Get a handle for the dialog URL edit text.
+ val dialogUrlEditText = dialog.findViewById<EditText>(R.id.url_edittext)
- // 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)))
- }
- }
- }
+ // Get the URL from the edit text, which may have been modified.
+ dialogUrlEditText.text.toString()
}
- // 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
+ // Open the file picker.
+ saveUrlActivityResultLauncher.launch(fileNameString)
+ }
- // Get the intent that started the app.
- val launchingIntent = intent
+ private fun setCurrentWebView(pageNumber: Int) {
+ // Stop the swipe to refresh indicator if it is running
+ swipeRefreshLayout.isRefreshing = false
- // Reset the intent. This prevents a duplicate tab from being created on restart.
- intent = Intent()
+ // Get the WebView tab fragment.
+ val webViewTabFragment = webViewStateAdapter!!.getPageFragment(pageNumber)
- // Get the information from the intent.
- val launchingIntentAction = launchingIntent.action
- val launchingIntentUriData = launchingIntent.data
- val launchingIntentStringExtra = launchingIntent.getStringExtra(Intent.EXTRA_TEXT)
+ // Get the fragment view.
+ val webViewFragmentView = webViewTabFragment.view
- // 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) {
- ""
- }
+ // 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)
- // 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))
+ // 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
}
- // 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!!)
- }
+ // Set the cookie status.
+ cookieManager.setAcceptCookie(currentWebView!!.acceptCookies)
- // 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)
+ // Update the privacy icons. `true` redraws the icons in the app bar.
+ updatePrivacyIcons(true)
- // Set the focus and display the keyboard if the URL is blank.
- if (urlString == "") {
- // Request focus for the URL text box.
- urlEditText.requestFocus()
+ // Get a handle for the input method manager.
+ val inputMethodManager = (getSystemService(INPUT_METHOD_SERVICE) as InputMethodManager)
- // Create a display keyboard handler.
- val displayKeyboardHandler = Handler(Looper.getMainLooper())
+ // Get the current URL.
+ val urlString = currentWebView!!.url
+
+ // 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("")
+
+ // Request focus for the URL text box.
+ urlEditText.requestFocus()
- // Create a display keyboard runnable.
- val displayKeyboardRunnable = Runnable {
// Display the keyboard.
inputMethodManager.showSoftInput(urlEditText, 0)
+ } else { // The WebView has a loaded URL.
+ // Clear the focus from the URL text box.
+ urlEditText.clearFocus()
+
+ // Hide the soft keyboard.
+ inputMethodManager.hideSoftInputFromWindow(currentWebView!!.windowToken, 0)
+
+ // Display the current URL in the URL text box.
+ urlEditText.setText(urlString)
+
+ // 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
+ }
- // Display the keyboard after 100 milliseconds, which leaves enough time for the tab to transition.
- displayKeyboardHandler.postDelayed(displayKeyboardRunnable, 100)
+ // 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) || (pageNumber == (webViewStateAdapter!!.itemCount - 1))) { // The tab has not been populated yet.
+ // Try again in 100 milliseconds if the app is being restored or the a new tab has been added (the last tab).
+ // Create a handler to set the current WebView.
+ val setCurrentWebViewHandler = Handler(Looper.getMainLooper())
+
+ // Create a runnable to set the current WebView.
+ val setCurrentWebWebRunnable = Runnable {
+ // Set the current WebView.
+ setCurrentWebView(pageNumber)
}
+
+ // Try setting the current WebView again after 100 milliseconds.
+ setCurrentWebViewHandler.postDelayed(setCurrentWebWebRunnable, 100)
}
}
+ // 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
+
+ // Update the bookmarks drawer pinned image view.
+ updateBookmarksDrawerPinnedImageView()
+ }
+
+ private fun updateBookmarksDrawerPinnedImageView() {
+ // Set the current icon.
+ if (bookmarksDrawerPinned)
+ bookmarksDrawerPinnedImageView.setImageResource(R.drawable.pin_selected)
+ else
+ bookmarksDrawerPinnedImageView.setImageResource(R.drawable.pin)
+ }
+
private fun updateDomainsSettingsSet() {
// Reset the domains settings set.
domainsSettingsSet = HashSet()
// Close the domains cursor.
domainsCursor.close()
}
+
+ override fun updateFontSize(dialogFragment: DialogFragment) {
+ // Get the dialog.
+ val dialog = dialogFragment.dialog!!
+
+ // Get a handle for the font size edit text.
+ val fontSizeEditText = dialog.findViewById<EditText>(R.id.font_size_edittext)
+
+ // Initialize the new font size variable with the current font size.
+ var newFontSize = currentWebView!!.settings.textZoom
+
+ // 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
+ }
+
+ 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