Merge pull request #6058 from vector-im/steve/6021_beacon_event

Location sharing: Support live location event in the timeline

Author: SBiOSoftWhare

Riot/Modules/MatrixKit/Models/MXKAppSettings.m

@@ -147,7 +147,9 @@ -(instancetype)init
             kMXEventTypeStringKeyVerificationCancel,
             kMXEventTypeStringKeyVerificationDone,
             kMXEventTypeStringPollStart,
-            kMXEventTypeStringPollStartMSC3381
+            kMXEventTypeStringPollStartMSC3381,
+            kMXEventTypeStringBeaconInfo,
+            kMXEventTypeStringBeaconInfoMSC3672
         ].mutableCopy;
 
 
@@ -179,7 +181,9 @@ -(instancetype)init
             kMXEventTypeStringKeyVerificationCancel,
             kMXEventTypeStringKeyVerificationDone,
             kMXEventTypeStringPollStart,
-            kMXEventTypeStringPollStartMSC3381
+            kMXEventTypeStringPollStartMSC3381,
+            kMXEventTypeStringBeaconInfo,
+            kMXEventTypeStringBeaconInfoMSC3672
         ].mutableCopy;
 
         lastMessageEventTypesAllowList = @[

Riot/Modules/Room/CellData/RoomBubbleCellData.h

@@ -16,6 +16,8 @@
 
 #import "MatrixKit.h"
 
+@protocol MXBeaconInfoSummaryProtocol;
+
 extern NSString *const URLPreviewDidUpdateNotification;
 
 // Custom tags for MXKRoomBubbleCellDataStoring.tag
@@ -33,7 +35,8 @@ typedef NS_ENUM(NSInteger, RoomBubbleCellDataTag)
     RoomBubbleCellDataTagGroupCall,
     RoomBubbleCellDataTagRoomCreationIntro,
     RoomBubbleCellDataTagPoll,
-    RoomBubbleCellDataTagLocation
+    RoomBubbleCellDataTagLocation,
+    RoomBubbleCellDataTagLiveLocation
 };
 
 /**
@@ -92,6 +95,8 @@ typedef NS_ENUM(NSInteger, RoomBubbleCellDataTag)
  */
 @property(nonatomic) BOOL isKeyVerificationOperationPending;
 
+@property(nonatomic, strong, readonly) id<MXBeaconInfoSummaryProtocol> beaconInfoSummary;
+
 /**
  Index of the component which needs a sent tick displayed. -1 if none.
  */

Riot/Modules/Room/CellData/RoomBubbleCellData.m

@@ -38,6 +38,8 @@ @interface RoomBubbleCellData()
 // Flags to "Show All" reactions for an event
 @property(nonatomic) NSMutableSet<NSString* /* eventId */> *eventsToShowAllReactions;
 
+@property(nonatomic, strong, readwrite) id<MXBeaconInfoSummaryProtocol> beaconInfoSummary;
+
 @end
 
 @implementation RoomBubbleCellData
@@ -159,6 +161,15 @@ - (instancetype)initWithEvent:(MXEvent *)event andRoomState:(MXRoomState *)roomS
 
                 break;
             }
+            case MXEventTypeBeaconInfo:
+            {
+                self.tag = RoomBubbleCellDataTagLiveLocation;
+                self.collapsable = NO;
+                self.collapsed = NO;
+                
+                [self updateBeaconInfoSummaryWithEventId:event.eventId];
+            }
+                break;
             case MXEventTypeCustom:
             {
                 if ([event.type isEqualToString:kWidgetMatrixEventTypeString]
@@ -210,6 +221,11 @@ - (NSUInteger)updateEvent:(NSString *)eventId withEvent:(MXEvent *)event
 
     // Update any URL preview data as necessary.
     [self refreshURLPreviewForEventId:event.eventId];
+    
+    if (self.tag == RoomBubbleCellDataTagLiveLocation)
+    {
+        [self updateBeaconInfoSummaryWithEventId:eventId];
+    }
 
     return retVal;
 }
@@ -279,6 +295,17 @@ - (BOOL)hasNoDisplay
         return NO;
     }
 
+    if (self.tag == RoomBubbleCellDataTagLiveLocation)
+    {
+        // If the summary does not exist don't show the cell
+        if (!self.beaconInfoSummary)
+        {
+            return YES;
+        }
+        
+        return NO;
+    }
+    
     return [super hasNoDisplay];
 }
 
@@ -983,6 +1010,9 @@ - (BOOL)addEvent:(MXEvent*)event andRoomState:(MXRoomState*)roomState
         case RoomBubbleCellDataTagLocation:
             shouldAddEvent = NO;
             break;
+        case RoomBubbleCellDataTagLiveLocation:
+            shouldAddEvent = NO;
+            break;
         default:
             break;
     }
@@ -1294,5 +1324,11 @@ - (void)refreshURLPreviewForEventId:(NSString *)eventId
     }];
 }
 
+- (void)updateBeaconInfoSummaryWithEventId:(NSString *)eventId
+{
+    MXBeaconInfoSummary *beaconInfoSummary = [self.mxSession.aggregations.beaconAggegations beaconInfoSummaryFor:eventId inRoomWithId:self.roomId];
+    
+    self.beaconInfoSummary = beaconInfoSummary;
+}
 
 @end

Riot/Modules/Room/RoomViewController.m

@@ -2905,7 +2905,7 @@ - (RoomTimelineCellIdentifier)cellIdentifierForCellData:(MXKCellData*)cellData a
             }
         }
     }
-    else if (bubbleData.tag == RoomBubbleCellDataTagLocation)
+    else if (bubbleData.tag == RoomBubbleCellDataTagLocation || bubbleData.tag == RoomBubbleCellDataTagLiveLocation)
     {
         if (bubbleData.isIncoming)
         {

changelog.d/6057.wip

@@ -0,0 +1 @@
+Location sharing: Support live location event in the timeline.