Settings discovery: Implement settings table view discovery section.

2026-04-20 16:42:44 +02:00 · 2019-09-10 20:33:27 +02:00
parent 881886cd16
commit 04a62eb9da
5 changed files with 536 additions and 0 deletions
@@ -0,0 +1,200 @@
+/*
+ Copyright 2019 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 Foundation
+
+@objc final class SettingsDiscoveryViewModel: NSObject, SettingsDiscoveryViewModelType {
+    
+    // MARK: - Properties
+    
+    // MARK: Private
+    
+    private let session: MXSession
+    private var identityService: MXIdentityService?
+    private var serviceTerms: MXServiceTerms?
+    private var viewState: SettingsDiscoveryViewState?
+    private var threePIDs: [MX3PID] = []
+    
+    // MARK: Public
+    
+    weak var viewDelegate: SettingsDiscoveryViewModelViewDelegate?
+    @objc weak var coordinatorDelegate: SettingsDiscoveryViewModelCoordinatorDelegate?
+    
+    // MARK: - Setup
+    
+    @objc init(session: MXSession, thirdPartyIdentifiers: [MXThirdPartyIdentifier]) {
+        self.session = session
+        
+        let identityService = session.identityService
+        
+        if let identityService = identityService {
+            self.serviceTerms = MXServiceTerms(baseUrl: identityService.identityServer, serviceType: MXServiceTypeIdentityService, matrixSession: session, accessToken: nil)
+        }
+        
+        self.identityService = identityService
+        self.threePIDs = SettingsDiscoveryViewModel.threePids(from: thirdPartyIdentifiers)
+        super.init()
+    }
+    
+    // MARK: - Public
+    
+    func process(viewAction: SettingsDiscoveryViewAction) {
+        switch viewAction {
+        case .load:
+            self.checkTerms()
+        case .acceptTerms:
+            self.acceptTerms()
+        case .select(threePid: let threePid):
+            self.coordinatorDelegate?.settingsDiscoveryViewModel(self, didSelectThreePidWith: threePid.medium.identifier, and: threePid.address)
+        case .tapUserSettingsLink:
+            self.coordinatorDelegate?.settingsDiscoveryViewModelDidTapUserSettingsLink(self)
+        }
+    }
+    
+    @objc func update(thirdPartyIdentifiers: [MXThirdPartyIdentifier]) {
+        self.threePIDs = SettingsDiscoveryViewModel.threePids(from: thirdPartyIdentifiers)
+        
+        // Update view state only if three3pids was previously
+        guard let viewState = self.viewState,
+            case let .loaded(displayMode: displayMode) = viewState else {
+            return
+        }
+        
+        let canDisplayThreePids: Bool
+        
+        switch displayMode {
+        case .threePidsAdded, .noThreePidsAdded:
+            canDisplayThreePids = true
+        default:
+            canDisplayThreePids = false
+        }
+        
+        if canDisplayThreePids {
+            self.updateViewStateFromCurrentThreePids()
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func checkTerms() {
+        guard let identityService = self.identityService, let serviceTerms = self.serviceTerms else {
+            self.update(viewState: .loaded(displayMode: .noIdentityServer))
+            return
+        }
+        
+        guard self.canCheckTerms() else {
+            return
+        }
+        
+        self.update(viewState: .loading)
+        
+        serviceTerms.areAllTermsAgreed({ (areAllTermsAgreed) in
+            if areAllTermsAgreed {
+                // Display three pids if presents
+                self.updateViewStateFromCurrentThreePids()
+            } else {
+                let identityServer = identityService.identityServer
+                let identityServerHost = URL(string: identityServer)?.host ?? identityServer
+                
+                self.update(viewState: .loaded(displayMode: .termsNotSigned(host: identityServerHost)))
+            }
+        }, failure: { (error) in
+            self.update(viewState: .error(error))
+        })
+    }
+    
+    private func acceptTerms() {
+        guard let identityService = self.identityService else {
+            self.update(viewState: .loaded(displayMode: .noIdentityServer))
+            return
+        }
+        
+        // Launch an identity server request to trigger terms modal apparition
+        identityService.account { (response) in
+            switch response {
+            case .success:
+                // Display three pids if presents
+                self.updateViewStateFromCurrentThreePids()
+            case .failure(let error):
+                if MXError(nsError: error)?.errcode == kMXErrCodeStringTermsNotSigned {
+                    // Identity terms modal should appear
+                } else {
+                    self.update(viewState: .error(error))
+                }
+            }
+        }
+    }
+    
+    private func canCheckTerms() -> Bool {
+        guard let viewState = self.viewState else {
+            return true
+        }
+        
+        let canCheckTerms: Bool
+        
+        if case .loading = viewState {
+            canCheckTerms = false
+        } else {
+            canCheckTerms = true
+        }
+        
+        return canCheckTerms
+    }
+    
+    private func updateViewStateFromCurrentThreePids() {
+        self.updateViewState(with: self.threePIDs)
+    }
+    
+    private func updateViewState(with threePids: [MX3PID]) {
+        
+        let viewState: SettingsDiscoveryViewState
+        
+        if threePids.isEmpty {
+            viewState = .loaded(displayMode: .noThreePidsAdded)
+        } else {
+            let emails = threePids.compactMap { (threePid) -> MX3PID? in
+                if case .email = threePid.medium {
+                    return threePid
+                } else {
+                    return nil
+                }
+            }
+            
+            let phoneNumbers = threePids.compactMap { (threePid) -> MX3PID? in
+                if case .msisdn = threePid.medium {
+                    return threePid
+                } else {
+                    return nil
+                }
+            }
+            
+            viewState = .loaded(displayMode: .threePidsAdded(emails: emails, phoneNumbers: phoneNumbers))
+        }
+        
+        self.update(viewState: viewState)
+    }
+    
+    private func update(viewState: SettingsDiscoveryViewState) {
+        self.viewState = viewState
+        self.viewDelegate?.settingsDiscoveryViewModel(self, didUpdateViewState: viewState)
+    }
+    
+    private class func threePids(from thirdPartyIdentifiers: [MXThirdPartyIdentifier]) -> [MX3PID] {
+        return thirdPartyIdentifiers.map({ (thirdPartyIdentifier) -> MX3PID in
+            return MX3PID(medium: MX3PID.Medium(identifier: thirdPartyIdentifier.medium), address: thirdPartyIdentifier.address)
+        })
+    }    
+}