Pinning items Feature Flag (#3063)

.swiftlint.yml

@@ -24,8 +24,7 @@ line_length:
   error: 1000
 
 file_length:
-  warning: 1000
+  warning: 2000
-  error: 1000
 
 type_name:
   min_length: 3

ElementX/Resources/Localizations/en.lproj/Localizable.strings

@@ -102,6 +102,7 @@
 "action_view_source" = "View source";
 "action_yes" = "Yes";
 "action.load_more" = "Load more";
+"action.pin" = "Pin";
 "common_about" = "About";
 "common_acceptable_use_policy" = "Acceptable use policy";
 "common_advanced_settings" = "Advanced settings";
@@ -252,6 +253,10 @@
 "error_no_compatible_app_found" = "No compatible app was found to handle this action.";
 "error_some_messages_have_not_been_sent" = "Some messages have not been sent";
 "error_unknown" = "Sorry, an error occurred";
+"event_shield_reason_authenticity_not_guaranteed" = "The authenticity of this encrypted message can't be guaranteed on this device.";
+"event_shield_reason_unknown_device" = "Encrypted by an unknown or deleted device.";
+"event_shield_reason_unsigned_device" = "Encrypted by a device not verified by its owner.";
+"event_shield_reason_unverified_identity" = "Encrypted by an unverified user.";
 "full_screen_intent_banner_message" = "To ensure you never miss an important call, please change your settings to allow full-screen notifications when your phone is locked.";
 "full_screen_intent_banner_title" = "Enhance your call experience";
 "invite_friends_rich_title" = "🔐️ Join me on %1$@";

ElementX/Sources/Application/AppSettings.swift

@@ -46,6 +46,7 @@ final class AppSettings {
         case simplifiedSlidingSyncEnabled
         case publicSearchEnabled
         case fuzzyRoomListSearchEnabled
+        case pinningEnabled
     }
     
     private static var suiteName: String = InfoPlistReader.main.appGroupIdentifier
@@ -282,6 +283,9 @@ final class AppSettings {
     @UserPreference(key: UserDefaultsKeys.fuzzyRoomListSearchEnabled, defaultValue: false, storageType: .userDefaults(store))
     var fuzzyRoomListSearchEnabled
     
+    @UserPreference(key: UserDefaultsKeys.pinningEnabled, defaultValue: false, storageType: .userDefaults(store))
+    var pinningEnabled
+        
     #endif
     
     // MARK: - Shared

ElementX/Sources/FlowCoordinators/RoomFlowCoordinator.swift

@@ -19,7 +19,6 @@ import SwiftState
 import SwiftUI
 import UserNotifications
 
-// swiftlint:disable file_length
 enum RoomFlowCoordinatorAction: Equatable {
     case presentCallScreen(roomProxy: RoomProxyProtocol)
     case finished

ElementX/Sources/Generated/Strings.swift

@@ -562,6 +562,14 @@ internal enum L10n {
   internal static var errorSomeMessagesHaveNotBeenSent: String { return L10n.tr("Localizable", "error_some_messages_have_not_been_sent") }
   /// Sorry, an error occurred
   internal static var errorUnknown: String { return L10n.tr("Localizable", "error_unknown") }
+  /// The authenticity of this encrypted message can't be guaranteed on this device.
+  internal static var eventShieldReasonAuthenticityNotGuaranteed: String { return L10n.tr("Localizable", "event_shield_reason_authenticity_not_guaranteed") }
+  /// Encrypted by an unknown or deleted device.
+  internal static var eventShieldReasonUnknownDevice: String { return L10n.tr("Localizable", "event_shield_reason_unknown_device") }
+  /// Encrypted by a device not verified by its owner.
+  internal static var eventShieldReasonUnsignedDevice: String { return L10n.tr("Localizable", "event_shield_reason_unsigned_device") }
+  /// Encrypted by an unverified user.
+  internal static var eventShieldReasonUnverifiedIdentity: String { return L10n.tr("Localizable", "event_shield_reason_unverified_identity") }
   /// To ensure you never miss an important call, please change your settings to allow full-screen notifications when your phone is locked.
   internal static var fullScreenIntentBannerMessage: String { return L10n.tr("Localizable", "full_screen_intent_banner_message") }
   /// Enhance your call experience
@@ -2221,6 +2229,8 @@ internal enum L10n {
   internal enum Action {
     /// Load more
     internal static var loadMore: String { return L10n.tr("Localizable", "action.load_more") }
+    /// Pin
+    internal static var pin: String { return L10n.tr("Localizable", "action.pin") }
   }
 
   internal enum Common {

ElementX/Sources/Screens/RoomScreen/RoomScreenInteractionHandler.swift

@@ -171,6 +171,9 @@ class RoomScreenInteractionHandler {
             Task { await roomProxy.timeline.toggleReaction(key, to: eventID) }
         case .endPoll(let pollStartID):
             endPoll(pollStartID: pollStartID)
+        case .pin:
+            // TODO: Implement the pin action
+            break
         }
         
         if action.switchToDefaultComposer {

ElementX/Sources/Screens/RoomScreen/RoomScreenModels.swift

@@ -163,6 +163,7 @@ struct RoomScreenViewState: BindableState {
     var ownUserID: String
     var canCurrentUserRedactOthers = false
     var canCurrentUserRedactSelf = false
+    var canCurrentUserPin = false
     var isViewSourceEnabled: Bool
     
     var canJoinCall = false

ElementX/Sources/Screens/RoomScreen/RoomScreenViewModel.swift

@@ -359,6 +359,13 @@ class RoomScreenViewModel: RoomScreenViewModelType, RoomScreenViewModelProtocol
         } else {
             state.canCurrentUserRedactSelf = false
         }
+        
+        if appSettings.pinningEnabled,
+           case let .success(value) = await roomProxy.canUser(userID: roomProxy.ownUserID, sendStateEvent: .roomPinnedEvents) {
+            state.canCurrentUserPin = value
+        } else {
+            state.canCurrentUserPin = false
+        }
     }
     
     private func setupSubscriptions() {

ElementX/Sources/Screens/RoomScreen/View/ItemMenu/TimelineItemMenu.swift

@@ -183,7 +183,7 @@ struct TimelineItemMenu_Previews: PreviewProvider, TestablePreview {
     @ViewBuilder
     static var testView: some View {
         if let item = RoomTimelineItemFixtures.singleMessageChunk.first as? EventBasedTimelineItemProtocol,
-           let actions = TimelineItemMenuActions(isReactable: true, actions: [.copy, .edit, .reply(isThread: false), .redact], debugActions: [.viewSource]) {
+           let actions = TimelineItemMenuActions(isReactable: true, actions: [.copy, .edit, .reply(isThread: false), .pin, .redact], debugActions: [.viewSource]) {
             TimelineItemMenu(item: item, actions: actions)
                 .environmentObject(viewModel.context)
         }

ElementX/Sources/Screens/RoomScreen/View/ItemMenu/TimelineItemMenuAction.swift

@@ -61,6 +61,7 @@ enum TimelineItemMenuAction: Identifiable, Hashable {
     case react
     case toggleReaction(key: String)
     case endPoll(pollStartID: String)
+    case pin
     
     var id: Self { self }
     
@@ -133,6 +134,8 @@ enum TimelineItemMenuAction: Identifiable, Hashable {
             Label(L10n.actionReact, icon: \.reactionAdd)
         case .endPoll:
             Label(L10n.actionEndPoll, icon: \.pollsEnd)
+        case .pin:
+            Label(L10n.Action.pin, icon: \.pin)
         }
     }
 }

ElementX/Sources/Screens/RoomScreen/View/ItemMenu/TimelineItemMenuActionProvider.swift

@@ -20,6 +20,7 @@ struct TimelineItemMenuActionProvider {
     let timelineItem: RoomTimelineItemProtocol
     let canCurrentUserRedactSelf: Bool
     let canCurrentUserRedactOthers: Bool
+    let canCurrentUserPin: Bool
     let isDM: Bool
     let isViewSourceEnabled: Bool
     
@@ -65,6 +66,11 @@ struct TimelineItemMenuActionProvider {
             actions.append(.forward(itemID: item.id))
         }
         
+        if canCurrentUserPin {
+            // TODO: If the event is already pinned use the unpinned action
+            actions.append(.pin)
+        }
+
         if item.isEditable {
             actions.append(.edit)
         }

ElementX/Sources/Screens/RoomScreen/View/RoomScreen.swift

@@ -60,6 +60,7 @@ struct RoomScreen: View {
                 let actions = TimelineItemMenuActionProvider(timelineItem: info.item,
                                                              canCurrentUserRedactSelf: context.viewState.canCurrentUserRedactSelf,
                                                              canCurrentUserRedactOthers: context.viewState.canCurrentUserRedactOthers,
+                                                             canCurrentUserPin: context.viewState.canCurrentUserPin,
                                                              isDM: context.viewState.isEncryptedOneToOneRoom,
                                                              isViewSourceEnabled: context.viewState.isViewSourceEnabled).makeActions()
                 if let actions {

ElementX/Sources/Screens/RoomScreen/View/Style/TimelineItemBubbledStylerView.swift

@@ -146,6 +146,7 @@ struct TimelineItemBubbledStylerView<Content: View>: View {
                 let provider = TimelineItemMenuActionProvider(timelineItem: timelineItem,
                                                               canCurrentUserRedactSelf: context.viewState.canCurrentUserRedactSelf,
                                                               canCurrentUserRedactOthers: context.viewState.canCurrentUserRedactOthers,
+                                                              canCurrentUserPin: context.viewState.canCurrentUserPin,
                                                               isDM: context.viewState.isEncryptedOneToOneRoom,
                                                               isViewSourceEnabled: context.viewState.isViewSourceEnabled)
                 TimelineItemMacContextMenu(item: timelineItem, actionProvider: provider) { action in

ElementX/Sources/Screens/Settings/DeveloperOptionsScreen/DeveloperOptionsScreenModels.swift

@@ -50,6 +50,7 @@ protocol DeveloperOptionsProtocol: AnyObject {
     var hideUnreadMessagesBadge: Bool { get set }
     var elementCallBaseURLOverride: URL? { get set }
     var fuzzyRoomListSearchEnabled: Bool { get set }
+    var pinningEnabled: Bool { get set }
 }
 
 extension AppSettings: DeveloperOptionsProtocol { }

ElementX/Sources/Screens/Settings/DeveloperOptionsScreen/View/DeveloperOptionsScreen.swift

@@ -34,6 +34,12 @@ struct DeveloperOptionsScreen: View {
                 }
             }
             
+            Section("Message Pinning") {
+                Toggle(isOn: $context.pinningEnabled) {
+                    Text("Enable message pinning")
+                }
+            }
+            
             Section("Room List") {
                 Toggle(isOn: $context.hideUnreadMessagesBadge) {
                     Text("Hide grey dots")

ElementX/Sources/Services/Client/ClientProxy.swift

@@ -21,7 +21,6 @@ import OrderedCollections
 
 import MatrixRustSDK
 
-// swiftlint:disable file_length
 class ClientProxy: ClientProxyProtocol {
     private let client: ClientProtocol
     private let networkMonitor: NetworkMonitorProtocol