This repository has been archived by the owner on Mar 6, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 261
/
WebViewController.swift
581 lines (484 loc) · 24.3 KB
/
WebViewController.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
import UIKit
import WebKit
import Telemetry
import PassKit
import Combine
protocol BrowserState {
var url: URL? { get }
var isLoading: Bool { get }
var canGoBack: Bool { get }
var canGoForward: Bool { get }
var estimatedProgress: Double { get }
}
protocol WebController {
var delegate: WebControllerDelegate? { get set }
var canGoBack: Bool { get }
var canGoForward: Bool { get }
func load(_ request: URLRequest)
}
protocol WebControllerDelegate: AnyObject {
func webControllerDidStartProvisionalNavigation(_ controller: WebController)
func webControllerDidStartNavigation(_ controller: WebController)
func webControllerDidFinishNavigation(_ controller: WebController)
func webControllerDidNavigateBack(_ controller: WebController)
func webControllerDidNavigateForward(_ controller: WebController)
func webControllerDidReload(_ controller: WebController)
func webControllerURLDidChange(_ controller: WebController, url: URL)
func webController(_ controller: WebController, didFailNavigationWithError error: Error)
func webController(_ controller: WebController, didUpdateCanGoBack canGoBack: Bool)
func webController(_ controller: WebController, didUpdateCanGoForward canGoForward: Bool)
func webController(_ controller: WebController, didUpdateEstimatedProgress estimatedProgress: Double)
func webController(_ controller: WebController, scrollViewWillBeginDragging scrollView: UIScrollView)
func webController(_ controller: WebController, scrollViewDidEndDragging scrollView: UIScrollView)
func webController(_ controller: WebController, scrollViewDidScroll scrollView: UIScrollView)
func webControllerShouldScrollToTop(_ controller: WebController) -> Bool
func webController(_ controller: WebController, didUpdateTrackingProtectionStatus trackingStatus: TrackingProtectionStatus, oldTrackingProtectionStatus: TrackingProtectionStatus)
func webController(_ controller: WebController, didUpdateFindInPageResults currentResult: Int?, totalResults: Int?)
}
class WebViewController: UIViewController, WebController {
private enum ScriptHandlers: String, CaseIterable {
case focusTrackingProtection
case focusTrackingProtectionPostLoad
case findInPageHandler
case fullScreen
case metadata
case adsMessageHandler
}
private enum KVOConstants: String, CaseIterable {
case URL = "URL"
case canGoBack = "canGoBack"
case canGoForward = "canGoForward"
}
weak var delegate: WebControllerDelegate?
var browserView: WKWebView! {
didSet { configureRefreshControl() }
}
private var progressObserver: NSKeyValueObservation?
private var currentBackForwardItem: WKBackForwardListItem?
private let trackingProtectionManager: TrackingProtectionManager
private var cancellable: AnyCancellable?
private var menuAction: WebMenuAction
var pageTitle: String? {
return browserView.title
}
private var currentContentMode: WKWebpagePreferences.ContentMode?
private var contentModeForHost: [String: WKWebpagePreferences.ContentMode] = [:]
var requestMobileSite: Bool { currentContentMode == .desktop }
var connectionIsSecure: Bool {
return browserView.hasOnlySecureContent
}
var printFormatter: UIPrintFormatter { return browserView.viewPrintFormatter() }
var scrollView: UIScrollView { return browserView.scrollView }
var adsTelemetryHelper = AdsTelemetryHelper()
var searchInContentTelemetry: SearchInContentTelemetry?
init(trackingProtectionManager: TrackingProtectionManager, webMenuAction: WebMenuAction) {
self.trackingProtectionManager = trackingProtectionManager
self.menuAction = webMenuAction
super.init(nibName: nil, bundle: nil)
cancellable = self.trackingProtectionManager.$trackingProtectionStatus.sink { [weak self] status in
guard let self = self else { return }
self.delegate?.webController(self, didUpdateTrackingProtectionStatus: status, oldTrackingProtectionStatus: self.trackingProtectionManager.trackingProtectionStatus)
}
setupWebview()
ContentBlockerHelper.shared.handler = reloadBlockers(_:)
adsTelemetryHelper.getURL = { [weak self] in
guard let self = self else { return nil }
return self.url
}
}
required init?(coder: NSCoder) {
fatalError("init(coder:) has not been implemented")
}
func reset() {
browserView.load(URLRequest(url: URL(string: "about:blank")!))
browserView.navigationDelegate = nil
browserView.removeFromSuperview()
setupWebview()
self.browserView.addObserver(self, forKeyPath: "URL", options: .new, context: nil)
}
// Browser proxy methods
func load(_ request: URLRequest) { browserView.load(request) }
func goBack() { browserView.goBack() }
func goForward() { browserView.goForward() }
func reload() { browserView.reload() }
func requestUserAgentChange() {
if let hostName = browserView.url?.host {
contentModeForHost[hostName] = requestMobileSite ? .mobile : .desktop
}
self.browserView.reloadFromOrigin()
}
func stop() { browserView.stopLoading() }
private func setupWebview() {
let configuration = WKWebViewConfiguration()
configuration.websiteDataStore = WKWebsiteDataStore.nonPersistent()
configuration.allowsInlineMediaPlayback = true
// For consistency we set our user agent similar to Firefox iOS.
//
// Important to note that this UA change only applies when the webview is created initially or
// when people hit the erase session button. The UA is not changed when you change the width of
// Focus on iPad, which means there could be some edge cases right now.
if UIDevice.current.userInterfaceIdiom == .pad {
configuration.applicationNameForUserAgent = "Version/13.1 Safari/605.1.15"
} else {
configuration.applicationNameForUserAgent = "FxiOS/\(AppInfo.majorVersion) Mobile/15E148 Version/15.0"
}
if #available(iOS 15.0, *) {
configuration.upgradeKnownHostsToHTTPS = true
}
browserView = WKWebView(frame: .zero, configuration: configuration)
browserView.allowsBackForwardNavigationGestures = true
browserView.allowsLinkPreview = true
browserView.scrollView.clipsToBounds = false
browserView.scrollView.delegate = self
browserView.navigationDelegate = self
browserView.uiDelegate = self
progressObserver = browserView.observe(\WKWebView.estimatedProgress) { (webView, value) in
self.delegate?.webController(self, didUpdateEstimatedProgress: webView.estimatedProgress)
}
if case .on(_) = trackingProtectionManager.trackingProtectionStatus {
setupBlockLists()
setupTrackingProtectionScripts()
}
setupFindInPageScripts()
setupMetadataScripts()
setupFullScreen()
setupAdsScripts()
view.addSubview(browserView)
browserView.snp.makeConstraints { make in
make.edges.equalTo(view.snp.edges)
}
KVOConstants.allCases.forEach { browserView.addObserver(self, forKeyPath: $0.rawValue, options: .new, context: nil) }
}
@objc private func reloadBlockers(_ blockLists: [WKContentRuleList]) {
DispatchQueue.main.async {
self.browserView.configuration.userContentController.removeAllContentRuleLists()
blockLists.forEach(self.browserView.configuration.userContentController.add)
}
}
private func setupBlockLists() {
ContentBlockerHelper.shared.getBlockLists { [weak self] lists in
guard let self = self else { return }
self.reloadBlockers(lists)
}
}
private func configureRefreshControl() {
scrollView.refreshControl = UIRefreshControl()
scrollView.refreshControl?.addTarget(self, action: #selector(reloadPage), for: .valueChanged)
}
@objc private func reloadPage() {
reload()
DispatchQueue.main.async {
self.scrollView.refreshControl?.endRefreshing()
}
}
private func addScript(forResource resource: String, injectionTime: WKUserScriptInjectionTime, forMainFrameOnly mainFrameOnly: Bool) {
let source = try! String(contentsOf: Bundle.main.url(forResource: resource, withExtension: "js")!)
let script = WKUserScript(source: source, injectionTime: injectionTime, forMainFrameOnly: mainFrameOnly)
browserView.configuration.userContentController.addUserScript(script)
}
private func setupTrackingProtectionScripts() {
browserView.configuration.userContentController.add(self, name: ScriptHandlers.focusTrackingProtection.rawValue)
addScript(forResource: "preload", injectionTime: .atDocumentStart, forMainFrameOnly: true)
browserView.configuration.userContentController.add(self, name: ScriptHandlers.focusTrackingProtectionPostLoad.rawValue)
addScript(forResource: "postload", injectionTime: .atDocumentEnd, forMainFrameOnly: false)
}
private func setupFindInPageScripts() {
browserView.configuration.userContentController.add(self, name: ScriptHandlers.findInPageHandler.rawValue)
addScript(forResource: "FindInPage", injectionTime: .atDocumentEnd, forMainFrameOnly: true)
}
private func setupMetadataScripts() {
browserView.configuration.userContentController.add(self, name: ScriptHandlers.metadata.rawValue)
addScript(forResource: "MetadataHelper", injectionTime: .atDocumentEnd, forMainFrameOnly: true)
}
private func setupFullScreen() {
browserView.configuration.userContentController.add(self, name: ScriptHandlers.fullScreen.rawValue)
addScript(forResource: "FullScreen", injectionTime: .atDocumentEnd, forMainFrameOnly: true)
}
private func setupAdsScripts() {
browserView.configuration.userContentController.add(self, name: ScriptHandlers.adsMessageHandler.rawValue)
addScript(forResource: "Ads", injectionTime: .atDocumentEnd, forMainFrameOnly: false)
}
func disableTrackingProtection() {
guard case .on = trackingProtectionManager.trackingProtectionStatus else { return }
ScriptHandlers.allCases.forEach {
browserView.configuration.userContentController.removeScriptMessageHandler(forName: $0.rawValue)
}
browserView.configuration.userContentController.removeAllUserScripts()
browserView.configuration.userContentController.removeAllContentRuleLists()
setupFindInPageScripts()
setupMetadataScripts()
setupFullScreen()
setupAdsScripts()
trackingProtectionManager.trackingProtectionStatus = .off
}
func enableTrackingProtection() {
guard case .off = trackingProtectionManager.trackingProtectionStatus else { return }
setupBlockLists()
setupTrackingProtectionScripts()
trackingProtectionManager.trackingProtectionStatus = .on(TPPageStats())
}
func evaluate(_ javascript: String, completion: ((Any?, Error?) -> Void)?) {
browserView.evaluateJavaScript(javascript, completionHandler: completion)
}
func evaluateDocumentContentType(_ completion: @escaping (String?) -> Void) {
evaluate("document.contentType") { documentType, _ in
completion(documentType as? String)
}
}
enum MetadataError: Swift.Error {
case missingMetadata
case missingURL
}
/// Get the metadata out of the page-metadata-parser, and into a type safe struct as soon as possible.
///
func getMetadata(completion: @escaping (Swift.Result<Metadata, Error>) -> Void) {
evaluate("__firefox__.metadata.getMetadata()") { result, error in
let metadata = result
.flatMap { try? JSONSerialization.data(withJSONObject: $0) }
.flatMap { try? JSONDecoder().decode(Metadata.self, from: $0) }
if let metadata = metadata {
completion(.success(metadata))
} else if let error = error {
completion(.failure(error))
} else {
completion(.failure(MetadataError.missingMetadata))
}
}
}
func getMetadata() -> Future<Metadata, Error> {
Future { [weak self] promise in
guard let self = self else { return }
self.getMetadata { result in
promise(result)
}
}
}
func getMetadata() async throws -> Metadata {
return try await withCheckedThrowingContinuation { [weak self] continuation in
guard let self = self else { return }
self.getMetadata { result in
continuation.resume(with: result)
}
}
}
func focus() {
browserView.becomeFirstResponder()
}
func resetZoom() {
browserView.scrollView.setZoomScale(1.0, animated: true)
}
override func viewDidLoad() {
self.browserView.addObserver(self, forKeyPath: "URL", options: .new, context: nil)
searchInContentTelemetry = SearchInContentTelemetry()
}
override func observeValue(forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey: Any]?, context: UnsafeMutableRawPointer?) {
guard let kp = keyPath, let path = KVOConstants(rawValue: kp) else {
assertionFailure("Unhandled KVO key: \(keyPath ?? "nil")")
return
}
switch path {
case .URL:
guard let url = browserView.url else { break }
delegate?.webControllerURLDidChange(self, url: url)
case .canGoBack:
guard let canGoBack = change?[.newKey] as? Bool else { break }
delegate?.webController(self, didUpdateCanGoBack: canGoBack)
case .canGoForward:
guard let canGoForward = change?[.newKey] as? Bool else { break }
delegate?.webController(self, didUpdateCanGoForward: canGoForward)
}
}
}
extension WebViewController: UIScrollViewDelegate {
func scrollViewDidScroll(_ scrollView: UIScrollView) {
delegate?.webController(self, scrollViewDidScroll: scrollView)
}
func scrollViewWillBeginDragging(_ scrollView: UIScrollView) {
delegate?.webController(self, scrollViewWillBeginDragging: scrollView)
}
func scrollViewDidEndDragging(_ scrollView: UIScrollView, willDecelerate decelerate: Bool) {
delegate?.webController(self, scrollViewDidEndDragging: scrollView)
}
func scrollViewShouldScrollToTop(_ scrollView: UIScrollView) -> Bool {
return delegate?.webControllerShouldScrollToTop(self) ?? true
}
}
extension WebViewController: WKNavigationDelegate {
func webView(_ webView: WKWebView, didCommit navigation: WKNavigation!) {
delegate?.webControllerDidStartNavigation(self)
trackingProtectionManager.trackingProtectionStatus.trackingInformation = TPPageStats()
currentContentMode = navigation?.effectiveContentMode
searchInContentTelemetry?.setSearchType(webView: webView)
}
func webView(_ webView: WKWebView, didFinish navigation: WKNavigation!) {
delegate?.webControllerDidFinishNavigation(self)
}
func webView(_ webView: WKWebView, didFail navigation: WKNavigation!, withError error: Error) {
delegate?.webController(self, didFailNavigationWithError: error)
}
func webView(_ webView: WKWebView, didFailProvisionalNavigation navigation: WKNavigation!, withError error: Error) {
let error = error as NSError
guard error.code != Int(CFNetworkErrors.cfurlErrorCancelled.rawValue), let errorUrl = error.userInfo[NSURLErrorFailingURLErrorKey] as? URL else { return }
let errorPageData = ErrorPage(error: error).data
webView.load(errorPageData, mimeType: "", characterEncodingName: UIConstants.strings.encodingNameUTF8, baseURL: errorUrl)
}
func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction, preferences: WKWebpagePreferences, decisionHandler: @escaping (WKNavigationActionPolicy, WKWebpagePreferences) -> Void) {
if let redirectedURL = navigationAction.request.url {
adsTelemetryHelper.trackClickedAds(with: redirectedURL)
}
// If the user has asked for a specific content mode for this host, use that.
if let hostName = navigationAction.request.url?.host, let preferredContentMode = contentModeForHost[hostName] {
preferences.preferredContentMode = preferredContentMode
}
let present: (UIViewController) -> Void = {
self.present($0, animated: true) {
self.delegate?.webController(self, didUpdateEstimatedProgress: 1.0)
self.delegate?.webControllerDidFinishNavigation(self)
}
}
switch navigationAction.navigationType {
case .backForward:
let navigatingBack = webView.backForwardList.backList.filter { $0 == currentBackForwardItem }.count == 0
if navigatingBack {
delegate?.webControllerDidNavigateBack(self)
} else {
delegate?.webControllerDidNavigateForward(self)
}
case .reload:
delegate?.webControllerDidReload(self)
default:
break
}
currentBackForwardItem = webView.backForwardList.currentItem
// prevent Focus from opening universal links
// https://stackoverflow.com/questions/38450586/prevent-universal-links-from-opening-in-wkwebview-uiwebview
let allowDecision = WKNavigationActionPolicy(rawValue: WKNavigationActionPolicy.allow.rawValue + 2) ?? .allow
let decision: WKNavigationActionPolicy = RequestHandler().handle(request: navigationAction.request, alertCallback: present) ? allowDecision : .cancel
if navigationAction.navigationType == .linkActivated && browserView.url != navigationAction.request.url {
Telemetry.default.recordEvent(category: TelemetryEventCategory.action, method: TelemetryEventMethod.click, object: TelemetryEventObject.websiteLink)
}
decisionHandler(decision, preferences)
}
func webView(_ webView: WKWebView, decidePolicyFor navigationResponse: WKNavigationResponse, decisionHandler: @escaping (WKNavigationResponsePolicy) -> Void) {
let response = navigationResponse.response
guard let responseMimeType = response.mimeType else {
decisionHandler(.allow)
return
}
// Check for passbook response
if responseMimeType == "application/vnd.apple.pkpass" {
decisionHandler(.allow)
browserView.load(URLRequest(url: URL(string: "about:blank")!))
func presentPassErrorAlert() {
let passErrorAlert = UIAlertController(title: UIConstants.strings.addPassErrorAlertTitle, message: UIConstants.strings.addPassErrorAlertMessage, preferredStyle: .alert)
let passErrorDismissAction = UIAlertAction(title: UIConstants.strings.addPassErrorAlertDismiss, style: .default) { (UIAlertAction) in
passErrorAlert.dismiss(animated: true, completion: nil)
}
passErrorAlert.addAction(passErrorDismissAction)
self.present(passErrorAlert, animated: true, completion: nil)
}
guard let responseURL = response.url else {
presentPassErrorAlert()
return
}
guard let passData = try? Data(contentsOf: responseURL) else {
presentPassErrorAlert()
return
}
guard let pass = try? PKPass(data: passData) else {
// Alert user to add pass failure
presentPassErrorAlert()
return
}
// Present pass
let passLibrary = PKPassLibrary()
if passLibrary.containsPass(pass) {
UIApplication.shared.open(pass.passURL!, options: [:])
} else {
guard let addController = PKAddPassesViewController(pass: pass) else {
presentPassErrorAlert()
return
}
self.present(addController, animated: true, completion: nil)
}
return
}
decisionHandler(.allow)
}
func webView(_ webView: WKWebView, didStartProvisionalNavigation navigation: WKNavigation!) {
delegate?.webControllerDidStartProvisionalNavigation(self)
}
}
extension WebViewController: BrowserState {
var canGoBack: Bool { return browserView.canGoBack }
var canGoForward: Bool { return browserView.canGoForward }
var estimatedProgress: Double { return browserView.estimatedProgress }
var isLoading: Bool { return browserView.isLoading }
var url: URL? { return browserView.url }
}
extension WebViewController: WKUIDelegate {
func webView(_ webView: WKWebView, createWebViewWith configuration: WKWebViewConfiguration, for navigationAction: WKNavigationAction, windowFeatures: WKWindowFeatures) -> WKWebView? {
if navigationAction.targetFrame == nil {
browserView.load(navigationAction.request)
}
return nil
}
}
extension WebViewController: WKScriptMessageHandler {
func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
if message.name == "adsMessageHandler" {
adsTelemetryHelper.trackAds(message: message)
}
if message.name == "findInPageHandler" {
let data = message.body as! [String: Int]
// We pass these separately as they're sent in different messages to the userContentController
if let currentResult = data["currentResult"] {
delegate?.webController(self, didUpdateFindInPageResults: currentResult, totalResults: nil)
}
if let totalResults = data["totalResults"] {
delegate?.webController(self, didUpdateFindInPageResults: nil, totalResults: totalResults)
}
return
}
guard let body = message.body as? [String: String],
let urlString = body["url"],
var components = URLComponents(string: urlString) else {
return
}
components.scheme = "http"
guard let url = components.url else { return }
let enabled = Utils.getEnabledLists().compactMap { BlocklistName(rawValue: $0) }
TPStatsBlocklistChecker.shared.isBlocked(url: url, enabledLists: enabled).uponQueue(.main) { [unowned self] listItem in
if let listItem = listItem {
let currentInfo = trackingProtectionManager.trackingProtectionStatus.trackingInformation
trackingProtectionManager.trackingProtectionStatus.trackingInformation = currentInfo.map { $0.create(byAddingListItem: listItem) }
}
}
}
}
extension WebViewController {
func webView(_ webView: WKWebView, contextMenuConfigurationFor elementInfo: WKContextMenuElementInfo) async -> UIContextMenuConfiguration? {
guard let url = elementInfo.linkURL else { return nil }
return UIContextMenuConfiguration(identifier: nil) {
let previewViewController = UIViewController()
previewViewController.view.isUserInteractionEnabled = false
let clonedWebView = WKWebView(frame: webView.frame, configuration: webView.configuration)
previewViewController.view.addSubview(clonedWebView)
clonedWebView.snp.makeConstraints { make in
make.edges.equalTo(previewViewController.view)
}
clonedWebView.load(URLRequest(url: url))
return previewViewController
} actionProvider: { [unowned self] menu in
UIMenu(title: url.absoluteString, children: [
UIAction(self.menuAction.openLink(url: url)),
UIAction(self.menuAction.openInDefaultBrowserItem(for: url)),
UIAction(self.menuAction.copyItem(url: url)),
UIAction(self.menuAction.sharePageItem(for: .init(url: url, webViewController: self), sender: self.view, presenter: self))
])
}
}
}