forked from mozilla-mobile/firefox-ios
-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathBrowserViewController.swift
More file actions
5226 lines (4509 loc) · 216 KB
/
BrowserViewController.swift
File metadata and controls
5226 lines (4509 loc) · 216 KB
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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// 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 Foundation
import Photos
import UIKit
import WebKit
import Shared
import Storage
import SnapKit
import Account
import MobileCoreServices
import Common
import Redux
import WebEngine
import WidgetKit
import SummarizeKit
import ActivityKit
import Glean
import class MozillaAppServices.BookmarkFolderData
import class MozillaAppServices.BookmarkItemData
import struct MozillaAppServices.Login
import enum MozillaAppServices.BookmarkRoots
import struct MozillaAppServices.VisitObservation
import enum MozillaAppServices.VisitType
class BrowserViewController: UIViewController,
SearchBarLocationProvider,
Themeable,
Notifiable,
LibraryPanelDelegate,
RecentlyClosedPanelDelegate,
QRCodeViewControllerDelegate,
StoreSubscriber,
BrowserFrameInfoProvider,
NavigationToolbarContainerDelegate,
AddressToolbarContainerDelegate,
BookmarksHandlerDelegate,
FeatureFlaggable,
CanRemoveQuickActionBookmark,
BrowserStatusBarScrollDelegate {
enum UX {
static let showHeaderTapAreaHeight: CGFloat = 32
static let downloadToastDelay = DispatchTimeInterval.milliseconds(500)
static let downloadToastDuration = DispatchTimeInterval.seconds(5)
static let minimalHeaderOffset: CGFloat = 14
}
/// Describes the state of the current search session. This state is used
/// to record search engagement and abandonment telemetry.
enum SearchSessionState {
/// The user is currently searching. The URL bar's text field
/// is focused, but the search controller may be hidden if the
/// text field is empty.
case active
/// The user completed their search by navigating to a destination,
/// either by tapping on a suggestion, or by entering a search term
/// or a URL.
case engaged
/// The user abandoned their search by dismissing the URL bar.
case abandoned
}
typealias SubscriberStateType = BrowserViewControllerState
private let KVOs: [KVOConstants] = [
.estimatedProgress,
.loading,
.canGoBack,
.canGoForward,
.URL,
.title,
.hasOnlySecureContent,
// TODO: FXIOS-12158 Add back after investigating why video player is broken
// .fullscreenState
]
weak var browserDelegate: BrowserDelegate?
weak var navigationHandler: BrowserNavigationHandler?
weak var fullscreenDelegate: FullscreenDelegate?
nonisolated let windowUUID: WindowUUID
var currentWindowUUID: UUID? { return windowUUID }
private var observedWebViews = WeakList<WKWebView>()
var themeManager: ThemeManager
var notificationCenter: NotificationProtocol
var themeListenerCancellable: Any?
nonisolated let logger: Logger
var zoomManager: ZoomPageManager
let documentLogger: DocumentLogger
var downloadHelper: DownloadHelper?
// MARK: Optional UI elements
var topTabsViewController: TopTabsViewController?
var tabTrayViewController: TabTrayController?
var clipboardBarDisplayHandler: ClipboardBarDisplayHandler?
var readerModeBar: ReaderModeBarView?
var searchController: SearchViewController?
var searchSessionState: SearchSessionState?
var searchLoader: SearchLoader?
var findInPageBar: FindInPageBar?
var zoomPageBar: ZoomPageBar?
var addressBarPanGestureHandler: AddressBarPanGestureHandler?
var microsurvey: MicrosurveyPromptView?
var keyboardBackdrop: UIView?
var pendingToast: Toast? // A toast that might be waiting for BVC to appear before displaying
var downloadToast: DownloadToast? // A toast that is showing the combined download progress
var downloadProgressManager: DownloadProgressManager?
let tabsPanelTelemetry: TabsPanelTelemetry
let recordVisitManager: RecordVisitObserving
private var _downloadLiveActivityWrapper: Any?
@available(iOS 17, *)
var downloadLiveActivityWrapper: DownloadLiveActivityWrapper? {
get {
return _downloadLiveActivityWrapper as? DownloadLiveActivityWrapper
} set(newValue) {
_downloadLiveActivityWrapper = newValue
}
}
// popover rotation handling
var displayedPopoverController: UIViewController?
var updateDisplayedPopoverProperties: (() -> Void)?
lazy var screenshotHelper = ScreenshotHelper(controller: self)
// MARK: Lazy loading UI elements
private var documentLoadingView: TemporaryDocumentLoadingView?
private(set) lazy var mailtoLinkHandler = MailtoLinkHandler()
private lazy var statusBarOverlay: StatusBarOverlay = .build { view in
view.accessibilityIdentifier = AccessibilityIdentifiers.Browser.statusBarOverlay
}
private var statusBarOverlayConstraints = [NSLayoutConstraint]()
private(set) lazy var addressToolbarContainer: AddressToolbarContainer = .build(nil, {
AddressToolbarContainer(isMinimalAddressBarEnabled: self.isMinimalAddressBarEnabled,
toolbarHelper: self.toolbarHelper)
})
private(set) lazy var readerModeCache: ReaderModeCache = DiskReaderModeCache.shared
private(set) lazy var overlayManager: OverlayModeManager = DefaultOverlayModeManager()
// Header stack view can contain the top url bar, top reader mode, top ZoomPageBar
private(set) lazy var header: BaseAlphaStackView = .build { view in
view.accessibilityIdentifier = AccessibilityIdentifiers.Browser.headerContainer
}
// OverKeyboardContainer stack view contains
// the bottom reader mode, the bottom url bar and the ZoomPageBar
private(set) lazy var overKeyboardContainer: BaseAlphaStackView = .build { view in
view.accessibilityIdentifier = AccessibilityIdentifiers.Browser.overKeyboardContainer
}
// Constraints used to show/hide toolbars
var headerTopConstraint: Constraint?
var overKeyboardContainerConstraint: Constraint?
var bottomContainerConstraint: Constraint?
var topTouchAreaHeightConstraint: NSLayoutConstraint?
// Overlay dimming view for private mode
private lazy var privateModeDimmingView: UIView = .build { view in
view.backgroundColor = self.currentTheme().colors.layerScrim
view.accessibilityIdentifier = AccessibilityIdentifiers.PrivateMode.dimmingView
}
// Overlay dimming view for zero search mode
private lazy var zeroSearchDimmingView: UIView = .build { view in
view.accessibilityIdentifier = AccessibilityIdentifiers.ZeroSearch.dimmingView
let tapRecognizer = UITapGestureRecognizer(target: self, action: #selector(self.tappedZeroSearchScrim))
view.addGestureRecognizer(tapRecognizer)
}
// BottomContainer stack view contains toolbar
lazy var bottomContainer: BaseAlphaStackView = .build { view in
view.accessibilityIdentifier = AccessibilityIdentifiers.Browser.bottomContainer
}
// Alert content that appears on top of the content
// ex: Find In Page, SnackBar from LoginsHelper
private(set) lazy var bottomContentStackView: BaseAlphaStackView = .build { stackview in
stackview.isClearBackground = true
stackview.accessibilityIdentifier = AccessibilityIdentifiers.Browser.bottomContentStackView
}
// The content container contains the homepage, error page or webview. Embedded by the coordinator.
private(set) lazy var contentContainer: ContentContainer = .build { view in
view.accessibilityIdentifier = AccessibilityIdentifiers.Browser.contentContainer
}
// A view for displaying a preview of the web page.
private lazy var webPagePreview: TabWebViewPreview = .build {
$0.isHidden = true
}
private lazy var topTouchArea: UIButton = .build { topTouchArea in
topTouchArea.isAccessibilityElement = false
topTouchArea.addTarget(self, action: #selector(self.tappedTopArea), for: .touchUpInside)
}
private(set) lazy var scrollController: TabScrollHandlerProtocol = {
if isTabScrollRefactoringEnabled {
return TabScrollHandler(windowUUID: windowUUID, delegate: self)
} else {
return LegacyTabScrollController(windowUUID: windowUUID)
}
}()
var toolbarAnimator: ToolbarAnimator?
// Window helper used for displaying an opaque background for private tabs.
private lazy var privacyWindowHelper = PrivacyWindowHelper()
private lazy var navigationToolbarContainer: NavigationToolbarContainer = .build { view in
view.windowUUID = self.windowUUID
}
private lazy var effect: some UIVisualEffect = {
#if canImport(FoundationModels)
if #available(iOS 26, *), !DeviceInfo.isRunningLiquidGlassEarlyBeta {
return UIGlassEffect(style: .regular)
} else {
return UIBlurEffect(style: .systemUltraThinMaterial)
}
#else
return UIBlurEffect(style: .systemUltraThinMaterial)
#endif
}()
// MARK: Blur views for translucent toolbars
lazy var topBlurView: UIVisualEffectView = .build { view in
view.effect = self.effect
}
lazy var bottomBlurView: UIVisualEffectView = .build { view in
view.effect = self.effect
}
// background view is placed behind content view so view scrolled to top or bottom shows
// correct background for translucent toolbars
private let backgroundView: UIView = .build()
// MARK: Contextual Hints
private(set) lazy var dataClearanceContextHintVC: ContextualHintViewController = {
let dataClearanceViewProvider = ContextualHintViewProvider(
forHintType: .dataClearance,
with: profile
)
return ContextualHintViewController(with: dataClearanceViewProvider,
windowUUID: windowUUID)
}()
var navigationHintDoubleTapTimer: Timer?
private(set) lazy var navigationContextHintVC: ContextualHintViewController = {
let navigationViewProvider = ContextualHintViewProvider(forHintType: .navigation, with: profile)
return ContextualHintViewController(with: navigationViewProvider, windowUUID: windowUUID)
}()
private(set) lazy var toolbarUpdateContextHintVC: ContextualHintViewController = {
let toolbarViewProvider = ContextualHintViewProvider(forHintType: .toolbarUpdate, with: profile)
return ContextualHintViewController(with: toolbarViewProvider, windowUUID: windowUUID)
}()
private(set) lazy var translationContextHintVC: ContextualHintViewController = {
let translationProvider = ContextualHintViewProvider(forHintType: .translation, with: profile)
return ContextualHintViewController(with: translationProvider, windowUUID: windowUUID)
}()
private(set) lazy var relayMaskContextHintVC: ContextualHintViewController = {
let relayProvider = ContextualHintViewProvider(forHintType: .relay, with: profile)
return ContextualHintViewController(with: relayProvider, windowUUID: windowUUID)
}()
private(set) lazy var summarizeToolbarEntryContextHintVC: ContextualHintViewController = {
let summarizeViewProvider = ContextualHintViewProvider(forHintType: .summarizeToolbarEntry, with: profile)
return ContextualHintViewController(with: summarizeViewProvider, windowUUID: windowUUID)
}()
// MARK: Telemetry Variables
private(set) lazy var searchTelemetry = SearchTelemetry(tabManager: tabManager)
private(set) lazy var webviewTelemetry = WebViewLoadMeasurementTelemetry()
private(set) lazy var privateBrowsingTelemetry = PrivateBrowsingTelemetry()
private(set) lazy var tabsTelemetry = TabsTelemetry()
private let appStartupTelemetry: AppStartupTelemetry
// location label actions
var pasteGoAction: AccessibleAction?
var pasteAction: AccessibleAction?
var copyAddressAction: AccessibleAction?
// TODO: FXIOS-13669 The session dependencies shouldn't be empty
private lazy var browserWebUIDelegate = BrowserWebUIDelegate(
engineResponder: DefaultUIHandler.factory(sessionDependencies: .empty(),
sessionCreator: tabManager as? SessionCreator),
legacyResponder: self
)
/// The ui delegate used by a `WKWebView`
var wkUIDelegate: WKUIDelegate {
if featureFlags.isFeatureEnabled(.webEngineIntegrationRefactor, checking: .buildOnly) {
return browserWebUIDelegate
}
return self
}
// MARK: Feature flags
private var isTabTrayUIExperimentsEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let flagToCheck = NimbusFeatureFlagID.tabTrayUIExperiments
let featureFlagStatus = featureFlags.isFeatureEnabled(flagToCheck, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [flagToCheck.rawValue: "\(featureFlagStatus)"]
)
return featureFlagStatus && UIDevice.current.userInterfaceIdiom != .pad
}
var isUnifiedSearchEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let flagToCheck = NimbusFeatureFlagID.unifiedSearch
let featureFlagStatus = featureFlags.isFeatureEnabled(flagToCheck, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [flagToCheck.rawValue: "\(featureFlagStatus)"]
)
return featureFlagStatus
}
var isOneTapNewTabEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let flagToCheck = NimbusFeatureFlagID.toolbarOneTapNewTab
let featureFlagStatus = featureFlags.isFeatureEnabled(flagToCheck, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [flagToCheck.rawValue: "\(featureFlagStatus)"]
)
return featureFlagStatus
}
var isToolbarTranslucencyEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let flagToCheck = NimbusFeatureFlagID.toolbarTranslucency
let featureFlagStatus = featureFlags.isFeatureEnabled(flagToCheck, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [flagToCheck.rawValue: "\(featureFlagStatus)"]
)
return featureFlagStatus
}
var isToolbarTranslucencyRefactorEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let flagToCheck = NimbusFeatureFlagID.toolbarTranslucencyRefactor
let featureFlagStatus = featureFlags.isFeatureEnabled(flagToCheck, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [flagToCheck.rawValue: "\(featureFlagStatus)"]
)
return featureFlagStatus
}
var isSwipingTabsEnabled: Bool {
return toolbarHelper.isSwipingTabsEnabled
}
var isMinimalAddressBarEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let flagToCheck = NimbusFeatureFlagID.toolbarMinimalAddressBar
let featureFlagStatus = featureFlags.isFeatureEnabled(flagToCheck, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [flagToCheck.rawValue: "\(featureFlagStatus)"]
)
return featureFlagStatus
}
var isToolbarNavigationHintEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let flagToCheck = NimbusFeatureFlagID.toolbarNavigationHint
let featureFlagStatus = featureFlags.isFeatureEnabled(flagToCheck, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [flagToCheck.rawValue: "\(featureFlagStatus)"]
)
return featureFlagStatus
}
var isToolbarUpdateHintEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let flagToCheck = NimbusFeatureFlagID.toolbarUpdateHint
let featureFlagStatus = featureFlags.isFeatureEnabled(flagToCheck, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [flagToCheck.rawValue: "\(featureFlagStatus)"]
)
return featureFlagStatus
}
var isNativeErrorPageEnabled: Bool {
return NativeErrorPageFeatureFlag().isNativeErrorPageEnabled
}
var isNICErrorPageEnabled: Bool {
return NativeErrorPageFeatureFlag().isNICErrorPageEnabled
}
var isDeeplinkOptimizationRefactorEnabled: Bool {
return featureFlags.isFeatureEnabled(.deeplinkOptimizationRefactor, checking: .buildOnly)
}
var isHomepageSearchBarEnabled: Bool {
return featureFlags.isFeatureEnabled(.homepageSearchBar, checking: .buildOnly)
}
var isSummarizerToolbarFeatureEnabled: Bool {
return summarizerNimbusUtils.isToolbarButtonEnabled
}
var isTabScrollRefactoringEnabled: Bool {
return featureFlags.isFeatureEnabled(.tabScrollRefactorFeature, checking: .buildOnly)
}
private var isRecentOrTrendingSearchEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let isTrendingSearchEnabled = featureFlags.isFeatureEnabled(.trendingSearches, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [NimbusFeatureFlagID.trendingSearches.rawValue: "\(isTrendingSearchEnabled)"]
)
let isRecentSearchEnabled = featureFlags.isFeatureEnabled(.recentSearches, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [NimbusFeatureFlagID.recentSearches.rawValue: "\(isRecentSearchEnabled)"]
)
return isTrendingSearchEnabled || isRecentSearchEnabled
}
private var isRecentSearchEnabled: Bool {
// TODO: FXIOS-14107 Remove logs after Nimbus incident is resolved
let flagToCheck = NimbusFeatureFlagID.recentSearches
let featureFlagStatus = featureFlags.isFeatureEnabled(flagToCheck, checking: .buildOnly)
logger.log(
"Feature flag status",
level: .info,
category: .experiments,
extra: [flagToCheck.rawValue: "\(featureFlagStatus)"]
)
return featureFlagStatus
}
// MARK: Computed vars
lazy var isBottomSearchBar: Bool = {
guard isSearchBarLocationFeatureEnabled else { return false }
return searchBarPosition == .bottom
}()
var topTabsVisible: Bool {
return topTabsViewController != nil
}
// MARK: Data management
let profile: Profile
let tabManager: TabManager
let crashTracker: CrashTracker
let ratingPromptManager: RatingPromptManager
private var browserViewControllerState: BrowserViewControllerState?
var appAuthenticator: AppAuthenticationProtocol
let searchEnginesManager: SearchEnginesManager
private let summarizerNimbusUtils: SummarizerNimbusUtils
private var keyboardState: KeyboardState?
// Tracking navigation items to record history types.
var ignoredNavigation = Set<WKNavigation>()
var typedNavigation = [WKNavigation: VisitType]()
// Keep track of allowed `URLRequest`s from `webView(_:decidePolicyFor:decisionHandler:)` so
// that we can obtain the originating `URLRequest` when a `URLResponse` is received. This will
// allow us to re-trigger the `URLRequest` if the user requests a file to be downloaded.
var pendingRequests = [String: URLRequest]()
// This is set when the user taps "Download Link" from the context menu. We then force a
// download of the next request through the `WKNavigationDelegate` that matches this web view.
weak var pendingDownloadWebView: WKWebView?
let downloadQueue: DownloadQueue
let userInitiatedQueue: DispatchQueueInterface
private let bookmarksSaver: BookmarksSaver
let bookmarksHandler: BookmarksHandler
var newTabSettings: NewTabPage {
return NewTabAccessors.getNewTabPage(profile.prefs)
}
private var keyboardPressesHandlerValue: Any?
var toolbarHelper: ToolbarHelperInterface = ToolbarHelper()
@available(iOS 13.4, *)
func keyboardPressesHandler() -> KeyboardPressesHandler {
if let existingHandler = keyboardPressesHandlerValue as? KeyboardPressesHandler {
return existingHandler
} else {
let newHandler = KeyboardPressesHandler()
keyboardPressesHandlerValue = newHandler
return newHandler
}
}
init(
profile: Profile,
tabManager: TabManager,
themeManager: ThemeManager = AppContainer.shared.resolve(),
notificationCenter: NotificationProtocol = NotificationCenter.default,
downloadQueue: DownloadQueue = AppContainer.shared.resolve(),
gleanWrapper: GleanWrapper = DefaultGleanWrapper(),
appStartupTelemetry: AppStartupTelemetry = DefaultAppStartupTelemetry(),
logger: Logger = DefaultLogger.shared,
summarizerNimbusUtils: SummarizerNimbusUtils = DefaultSummarizerNimbusUtils(),
documentLogger: DocumentLogger = AppContainer.shared.resolve(),
appAuthenticator: AppAuthenticationProtocol = AppAuthenticator(),
searchEnginesManager: SearchEnginesManager = AppContainer.shared.resolve(),
userInitiatedQueue: DispatchQueueInterface = DispatchQueue.global(qos: .userInitiated),
recordVisitManager: RecordVisitObserving? = nil
) {
self.summarizerNimbusUtils = summarizerNimbusUtils
self.profile = profile
self.tabManager = tabManager
self.windowUUID = tabManager.windowUUID
self.themeManager = themeManager
self.notificationCenter = notificationCenter
self.crashTracker = DefaultCrashTracker()
self.ratingPromptManager = RatingPromptManager(prefs: profile.prefs, crashTracker: crashTracker)
self.downloadQueue = downloadQueue
self.appStartupTelemetry = appStartupTelemetry
self.logger = logger
self.documentLogger = documentLogger
self.appAuthenticator = appAuthenticator
self.searchEnginesManager = searchEnginesManager
self.bookmarksSaver = DefaultBookmarksSaver(profile: profile)
self.bookmarksHandler = profile.places
self.zoomManager = ZoomPageManager(windowUUID: tabManager.windowUUID)
self.tabsPanelTelemetry = TabsPanelTelemetry(gleanWrapper: gleanWrapper, logger: logger)
self.userInitiatedQueue = userInitiatedQueue
self.recordVisitManager = recordVisitManager ?? RecordVisitObservationManager(historyHandler: profile.places)
super.init(nibName: nil, bundle: nil)
didInit()
}
required init?(coder aDecoder: NSCoder) {
fatalError("init(coder:) has not been implemented")
}
deinit {
// TODO: FXIOS-13097 This is a work around until we can leverage isolated deinits
guard Thread.isMainThread else {
assertionFailure("AddressBarPanGestureHandler was not deallocated on the main thread. Observer was not removed")
return
}
MainActor.assumeIsolated {
logger.log("BVC deallocating (window: \(windowUUID))", level: .info, category: .lifecycle)
unsubscribeFromRedux()
observedWebViews.forEach({ stopObserving(webView: $0) })
}
}
override var prefersStatusBarHidden: Bool {
return false
}
override var preferredStatusBarStyle: UIStatusBarStyle {
return switch currentTheme().type {
case .dark, .nightMode, .privateMode:
.lightContent
case .light:
.darkContent
}
}
override var supportedInterfaceOrientations: UIInterfaceOrientationMask {
if UIDevice.current.userInterfaceIdiom == .phone {
return .allButUpsideDown
} else {
return .all
}
}
private func didInit() {
tabManager.addDelegate(self)
tabManager.setNavigationDelegate(self)
downloadQueue.addDelegate(self)
let tabWindowUUID = tabManager.windowUUID
AppEventQueue.wait(for: [.startupFlowComplete, .tabRestoration(tabWindowUUID)]) { [weak self] in
ensureMainThread { [weak self] in
// Ensure we call into didBecomeActive at least once during startup flow (if needed)
guard !AppEventQueue.activityIsCompleted(.browserUpdatedForAppActivation(tabWindowUUID)) else { return }
self?.browserDidBecomeActive()
}
}
crashTracker.updateData()
ratingPromptManager.showRatingPromptIfNeeded()
_ = RelayController.shared // Ensure RelayController is init'd early to allow for account notification observers.
}
private func didAddPendingBlobDownloadToQueue() {
pendingDownloadWebView = nil
}
/// If user manually opens the keyboard and presses undo, the app switches to the last
/// open tab, and because of that we need to leave overlay state
func didTapUndoCloseAllTabToast(notificationWindowUUID: WindowUUID?) {
guard let notificationWindowUUID, windowUUID == notificationWindowUUID else { return }
overlayManager.switchTab(shouldCancelLoading: true)
}
func didFinishAnnouncement(announcementText: String?) {
if let announcementText {
let saveSuccessMessage: String = .CreditCard.RememberCreditCard.CreditCardSaveSuccessToastMessage
let updateSuccessMessage: String = .CreditCard.UpdateCreditCard.CreditCardUpdateSuccessToastMessage
if announcementText == saveSuccessMessage || announcementText == updateSuccessMessage {
UIAccessibility.post(
notification: .layoutChanged,
argument: self.tabManager.selectedTab?.currentWebView()
)
}
}
}
func searchBarPositionDidChange(newSearchBarPosition: SearchBarPosition?) {
guard let newSearchBarPosition else { return }
let searchBarView: TopBottomInterchangeable = addressToolbarContainer
let newPositionIsBottom = newSearchBarPosition == .bottom
let newParent = newPositionIsBottom ? overKeyboardContainer : header
searchBarView.removeFromParent()
searchBarView.addToParent(parent: newParent, addToTop: !newPositionIsBottom)
if isSwipingTabsEnabled {
webPagePreview.invalidateScreenshotData()
}
if let readerModeBar = readerModeBar {
readerModeBar.removeFromParent()
readerModeBar.addToParent(parent: newParent, addToTop: newSearchBarPosition == .bottom)
}
isBottomSearchBar = newPositionIsBottom
updateViewConstraints()
updateHeaderConstraints()
searchBarView.updateConstraints()
updateMicrosurveyConstraints()
updateToolbarDisplay()
if isToolbarTranslucencyRefactorEnabled {
addOrUpdateMaskViewIfNeeded()
}
let action = GeneralBrowserMiddlewareAction(
scrollOffset: scrollController.contentOffset,
toolbarPosition: newSearchBarPosition,
windowUUID: windowUUID,
actionType: GeneralBrowserMiddlewareActionType.toolbarPositionChanged)
store.dispatch(action)
updateSwipingTabs()
}
private func updateToolbarDisplay(scrollOffset: CGFloat? = nil, shouldUpdateBlurViews: Bool = true) {
// move views to the front so the address toolbar shadow doesn't get clipped
if isBottomSearchBar {
overKeyboardContainer.bringSubviewToFront(addressToolbarContainer)
view.bringSubviewToFront(overKeyboardContainer)
} else {
header.bringSubviewToFront(addressToolbarContainer)
view.bringSubviewToFront(header)
}
if shouldUpdateBlurViews {
updateBlurViews(scrollOffset: scrollOffset)
}
}
private func updateBlurViews(scrollOffset: CGFloat? = nil) {
guard toolbarHelper.shouldBlur() else {
topBlurView.alpha = 0
bottomBlurView.isHidden = true
header.isClearBackground = false
overKeyboardContainer.isClearBackground = false
bottomContainer.isClearBackground = false
contentContainer.mask = nil
return
}
let enableBlur = isToolbarTranslucencyEnabled
let showNavToolbar = toolbarHelper.shouldShowNavigationToolbar(for: traitCollection)
let theme = themeManager.getCurrentTheme(for: windowUUID)
let isKeyboardShowing = keyboardState != nil
let isScrollAlphaZero = if #available(iOS 26.0, *) {
store.state.screenState(
ToolbarState.self,
for: .toolbar,
window: windowUUID
)?.scrollAlpha == 0 } else { false }
if isBottomSearchBar {
header.isClearBackground = false
// Prevent homepage from showing behind the keyboard when content isn't scrollable.
// Only clear background if content exceeds viewport height.
let shouldClearBackground: Bool = {
guard let webView = tabManager.selectedTab?.webView else { return false }
return isScrollAlphaZero && webView.scrollView.contentSize.height > view.bounds.height
}()
// we disable the translucency when the keyboard is getting displayed
overKeyboardContainer.isClearBackground = (enableBlur && !isKeyboardShowing) || shouldClearBackground
let isFxHomeTab = tabManager.selectedTab?.isFxHomeTab ?? false
let offset = scrollOffset ?? statusBarOverlay.scrollOffset
topBlurView.alpha = isFxHomeTab ? offset : 1
} else {
header.isClearBackground = enableBlur
overKeyboardContainer.isClearBackground = false
topBlurView.alpha = 1
}
bottomContainer.isClearBackground = showNavToolbar && enableBlur
bottomBlurView.isHidden = (!showNavToolbar && !isBottomSearchBar && enableBlur) || isScrollAlphaZero
bottomContainer.isHidden = isScrollAlphaZero
if !isToolbarTranslucencyRefactorEnabled {
let maskView = UIView(frame: CGRect(x: 0,
y: -contentContainer.frame.origin.y,
width: view.frame.width,
height: view.frame.height))
maskView.backgroundColor = .black
contentContainer.mask = maskView
}
let views: [UIView] = [header, overKeyboardContainer, bottomContainer, statusBarOverlay]
views.forEach {
($0 as? ThemeApplicable)?.applyTheme(theme: theme)
if !isToolbarTranslucencyRefactorEnabled {
$0.setNeedsLayout()
$0.layoutIfNeeded()
}
}
}
// Adds or updates the mask for the content container that ensures the content is extending
// under the toolbars but not leading and trailing (would show during swiping tabs)
private func addOrUpdateMaskViewIfNeeded() {
guard toolbarHelper.shouldBlur() else { return }
let frame = CGRect(x: 0,
y: -contentContainer.frame.origin.y,
width: view.frame.width,
height: view.frame.height)
// if we already have a mask update the frame
if let mask = contentContainer.mask {
mask.frame = frame
} else {
let maskView = UIView(frame: frame)
maskView.backgroundColor = .black
contentContainer.mask = maskView
}
}
fileprivate func appMenuBadgeUpdate() {
let isActionNeeded = RustFirefoxAccounts.shared.isActionNeeded
let showWarningBadge = isActionNeeded
let shouldShowWarningBadge = store.state.screenState(
ToolbarState.self,
for: .toolbar,
window: windowUUID
)?.showMenuWarningBadge
guard showWarningBadge != shouldShowWarningBadge else { return }
let action = ToolbarAction(
showMenuWarningBadge: showWarningBadge,
windowUUID: self.windowUUID,
actionType: ToolbarActionType.showMenuWarningBadge
)
store.dispatch(action)
}
private func updateAddressToolbarContainerPosition(for traitCollection: UITraitCollection) {
guard searchBarPosition == .bottom, isSearchBarLocationFeatureEnabled else { return }
let isNavToolbar = toolbarHelper.shouldShowNavigationToolbar(for: traitCollection)
let newPosition: SearchBarPosition = isNavToolbar ? .bottom : .top
let notificationObject = [PrefsKeys.FeatureFlags.SearchBarPosition: newPosition]
notificationCenter.post(name: .SearchBarPositionDidChange, withObject: notificationObject)
}
func updateToolbarStateForTraitCollection(_ newCollection: UITraitCollection) {
guard let toolbarState = store.state.screenState(ToolbarState.self, for: .toolbar, window: windowUUID)
else { return }
let showNavToolbar = toolbarHelper.shouldShowNavigationToolbar(for: newCollection)
let showTopTabs = toolbarHelper.shouldShowTopTabs(for: newCollection)
let isShowingNavigationToolbar = toolbarState.isShowingNavigationToolbar
let needsUpdate = toolbarState.isShowingTopTabs != showTopTabs || isShowingNavigationToolbar != showNavToolbar
let needsUpdateTranslucencyRefactor = isToolbarTranslucencyRefactorEnabled && needsUpdate
// Only update the UI when the value of top tabs or navigation toolbar being shown
// is different from what is saved in the state (with toolbar translucency refactor turned on)
// else if toolbar translucency refactor is off update the UI
guard needsUpdateTranslucencyRefactor || !isToolbarTranslucencyRefactorEnabled
else { return }
if showNavToolbar {
navigationToolbarContainer.isHidden = false
navigationToolbarContainer.applyTheme(theme: currentTheme())
updateTabCountUsingTabManager(self.tabManager)
} else {
navigationToolbarContainer.isHidden = true
}
updateToolbarStateTraitCollectionIfNecessary(newCollection)
appMenuBadgeUpdate()
updateTopTabs(showTopTabs: showTopTabs)
if !isToolbarTranslucencyRefactorEnabled {
header.setNeedsLayout()
view.layoutSubviews()
}
updateToolbarDisplay()
}
private func updateSwipingTabs() {
guard isSwipingTabsEnabled else { return }
if isBottomSearchBar,
let toolbarState = store.state.screenState(ToolbarState.self, for: .toolbar, window: windowUUID),
!toolbarState.addressToolbar.isEditing {
addressBarPanGestureHandler?.enablePanGestureRecognizer()
addressToolbarContainer.updateSkeletonAddressBarsVisibility(tabManager: tabManager)
} else {
addressBarPanGestureHandler?.disablePanGestureRecognizer()
addressToolbarContainer.hideSkeletonBars()
}
}
private func updateTopTabs(showTopTabs: Bool) {
if showTopTabs, topTabsViewController == nil {
setupTopTabsViewController()
topTabsViewController?.applyTheme()
} else if showTopTabs, topTabsViewController != nil {
topTabsViewController?.applyTheme()
} else {
if let topTabsView = topTabsViewController?.view {
header.removeArrangedView(topTabsView)
}
topTabsViewController?.removeFromParent()
topTabsViewController = nil
}
}
func dismissVisibleMenus() {
displayedPopoverController?.dismiss(animated: true)
if self.presentedViewController is PhotonActionSheet {
self.presentedViewController?.dismiss(animated: true, completion: nil)
}
}
func appDidEnterBackgroundNotification() {
displayedPopoverController?.dismiss(animated: false) {
self.updateDisplayedPopoverProperties = nil
self.displayedPopoverController = nil
}
if self.presentedViewController is PhotonActionSheet {
self.presentedViewController?.dismiss(animated: true, completion: nil)
}
// Formerly these calls were run during AppDelegate.didEnterBackground(), but we have
// individual TabManager instances for each BVC, so we perform these here instead.
tabManager.preserveTabs()
logTelemetryForAppDidEnterBackground()
}
@objc
func tappedTopArea() {
scrollController.showToolbars(animated: true)
}
func sceneDidEnterBackgroundNotification(windowScene: UIWindowScene?) {
// Ensure the notification is for the current window scene
guard let currentWindowScene = view.window?.windowScene,
let windowScene,
currentWindowScene === windowScene else { return }
guard canShowPrivacyWindow else { return }
privacyWindowHelper.showWindow(windowScene: currentWindowScene, withThemedColor: currentTheme().colors.layer3)
}
func sceneDidActivateNotification() {
privacyWindowHelper.removeWindow()
}
func appWillResignActiveNotification() {
// Dismiss any popovers that might be visible
displayedPopoverController?.dismiss(animated: false) {
self.updateDisplayedPopoverProperties = nil
self.displayedPopoverController = nil
}
// No need to take a screenshot if a view is presented over the current tab
// because a screenshot will already have been taken when we navigate away
if let tab = tabManager.selectedTab, presentedViewController == nil {
screenshotHelper.takeScreenshot(tab,
windowUUID: windowUUID,
screenshotBounds: CGRect(
x: contentContainer.frame.origin.x,
y: -contentContainer.frame.origin.y,
width: view.frame.width,
height: view.frame.height))
}
guard canShowPrivacyWindow else { return }
privacyWindowHelper.showWindow(windowScene: view.window?.windowScene, withThemedColor: currentTheme().colors.layer3)
}
private var canShowPrivacyWindow: Bool {
// Ensure the selected tab is private and determine if the privacy window can be shown.
guard let privateTab = tabManager.selectedTab, privateTab.isPrivate else { return false }
// Show privacy window if no view controller is presented
// or if the presented view is a PhotonActionSheet.
return self.presentedViewController == nil || presentedViewController is PhotonActionSheet
}
func appDidBecomeActiveNotification() {
processAppleIntelligenceState()
privacyWindowHelper.removeWindow()
if let tab = tabManager.selectedTab, !tab.isFindInPageMode {
// Re-show toolbar which might have been hidden during scrolling (prior to app moving into the background)
if !isMinimalAddressBarEnabled { scrollController.showToolbars(animated: false) }
}
navigationHandler?.showTermsOfUse(context: .appBecameActive)
browserDidBecomeActive()
}
private func processAppleIntelligenceState() {
if #available(iOS 26, *) {
#if canImport(FoundationModels)
AppleIntelligenceUtil().processAvailabilityState()
#endif
}
}
func browserDidBecomeActive() {
let uuid = tabManager.windowUUID
AppEventQueue.started(.browserUpdatedForAppActivation(uuid))
defer { AppEventQueue.completed(.browserUpdatedForAppActivation(uuid)) }
let allWindowUUIDs = (AppContainer.shared.resolve() as WindowManager).windows.keys.map { $0.uuidString.prefix(4) }
logger.log("BrowserDidBecomeActive. UUID = \(windowUUID.uuidString.prefix(4)). All windows: \(allWindowUUIDs)",
level: .info,
category: .lifecycle)