Add informational sheet for sessions (PSG-714)

Riot/Assets/en.lproj/Vector.strings

@@ -2448,6 +2448,15 @@ To enable access, tap Settings> Location and select Always";
 "user_other_session_verified_additional_info" = "This session is ready for secure messaging.";
 "user_session_push_notifications" = "Push notifications";
 "user_session_push_notifications_message" = "When turned on, this session will receive push notifications.";
+"user_session_got_it" = "Got it";
+"user_session_verified_session_title" = "Verified sessions";
+"user_session_verified_session_description" = "Verified sessions are anywhere you are using Element after entering your passphrase or confirming your identity with another verified session.\n\nThis means that you have all the keys needed to unlock your encrypted messages and confirm to other users that you trust this session.";
+"user_session_unverified_session_title" = "Unverified session";
+"user_session_unverified_session_description" = "Unverified sessions are sessions that have logged in with your credentials but not been cross-verified.\n\nYou should make especially certain that you recognise these sessions as they could represent an unauthorised use of your account.";
+"user_session_inactive_session_title" = "Inactive sessions";
+"user_session_inactive_session_description" = "Inactive sessions are sessions you have not used in some time, but they continue to receive encryption keys.\n\nRemoving inactive sessions improves security and performance, and makes it easier for you to identify if a new session is suspicious.";
+"user_session_rename_session_title" = "Renaming sessions";
+"user_session_rename_session_description" = "Other users in direct messages and rooms that you join are able to view a full list of your sessions.\n\nThis provides them with confidence that they are really speaking to you, but it also means they can see the session name you enter here.";
 
 "user_other_session_security_recommendation_title" = "Security recommendation";
 "user_other_session_unverified_sessions_header_subtitle" = "Verify your sessions for enhanced secure messaging or sign out from those you don’t recognize or use anymore.";

Riot/Generated/Strings.swift

