✨Add multiroom to MXStore

Author: artemkrachulov

MatrixSDK/Background/MXBackgroundStore.swift

@@ -186,7 +186,14 @@ class MXBackgroundStore: NSObject, MXStore {
     func user(withUserId userId: String) -> MXUser? {
         return nil
     }
-    
+
+    func storeLocations(_ newLocations: [String : MXMultiroomSync]) {
+    }
+
+    func locations() -> [String : MXMultiroomSync] {
+      return [:]
+    }
+
     func store(_ group: MXGroup) {
     }
 

MatrixSDK/Data/Store/MXFileStore/MXFileStore.h

@@ -71,6 +71,10 @@ typedef NS_OPTIONS(NSInteger, MXFileStorePreloadOptions)
                 L usersGroup #1
                 L usersGroup #2
                 L ...
+            + multiroom
+                L userLocation #1
+                L userLocation #2
+                L ...
             + groups:
                 L groupA
                 L groupB

MatrixSDK/Data/Store/MXFileStore/MXFileStore.m

@@ -35,6 +35,7 @@
 static NSString *const kMXFileStoreMedaDataFile = @"MXFileStore";
 static NSString *const kMXFileStoreFiltersFile = @"filters";
 static NSString *const kMXFileStoreUsersFolder = @"users";
+static NSString *const kMXFileStoreMultiroomFolder = @"multiroom";
 static NSString *const kMXFileStoreGroupsFolder = @"groups";
 static NSString *const kMXFileStoreBackupFolder = @"backup";
 
@@ -71,6 +72,8 @@ @interface MXFileStore ()
     NSMutableArray *roomsToCommitForDeletion;
 
     NSMutableDictionary *usersToCommit;
+  
+    NSDictionary *multiroomToCommit;
 
     NSMutableDictionary *groupsToCommit;
     NSMutableArray *groupsToCommitForDeletion;
@@ -86,6 +89,9 @@ @interface MXFileStore ()
 
     // The path of the rooms folder
     NSString *storeUsersPath;
+  
+    // The path of the multiroom folder
+    NSString *storeMultiroomPath;
 
     // The path of the groups folder
     NSString *storeGroupsPath;
@@ -150,6 +156,7 @@ - (instancetype)init;
         roomsToCommitForReceipts = [NSMutableArray array];
         roomsToCommitForDeletion = [NSMutableArray array];
         usersToCommit = [NSMutableDictionary dictionary];
+        multiroomToCommit = [NSDictionary dictionary];
         groupsToCommit = [NSMutableDictionary dictionary];
         groupsToCommitForDeletion = [NSMutableArray array];
         preloadedRoomsStates = [NSMutableDictionary dictionary];
@@ -260,6 +267,7 @@ - (void)openWithCredentials:(MXCredentials*)someCredentials onComplete:(void (^)
                     [self preloadRoomReceipts];
                 }
                 [self loadUsers];
+                [self loadMultiroom];
                 [self loadGroups];
                 [self loadUnreadRooms];
                 taskProfile.units = self.roomSummaryStore.countOfRooms;
@@ -412,6 +420,7 @@ - (void)deleteAllData
     [[NSFileManager defaultManager] createDirectoryExcludedFromBackupAtPath:storePath error:nil];
     [[NSFileManager defaultManager] createDirectoryExcludedFromBackupAtPath:storeRoomsPath error:nil];
     [[NSFileManager defaultManager] createDirectoryExcludedFromBackupAtPath:storeUsersPath error:nil];
+    [[NSFileManager defaultManager] createDirectoryExcludedFromBackupAtPath:storeMultiroomPath error:nil];
     [[NSFileManager defaultManager] createDirectoryExcludedFromBackupAtPath:storeGroupsPath error:nil];
 
     [roomSummaryStore removeAllSummaries];
@@ -620,6 +629,13 @@ - (void)storeUser:(MXUser *)user
     usersToCommit[user.userId] = user;
 }
 
+- (void)storeLocations:(nonnull NSDictionary<NSString*, MXMultiroomSync*>*)newLocations {
+  
+  [super storeLocations:newLocations];
+  
+  multiroomToCommit = newLocations;
+}
+
 - (void)storeGroup:(MXGroup *)group
 {
     [super storeGroup:group];
@@ -840,6 +856,7 @@ - (void)saveDataToFiles
     [self saveRoomsAccountData];
     [self saveReceipts];
     [self saveUsers];
+    [self saveMultiroom];
     [self saveGroupsDeletion];
     [self saveGroups];
     [self saveUnreadRooms];
@@ -1123,6 +1140,7 @@ - (void)setUpStoragePaths
     storePath = [[cachePath stringByAppendingPathComponent:kMXFileStoreFolder] stringByAppendingPathComponent:credentials.userId];
     storeRoomsPath = [storePath stringByAppendingPathComponent:kMXFileStoreRoomsFolder];
     storeUsersPath = [storePath stringByAppendingPathComponent:kMXFileStoreUsersFolder];
+    storeMultiroomPath = [storePath stringByAppendingPathComponent:kMXFileStoreMultiroomFolder];
     storeGroupsPath = [storePath stringByAppendingPathComponent:kMXFileStoreGroupsFolder];
 
     storeBackupPath = [storePath stringByAppendingPathComponent:kMXFileStoreBackupFolder];
@@ -1257,6 +1275,31 @@ - (NSString*)usersFileForUser:(NSString*)userId forBackup:(BOOL)backup
     }
 }
 
