Add AppLockSetupPINScreen. (#1930)

2026-11-02 21:33:26 +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,89 @@
+//
+// 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 Compound
+import SwiftUI
+
+/// The screen shown to unlock the App Lock settings or to create a new PIN and enable the feature.
+struct AppLockSetupPINScreen: View {
+    @ObservedObject var context: AppLockSetupPINScreenViewModel.Context
+    
+    var body: some View {
+        ScrollView {
+            VStack(spacing: 48) {
+                header
+                
+                PINTextField(pinCode: $context.pinCode,
+                             isSecure: context.viewState.mode == .unlock)
+                    .onChange(of: context.pinCode) { newValue in
+                        guard newValue.count == 4 else { return }
+                        context.send(viewAction: .submitPINCode)
+                    }
+            }
+            .padding(.horizontal, 16)
+            .padding(.top, UIConstants.iconTopPaddingToNavigationBar)
+            .frame(maxWidth: .infinity)
+        }
+        .background(Color.compound.bgCanvasDefault.ignoresSafeArea())
+    }
+    
+    var header: some View {
+        VStack(spacing: 8) {
+            HeroImage(image: Image(systemSymbol: .lock))
+                .symbolVariant(.fill)
+                .padding(.bottom, 8)
+            
+            Text(context.viewState.title)
+                .font(.compound.headingMDBold)
+                .multilineTextAlignment(.center)
+                .foregroundColor(.compound.textPrimary)
+            
+            if let subtitle = context.viewState.subtitle {
+                Text(subtitle)
+                    .font(.compound.bodyMD)
+                    .multilineTextAlignment(.center)
+                    .foregroundColor(.compound.textSecondary)
+            }
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct AppLockSetupPINScreen_Previews: PreviewProvider, TestablePreview {
+    static let service = AppLockService(keychainController: KeychainControllerMock(),
+                                        appSettings: ServiceLocator.shared.settings)
+    static let createViewModel = AppLockSetupPINScreenViewModel(initialMode: .create, appLockService: service)
+    static let confirmViewModel = AppLockSetupPINScreenViewModel(initialMode: .confirm, appLockService: service)
+    static let unlockViewModel = AppLockSetupPINScreenViewModel(initialMode: .unlock, appLockService: service)
+    
+    static var previews: some View {
+        NavigationStack {
+            AppLockSetupPINScreen(context: createViewModel.context)
+        }
+        .previewDisplayName("Create")
+        
+        NavigationStack {
+            AppLockSetupPINScreen(context: confirmViewModel.context)
+        }
+        .previewDisplayName("Confirm")
+        
+        NavigationStack {
+            AppLockSetupPINScreen(context: unlockViewModel.context)
+        }
+        .previewDisplayName("Unlock")
+    }
+}
@@ -0,0 +1,125 @@
+//
+// Copyright 2023 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 SwiftUI
+
+/// A text field that enables secure entry of a numerical PIN code.
+/// The view itself handles validation and the base text field type.
+struct PINTextField: View {
+    @Binding var pinCode: String
+    var isSecure = false
+    
+    var body: some View {
+        textField
+            .textFieldStyle(PINTextFieldStyle(pinCode: pinCode, isSecure: isSecure))
+            .keyboardType(.numberPad)
+            .onChange(of: pinCode) { newValue in
+                let sanitized = sanitize(newValue)
+                if sanitized != newValue {
+                    MXLog.warning("PIN code input sanitized.")
+                    pinCode = sanitized
+                }
+            }
+    }
+    
+    @ViewBuilder
+    var textField: some View {
+        if isSecure {
+            SecureField("", text: $pinCode)
+        } else {
+            TextField("", text: $pinCode)
+        }
+    }
+    
+    func sanitize(_ pinCode: String) -> String {
+        var sanitized = pinCode
+        if sanitized.count > 4 { sanitized = String(pinCode.prefix(4)) }
+        return sanitized.filter(\.isNumber)
+    }
+}
+
+/// A text field style for displaying individual digits of a PIN code.
+private struct PINTextFieldStyle: TextFieldStyle {
+    @FocusState private var isFocussed
+    
+    let pinCode: String
+    let isSecure: Bool
+    
+    public func _body(configuration: TextField<_Label>) -> some View {
+        HStack(spacing: 8) {
+            ForEach(0..<4) { index in
+                PINDigitField(digit: digit(index))
+            }
+        }
+        .overlay {
+            configuration
+                .focused($isFocussed)
+                .opacity(0.0)
+        }
+        .onTapGesture { isFocussed = true }
+    }
+    
+    func digit(_ index: Int) -> Character? {
+        guard pinCode.count > index else { return nil }
+        let stringIndex = pinCode.index(pinCode.startIndex, offsetBy: index)
+        return isSecure ? "●" : pinCode[stringIndex]
+    }
+}
+
+/// A single digit shown within the text field style.
+private struct PINDigitField: View {
+    let digit: Character?
+    
+    var body: some View {
+        ZStack {
+            if let digit {
+                RoundedRectangle(cornerRadius: 8, style: .continuous)
+                    .fill(Color.compound.bgSubtlePrimary)
+                Text(String(digit))
+                    .font(.compound.headingMDBold)
+            } else {
+                RoundedRectangle(cornerRadius: 8, style: .continuous)
+                    .inset(by: 0.5)
+                    .stroke(Color.compound.iconPrimary, lineWidth: 1)
+            }
+        }
+        .frame(width: 48, height: 48)
+    }
+}
+
+struct PINTextField_Previews: PreviewProvider, TestablePreview {
+    static var previews: some View {
+        VStack {
+            PreviewWrapper(pinCode: "", isSecure: false)
+            PreviewWrapper(pinCode: "12", isSecure: false)
+            PreviewWrapper(pinCode: "1234", isSecure: false)
+                .padding(.bottom)
+            
+            PreviewWrapper(pinCode: "", isSecure: true)
+            PreviewWrapper(pinCode: "12", isSecure: true)
+            PreviewWrapper(pinCode: "1234", isSecure: true)
+        }
+    }
+    
+    struct PreviewWrapper: View {
+        @State var pinCode = ""
+        let isSecure: Bool
+        
+        var body: some View {
+            PINTextField(pinCode: $pinCode, isSecure: isSecure)
+        }
+    }
+}