Add AppLockSetupPINScreen. (#1930)

2026-11-02 03:06:37 +00:00 · 2023-10-23 10:07:13 +01:00
parent ceee6b1853
commit 5356a56a00
27 changed files with 811 additions and 7 deletions
@@ -0,0 +1,130 @@
+//
+// Copyright 2022 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 Combine
+import SwiftUI
+
+typealias AppLockSetupPINScreenViewModelType = StateStoreViewModel<AppLockSetupPINScreenViewState, AppLockSetupPINScreenViewAction>
+
+class AppLockSetupPINScreenViewModel: AppLockSetupPINScreenViewModelType, AppLockSetupPINScreenViewModelProtocol {
+    private let appLockService: AppLockServiceProtocol
+    private var actionsSubject: PassthroughSubject<AppLockSetupPINScreenViewModelAction, Never> = .init()
+    
+    /// The PIN entered by the user in `.create` mode, used for confirmation.
+    var newPIN: String?
+    
+    var actions: AnyPublisher<AppLockSetupPINScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+
+    init(initialMode: AppLockSetupPINScreenMode, appLockService: AppLockServiceProtocol) {
+        self.appLockService = appLockService
+        super.init(initialViewState: AppLockSetupPINScreenViewState(mode: initialMode, bindings: .init(pinCode: "")))
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: AppLockSetupPINScreenViewAction) {
+        MXLog.info("View model: received view action: \(viewAction)")
+        
+        switch viewAction {
+        case .submitPINCode:
+            submitPINCode()
+        case .cancel:
+            actionsSubject.send(.cancel)
+        }
+    }
+    
+    // MARK: - Private
+    
+    /// Handle the entered PIN code.
+    private func submitPINCode() {
+        switch state.mode {
+        case .create:
+            createPIN()
+        case .confirm:
+            confirmPIN()
+        case .unlock:
+            unlock()
+        }
+    }
+    
+    /// Handles a PIN input from the create mode. Transitions to confirmation if valid.
+    private func createPIN() {
+        let pinCode = state.bindings.pinCode
+        if case let .failure(error) = appLockService.validate(pinCode) {
+            MXLog.warning("PIN rejected: \(error)")
+            handleError(.weakPIN)
+            return
+        }
+        
+        newPIN = pinCode
+        state.mode = .confirm
+        state.bindings.pinCode = ""
+    }
+    
+    /// Handles a PIN input from the confirm mode. Stores the pin if it matches.
+    private func confirmPIN() {
+        let pinCode = state.bindings.pinCode
+        guard pinCode == newPIN else {
+            MXLog.warning("PIN mismatch.")
+            handleError(.pinMismatch)
+            return
+        }
+        
+        if case let .failure(error) = appLockService.setupPINCode(pinCode) {
+            MXLog.warning("Failed to set PIN: \(error)")
+            if case .keychainError = error {
+                handleError(.failedToSetPIN)
+                return
+            } else {
+                handleError(.weakPIN) // Shouldn't really happen but just in case.
+                return
+            }
+        }
+         
+        actionsSubject.send(.complete)
+    }
+    
+    /// Handles a PIN input for the unlock mode.
+    private func unlock() {
+        guard appLockService.unlock(with: state.bindings.pinCode) else {
+            // show an error
+            // https://www.figma.com/file/0MMNu7cTOzLOlWb7ctTkv3?node-id=13067:107631&mode=dev#591068578
+            state.bindings.pinCode = ""
+            return
+        }
+        
+        actionsSubject.send(.complete)
+    }
+    
+    private func handleError(_ error: AppLockSetupPINScreenAlertType) {
+        switch error {
+        case .weakPIN:
+            state.bindings.alertInfo = .init(id: error,
+                                             title: L10n.screenAppLockSetupPinBlacklistedDialogTitle,
+                                             message: L10n.screenAppLockSetupPinBlacklistedDialogContent,
+                                             primaryButton: .init(title: L10n.actionOk) { self.state.bindings.pinCode = "" })
+        case .pinMismatch:
+            state.bindings.alertInfo = .init(id: error,
+                                             title: L10n.screenAppLockSetupPinMismatchDialogTitle,
+                                             message: L10n.screenAppLockSetupPinMismatchDialogContent,
+                                             primaryButton: .init(title: L10n.actionTryAgain) { self.state.bindings.pinCode = "" })
+        case .failedToSetPIN:
+            state.bindings.alertInfo = .init(id: error)
+        }
+    }
+}