Merge pull request #1428 from matrix-org/maximee/5858_pin_drop_sharing

[Location Sharing]: Pin drop location sharing

Author: MaximeEvrard42

MatrixSDK.xcodeproj/project.pbxproj

@@ -1358,6 +1358,8 @@
 		B1E09A492398028D0057C069 /* MXSelfSignedHomeserverTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 32322A471E57264E005DD155 /* MXSelfSignedHomeserverTests.m */; };
 		B1F939F526289F2600D0E525 /* MXSpaceChildContentTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = B1F939F426289F2600D0E525 /* MXSpaceChildContentTests.swift */; };
 		B1F939F626289F2600D0E525 /* MXSpaceChildContentTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = B1F939F426289F2600D0E525 /* MXSpaceChildContentTests.swift */; };
+		B2EC7E2327F483DB00F40C26 /* MXEventAssetTypeMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = B2EC7E2227F483DB00F40C26 /* MXEventAssetTypeMapper.swift */; };
+		B2EC7E2427F483DB00F40C26 /* MXEventAssetTypeMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = B2EC7E2227F483DB00F40C26 /* MXEventAssetTypeMapper.swift */; };
 		C60165381E3AA57900B92CFA /* MXSDKOptions.h in Headers */ = {isa = PBXBuildFile; fileRef = F0C34CB91C18C80000C36F09 /* MXSDKOptions.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		C602B58C1F2268F700B67D87 /* MXRoom.swift in Sources */ = {isa = PBXBuildFile; fileRef = C602B58B1F2268F700B67D87 /* MXRoom.swift */; };
 		C602B58E1F22A8D700B67D87 /* MXImage.swift in Sources */ = {isa = PBXBuildFile; fileRef = C602B58D1F22A8D700B67D87 /* MXImage.swift */; };
@@ -2483,6 +2485,7 @@
 		B1DDC9D52418098200D208E3 /* MXIncomingSASTransaction_Private.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MXIncomingSASTransaction_Private.h; sourceTree = "<group>"; };
 		B1E09A0E2397FA950057C069 /* MatrixSDKTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = MatrixSDKTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
 		B1F939F426289F2600D0E525 /* MXSpaceChildContentTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MXSpaceChildContentTests.swift; sourceTree = "<group>"; };
+		B2EC7E2227F483DB00F40C26 /* MXEventAssetTypeMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MXEventAssetTypeMapper.swift; sourceTree = "<group>"; };
 		B57EF0A39A7649D55CA1208A /* libPods-MatrixSDK-MatrixSDK-iOS.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = "libPods-MatrixSDK-MatrixSDK-iOS.a"; sourceTree = BUILT_PRODUCTS_DIR; };
 		BD0431D223F108AED4C70A42 /* Pods-SDK-MatrixSDK-iOS.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-SDK-MatrixSDK-iOS.debug.xcconfig"; path = "Target Support Files/Pods-SDK-MatrixSDK-iOS/Pods-SDK-MatrixSDK-iOS.debug.xcconfig"; sourceTree = "<group>"; };
 		BD96770F88F116285272DB47 /* Pods-MatrixSDKTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-MatrixSDKTests.release.xcconfig"; path = "Target Support Files/Pods-MatrixSDKTests/Pods-MatrixSDKTests.release.xcconfig"; sourceTree = "<group>"; };
@@ -2931,7 +2934,6 @@
 				B146D46E21A5939000D8C2C6 /* Realm */,
 				32322A491E575F65005DD155 /* MXAllowedCertificates.h */,
 				32322A4A1E575F65005DD155 /* MXAllowedCertificates.m */,
-				ECE3DF9C270C660900FB4C96 /* MXMulticastDelegate.swift */,
 				C6FE1EEF1E65C4F7008587E4 /* MXAnalyticsDelegate.h */,
 				32B090E1261F709B002924AA /* MXAsyncTaskQueue.swift */,
 				32A9E8211EF4026E0081358A /* MXBackgroundModeHandler.h */,
@@ -2941,6 +2943,7 @@
 				B1798D0524091A0100308A8F /* MXBase64Tools.m */,
 				3283F7761EAF30F700C1688C /* MXBugReportRestClient.h */,
 				3283F7771EAF30F700C1688C /* MXBugReportRestClient.m */,
+				B2EC7E2227F483DB00F40C26 /* MXEventAssetTypeMapper.swift */,
 				322DB456212EB8E600F4EFE9 /* MXHTTPClient_Private.h */,
 				320DFDD719DD99B60068622A /* MXHTTPClient.h */,
 				320DFDD819DD99B60068622A /* MXHTTPClient.m */,
@@ -2955,6 +2958,7 @@
 				F03EF5021DF01596009DF592 /* MXLRUCache.h */,
 				F03EF5031DF01596009DF592 /* MXLRUCache.m */,
 				324676EB25C15F4600EA855B /* MXMemory.swift */,
+				ECE3DF9C270C660900FB4C96 /* MXMulticastDelegate.swift */,
 				32A9770221626E5C00919CC0 /* MXServerNotices.h */,
 				32A9770321626E5C00919CC0 /* MXServerNotices.m */,
 				32A9F8DC244720B10069C65B /* MXThrottler.h */,
@@ -6016,6 +6020,7 @@
 				3A59A49F25A7A16F00DDA1FC /* MXOlmOutboundGroupSession.m in Sources */,
 				B146D4F221A5AF7F00D8C2C6 /* MXRealmEventScanMapper.m in Sources */,
 				B11BD45A22CB58850064D8B0 /* MXReplyEventFormattedBodyParts.m in Sources */,
+				B2EC7E2327F483DB00F40C26 /* MXEventAssetTypeMapper.swift in Sources */,
 				32CE6FB91A409B1F00317F1E /* MXFileStoreMetaData.m in Sources */,
 				3264DB921CEC528D00B99881 /* MXAccountData.m in Sources */,
 				3229535325A5F7220012FCF0 /* MXBackgroundCryptoStore.m in Sources */,
@@ -6539,6 +6544,7 @@
 				B14EF2322397E90400758AF0 /* MXBugReportRestClient.m in Sources */,
 				B14EF2342397E90400758AF0 /* MXCallKitAdapter.m in Sources */,
 				327C3E4E23A39D91006183D1 /* MXAggregatedReferencesUpdater.m in Sources */,
+				B2EC7E2427F483DB00F40C26 /* MXEventAssetTypeMapper.swift in Sources */,
 				B14EF2352397E90400758AF0 /* MXRoomPowerLevels.swift in Sources */,
 				32AF9287240EA2430008A0FD /* MXSecretShareRequest.m in Sources */,
 				91CC0FCD26A033AE00C2A387 /* MXURLPreview.m in Sources */,

MatrixSDK/Data/MXRoom.h

@@ -39,6 +39,7 @@
 #import "MXCall.h"
 #import "MXEventTimeline.h"
 #import "MXEventsEnumerator.h"
+#import "MXEventContentLocation.h"
 #import "MXCryptoConstants.h"
 #import "MXSendReplyEventStringLocalizerProtocol.h"
 
@@ -1026,6 +1027,7 @@ FOUNDATION_EXPORT NSInteger const kMXRoomInvalidInviteSenderErrorCode;
                                   description:(NSString *)description
                                      threadId:(NSString*)threadId
                                     localEcho:(MXEvent **)localEcho
+                                    assetType:(MXEventAssetType)assetType
                                       success:(void (^)(NSString *))success
                                       failure:(void (^)(NSError *))failure;
 

MatrixSDK/Data/MXRoom.m

@@ -2535,10 +2535,11 @@ - (MXHTTPOperation *)sendLocationWithLatitude:(double)latitude
                                   description:(NSString *)description
                                      threadId:(NSString*)threadId
                                     localEcho:(MXEvent **)localEcho
+                                    assetType:(MXEventAssetType)assetType
                                       success:(void (^)(NSString *))success
                                       failure:(void (^)(NSError *))failure
 {
-    MXEventContentLocation *locationContent = [[MXEventContentLocation alloc] initWithAssetType:MXEventAssetTypeUser
+    MXEventContentLocation *locationContent = [[MXEventContentLocation alloc] initWithAssetType:assetType
                                                                                        latitude:latitude
                                                                                       longitude:longitude
                                                                                     description:description];
@@ -2547,7 +2548,7 @@ - (MXHTTPOperation *)sendLocationWithLatitude:(double)latitude
 
     [content addEntriesFromDictionary:locationContent.JSONDictionary];
 
-    NSString *fallbackText = [NSString stringWithFormat:@"%@ was at %@ as of %@", self.mxSession.myUser.displayname, locationContent.geoURI, NSDate.date];
+    NSString *fallbackText = [NSString stringWithFormat:@"Location was shared at %@ as of %@", locationContent.geoURI, NSDate.date];
     content[kMXMessageBodyKey] = fallbackText;
     content[kMXMessageContentKeyExtensibleTextMSC1767] = fallbackText;
 

MatrixSDK/JSONModels/Event/Content/MXEventContentLocation.h

@@ -23,6 +23,7 @@ NS_ASSUME_NONNULL_BEGIN
 typedef NS_ENUM(NSUInteger, MXEventAssetType)
 {
     MXEventAssetTypeUser,
+    MXEventAssetTypePin,
     MXEventAssetTypeGeneric
 };
 

MatrixSDK/JSONModels/Event/Content/MXEventContentLocation.m

@@ -17,6 +17,14 @@
 #import "MXEventContentLocation.h"
 #import "MXEvent.h"
 
+#import "MatrixSDKSwiftHeader.h"
+
+@interface MXEventContentLocation()
+
+@property (nonatomic) MXEventAssetTypeMapper *eventAssetTypeMapper;
+
+@end
+
 @implementation MXEventContentLocation
 
 - (instancetype)initWithAssetType:(MXEventAssetType)assetType
@@ -31,6 +39,7 @@ - (instancetype)initWithAssetType:(MXEventAssetType)assetType
         _longitude = longitude;
         _locationDescription = description;
         _geoURI = [NSString stringWithFormat:@"geo:%@,%@", @(self.latitude), @(self.longitude)];
+        _eventAssetTypeMapper = [[MXEventAssetTypeMapper alloc] init];
     }
 
     return self;
@@ -40,7 +49,7 @@ + (instancetype)modelFromJSON:(NSDictionary *)JSONDictionary
 {
     NSString *description;
     NSString *geoURIString;
-    MXEventAssetType assetType = MXEventAssetTypeUser;
+    MXEventAssetType assetType;
 
     NSDictionary *locationDictionary = JSONDictionary[kMXMessageContentKeyExtensibleLocationMSC3488];
     if (locationDictionary == nil)
@@ -67,12 +76,12 @@ + (instancetype)modelFromJSON:(NSDictionary *)JSONDictionary
     {
         assetDictionary = JSONDictionary[kMXMessageContentKeyExtensibleAsset];
     }
-    
     if (assetDictionary)
     {
-        if (![assetDictionary[kMXMessageContentKeyExtensibleAssetType] isEqualToString:kMXMessageContentKeyExtensibleAssetTypeUser]) {
-            assetType = MXEventAssetTypeGeneric;
-        }
+        assetType = [[[MXEventAssetTypeMapper alloc] init] eventAssetTypeFrom:assetDictionary[kMXMessageContentKeyExtensibleAssetType]];
+    } else {
+        // Should behave like m.self if assetType is nil
+        assetType = MXEventAssetTypeUser;
     }
 
     NSString *locationString = [[geoURIString componentsSeparatedByString:@":"].lastObject componentsSeparatedByString:@";"].firstObject;
@@ -101,7 +110,7 @@ - (NSDictionary *)JSONDictionary
     locationContent[kMXMessageContentKeyExtensibleLocationDescription] = self.locationDescription;
     content[kMXMessageContentKeyExtensibleLocationMSC3488] = locationContent;
 
-    content[kMXMessageContentKeyExtensibleAssetMSC3488] = @{ kMXMessageContentKeyExtensibleAssetType: kMXMessageContentKeyExtensibleAssetTypeUser };
+    content[kMXMessageContentKeyExtensibleAssetMSC3488] = @{ kMXMessageContentKeyExtensibleAssetType: [_eventAssetTypeMapper eventKeyFrom:self.assetType] };
 
     content[kMXMessageTypeKey] = kMXMessageTypeLocation;
     content[kMXMessageGeoURIKey] = self.geoURI;

MatrixSDK/JSONModels/MXEvent.h

@@ -281,6 +281,7 @@ FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAsset;
 FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAssetMSC3488;
 FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAssetType;
 FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAssetTypeUser;
+FOUNDATION_EXPORT NSString *const kMXMessageContentKeyExtensibleAssetTypePin;
 
 // Join Rules
 

MatrixSDK/JSONModels/MXEvent.m

@@ -189,6 +189,7 @@
 NSString *const kMXMessageContentKeyExtensibleAssetMSC3488 = @"org.matrix.msc3488.asset";
 NSString *const kMXMessageContentKeyExtensibleAssetType = @"type";
 NSString *const kMXMessageContentKeyExtensibleAssetTypeUser = @"m.self";
+NSString *const kMXMessageContentKeyExtensibleAssetTypePin = @"m.pin";
 
 // Join Rules
 

MatrixSDK/MatrixSDK.h

@@ -105,6 +105,7 @@ FOUNDATION_EXPORT NSString *MatrixSDKVersion;
 #import "MXEventReplace.h"
 #import "MXInReplyTo.h"
 #import "MXEventRelationThread.h"
+#import "MXEventContentLocation.h"
 
 #import "MXReplyEventParser.h"
 

MatrixSDK/Utils/MXEventAssetTypeMapper.swift

@@ -0,0 +1,54 @@
+// 
+// Copyright 2022 The Matrix.org Foundation C.I.C
+//
+// 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
+
+/// MXEventAssetTypeMapper enables to get the corresponding MXEventAssetType from event key String and the other way around.
+@objcMembers
+public class MXEventAssetTypeMapper: NSObject {
+    
+    // MARK: - Public
+    
+    /// Return event key String associate to the MXEventAssetType given
+    public func eventKey(from eventAssetType: MXEventAssetType) -> String {
+        let eventKey: String
+        switch eventAssetType {
+        case .user:
+            eventKey = kMXMessageContentKeyExtensibleAssetTypeUser
+        case .pin:
+            eventKey = kMXMessageContentKeyExtensibleAssetTypePin
+        case .generic:
+            eventKey = ""
+        @unknown default:
+            eventKey = ""
+        }
+        return eventKey
+    }
+    
+    /// Return MXEventAssetType associate to the event key String given
+    public func eventAssetType(from eventKey: String) -> MXEventAssetType {
+        let eventAssetType: MXEventAssetType
+        switch eventKey {
+        case kMXMessageContentKeyExtensibleAssetTypeUser:
+            eventAssetType = .user
+        case kMXMessageContentKeyExtensibleAssetTypePin:
+            eventAssetType = .pin
+        default:
+            eventAssetType = .generic
+        }
+        return eventAssetType
+    }
+}

changelog.d/5858.api

@@ -0,0 +1 @@
+Location sharing: Add new event asset type for pin drop location sharing