2 * Copyright 2016-2022 Soren Stoutner <soren@stoutner.com>.
4 * This file is part of Privacy Browser Android <https://www.stoutner.com/privacy-browser-android>.
6 * Privacy Browser Android is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * Privacy Browser Android is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with Privacy Browser Android. If not, see <http://www.gnu.org/licenses/>.
20 package com.stoutner.privacybrowser.fragments
22 import android.content.Intent
23 import android.content.res.Configuration
24 import android.net.Uri
25 import android.os.Build
26 import android.os.Bundle
27 import android.view.LayoutInflater
28 import android.view.View
29 import android.view.ViewGroup
30 import android.webkit.WebResourceRequest
31 import android.webkit.WebResourceResponse
32 import android.webkit.WebView
33 import android.webkit.WebViewClient
35 import androidx.fragment.app.Fragment
36 import androidx.webkit.WebSettingsCompat
37 import androidx.webkit.WebViewAssetLoader
38 import androidx.webkit.WebViewAssetLoader.AssetsPathHandler
39 import androidx.webkit.WebViewFeature
41 import com.stoutner.privacybrowser.R
43 // Define the class constants.
44 private const val TAB_NUMBER = "tab_number"
45 private const val SCROLL_Y = "scroll_y"
47 class GuideWebViewFragment : Fragment() {
48 // Define the class variables.
49 private var tabNumber = 0
51 // Declare the class views.
52 private lateinit var webViewLayout: View
55 fun createTab(tabNumber: Int): GuideWebViewFragment {
56 // Create an arguments bundle.
57 val argumentsBundle = Bundle()
59 // Store the tab number in the bundle.
60 argumentsBundle.putInt(TAB_NUMBER, tabNumber)
62 // Create a new instance of the tab fragment.
63 val guideWebViewFragment = GuideWebViewFragment()
65 // Add the arguments bundle to the fragment.
66 guideWebViewFragment.arguments = argumentsBundle
68 // Return the new fragment.
69 return guideWebViewFragment
73 override fun onCreate(savedInstanceState: Bundle?) {
74 // Run the default commands.
75 super.onCreate(savedInstanceState)
77 // Store the tab number in a class variable.
78 tabNumber = requireArguments().getInt(TAB_NUMBER)
81 override fun onCreateView(layoutInflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {
82 // Inflate the layout. The fragment will take care of attaching the root automatically.
83 webViewLayout = layoutInflater.inflate(R.layout.bare_webview, container, false)
85 // Get a handle for the tab WebView.
86 val tabWebView = webViewLayout as WebView
88 // Create a WebView asset loader.
89 val webViewAssetLoader = WebViewAssetLoader.Builder().addPathHandler("/assets/", AssetsPathHandler(requireContext())).build()
91 // Set a WebView client.
92 tabWebView.webViewClient = object : WebViewClient() {
93 // Send external links back to the main Privacy Browser WebView. The deprecated `shouldOverrideUrlLoading` must be used until API >= 24.
94 @Deprecated("Deprecated in Java")
95 override fun shouldOverrideUrlLoading(view: WebView, url: String): Boolean {
96 // Create an intent to view the URL.
97 val urlIntent = Intent(Intent.ACTION_VIEW)
99 // Add the URL to the intent.
100 urlIntent.data = Uri.parse(url)
103 startActivity(urlIntent)
105 // Consume the click.
109 // Process asset requests with the asset loader.
110 override fun shouldInterceptRequest(webView: WebView, webResourceRequest: WebResourceRequest): WebResourceResponse? {
111 // This allows using the `appassets.androidplatform.net` URL, which handles the loading of SVG files, which otherwise is prevented by the CORS policy.
112 return webViewAssetLoader.shouldInterceptRequest(webResourceRequest.url)
116 // Get the current theme status.
117 val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
119 // Check to see if the app is in night mode. This can be removed once the minimum API >= 33.
120 if ((Build.VERSION.SDK_INT < 33) && (currentThemeStatus == Configuration.UI_MODE_NIGHT_YES) && WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) { // The app is in night mode.
121 // Apply the dark WebView theme.
122 @Suppress("DEPRECATION")
123 WebSettingsCompat.setForceDark(tabWebView.settings, WebSettingsCompat.FORCE_DARK_ON)
126 // Load the indicated tab. The tab numbers start at 0.
128 0 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_overview.html")
129 1 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_javascript.html")
130 2 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_local_storage.html")
131 3 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_user_agent.html")
132 4 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_requests.html")
133 5 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_domain_settings.html")
134 6 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_ssl_certificates.html")
135 7 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_proxies.html")
136 8 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_tracking_ids.html")
137 9 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/guide_interface.html")
140 // Scroll the WebView if the saved instance state is not null.
141 if (savedInstanceState != null) {
143 tabWebView.scrollY = savedInstanceState.getInt(SCROLL_Y)
147 // Return the formatted WebView layout.
151 override fun onSaveInstanceState(savedInstanceState: Bundle) {
152 // Run the default commands.
153 super.onSaveInstanceState(savedInstanceState)
155 // Get a handle for the tab WebView. A class variable cannot be used because it gets out of sync when restarting.
156 val tabWebView = webViewLayout as WebView?
158 // Save the scroll Y position if the tab WebView is not null, which can happen if a tab is not currently selected.
159 if (tabWebView != null) {
160 savedInstanceState.putInt(SCROLL_Y, tabWebView.scrollY)