mirror of
https://github.com/vector-im/element-ios.git
synced 2024-09-28 23:32:41 +00:00
645 lines
28 KiB
Swift
645 lines
28 KiB
Swift
// File created from FlowTemplate
|
|
// $ createRootCoordinator.sh Onboarding/SplashScreen Onboarding OnboardingSplashScreen
|
|
/*
|
|
Copyright 2021 New Vector Ltd
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import UIKit
|
|
import CommonKit
|
|
|
|
/// OnboardingCoordinator input parameters
|
|
struct OnboardingCoordinatorParameters {
|
|
|
|
/// The navigation router that manage physical navigation
|
|
let router: NavigationRouterType
|
|
|
|
init(router: NavigationRouterType? = nil) {
|
|
self.router = router ?? NavigationRouter(navigationController: RiotNavigationController(isLockedToPortraitOnPhone: true))
|
|
}
|
|
}
|
|
|
|
@objcMembers
|
|
/// A coordinator to manage the full onboarding flow with pre-auth screens, authentication and setup screens once signed in.
|
|
final class OnboardingCoordinator: NSObject, OnboardingCoordinatorProtocol {
|
|
|
|
// MARK: - Properties
|
|
|
|
// MARK: Private
|
|
|
|
private let parameters: OnboardingCoordinatorParameters
|
|
|
|
// MARK: Navigation State
|
|
private var navigationRouter: NavigationRouterType {
|
|
parameters.router
|
|
}
|
|
/// A strong ref to the legacy authVC as we need to init early to preload its view.
|
|
private let legacyAuthenticationCoordinator: LegacyAuthenticationCoordinator
|
|
/// The currently active authentication coordinator, otherwise `nil`.
|
|
private weak var authenticationCoordinator: AuthenticationCoordinatorProtocol?
|
|
|
|
// MARK: Screen results
|
|
private var splashScreenResult: OnboardingSplashScreenViewModelResult?
|
|
private var useCaseResult: OnboardingUseCaseViewModelResult?
|
|
/// The flow being used for authentication.
|
|
private var authenticationFlow: AuthenticationFlow?
|
|
/// The type of authentication used to login/register.
|
|
private var authenticationType: AuthenticationType?
|
|
private var session: MXSession?
|
|
/// A place to store the image selected in the avatar screen until it has been saved.
|
|
private var selectedAvatar: UIImage?
|
|
private let authenticationService: AuthenticationService = .shared
|
|
|
|
private var indicatorPresenter: UserIndicatorTypePresenterProtocol
|
|
private var loadingIndicator: UserIndicator?
|
|
|
|
private var shouldShowDisplayNameScreen = false
|
|
private var shouldShowAvatarScreen = false
|
|
|
|
/// Whether all of the onboarding steps have been completed or not. `false` if there are more screens to be shown.
|
|
private var onboardingFinished = false
|
|
/// Whether authentication is complete. `true` once authenticated, verified and the app is ready to be shown.
|
|
private var authenticationFinished = false
|
|
|
|
// MARK: Public
|
|
|
|
// Must be used only internally
|
|
var childCoordinators: [Coordinator] = []
|
|
var completion: (() -> Void)?
|
|
|
|
// MARK: - Setup
|
|
|
|
init(parameters: OnboardingCoordinatorParameters) {
|
|
self.parameters = parameters
|
|
|
|
// Preload the legacy authVC (it is *really* slow to load in realtime)
|
|
let params = LegacyAuthenticationCoordinatorParameters(navigationRouter: parameters.router,
|
|
canPresentAdditionalScreens: false)
|
|
legacyAuthenticationCoordinator = LegacyAuthenticationCoordinator(parameters: params)
|
|
|
|
indicatorPresenter = UserIndicatorTypePresenter(presentingViewController: parameters.router.toPresentable())
|
|
|
|
super.init()
|
|
}
|
|
|
|
// MARK: - Public
|
|
|
|
func start() {
|
|
if authenticationService.softLogoutCredentials != nil {
|
|
// show the splash screen and a loading indicator
|
|
if BuildSettings.authScreenShowRegister {
|
|
showSplashScreen()
|
|
} else {
|
|
showEmptyScreen()
|
|
}
|
|
startLoading()
|
|
if BuildSettings.onboardingEnableNewAuthenticationFlow {
|
|
beginAuthentication(with: .login) { [weak self] in
|
|
self?.stopLoading()
|
|
}
|
|
} else {
|
|
showLegacyAuthenticationScreen(forceAsRootModule: true)
|
|
}
|
|
} else if BuildSettings.authScreenShowRegister {
|
|
showSplashScreen()
|
|
} else {
|
|
showLegacyAuthenticationScreen()
|
|
}
|
|
}
|
|
|
|
func toPresentable() -> UIViewController {
|
|
navigationRouter.toPresentable()
|
|
}
|
|
|
|
// MARK: - Pre-Authentication
|
|
|
|
/// Show the onboarding splash screen as the root module in the flow.
|
|
private func showSplashScreen() {
|
|
MXLog.debug("[OnboardingCoordinator] showSplashScreen")
|
|
|
|
let coordinator = OnboardingSplashScreenCoordinator()
|
|
coordinator.completion = { [weak self, weak coordinator] result in
|
|
guard let self = self, let coordinator = coordinator else { return }
|
|
self.splashScreenCoordinator(coordinator, didCompleteWith: result)
|
|
}
|
|
|
|
coordinator.start()
|
|
add(childCoordinator: coordinator)
|
|
|
|
navigationRouter.setRootModule(coordinator) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
}
|
|
|
|
/// Show an empty screen when configuring soft logout flow
|
|
private func showEmptyScreen() {
|
|
MXLog.debug("[OnboardingCoordinator] showEmptyScreen")
|
|
|
|
let viewController = UIViewController()
|
|
viewController.view.backgroundColor = ThemeService.shared().theme.backgroundColor
|
|
navigationRouter.setRootModule(viewController)
|
|
}
|
|
|
|
/// Displays the next view in the flow after the splash screen.
|
|
private func splashScreenCoordinator(_ coordinator: OnboardingSplashScreenCoordinator, didCompleteWith result: OnboardingSplashScreenViewModelResult) {
|
|
splashScreenResult = result
|
|
|
|
// Set the auth type early on the legacy auth to allow network requests to finish during display of the use case screen.
|
|
legacyAuthenticationCoordinator.update(authenticationFlow: result.flow)
|
|
|
|
switch result {
|
|
case .register:
|
|
showUseCaseSelectionScreen()
|
|
case .login:
|
|
if BuildSettings.onboardingEnableNewAuthenticationFlow {
|
|
beginAuthentication(with: .login, onStart: coordinator.stop)
|
|
} else {
|
|
coordinator.stop()
|
|
showLegacyAuthenticationScreen()
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Show the use case screen for new users.
|
|
private func showUseCaseSelectionScreen(animated: Bool = true) {
|
|
MXLog.debug("[OnboardingCoordinator] showUseCaseSelectionScreen")
|
|
|
|
let coordinator = OnboardingUseCaseSelectionCoordinator()
|
|
coordinator.completion = { [weak self, weak coordinator] result in
|
|
guard let self = self, let coordinator = coordinator else { return }
|
|
self.useCaseSelectionCoordinator(coordinator, didCompleteWith: result)
|
|
}
|
|
|
|
coordinator.start()
|
|
add(childCoordinator: coordinator)
|
|
|
|
if navigationRouter.modules.isEmpty {
|
|
navigationRouter.setRootModule(coordinator) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
} else {
|
|
navigationRouter.push(coordinator, animated: animated) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Displays the next view in the flow after the use case screen.
|
|
private func useCaseSelectionCoordinator(_ coordinator: OnboardingUseCaseSelectionCoordinator, didCompleteWith result: OnboardingUseCaseViewModelResult) {
|
|
useCaseResult = result
|
|
|
|
guard BuildSettings.onboardingEnableNewAuthenticationFlow else {
|
|
showLegacyAuthenticationScreen()
|
|
coordinator.stop()
|
|
return
|
|
}
|
|
|
|
beginAuthentication(with: .registration, onStart: coordinator.stop)
|
|
}
|
|
|
|
// MARK: - Authentication
|
|
|
|
/// Show the authentication flow, starting at the specified initial screen.
|
|
private func beginAuthentication(with initialScreen: AuthenticationCoordinator.EntryPoint, onStart: (() -> Void)? = nil) {
|
|
MXLog.debug("[OnboardingCoordinator] beginAuthentication")
|
|
|
|
let parameters = AuthenticationCoordinatorParameters(navigationRouter: navigationRouter,
|
|
initialScreen: initialScreen,
|
|
canPresentAdditionalScreens: false)
|
|
let coordinator = AuthenticationCoordinator(parameters: parameters)
|
|
coordinator.callback = { [weak self, weak coordinator] result in
|
|
guard let self = self, let coordinator = coordinator else { return }
|
|
|
|
switch result {
|
|
case .didStart:
|
|
onStart?()
|
|
case .didLogin(let session, let authenticationFlow, let authenticationType):
|
|
self.authenticationCoordinator(coordinator, didLoginWith: session, and: authenticationFlow, using: authenticationType)
|
|
case .didComplete:
|
|
self.authenticationCoordinatorDidComplete(coordinator)
|
|
case .clearAllData:
|
|
self.showClearAllDataConfirmation()
|
|
case .cancel(let flow):
|
|
self.cancelAuthentication(flow: flow)
|
|
}
|
|
}
|
|
authenticationCoordinator = coordinator
|
|
|
|
add(childCoordinator: coordinator)
|
|
coordinator.start()
|
|
}
|
|
|
|
/// Show the legacy authentication screen. Any parameters that have been set in previous screens are be applied.
|
|
/// - Parameter forceAsRootModule: Force setting the module as root instead of pushing
|
|
private func showLegacyAuthenticationScreen(forceAsRootModule: Bool = false) {
|
|
MXLog.debug("[OnboardingCoordinator] showLegacyAuthenticationScreen")
|
|
|
|
let coordinator = legacyAuthenticationCoordinator
|
|
coordinator.callback = { [weak self, weak coordinator] result in
|
|
guard let self = self, let coordinator = coordinator else { return }
|
|
|
|
switch result {
|
|
case .didLogin(let session, let authenticationFlow, let authenticationType):
|
|
self.authenticationCoordinator(coordinator, didLoginWith: session, and: authenticationFlow, using: authenticationType)
|
|
case .didComplete:
|
|
self.authenticationCoordinatorDidComplete(coordinator)
|
|
case .clearAllData:
|
|
self.showClearAllDataConfirmation()
|
|
case .didStart, .cancel:
|
|
// These results are only sent by the new flow.
|
|
break
|
|
}
|
|
}
|
|
|
|
authenticationCoordinator = coordinator
|
|
|
|
coordinator.start()
|
|
add(childCoordinator: coordinator)
|
|
|
|
if navigationRouter.modules.isEmpty || forceAsRootModule {
|
|
navigationRouter.setRootModule(coordinator, popCompletion: nil)
|
|
} else {
|
|
navigationRouter.push(coordinator, animated: true) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
}
|
|
stopLoading()
|
|
}
|
|
|
|
/// Cancels the registration flow, returning to the Use Case screen.
|
|
private func cancelAuthentication(flow: AuthenticationFlow) {
|
|
switch flow {
|
|
case .register:
|
|
navigationRouter.popAllModules(animated: false)
|
|
|
|
showSplashScreen()
|
|
showUseCaseSelectionScreen(animated: false)
|
|
case .login:
|
|
navigationRouter.popAllModules(animated: false)
|
|
|
|
showSplashScreen()
|
|
}
|
|
}
|
|
|
|
/// Displays the next view in the flow after the authentication screens,
|
|
/// whilst crypto and the rest of the app is launching in the background.
|
|
private func authenticationCoordinator(_ coordinator: AuthenticationCoordinatorProtocol,
|
|
didLoginWith session: MXSession,
|
|
and authenticationFlow: AuthenticationFlow,
|
|
using authenticationType: AuthenticationType) {
|
|
self.session = session
|
|
self.authenticationFlow = authenticationFlow
|
|
self.authenticationType = authenticationType
|
|
|
|
// Check whether another screen should be shown.
|
|
if authenticationFlow == .register,
|
|
let userId = session.credentials.userId,
|
|
let userSession = UserSessionsService.shared.userSession(withUserId: userId) {
|
|
// Skip personalisation when a generic SSO provider was used in case it already included the same steps.
|
|
let shouldShowPersonalization = BuildSettings.onboardingShowAccountPersonalization && authenticationType.analyticsType != .SSO
|
|
|
|
// If personalisation is to be shown, check that the homeserver supports it otherwise show the congratulations screen
|
|
if shouldShowPersonalization {
|
|
checkHomeserverCapabilities(for: userSession)
|
|
return
|
|
} else {
|
|
showCongratulationsScreen(for: userSession)
|
|
return
|
|
}
|
|
} else if Analytics.shared.shouldShowAnalyticsPrompt {
|
|
showAnalyticsPrompt(for: session)
|
|
return
|
|
}
|
|
|
|
// Otherwise onboarding is finished.
|
|
onboardingFinished = true
|
|
completeIfReady()
|
|
}
|
|
|
|
/// Checks the capabilities of the user's homeserver in order to determine
|
|
/// whether or not the display name and avatar can be updated.
|
|
///
|
|
/// Once complete this method will start the post authentication flow automatically.
|
|
private func checkHomeserverCapabilities(for userSession: UserSession) {
|
|
userSession.matrixSession.matrixRestClient.capabilities { [weak self] capabilities in
|
|
guard let self = self else { return }
|
|
self.shouldShowDisplayNameScreen = capabilities?.setDisplayName?.isEnabled == true
|
|
self.shouldShowAvatarScreen = capabilities?.setAvatarUrl?.isEnabled == true
|
|
|
|
self.beginPostAuthentication(for: userSession)
|
|
} failure: { [weak self] _ in
|
|
MXLog.warning("[OnboardingCoordinator] Homeserver capabilities not returned. Skipping personalisation")
|
|
self?.beginPostAuthentication(for: userSession)
|
|
}
|
|
}
|
|
|
|
/// Completes the onboarding flow if possible, otherwise waits for any remaining screens.
|
|
private func authenticationCoordinatorDidComplete(_ coordinator: AuthenticationCoordinatorProtocol) {
|
|
// Handle the chosen use case where applicable
|
|
if authenticationFlow == .register,
|
|
let useCase = useCaseResult?.userSessionPropertyValue,
|
|
let userSession = UserSessionsService.shared.mainUserSession {
|
|
// Store the value in the user's session
|
|
userSession.userProperties.useCase = useCase
|
|
|
|
// Update the analytics user properties with the use case
|
|
Analytics.shared.updateUserProperties(ftueUseCase: useCase)
|
|
}
|
|
|
|
// This method is only called when the app is ready so we can complete if finished
|
|
authenticationFinished = true
|
|
completeIfReady()
|
|
}
|
|
|
|
// MARK: - Post-Authentication
|
|
|
|
/// Starts the part of the flow that comes after authentication for new users.
|
|
private func beginPostAuthentication(for userSession: UserSession) {
|
|
showCongratulationsScreen(for: userSession)
|
|
}
|
|
|
|
/// Show the congratulations screen for new users. The screen will be configured based on the homeserver's capabilities.
|
|
private func showCongratulationsScreen(for userSession: UserSession) {
|
|
MXLog.debug("[OnboardingCoordinator] showCongratulationsScreen")
|
|
|
|
let parameters = OnboardingCongratulationsCoordinatorParameters(userSession: userSession,
|
|
personalizationDisabled: !shouldShowDisplayNameScreen && !shouldShowAvatarScreen)
|
|
let coordinator = OnboardingCongratulationsCoordinator(parameters: parameters)
|
|
|
|
coordinator.completion = { [weak self, weak coordinator] result in
|
|
guard let self = self, let coordinator = coordinator else { return }
|
|
self.congratulationsCoordinator(coordinator, didCompleteWith: result)
|
|
}
|
|
|
|
add(childCoordinator: coordinator)
|
|
coordinator.start()
|
|
|
|
// Navigating back doesn't make any sense now, so replace the whole stack.
|
|
navigationRouter.setRootModule(coordinator, hideNavigationBar: true, animated: true) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
}
|
|
|
|
/// Displays the next view in the flow after the congratulations screen.
|
|
private func congratulationsCoordinator(_ coordinator: OnboardingCongratulationsCoordinator, didCompleteWith result: OnboardingCongratulationsCoordinatorResult) {
|
|
switch result {
|
|
case .personalizeProfile(let userSession):
|
|
if shouldShowDisplayNameScreen {
|
|
showDisplayNameScreen(for: userSession)
|
|
return
|
|
} else if shouldShowAvatarScreen {
|
|
showAvatarScreen(for: userSession)
|
|
return
|
|
} else if Analytics.shared.shouldShowAnalyticsPrompt {
|
|
showAnalyticsPrompt(for: userSession.matrixSession)
|
|
return
|
|
}
|
|
case .takeMeHome(let userSession):
|
|
if Analytics.shared.shouldShowAnalyticsPrompt {
|
|
showAnalyticsPrompt(for: userSession.matrixSession)
|
|
return
|
|
}
|
|
}
|
|
|
|
onboardingFinished = true
|
|
completeIfReady()
|
|
}
|
|
|
|
/// Show the display name personalization screen for new users using the supplied user session.
|
|
private func showDisplayNameScreen(for userSession: UserSession) {
|
|
MXLog.debug("[OnboardingCoordinator]: showDisplayNameScreen")
|
|
|
|
let parameters = OnboardingDisplayNameCoordinatorParameters(userSession: userSession)
|
|
let coordinator = OnboardingDisplayNameCoordinator(parameters: parameters)
|
|
|
|
coordinator.completion = { [weak self, weak coordinator] userSession in
|
|
guard let self = self, let coordinator = coordinator else { return }
|
|
self.displayNameCoordinator(coordinator, didCompleteWith: userSession)
|
|
}
|
|
|
|
add(childCoordinator: coordinator)
|
|
coordinator.start()
|
|
|
|
navigationRouter.setRootModule(coordinator, hideNavigationBar: false, animated: true) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
}
|
|
|
|
/// Displays the next view in the flow after the display name screen.
|
|
private func displayNameCoordinator(_ coordinator: OnboardingDisplayNameCoordinator, didCompleteWith userSession: UserSession) {
|
|
if shouldShowAvatarScreen {
|
|
showAvatarScreen(for: userSession)
|
|
} else {
|
|
showCelebrationScreen(for: userSession)
|
|
}
|
|
}
|
|
|
|
/// Show the avatar personalization screen for new users using the supplied user session.
|
|
private func showAvatarScreen(for userSession: UserSession) {
|
|
MXLog.debug("[OnboardingCoordinator]: showAvatarScreen")
|
|
|
|
let parameters = OnboardingAvatarCoordinatorParameters(userSession: userSession, avatar: selectedAvatar)
|
|
let coordinator = OnboardingAvatarCoordinator(parameters: parameters)
|
|
|
|
coordinator.callback = { [weak self, weak coordinator] result in
|
|
guard let self = self, let coordinator = coordinator else { return }
|
|
|
|
switch result {
|
|
case .selectedAvatar(let image):
|
|
// Store the avatar so that if the user navigates back to the display name
|
|
// screen we can show the chosen image again when the avatar screen is pushed.
|
|
self.selectedAvatar = image
|
|
case .complete(let userSession):
|
|
self.avatarCoordinator(coordinator, didCompleteWith: userSession)
|
|
}
|
|
}
|
|
|
|
add(childCoordinator: coordinator)
|
|
coordinator.start()
|
|
|
|
if navigationRouter.modules.isEmpty || !shouldShowDisplayNameScreen {
|
|
navigationRouter.setRootModule(coordinator, hideNavigationBar: false, animated: true) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
} else {
|
|
navigationRouter.push(coordinator, animated: true) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Displays the next view in the flow after the avatar screen.
|
|
private func avatarCoordinator(_ coordinator: OnboardingAvatarCoordinator, didCompleteWith userSession: UserSession) {
|
|
showCelebrationScreen(for: userSession)
|
|
|
|
// It is no longer possible to navigate backwards so forget the selected avatar
|
|
selectedAvatar = nil
|
|
}
|
|
|
|
private func showCelebrationScreen(for userSession: UserSession) {
|
|
MXLog.debug("[OnboardingCoordinator] showCelebrationScreen")
|
|
|
|
let parameters = OnboardingCelebrationCoordinatorParameters(userSession: userSession)
|
|
let coordinator = OnboardingCelebrationCoordinator(parameters: parameters)
|
|
|
|
coordinator.completion = { [weak self, weak coordinator] userSession in
|
|
guard let self = self, let coordinator = coordinator else { return }
|
|
self.celebrationCoordinator(coordinator, didCompleteWith: userSession)
|
|
}
|
|
|
|
add(childCoordinator: coordinator)
|
|
coordinator.start()
|
|
|
|
navigationRouter.setRootModule(coordinator, hideNavigationBar: true, animated: true) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
}
|
|
|
|
private func celebrationCoordinator(_ coordinator: OnboardingCelebrationCoordinator, didCompleteWith userSession: UserSession) {
|
|
if Analytics.shared.shouldShowAnalyticsPrompt {
|
|
showAnalyticsPrompt(for: userSession.matrixSession)
|
|
return
|
|
}
|
|
|
|
onboardingFinished = true
|
|
completeIfReady()
|
|
}
|
|
|
|
/// Shows the analytics prompt for the supplied session.
|
|
///
|
|
/// Check `Analytics.shared.shouldShowAnalyticsPrompt` before calling this method.
|
|
private func showAnalyticsPrompt(for session: MXSession) {
|
|
MXLog.debug("[OnboardingCoordinator]: Invite the user to send analytics")
|
|
|
|
let parameters = AnalyticsPromptCoordinatorParameters(session: session)
|
|
let coordinator = AnalyticsPromptCoordinator(parameters: parameters)
|
|
|
|
coordinator.completion = { [weak self, weak coordinator] in
|
|
guard let self = self, let coordinator = coordinator else { return }
|
|
self.analyticsPromptCoordinatorDidComplete(coordinator)
|
|
}
|
|
|
|
add(childCoordinator: coordinator)
|
|
coordinator.start()
|
|
|
|
// TODO: Re-asses replacing the stack based on the previous screen once the whole flow is implemented
|
|
navigationRouter.setRootModule(coordinator, hideNavigationBar: true, animated: true) { [weak self] in
|
|
self?.remove(childCoordinator: coordinator)
|
|
}
|
|
}
|
|
|
|
/// Displays the next view in the flow after the analytics screen.
|
|
private func analyticsPromptCoordinatorDidComplete(_ coordinator: AnalyticsPromptCoordinator) {
|
|
onboardingFinished = true
|
|
completeIfReady()
|
|
}
|
|
|
|
// MARK: - Finished
|
|
|
|
/// Calls the coordinator's completion handler if both `onboardingFinished` and `authenticationFinished`
|
|
/// are true. Otherwise displays any pending screens and waits to be called again.
|
|
private func completeIfReady() {
|
|
guard onboardingFinished else {
|
|
MXLog.debug("[OnboardingCoordinator] Delaying onboarding completion until all screens have been shown.")
|
|
return
|
|
}
|
|
|
|
guard authenticationFinished else {
|
|
guard let authenticationCoordinator = authenticationCoordinator else {
|
|
MXLog.failure("[OnboardingCoordinator] completeIfReady: authenticationCoordinator is missing.")
|
|
return
|
|
}
|
|
|
|
MXLog.debug("[OnboardingCoordinator] Allowing AuthenticationCoordinator to display any remaining screens.")
|
|
authenticationCoordinator.presentPendingScreensIfNecessary()
|
|
return
|
|
}
|
|
|
|
trackSignup()
|
|
|
|
completion?()
|
|
|
|
// Reset the authentication service back to using matrix.org
|
|
authenticationService.reset(useDefaultServer: true)
|
|
}
|
|
|
|
/// Sends a signup event to the Analytics class if onboarding has completed via the register flow.
|
|
private func trackSignup() {
|
|
guard authenticationFlow == .register else { return }
|
|
guard let authenticationType = authenticationType else {
|
|
MXLog.warning("[OnboardingCoordinator] sendSignedEvent: Registration finished without collecting an authentication type.")
|
|
return
|
|
}
|
|
|
|
Analytics.shared.trackSignup(authenticationType: authenticationType.analyticsType)
|
|
}
|
|
|
|
/// Show an activity indicator whilst loading.
|
|
private func startLoading() {
|
|
loadingIndicator = indicatorPresenter.present(.loading(label: VectorL10n.loading, isInteractionBlocking: true))
|
|
}
|
|
|
|
/// Hide the currently displayed activity indicator.
|
|
private func stopLoading() {
|
|
loadingIndicator = nil
|
|
}
|
|
|
|
/// Shows a confirmation to clear all data, and proceeds to do so if the user confirms.
|
|
private func showClearAllDataConfirmation() {
|
|
let alertController = UIAlertController(title: VectorL10n.authSoftlogoutClearDataSignOutTitle,
|
|
message: VectorL10n.authSoftlogoutClearDataSignOutMsg,
|
|
preferredStyle: .alert)
|
|
alertController.addAction(UIAlertAction(title: VectorL10n.cancel, style: .cancel, handler: nil))
|
|
alertController.addAction(UIAlertAction(title: VectorL10n.authSoftlogoutClearDataSignOut, style: .destructive) { [weak self] action in
|
|
guard let self = self else { return }
|
|
MXLog.debug("[OnboardingCoordinator] showClearAllDataConfirmation: clear all data after soft logout")
|
|
self.authenticationService.reset()
|
|
self.authenticationFinished = false
|
|
self.cancelAuthentication(flow: .login)
|
|
AppDelegate.theDelegate().logoutSendingRequestServer(true, completion: nil)
|
|
})
|
|
|
|
navigationRouter.present(alertController, animated: true)
|
|
}
|
|
}
|
|
|
|
// MARK: - Helpers
|
|
|
|
extension OnboardingSplashScreenViewModelResult {
|
|
/// The result converted into an authentication flow.
|
|
var flow: AuthenticationFlow {
|
|
switch self {
|
|
case .login:
|
|
return .login
|
|
case .register:
|
|
return .register
|
|
}
|
|
}
|
|
}
|
|
|
|
extension OnboardingUseCaseViewModelResult {
|
|
/// The result converted into the type stored in the user session.
|
|
var userSessionPropertyValue: UserSessionProperties.UseCase {
|
|
switch self {
|
|
case .personalMessaging:
|
|
return .personalMessaging
|
|
case .workMessaging:
|
|
return .workMessaging
|
|
case .communityMessaging:
|
|
return .communityMessaging
|
|
case .skipped:
|
|
return .skipped
|
|
}
|
|
}
|
|
}
|