@@ -8787,6 +8787,18 @@ public class VectorL10n: NSObject {
   public static var userSessionDetailsTitle: String { 
     return VectorL10n.tr("Vector", "user_session_details_title") 
   }
+  /// Got it
+  public static var userSessionGotIt: String { 
+    return VectorL10n.tr("Vector", "user_session_got_it") 
+  }
+  /// Inactive sessions are sessions you have not used in some time, but they continue to receive encryption keys.\n\nRemoving inactive sessions improves security and performance, and makes it easier for you to identify if a new session is suspicious.
+  public static var userSessionInactiveSessionDescription: String { 
+    return VectorL10n.tr("Vector", "user_session_inactive_session_description") 
+  }
+  /// Inactive sessions
+  public static var userSessionInactiveSessionTitle: String { 
+    return VectorL10n.tr("Vector", "user_session_inactive_session_title") 
+  }
   /// %1$@ · %2$@
   public static func userSessionItemDetails(_ p1: String, _ p2: String) -> String {
     return VectorL10n.tr("Vector", "user_session_item_details", p1, p2)
@@ -8823,6 +8835,14 @@ public class VectorL10n: NSObject {
   public static var userSessionPushNotificationsMessage: String { 
     return VectorL10n.tr("Vector", "user_session_push_notifications_message") 
   }
+  /// Other users in direct messages and rooms that you join are able to view a full list of your sessions.\n\nThis provides them with confidence that they are really speaking to you, but it also means they can see the session name you enter here.
+  public static var userSessionRenameSessionDescription: String { 
+    return VectorL10n.tr("Vector", "user_session_rename_session_description") 
+  }
+  /// Renaming sessions
+  public static var userSessionRenameSessionTitle: String { 
+    return VectorL10n.tr("Vector", "user_session_rename_session_title") 
+  }
   /// Unverified session
   public static var userSessionUnverified: String { 
     return VectorL10n.tr("Vector", "user_session_unverified") 
@@ -8831,6 +8851,14 @@ public class VectorL10n: NSObject {
   public static var userSessionUnverifiedAdditionalInfo: String { 
     return VectorL10n.tr("Vector", "user_session_unverified_additional_info") 
   }
+  /// Unverified sessions are sessions that have logged in with your credentials but not been cross-verified.\n\nYou should make especially certain that you recognise these sessions as they could represent an unauthorised use of your account.
+  public static var userSessionUnverifiedSessionDescription: String { 
+    return VectorL10n.tr("Vector", "user_session_unverified_session_description") 
+  }
+  /// Unverified session
+  public static var userSessionUnverifiedSessionTitle: String { 
+    return VectorL10n.tr("Vector", "user_session_unverified_session_title") 
+  }
   /// Unverified
   public static var userSessionUnverifiedShort: String { 
     return VectorL10n.tr("Vector", "user_session_unverified_short") 
@@ -8855,6 +8883,14 @@ public class VectorL10n: NSObject {
   public static var userSessionVerifiedAdditionalInfo: String { 
     return VectorL10n.tr("Vector", "user_session_verified_additional_info") 
   }
+  /// Verified sessions are anywhere you are using Element after entering your passphrase or confirming your identity with another verified session.\n\nThis means that you have all the keys needed to unlock your encrypted messages and confirm to other users that you trust this session.
+  public static var userSessionVerifiedSessionDescription: String { 
+    return VectorL10n.tr("Vector", "user_session_verified_session_description") 
+  }
+  /// Verified sessions
+  public static var userSessionVerifiedSessionTitle: String { 
+    return VectorL10n.tr("Vector", "user_session_verified_session_title") 
+  }
   /// Verified
   public static var userSessionVerifiedShort: String { 
     return VectorL10n.tr("Vector", "user_session_verified_short") 

RiotSwiftUI/Modules/Common/Extensions/View.swift

@@ -0,0 +1,24 @@
+// 
+// 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 UIKit
+import SwiftUI
+
+extension View {
+    func hideKeyboard() {
+        UIApplication.shared.vc_closeKeyboard()
+    }
+}

RiotSwiftUI/Modules/Common/InfoSheet/Coordinator/InfoSheetCoordinator.swift

@@ -0,0 +1,91 @@
+//
+// 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 CommonKit
+import SwiftUI
+
+struct InfoSheetCoordinatorParameters {
+    let title: String
+    let description: String
+    let action: InfoSheet.Action
+    let parentSize: CGSize?
+}
+
+final class InfoSheetCoordinator: Coordinator, Presentable {
+    private let parameters: InfoSheetCoordinatorParameters
+    private let infoSheetHostingController: UIViewController
+    private var infoSheetViewModel: InfoSheetViewModelProtocol
+
+    // Must be used only internally
+    var childCoordinators: [Coordinator] = []
+    var completion: ((InfoSheetViewModelResult) -> Void)?
+
+    init(parameters: InfoSheetCoordinatorParameters) {
+        self.parameters = parameters
+
+        let viewModel = InfoSheetViewModel(title: parameters.title, description: parameters.description, action: parameters.action)
+        let view = InfoSheet(viewModel: viewModel.context)
+        infoSheetViewModel = viewModel
+        let controller = VectorHostingController(rootView: view)
+        infoSheetHostingController = controller
+        setupPresentation(of: controller)
+    }
+
+    // MARK: - Public
+
+    func start() {
+        MXLog.debug("[InfoSheetCoordinator] did start.")
+        infoSheetViewModel.completion = { [weak self] result in
+            guard let self = self else { return }
+            MXLog.debug("[InfoSheetCoordinator] InfoSheetViewModel did complete with result: \(result).")
+            self.completion?(result)
+        }
+    }
+
+    func toPresentable() -> UIViewController {
+        infoSheetHostingController
+    }
+}
+
+private extension InfoSheetCoordinator {
+    // The bottom sheet should be presented with the content intrinsic height as for design requirement
+    // We can do it easily just on iOS 16+
+    func setupPresentation(of viewController: VectorHostingController) {
+        let cornerRadius: CGFloat = 24
+
+        guard
+            #available(iOS 16, *),
+            let parentSize = parameters.parentSize,
+            let presentationController = viewController.sheetPresentationController
+        else {
+            viewController.bottomSheetPreferences = .init(cornerRadius: cornerRadius)
+            return
+        }
+
+        let intrisincSize = viewController.view.systemLayoutSizeFitting(.init(width: parentSize.width, height: 0),
+                                                                        withHorizontalFittingPriority: .defaultHigh,
+                                                                        verticalFittingPriority: .defaultLow)
+
+        presentationController.preferredCornerRadius = cornerRadius
+        presentationController.prefersGrabberVisible = true
+        presentationController.detents = [
+            .custom { context in
+                min(context.maximumDetentValue, intrisincSize.height)
+            },
+            .large()
+        ]
+    }
+}

RiotSwiftUI/Modules/Common/InfoSheet/InfoSheetModels.swift

@@ -0,0 +1,33 @@
+//
+// 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.
+//
+
+// MARK: View model
+
+enum InfoSheetViewModelResult {
+    case actionTriggered
+}
+
+// MARK: View
+
+struct InfoSheetViewState: BindableState {
+    let title: String
+    let description: String
+    let action: InfoSheet.Action
+}
+
+enum InfoSheetViewAction {
+    case actionTriggered
+}

RiotSwiftUI/Modules/Common/InfoSheet/InfoSheetViewModel.swift

@@ -0,0 +1,36 @@
+//
+// 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 SwiftUI
+
+typealias InfoSheetViewModelType = StateStoreViewModel<InfoSheetViewState, InfoSheetViewAction>
+
+class InfoSheetViewModel: InfoSheetViewModelType, InfoSheetViewModelProtocol {
+    var completion: ((InfoSheetViewModelResult) -> Void)?
+
+    init(title: String, description: String, action: InfoSheet.Action) {
+        super.init(initialViewState: InfoSheetViewState(title: title, description: description, action: action))
+    }
+
+    // MARK: - Public
+
+    override func process(viewAction: InfoSheetViewAction) {
+        switch viewAction {
+        case .actionTriggered:
+            completion?(.actionTriggered)
+        }
+    }
+}

RiotSwiftUI/Modules/Common/InfoSheet/InfoSheetViewModelProtocol.swift

@@ -0,0 +1,22 @@
+//
+// 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 Foundation
+
+protocol InfoSheetViewModelProtocol {
+    var completion: ((InfoSheetViewModelResult) -> Void)? { get set }
+    var context: InfoSheetViewModelType.Context { get }
+}

RiotSwiftUI/Modules/Common/InfoSheet/MockInfoSheetScreenState.swift

@@ -0,0 +1,57 @@
+//
+// 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 Foundation
+import SwiftUI
+
+/// Using an enum for the screen allows you define the different state cases with
+/// the relevant associated data for each case.
+enum MockInfoSheetScreenState: MockScreenState, CaseIterable {
+    // A case for each state you want to represent
+    // with specific, minimal associated data that will allow you
+    // mock that screen.
+    case sheet(title: String, subtitle: String, action: InfoSheet.Action)
+
+    /// The associated screen
+    var screenType: Any.Type {
+        InfoSheet.self
+    }
+
+    /// A list of screen state definitions
+    static var allCases: [MockInfoSheetScreenState] {
+        // Each of the presence statuses
+        [.sheet(title: VectorL10n.userSessionVerifiedSessionTitle, subtitle: VectorL10n.userSessionVerifiedSessionDescription, action: .init(text: VectorL10n.userSessionGotIt, action: { }))]
+    }
+
+    /// Generate the view struct for the screen state.
+    var screenView: ([Any], AnyView) {
+        let model: (title: String, subtitle: String, action: InfoSheet.Action)
+
+        switch self {
+        case let .sheet(title, subtitle, action):
+            model = (title, subtitle, action)
+        }
+        let viewModel = InfoSheetViewModel(title: model.title, description: model.subtitle, action: model.action)
+
+        // can simulate service and viewModel actions here if needs be.
+
+        return (
+            [model, viewModel],
+            AnyView(InfoSheet(viewModel: viewModel.context)
+                .addDependency(MockAvatarService.example))
+        )
+    }
+}