+- (NSString*)multiroomFileForGroup:(NSString*)multiroomId forBackup:(BOOL)backup
+{
+  if (!backup)
+  {
+    return [storeMultiroomPath stringByAppendingPathComponent:multiroomId];
+  }
+  else
+  {
+    if (backupEventStreamToken)
+    {
+      NSString *multiroomBackupFolder = [[storeBackupPath stringByAppendingPathComponent:backupEventStreamToken] stringByAppendingPathComponent:kMXFileStoreMultiroomFolder];
+      if (![NSFileManager.defaultManager fileExistsAtPath:multiroomBackupFolder])
+      {
+        [[NSFileManager defaultManager] createDirectoryExcludedFromBackupAtPath:multiroomBackupFolder error:nil];
+      }
+      
+      return [multiroomBackupFolder stringByAppendingPathComponent:multiroomId];
+    }
+    else
+    {
+      return nil;
+    }
+  }
+}
+
 - (NSString*)groupFileForGroup:(NSString*)groupId forBackup:(BOOL)backup
 {
     if (!backup)
@@ -2015,6 +2058,88 @@ - (void)saveUsers
     }
 }
 
+#pragma mark - Multiroom locations
+
+/**
+ Preload all multiroom locations.
+ 
+ This operation must be called on the `dispatchQueue` thread to avoid blocking the main thread.
+ */
+- (void)loadMultiroom
+{
+  NSDate *startDate = [NSDate date];
+  
+  // Load all multiroom files
+  NSArray *multiroomIds = [[NSFileManager defaultManager] contentsOfDirectoryAtPath:storeMultiroomPath error:nil];
+  
+  for (NSString *multiroomId in multiroomIds)
+  {
+    NSString *multiroomFile = [storeMultiroomPath stringByAppendingPathComponent:multiroomId];
+    
+    // Load stored locations
+    
+    @try
+    {
+      MXMultiroomSync *multiroom = [NSKeyedUnarchiver unarchiveObjectWithFile: multiroomFile];
+      if (multiroom) {
+        // Append them
+        [locations setObject:multiroom forKey:multiroomId];
+      }
+    }
+    @catch (NSException *exception)
+    {
+      MXLogDebug(@"[MXFileStore] Warning: MXFileRoomStore file for multiroom %@ has been corrupted", locations);
+    }
+  }
+  
+  MXLogDebug(@"[MXFileStore] Loaded %tu MXMultiroomSync in %.0fms", locations.count, [[NSDate date] timeIntervalSinceDate:startDate] * 1000);
+}
+
+- (void)saveMultiroom
+{
+  // Save only in case of change
+  if (multiroomToCommit.count)
+  {
+    
+    // Check if folder exists
+    if (![NSFileManager.defaultManager fileExistsAtPath:storeMultiroomPath])
+    {
+      [[NSFileManager defaultManager] createDirectoryExcludedFromBackupAtPath:storeMultiroomPath error:nil];
+    }
+    
+    // Take a snapshot of groups to store them on the other thread
+    NSMutableDictionary *theMultiroomToCommit = [[NSMutableDictionary alloc] initWithDictionary:multiroomToCommit copyItems:YES];
+    multiroomToCommit = [NSDictionary dictionary];
+#if DEBUG
+    MXLogDebug(@"[MXFileStore commit] queuing saveMultiroom");
+#endif
+    dispatch_async(dispatchQueue, ^(void){
+      
+#if DEBUG
+      NSDate *startDate = [NSDate date];
+#endif
+      for (NSString *multiroomId in theMultiroomToCommit)
+      {
+        MXMultiroomSync *multiroom = theMultiroomToCommit[multiroomId];
+        
+        NSString *file = [self multiroomFileForGroup:multiroomId forBackup:NO];
+        
+        // Backup the file for this location
+        NSString *backupFile = [self multiroomFileForGroup:multiroomId forBackup:YES];
+        if (backupFile && [[NSFileManager defaultManager] fileExistsAtPath:file])
+        {
+          [[NSFileManager defaultManager] moveItemAtPath:file toPath:backupFile error:nil];
+        }
+
+        [NSKeyedArchiver archiveRootObject:multiroom toFile:file];
+      }
+#if DEBUG
+      MXLogDebug(@"[MXFileStore] saveMultiroom in %.0fms", [[NSDate date] timeIntervalSinceDate:startDate] * 1000);
+#endif
+    });
+  }
+}
+
 #pragma mark - Matrix groups
 /**
  Preload all groups.

MatrixSDK/Data/Store/MXMemoryStore/MXMemoryStore.h

@@ -42,6 +42,10 @@ typedef NSMutableDictionary<NSString*, RoomReceiptsStore*> RoomThreadedReceiptsS
     // All matrix users known by the user
     // The keys are user ids.
     NSMutableDictionary <NSString*, MXUser*> *users;
+  
+    // All matrix multiroom locations known by the user
+    // The keys are user ids.
+    NSMutableDictionary <NSString*, MXMultiroomSync*> *locations;
 
     // All matrix groups known by the user
     // The keys are groups ids.

MatrixSDK/Data/Store/MXMemoryStore/MXMemoryStore.m

@@ -51,6 +51,7 @@ - (instancetype)init
         roomOutgoingMessagesStores = [NSMutableDictionary dictionary];
         roomThreadedReceiptsStores = [NSMutableDictionary dictionary];
         users = [NSMutableDictionary dictionary];
+//        locations = [NSMutableDictionary dictionary];
         groups = [NSMutableDictionary dictionary];
         roomUnreaded = [[NSMutableSet alloc] init];
         roomSummaryStore = [[MXMemoryRoomSummaryStore alloc] init];
@@ -446,6 +447,17 @@ - (MXUser *)userWithUserId:(NSString *)userId
     return users[userId];
 }
 
+#pragma mark - Multiroom locations
+
+- (void)storeLocations:(nonnull NSDictionary<NSString*, MXMultiroomSync*>*)newLocations {
+  [locations addEntriesFromDictionary: newLocations];
+}
+
+- (NSDictionary<NSString*, MXMultiroomSync*>*)locations
+{
+  return locations;
+}
+
 #pragma mark - Matrix groups
 - (void)storeGroup:(MXGroup *)group
 {

MatrixSDK/Data/Store/MXStore.h

@@ -26,6 +26,7 @@
 #import "MXRoomAccountData.h"
 #import "MXGroup.h"
 #import "MXFilterJSONModel.h"
+#import "MXMultiroomSync.h"
 
 #import "MXEventsEnumerator.h"
 #import "MXRoomSummaryStore.h"
@@ -218,6 +219,19 @@
  */
 - (MXUser* _Nullable)userWithUserId:(nonnull NSString*)userId;
 
