Merge pull request #1421 from matrix-org/steve/5903_lls_start

[Location sharing] Live location sharing start event

Author: SBiOSoftWhare

MatrixSDK.xcodeproj/project.pbxproj

@@ -78,6 +78,8 @@ public enum MXEventType: Equatable, Hashable {
     case pollStart
     case pollResponse
     case pollEnd
+    
+    case beaconInfo
 
     case custom(String)
 
@@ -132,7 +134,8 @@ public enum MXEventType: Equatable, Hashable {
         case .pollStart: return kMXEventTypeStringPollStartMSC3381
         case .pollResponse: return kMXEventTypeStringPollResponseMSC3381
         case .pollEnd: return kMXEventTypeStringPollEndMSC3381
-            
+        case .beaconInfo: return kMXEventTypeStringBeaconInfoMSC3672
+
         // Swift converts any constant with the suffix "Notification" as the type `Notification.Name`
         // The original value can be reached using the `rawValue` property.
         case .typing: return NSNotification.Name.mxEventTypeStringTyping.rawValue
@@ -142,7 +145,7 @@ public enum MXEventType: Equatable, Hashable {
     }
 
     public init(identifier: String) {
-        let events: [MXEventType] = [.roomName, .roomTopic, .roomAvatar, .roomMember, .roomCreate, .roomJoinRules, .roomPowerLevels, .roomAliases, .roomCanonicalAlias, .roomEncrypted, .roomEncryption, .roomGuestAccess, .roomHistoryVisibility, .roomKey, .roomForwardedKey, .roomKeyRequest, .roomMessage, .roomMessageFeedback, .roomRedaction, .roomThirdPartyInvite, .roomTag, .presence, .typing, .callInvite, .callCandidates, .callAnswer, .callSelectAnswer, .callHangup, .callReject, .callNegotiate, .callReplaces, .callRejectReplacement, .callAssertedIdentity, .callAssertedIdentityUnstable, .reaction, .receipt, .roomTombStone, .keyVerificationStart, .keyVerificationAccept, .keyVerificationKey, .keyVerificationMac, .keyVerificationCancel, .keyVerificationDone, .taggedEvents, .spaceChild, .spaceOrder, .pollStart, .pollResponse, .pollEnd]
+        let events: [MXEventType] = [.roomName, .roomTopic, .roomAvatar, .roomMember, .roomCreate, .roomJoinRules, .roomPowerLevels, .roomAliases, .roomCanonicalAlias, .roomEncrypted, .roomEncryption, .roomGuestAccess, .roomHistoryVisibility, .roomKey, .roomForwardedKey, .roomKeyRequest, .roomMessage, .roomMessageFeedback, .roomRedaction, .roomThirdPartyInvite, .roomTag, .presence, .typing, .callInvite, .callCandidates, .callAnswer, .callSelectAnswer, .callHangup, .callReject, .callNegotiate, .callReplaces, .callRejectReplacement, .callAssertedIdentity, .callAssertedIdentityUnstable, .reaction, .receipt, .roomTombStone, .keyVerificationStart, .keyVerificationAccept, .keyVerificationKey, .keyVerificationMac, .keyVerificationCancel, .keyVerificationDone, .taggedEvents, .spaceChild, .spaceOrder, .pollStart, .pollResponse, .pollEnd, .beaconInfo]
 
         if let type = events.first(where: { $0.identifier == identifier }) {
             self = type

MatrixSDK/Contrib/Swift/JSONModels/MXEvent.swift

@@ -27,6 +27,7 @@
 #import "MXStore.h"
 #import "MXRoomTombStoneContent.h"
 #import "MXRoomCreateContent.h"
+#import "MXBeaconInfo.h"
 
 @class MXSession;
 
@@ -172,6 +173,9 @@ Use MXRoomSummary.displayname to get a computed room display name.
  */
 @property (nonatomic, strong, readonly) MXRoomTombStoneContent *tombStoneContent;
 
+/// Beacon info events
+@property (nonatomic, readonly) NSArray<MXBeaconInfo*> *beaconInfos;
+
 /**
  Create a `MXRoomState` instance.
  

MatrixSDK/Data/MXRoomState.h

@@ -399,6 +399,25 @@ - (MXRoomTombStoneContent*)tombStoneContent
     return roomTombStoneContent;
 }
 
+- (NSArray<MXBeaconInfo*>*)beaconInfoEvents
+{
+    NSMutableArray *beaconInfoEvents = [NSMutableArray new];
+    
+    NSArray *stateEvents = [self stateEventsWithType:kMXEventTypeStringBeaconInfoMSC3672];
+    
+    for (MXEvent *event in stateEvents)
+    {
+        MXBeaconInfo *beaconInfo = [[MXBeaconInfo alloc] initWithMXEvent:event];
+        
+        if (beaconInfo)
+        {
+            [beaconInfoEvents addObject:beaconInfo];
+        }
+    }
+    
+    return beaconInfoEvents;
+}
+
 #pragma mark - State events handling
 - (void)handleStateEvents:(NSArray<MXEvent *> *)events;
 {

MatrixSDK/Data/MXRoomState.m

@@ -345,6 +345,9 @@ FOUNDATION_EXPORT NSUInteger const MXRoomSummaryPaginationChunkSize;
  */
 @property (nonatomic) NSSet<NSString*> *parentSpaceIds;
 
+/// User ids of users sharing active beacon in the room
+@property (nonatomic) NSSet<NSString*> *userIdsSharingLiveBeacon;
+
 /**
  Mark all messages as read.
  */

MatrixSDK/Data/MXRoomSummary.h

@@ -251,6 +251,7 @@ - (void)updateWith:(id<MXRoomSummaryProtocol>)summary
     _dataTypes = summary.dataTypes;
     _sentStatus = summary.sentStatus;
     _parentSpaceIds = summary.parentSpaceIds;
+    _userIdsSharingLiveBeacon = summary.userIdsSharingLiveBeacon;
 
     if (!_others)
     {
@@ -968,6 +969,7 @@ - (instancetype)initWithCoder:(NSCoder *)aDecoder
         _sentStatus = (MXRoomSummarySentStatus)[aDecoder decodeIntegerForKey:@"sentStatus"];
         _favoriteTagOrder = [aDecoder decodeObjectForKey:@"favoriteTagOrder"];
         _parentSpaceIds = [aDecoder decodeObjectForKey:@"parentSpaceIds"];
+        _userIdsSharingLiveBeacon = [aDecoder decodeObjectForKey:@"userIdsSharingLiveBeacon"];
 
         // Compute the trust if asked to do it automatically
         // or maintain its computation it has been already calcutated
@@ -1022,6 +1024,7 @@ - (void)encodeWithCoder:(NSCoder *)aCoder
     [aCoder encodeInteger:_sentStatus forKey:@"sentStatus"];
     [aCoder encodeObject:_favoriteTagOrder forKey:@"favoriteTagOrder"];
     [aCoder encodeObject:_parentSpaceIds forKey:@"parentSpaceIds"];
+    [aCoder encodeObject:_userIdsSharingLiveBeacon forKey:@"userIdsSharingLiveBeacon"];
 }
 
 - (NSString *)description

MatrixSDK/Data/MXRoomSummary.m

@@ -143,6 +143,9 @@ NS_ASSUME_NONNULL_BEGIN
 /// Parent space identifiers of whom the room is a descendant
 @property (nonatomic, readonly) NSSet<NSString*> *parentSpaceIds;
 
+/// User ids of users sharing active beacon in the room
+@property (nonatomic, readonly) NSSet<NSString*> *userIdsSharingLiveBeacon;
+
 #pragma mark - Optional
 
 @optional

MatrixSDK/Data/MXRoomSummaryProtocol.h

@@ -23,6 +23,7 @@
 #import "MXRoom.h"
 #import "MXSession.h"
 #import "MXRoomNameDefaultStringLocalizer.h"
+#import "MXBeaconInfo.h"
 
 #import "NSArray+MatrixSDK.h"
 
@@ -144,7 +145,9 @@ - (BOOL)session:(MXSession *)session updateRoomSummary:(MXRoomSummary *)summary
 {
     BOOL hasRoomMembersChange = NO;
     BOOL updated = NO;
-
+    
+    NSMutableSet<NSString*>* userIdsSharingLiveBeacon = [summary.userIdsSharingLiveBeacon mutableCopy] ?: [NSMutableSet new] ;
+    
     for (MXEvent *event in stateEvents)
     {
         switch (event.eventType)
@@ -236,13 +239,25 @@ - (BOOL)session:(MXSession *)session updateRoomSummary:(MXRoomSummary *)summary
                 updated = YES;
                 [self checkRoomCreateStateEventPredecessorAndUpdateObsoleteRoomSummaryIfNeededWithCreateContent:createContent summary:summary session:session roomState:roomState];
                 [self checkRoomIsVirtualWithCreateEvent:event summary:summary session:session];
+                
+                break;
             }
+
+            case MXEventTypeBeaconInfo:
+            {
+                [self updateUserIdsSharingLiveBeacon:userIdsSharingLiveBeacon withStateEvent:event];
                 break;
-                
+            }
             default:
                 break;
         }
     }
+    
+    if (![userIdsSharingLiveBeacon isEqualToSet:summary.userIdsSharingLiveBeacon])
+    {
+        summary.userIdsSharingLiveBeacon = userIdsSharingLiveBeacon;
+        updated = YES;
+    }
 
     if (hasRoomMembersChange)
     {
@@ -793,4 +808,41 @@ - (BOOL)isMembershipEventAllowedAsLastMessage:(MXEvent*)event forUserId:(NSStrin
     return [self isMembershipEventJoinOrInvite:event forUserId:userId]; 
 }
 
+#pragma mark Beacon info
+
+- (BOOL)updateUserIdsSharingLiveBeacon:(NSMutableSet<NSString*>*)userIdsSharingLiveBeacon withStateEvent:(MXEvent*)stateEvent
+{
+    MXBeaconInfo *beaconInfo = [[MXBeaconInfo alloc] initWithMXEvent:stateEvent];
+    
+    NSString *userId = beaconInfo.userId;
+    
+    if (!beaconInfo || !userId)
+    {
+        return NO;
+    }
+        
+    BOOL updated = NO;
+    
+    BOOL isUserExist = [userIdsSharingLiveBeacon containsObject:userId];
+    
+    if (beaconInfo.isLive)
+    {
+        if (!isUserExist)
+        {
+            [userIdsSharingLiveBeacon addObject:userId];
+            updated = YES;
+        }
+    }
+    else
+    {
+        if (isUserExist)
+        {
+            [userIdsSharingLiveBeacon removeObject:userId];
+            updated = YES;
+        }
+    }
+    
+    return updated;
+}
+
 @end

MatrixSDK/Data/MXRoomSummaryUpdater.m

@@ -447,7 +447,8 @@ private class RoomSummaryForTotalCounts: NSObject, MXRoomSummaryProtocol {
     var sentStatus: MXRoomSummarySentStatus
     var spaceChildInfo: MXSpaceChildInfo?
     var parentSpaceIds: Set<String> = []
-
+    var userIdsSharingLiveBeacon: Set<String> = []
+    
     /// Initializer with a dictionary obtained by a fetch request, with result type `.dictionaryResultType`. Only parses some properties.
     /// - Parameter dictionary: Dictionary object representing an `MXRoomSummaryMO` instance
     init(withDictionary dictionary: [String: Any]) {

MatrixSDK/Data/RoomList/CoreData/MXCoreDataRoomListDataFetcher.swift

@@ -30,11 +30,17 @@ public class MXCoreDataRoomSummaryStore: NSObject {
 
     private lazy var persistenceCoordinator: NSPersistentStoreCoordinator = {
         let result = NSPersistentStoreCoordinator(managedObjectModel: Self.managedObjectModel)
+        
+        let options: [AnyHashable : Any] = [
+            NSMigratePersistentStoresAutomaticallyOption: true,
+            NSInferMappingModelAutomaticallyOption: true
+        ]
+        
         do {
             try result.addPersistentStore(ofType: NSSQLiteStoreType,
                                           configurationName: nil,
                                           at: storeURL,
-                                          options: nil)
+                                          options: options)
         } catch {
             fatalError(error.localizedDescription)
         }