Release 3.9.
[PrivacyBrowser.git] / app / src / main / java / com / stoutner / privacybrowser / fragments / AboutWebViewFragment.kt
1 /*
2  * Copyright © 2016-2021 Soren Stoutner <soren@stoutner.com>.
3  *
4  * This file is part of Privacy Browser <https://www.stoutner.com/privacy-browser>.
5  *
6  * Privacy Browser 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.
10  *
11  * Privacy Browser 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.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Privacy Browser.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 package com.stoutner.privacybrowser.fragments
21
22 import android.content.Intent
23 import android.content.res.Configuration
24 import android.net.Uri
25 import android.os.Bundle
26 import android.view.LayoutInflater
27 import android.view.View
28 import android.view.ViewGroup
29 import android.webkit.WebResourceResponse
30 import android.webkit.WebView
31 import android.webkit.WebViewClient
32
33 import androidx.fragment.app.Fragment
34 import androidx.webkit.WebSettingsCompat
35 import androidx.webkit.WebViewAssetLoader
36 import androidx.webkit.WebViewAssetLoader.AssetsPathHandler
37 import androidx.webkit.WebViewFeature
38
39 import com.stoutner.privacybrowser.R
40
41 // Define the class constants.
42 private const val TAB_NUMBER = "tab_number"
43 private const val SCROLL_X = "scroll_x"
44 private const val SCROLL_Y = "scroll_y"
45
46 class AboutWebViewFragment : Fragment() {
47     // Define the class variables.
48     private var tabNumber = 0
49
50     // Declare the class views.
51     private lateinit var webViewLayout: View
52
53     companion object {
54         fun createTab(tabNumber: Int): AboutWebViewFragment {
55             // Create an arguments bundle.
56             val argumentsBundle = Bundle()
57
58             // Store the arguments in the bundle.
59             argumentsBundle.putInt(TAB_NUMBER, tabNumber)
60
61             // Create a new instance of the tab fragment.
62             val aboutWebViewFragment = AboutWebViewFragment()
63
64             // Add the arguments bundle to the fragment.
65             aboutWebViewFragment.arguments = argumentsBundle
66
67             // Return the new fragment.
68             return aboutWebViewFragment
69         }
70     }
71
72     override fun onCreate(savedInstanceState: Bundle?) {
73         // Run the default commands.
74         super.onCreate(savedInstanceState)
75
76         // Store the tab number in a class variable.
77         tabNumber = requireArguments().getInt(TAB_NUMBER)
78     }
79
80     override fun onCreateView(layoutInflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {
81         // Inflate the layout.  False does not attach the inflated layout as a child of container.  The fragment will take care of attaching the root automatically.
82         webViewLayout = layoutInflater.inflate(R.layout.bare_webview, container, false)
83
84         // Get a handle for tab WebView.
85         val tabWebView = webViewLayout as WebView
86
87         // Create a WebView asset loader.
88         val webViewAssetLoader = WebViewAssetLoader.Builder().addPathHandler("/assets/", AssetsPathHandler(requireContext())).build()
89
90         // Set a WebView client.
91         tabWebView.webViewClient = object : WebViewClient() {
92             // // Send external links back to the main Privacy Browser WebView.  The deprecated `shouldOverrideUrlLoading` must be used until API >= 24.
93             override fun shouldOverrideUrlLoading(view: WebView, url: String): Boolean {
94                 // Create an intent to view the URL.
95                 val urlIntent = Intent(Intent.ACTION_VIEW)
96
97                 // Add the URL to the intent.
98                 urlIntent.data = Uri.parse(url)
99
100                 // Make it so.
101                 startActivity(urlIntent)
102                 
103                 // Consume the click.
104                 return true
105             }
106             
107             // Process asset requests with the asset loader.
108             override fun shouldInterceptRequest(webView: WebView, url: String): WebResourceResponse? {
109                 // This allows using the `appassets.androidplatform.net` URL, which handles the loading of SVG files, which otherwise is prevented by the CORS policy.
110                 return webViewAssetLoader.shouldInterceptRequest(Uri.parse(url))
111             }
112         }
113
114         // Get the current theme status.
115         val currentThemeStatus = resources.configuration.uiMode and Configuration.UI_MODE_NIGHT_MASK
116
117         // Check to see if the app is in night mode.
118         if (currentThemeStatus == Configuration.UI_MODE_NIGHT_YES && WebViewFeature.isFeatureSupported(WebViewFeature.FORCE_DARK)) {  // The app is in night mode.
119             // Apply the dark WebView theme.
120             WebSettingsCompat.setForceDark(tabWebView.settings, WebSettingsCompat.FORCE_DARK_ON)
121         }
122
123         // Load the indicated tab.  The tab numbers start at 0, with the WebView tabs starting at 1.
124         when (tabNumber) {
125             1 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/about_permissions.html")
126             2 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/about_privacy_policy.html")
127             3 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/about_changelog.html")
128             4 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/about_licenses.html")
129             5 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/about_contributors.html")
130             6 -> tabWebView.loadUrl("https://appassets.androidplatform.net/assets/" + getString(R.string.android_asset_path) + "/about_links.html")
131         }
132
133         // Scroll the tab if the saved instance state is not null.
134         if (savedInstanceState != null) {
135             tabWebView.post {
136                 tabWebView.scrollX = savedInstanceState.getInt(SCROLL_X)
137                 tabWebView.scrollY = savedInstanceState.getInt(SCROLL_Y)
138             }
139         }
140
141         // Return the formatted WebView layout.
142         return webViewLayout
143     }
144
145     override fun onSaveInstanceState(savedInstanceState: Bundle) {
146         // Run the default commands.
147         super.onSaveInstanceState(savedInstanceState)
148
149         // Get a handle for the tab WebView.  A class variable cannot be used because it gets out of sync when restarting.
150         val tabWebView = webViewLayout as WebView?
151
152         // Save the scroll positions if the layout is not null, which can happen if a tab is not currently selected.
153         if (tabWebView != null) {
154             savedInstanceState.putInt(SCROLL_X, tabWebView.scrollX)
155             savedInstanceState.putInt(SCROLL_Y, tabWebView.scrollY)
156         }
157     }
158 }