+#pragma mark - Multiroom locations
+/**
+ Store a multiroom locations.
+ */
+- (void)storeLocations:(nonnull NSDictionary<NSString*, MXMultiroomSync*>*)newLocations;
+
+/**
+ Get the list of all stored multiroom locations.
+ 
+ @return an array of MXUser.
+ */
+- (NSDictionary<NSString*, MXMultiroomSync*>*)locations;
+
 #pragma mark - groups
 /**
  Store a matrix group.

MatrixSDK/JSONModels/Sync/Multiroom/MXMultiroomSync.h

@@ -5,13 +5,17 @@
 //  Created by Artem Krachulov on 04.04.2023.
 //
 
-#import <MatrixSDK/MatrixSDK.h>
+#import <Foundation/Foundation.h>
 
+#import "MXJSONModels.h"
+//#import "MXEnumConstants.h"
+
+@class MXSession;
 @class MXMultiroomSyncLocation;
 
 NS_ASSUME_NONNULL_BEGIN
 
-@interface MXMultiroomSync : MXJSONModel
+@interface MXMultiroomSync : MXJSONModel <NSCoding, NSCopying>
 
 /**
  The location posted via /_matrix/client/r0/multiroom/connect.multiroom.location request.

MatrixSDK/JSONModels/Sync/Multiroom/MXMultiroomSync.m

@@ -38,4 +38,38 @@ - (NSDictionary *)JSONDictionary
   return JSONDictionary;
 }
 
+#pragma mark - NSCoding
+
+- (instancetype)initWithCoder:(NSCoder *)aDecoder
+{
+  self = [super init];
+  if (self)
+  {
+    _location = [aDecoder decodeObjectForKey:@"location"];
+    _panic = [aDecoder decodeObjectForKey:@"panic"];
+  }
+  return self;
+}
+
+- (void)encodeWithCoder:(NSCoder *)aCoder
+{
+  if(_location) {
+    [aCoder encodeObject:_location forKey:@"location"];
+  }
+  if (_panic) {
+    [aCoder encodeObject:_panic forKey:@"panic"];
+  }
+}
+
+#pragma mark - NSCopying
+
+- (id)copyWithZone:(NSZone *)zone
+{
+  MXMultiroomSync *multiroomSync = [[[self class] allocWithZone:zone] init];
+  
+  multiroomSync->_location = [_location copyWithZone:zone];
+  multiroomSync->_panic = [_panic copyWithZone:zone];
+  return multiroomSync;
+}
+
 @end

MatrixSDK/JSONModels/Sync/Multiroom/MXMultiroomSyncLocation.h

@@ -16,7 +16,7 @@ NS_ASSUME_NONNULL_BEGIN
  by this model.
  */
 
-@interface MXMultiroomSyncLocation : MXJSONModel
+@interface MXMultiroomSyncLocation : MXJSONModel<NSCopying>
 
 /**
  The event (possibly encrypted) content.