Merge pull request #5928 from vector-im/steve/5903_lls_start

Location sharing: Support live location sharing start

Author: SBiOSoftWhare

Riot/Modules/Common/Recents/Service/Mock/MockRoomSummary.swift

@@ -94,6 +94,10 @@ public class MockRoomSummary: NSObject, MXRoomSummaryProtocol {
 
     public var parentSpaceIds: Set<String> = []
 
+    public var beaconInfoEvents: [MXBeaconInfo] = []
+    
+    public var userIdsSharingLiveBeacon: Set<String> = []
+    
     public init(withRoomId roomId: String) {
         self.roomId = roomId
         super.init()

Riot/Modules/Room/DataSources/RoomDataSource.h

@@ -66,6 +66,9 @@
  */
 @property (nonatomic, nullable) NSString *highlightedEventId;
 
+/// Is current user sharing is location in the room
+@property(nonatomic, readonly) BOOL isCurrentUserSharingIsLocation;
+
 /**
  Check if there is an active jitsi widget in the room and return it.
 
@@ -132,4 +135,7 @@
 - (void)roomDataSource:(RoomDataSource * _Nonnull)roomDataSource
           didTapThread:(id<MXThreadProtocol> _Nonnull)thread;
 
+/// Called when current live location sharing status is changing (start or stop location sharing in the room)
+- (void)roomDataSourceDidUpdateCurrentUserSharingLocationStatus:(RoomDataSource * _Nonnull)roomDataSource;
+
 @end

Riot/Modules/Room/DataSources/RoomDataSource.m

@@ -56,6 +56,8 @@ @interface RoomDataSource() <RoomReactionsViewModelDelegate, URLPreviewViewDeleg
 
 @property (nonatomic) NSInteger typingCellIndex;
 
+@property(nonatomic, readwrite) BOOL isCurrentUserSharingIsLocation;
+
 @end
 
 @implementation RoomDataSource
@@ -131,6 +133,8 @@ - (void)finalizeInitialization
     }
 
     self.showTypingRow = YES;
+    
+    [self updateCurrentUserLocationSharingStatus];
 }
 
 - (id<RoomDataSourceDelegate>)roomDataSourceDelegate
@@ -225,6 +229,11 @@ - (void)registerTrustLevelDidChangeNotifications
 
 - (void)roomSummaryDidChange:(NSNotification*)notification
 {
+    if (BuildSettings.liveLocationSharingEnabled)
+    {
+        [self updateCurrentUserLocationSharingStatus];
+    }
+    
     if (!self.room.summary.isEncrypted)
     {
         return;
@@ -1137,4 +1146,27 @@ - (void)threadSummaryViewTapped:(ThreadSummaryView *)summaryView
                                    didTapThread:summaryView.thread];
 }
 
+#pragma mark - Location sharing
+
+- (void)updateCurrentUserLocationSharingStatus
+{
+    MXLocationService *locationService = self.mxSession.locationService;
+    
+    if (!locationService || !self.roomId)
+    {
+        return;
+    }
+    
+    BOOL isUserSharingIsLocation = [locationService isCurrentUserSharingIsLocationInRoomWithId:self.roomId];
+    
+    if (isUserSharingIsLocation != self.isCurrentUserSharingIsLocation)
+    {
+        self.isCurrentUserSharingIsLocation = [locationService isCurrentUserSharingIsLocationInRoomWithId:self.roomId];
+        
+        dispatch_async(dispatch_get_main_queue(), ^{
+            [self.roomDataSourceDelegate roomDataSourceDidUpdateCurrentUserSharingLocationStatus:self];
+        });
+    }
+}
+
 @end

Riot/Modules/Room/RoomViewController+LocationSharing.swift

@@ -0,0 +1,63 @@
+// 
+// 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 Foundation
+
+/// RoomViewController live location sharing handling
+@objc extension RoomViewController {
+    
+    func updateLiveLocationBannerViewVisibility() {
+        if self.shouldShowLiveLocationSharingBannerView {
+            self.showLiveLocationBannerView()
+        } else {
+            self.hideLiveLocationBannerView()
+        }
+    }
+    
+    func hideLiveLocationBannerView() {
+        self.liveLocationSharingBannerView?.removeFromSuperview()
+    }
+    
+    func showLiveLocationBannerView() {
+        guard liveLocationSharingBannerView == nil else {
+            return
+        }
+
+        let bannerView = LiveLocationSharingBannerView.instantiate()
+
+        bannerView.update(theme: ThemeService.shared().theme)
+
+        bannerView.didTapBackground = { [weak self] in
+            guard let self = self else {
+                return
+            }
+            
+            self.delegate?.roomViewControllerDidTapLiveLocationSharingBanner(self)
+        }
+
+        bannerView.didTapStopButton = { [weak self] in
+            
+            guard let self = self else {
+                return
+            }
+            self.delegate?.roomViewControllerDidStopLiveLocationSharing(self)
+        }
+        
+        self.topBannersStackView?.addArrangedSubview(bannerView)
+
+        self.liveLocationSharingBannerView = bannerView
+    }
+}

Riot/Modules/Room/RoomViewController.h

@@ -32,6 +32,7 @@
 @protocol RoomViewControllerDelegate;
 @class RoomDisplayConfiguration;
 @class ThreadsCoordinatorBridgePresenter;
+@class LiveLocationSharingBannerView;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -92,6 +93,15 @@ extern NSNotificationName const RoomGroupCallTileTappedNotification;
 
 @property (nonatomic, getter=isContextPreview) BOOL contextPeview;
 
+/// Handles all banners that should be displayed at the top of the timeline but that should not scroll with the timeline
+@property (weak, nonatomic, nullable) IBOutlet UIStackView *topBannersStackView;
+
+/// Indicate YES to show live location sharing banner
+@property (nonatomic, readonly) BOOL shouldShowLiveLocationSharingBannerView;
+
+/// Displayed live location sharing banner if any
+@property (nonatomic, weak) LiveLocationSharingBannerView *liveLocationSharingBannerView;
+
 /**
  Display the preview of a room that is unknown for the user.
 

Riot/Modules/Room/RoomViewController.m

@@ -232,13 +232,6 @@ @interface RoomViewController () <UISearchBarDelegate, UIGestureRecognizerDelega
 // scroll state just before the layout change, and restore it after the layout.
 @property (nonatomic) BOOL wasScrollAtBottomBeforeLayout;
 
-/// Handles all banners that should be displayed at the top of the timeline but that should not scroll with the timeline
-@property (weak, nonatomic, nullable) IBOutlet UIStackView *topBannersStackView;
-
-@property (nonatomic) BOOL shouldShowLiveLocationSharingBannerView;
-
-@property (nonatomic, weak) LiveLocationSharingBannerView *liveLocationSharingBannerView;
-
 @end
 
 @implementation RoomViewController
@@ -410,6 +403,8 @@ - (void)viewDidLoad
     [self setupActions];
 
     [self setupUserSuggestionViewIfNeeded];
+    
+    [self.topBannersStackView vc_removeAllSubviews];
 }
 
 - (void)userInterfaceThemeDidChange
@@ -549,6 +544,8 @@ - (void)viewWillAppear:(BOOL)animated
 
         notificationTaskProfile = [MXSDKOptions.sharedInstance.profiler startMeasuringTaskWithName:MXTaskProfileNameNotificationsOpenEvent];
     }
+    
+    [self updateTopBanners];
 }
 
 - (void)viewWillDisappear:(BOOL)animated
@@ -1055,6 +1052,8 @@ - (void)displayRoom:(MXKRoomDataSource *)dataSource
     _userSuggestionCoordinator.delegate = self;
 
     [self setupUserSuggestionViewIfNeeded];
+    
+    [self updateTopBanners];
 }
 
 - (void)onRoomDataSourceReady
@@ -1525,6 +1524,11 @@ - (void)setMissedDiscussionsBadgeHidden:(BOOL)missedDiscussionsBadgeHidden{
     missedDiscussionsDotView.hidden = missedDiscussionsBadgeHidden;
 }
 
+- (BOOL)shouldShowLiveLocationSharingBannerView
+{
+    return customizedRoomDataSource.isCurrentUserSharingIsLocation;
+}
+
 #pragma mark - Internals
 
 - (UIBarButtonItem *)videoCallBarButtonItem
@@ -2423,12 +2427,7 @@ - (void)updateTopBanners
 {
     [self.view bringSubviewToFront:self.topBannersStackView];
 
-    [self.topBannersStackView vc_removeAllSubviews];
-    
-    if (self.shouldShowLiveLocationSharingBannerView)
-    {
-        [self showLiveLocationBannerView];
-    }
+    [self updateLiveLocationBannerViewVisibility];
 }
 
 #pragma mark - Jitsi
@@ -4419,6 +4418,11 @@ - (void)roomDataSource:(RoomDataSource *)roomDataSource didTapThread:(id<MXThrea
     [Analytics.shared trackInteraction:AnalyticsUIElementRoomThreadSummaryItem];
 }
 
+- (void)roomDataSourceDidUpdateCurrentUserSharingLocationStatus:(RoomDataSource *)roomDataSource
+{
+    [self updateLiveLocationBannerViewVisibility];
+}
+
 #pragma mark - Segues
 
 - (void)prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender
@@ -7484,34 +7488,4 @@ - (void)roomParticipantsInviteCoordinatorBridgePresenterDidEndLoading:(RoomParti
     [self stopActivityIndicator];
 }
 
-#pragma mark - Live location sharing
-
-- (void)showLiveLocationBannerView
-{
-    if (self.liveLocationSharingBannerView)
-    {
-        return;
-    }
-    
-    LiveLocationSharingBannerView *bannerView = [LiveLocationSharingBannerView instantiate];
-    
-    [bannerView updateWithTheme:ThemeService.shared.theme];
-    
-    MXWeakify(self);
-    
-    bannerView.didTapBackground = ^{
-        MXStrongifyAndReturnIfNil(self);
-        [self.delegate roomViewControllerDidTapLiveLocationSharingBanner:self];
-    };
-    
-    bannerView.didTapStopButton = ^{
-        MXStrongifyAndReturnIfNil(self);
-        [self.delegate roomViewControllerDidStopLiveLocationSharing:self];
-    };
-    
-    [self.topBannersStackView addArrangedSubview:bannerView];
-    
-    self.liveLocationSharingBannerView = bannerView;
-}
-
 @end