Merge pull request #126 from matrix-org/release-v0.6.13

Release v0.6.13

Author: manuroe

CHANGES.rst

@@ -1,3 +1,37 @@
+Changes in Matrix iOS SDK in 0.6.13 (2016-08-25)
+================================================
+
+Improvements:
+ * Add conference call support.
+ * Call: Update the libjingle lib to its latest version. That implied a major refactoring of MXJingleCallStack.
+ * Repair MXFileStore in case of interrupted commit (https://github.com/vector-im/vector-ios/issues/376).
+ * Speed up MXFileStore loading.
+ * Allow MXFileStore to run when the app is backgrounded.
+ * Change the MXStore API to be able to run several paginations in parallel.
+ 
+API improvements:
+ * Add MXEventsEnumerator to enumerate sets of events like those returned by the MXStore API.
+ * MXRoomState: Added - (NSArray*)membersWithMembership:(MXMembership)membership.
+ * MXSession & MXRestClient: Add createRoom with a parameters dictionary to manage all fields available in Matrix spec.
+ * MXCall: Add cameraPosition property to switch the camera.
+ * MXMyUser: Allow nil callback blocks in setter methods.
+ * SDK Tests: Add a test on [MXRestClient close].
+ * SDK Tests: Add a test on [MXFileStore diskUsage].
+ 
+Bug fixes:
+ * Redacting membership events should immediately reset the displayname & avatar of room members (https://github.com/vector-im/vector-ios/issues/443).
+ * Profile changes shouldn't reorder the room list (https://github.com/vector-im/vector-ios/issues/494).
+ * When the last message is redacted, [MXKRecentCellData update] makes paginations loops (https://github.com/vector-im/vector-ios/issues/520).
+ * MXSession: Do not send kMXSessionIgnoredUsersDidChangeNotification when the session loads the data from the store (https://github.com/vector-im/vector-ios/issues/491).
+ * MXHTTPClient: Fix crash: "Task created in a session that has been invalidated" (https://github.com/vector-im/vector-ios/issues/490).
+ * Call: the remote and local video are not scaled to fill the video container (https://github.com/vector-im/vector-ios/issues/537).
+
+API Breaks:
+ * Rename "kMXRoomSyncWithLimitedTimelineNotification" with "kMXRoomDidFlushMessagesNotification"
+ * MXRoom: Make placeCall: asynchronous.
+ * MXFileStore: Replace 'diskUsage' property by an async non blocking method: [self diskUsageWithBlock:].
+ * MXStore: Replace [MXStore resetPaginationOfRoom:], [MXStore paginateRoom:numMessages:] and [MXStore remainingMessagesForPaginationInRoom:] methods by [MXStore messagesEnumeratorForRoom:]
+
 Changes in Matrix iOS SDK in 0.6.12 (2016-08-01)
 ================================================
 

MatrixSDK.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "MatrixSDK"
-  s.version      = "0.6.12"
+  s.version      = "0.6.13"
   s.summary      = "The iOS SDK to build apps compatible with Matrix (http://www.matrix.org)"
 
   s.description  = <<-DESC
@@ -19,7 +19,7 @@ Pod::Spec.new do |s|
 
   s.platform     = :ios, "7.0"
 
-  s.source       = { :git => "https://github.com/matrix-org/matrix-ios-sdk.git", :tag => "v0.6.12" }
+  s.source       = { :git => "https://github.com/matrix-org/matrix-ios-sdk.git", :tag => "v0.6.13" }
   s.source_files = "MatrixSDK", "MatrixSDK/**/*.{h,m}"
   s.resources    = "MatrixSDK/Data/Store/MXCoreDataStore/*.xcdatamodeld"
 

MatrixSDK.xcodeproj/project.pbxproj

@@ -7,6 +7,11 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		320BBF3C1D6C7D9D0079890E /* MXEventsEnumerator.h in Headers */ = {isa = PBXBuildFile; fileRef = 320BBF3B1D6C7D9D0079890E /* MXEventsEnumerator.h */; };
+		320BBF411D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.m in Sources */ = {isa = PBXBuildFile; fileRef = 320BBF3D1D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.m */; };
+		320BBF421D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.h in Headers */ = {isa = PBXBuildFile; fileRef = 320BBF3E1D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.h */; };
+		320BBF431D6C81550079890E /* MXEventsEnumeratorOnArray.h in Headers */ = {isa = PBXBuildFile; fileRef = 320BBF3F1D6C81550079890E /* MXEventsEnumeratorOnArray.h */; };
+		320BBF441D6C81550079890E /* MXEventsEnumeratorOnArray.m in Sources */ = {isa = PBXBuildFile; fileRef = 320BBF401D6C81550079890E /* MXEventsEnumeratorOnArray.m */; };
 		320DFDDB19DD99B60068622A /* MXRoom.h in Headers */ = {isa = PBXBuildFile; fileRef = 320DFDCA19DD99B60068622A /* MXRoom.h */; };
 		320DFDDC19DD99B60068622A /* MXRoom.m in Sources */ = {isa = PBXBuildFile; fileRef = 320DFDCB19DD99B60068622A /* MXRoom.m */; };
 		320DFDE019DD99B60068622A /* MXSession.h in Headers */ = {isa = PBXBuildFile; fileRef = 320DFDD019DD99B60068622A /* MXSession.h */; };
@@ -172,6 +177,11 @@
 /* Begin PBXFileReference section */
 		0BCFBADF157F3C8C43112BD6 /* Pods-MatrixSDKTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-MatrixSDKTests.release.xcconfig"; path = "Pods/Target Support Files/Pods-MatrixSDKTests/Pods-MatrixSDKTests.release.xcconfig"; sourceTree = "<group>"; };
 		2BF02FACC417CA3368671024 /* Pods-MatrixSDK.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-MatrixSDK.debug.xcconfig"; path = "Pods/Target Support Files/Pods-MatrixSDK/Pods-MatrixSDK.debug.xcconfig"; sourceTree = "<group>"; };
+		320BBF3B1D6C7D9D0079890E /* MXEventsEnumerator.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MXEventsEnumerator.h; sourceTree = "<group>"; };
+		320BBF3D1D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MXEventsByTypesEnumeratorOnArray.m; sourceTree = "<group>"; };
+		320BBF3E1D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MXEventsByTypesEnumeratorOnArray.h; sourceTree = "<group>"; };
+		320BBF3F1D6C81550079890E /* MXEventsEnumeratorOnArray.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MXEventsEnumeratorOnArray.h; sourceTree = "<group>"; };
+		320BBF401D6C81550079890E /* MXEventsEnumeratorOnArray.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MXEventsEnumeratorOnArray.m; sourceTree = "<group>"; };
 		320DFDCA19DD99B60068622A /* MXRoom.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MXRoom.h; sourceTree = "<group>"; };
 		320DFDCB19DD99B60068622A /* MXRoom.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; lineEnding = 0; path = MXRoom.m; sourceTree = "<group>"; };
 		320DFDD019DD99B60068622A /* MXSession.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; lineEnding = 0; path = MXSession.h; sourceTree = "<group>"; };
@@ -354,9 +364,22 @@
 			name = Pods;
 			sourceTree = "<group>";
 		};
+		320BBF3A1D6C7D9D0079890E /* EventsEnumerator */ = {
+			isa = PBXGroup;
+			children = (
+				320BBF3B1D6C7D9D0079890E /* MXEventsEnumerator.h */,
+				320BBF3F1D6C81550079890E /* MXEventsEnumeratorOnArray.h */,
+				320BBF401D6C81550079890E /* MXEventsEnumeratorOnArray.m */,
+				320BBF3D1D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.m */,
+				320BBF3E1D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.h */,
+			);
+			path = EventsEnumerator;
+			sourceTree = "<group>";
+		};
 		320DFDC719DD99B60068622A /* Data */ = {
 			isa = PBXGroup;
 			children = (
+				320BBF3A1D6C7D9D0079890E /* EventsEnumerator */,
 				32114A831A262CE000FF2EC4 /* Store */,
 				320DFDCA19DD99B60068622A /* MXRoom.h */,
 				320DFDCB19DD99B60068622A /* MXRoom.m */,
@@ -686,7 +709,9 @@
 				3245A7521AF7B2930001D8A7 /* MXCallManager.h in Headers */,
 				3264E2A21BDF8D1500F89A86 /* MXCoreDataRoomState.h in Headers */,
 				3291D4D41A68FFEB00C3BA41 /* MXFileRoomStore.h in Headers */,
+				320BBF431D6C81550079890E /* MXEventsEnumeratorOnArray.h in Headers */,
 				32C6F93319DD814400EA4E9C /* MatrixSDK.h in Headers */,
+				320BBF3C1D6C7D9D0079890E /* MXEventsEnumerator.h in Headers */,
 				323D299A1D426F7000A80BE4 /* MXJingleVideoView.h in Headers */,
 				323E0C571A2F6E7D00A31D73 /* MXRoomPowerLevels.h in Headers */,
 				3245A7501AF7B2930001D8A7 /* MXCall.h in Headers */,
@@ -697,6 +722,7 @@
 				32481A841C03572900782AD3 /* MXRoomAccountData.h in Headers */,
 				3281E8B919E42DFE00976E1A /* MXJSONModels.h in Headers */,
 				323B2AFE1BCE9B6700B11F34 /* MXCoreDataEvent+CoreDataProperties.h in Headers */,
+				320BBF421D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.h in Headers */,
 				323B2ADF1BCD4CB600B11F34 /* MXCoreDataAccount+CoreDataProperties.h in Headers */,
 				32CAB1071A91EA34008C5BB9 /* MXPushRuleRoomMemberCountConditionChecker.h in Headers */,
 				32CAB10B1A925B41008C5BB9 /* MXHTTPOperation.h in Headers */,
@@ -916,6 +942,7 @@
 				322360531A8E610500A3CA81 /* MXPushRuleDisplayNameCondtionChecker.m in Sources */,
 				323E0C581A2F6E7D00A31D73 /* MXRoomPowerLevels.m in Sources */,
 				32DC15D51A8CF874006F9AD3 /* MXPushRuleEventMatchConditionChecker.m in Sources */,
+				320BBF411D6C81550079890E /* MXEventsByTypesEnumeratorOnArray.m in Sources */,
 				32CAB1081A91EA34008C5BB9 /* MXPushRuleRoomMemberCountConditionChecker.m in Sources */,
 				3245A7511AF7B2930001D8A7 /* MXCall.m in Sources */,
 				327F8DB31C6112BA00581CA3 /* MXRoomThirdPartyInvite.m in Sources */,
@@ -951,6 +978,7 @@
 				32FE41371D0AB7070060835E /* MXEnumConstants.m in Sources */,
 				320DFDE119DD99B60068622A /* MXSession.m in Sources */,
 				F0C34CBB1C18C93700C36F09 /* MXSDKOptions.m in Sources */,
+				320BBF441D6C81550079890E /* MXEventsEnumeratorOnArray.m in Sources */,
 				320DFDDC19DD99B60068622A /* MXRoom.m in Sources */,
 				3291D4D51A68FFEB00C3BA41 /* MXFileRoomStore.m in Sources */,
 				329FB1801A0B665800A5E88E /* MXUser.m in Sources */,

MatrixSDK/Data/EventsEnumerator/MXEventsByTypesEnumeratorOnArray.h

@@ -0,0 +1,37 @@
+/*
+ Copyright 2016 OpenMarket 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/Foundation.h>
+
+#import "MXEventsEnumerator.h"
+
+/**
+ Generic events enumerator on an array of events with a filter on events types.
+ */
+@interface MXEventsByTypesEnumeratorOnArray : NSObject <MXEventsEnumerator>
+
+/**
+ Construct an enumerator based on a events array.
+
+ @param messages the list of messages to enumerate on.
+ @param types an array of event types strings to use as a filter filter.
+ @param ignoreProfileChanges tell whether the profile changes should be ignored.
+
+ @return the newly created instance.
+ */
+- (instancetype)initWithMessages:(NSMutableArray<MXEvent*> *)messages andTypesIn:(NSArray*)types ignoreMemberProfileChanges:(BOOL)ignoreProfileChanges;
+
+@end

MatrixSDK/Data/EventsEnumerator/MXEventsByTypesEnumeratorOnArray.m

@@ -0,0 +1,99 @@
+/*
+ Copyright 2016 OpenMarket 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 "MXEventsByTypesEnumeratorOnArray.h"
+
+#import "MXEventsEnumeratorOnArray.h"
+
+@interface MXEventsByTypesEnumeratorOnArray ()
+{
+    // The all-messages enumerator
+    // Note: it would be much quicker to process directly `messages` but
+    // the all-messages enumerator make this enumerator easy to implement.
+    MXEventsEnumeratorOnArray *allMessagesEnumerator;
+
+    // The event types to filter in
+    NSArray *types;
+
+    // Tell whether the profile changes should be ignored
+    BOOL ignoreMemberProfileChanges;
+}
+
+@end
+
+@implementation MXEventsByTypesEnumeratorOnArray
+
+- (instancetype)initWithMessages:(NSMutableArray<MXEvent *> *)messages andTypesIn:(NSArray *)theTypes ignoreMemberProfileChanges:(BOOL)ignoreProfileChanges
+{
+    self = [super init];
+    if (self)
+    {
+        types = theTypes;
+        ignoreMemberProfileChanges = ignoreProfileChanges;
+        allMessagesEnumerator = [[MXEventsEnumeratorOnArray alloc] initWithMessages:messages];
+    }
+
+    return self;
+}
+
+- (NSArray<MXEvent *> *)nextEventsBatch:(NSUInteger)eventsCount
+{
+    NSMutableArray *nextEvents;
+    MXEvent *event;
+
+    // Feed the array with matching events
+    while ((event = self.nextEvent) && (nextEvents.count != eventsCount))
+    {
+        if (!nextEvents)
+        {
+            // Create the array only if there are events to return
+            nextEvents = [NSMutableArray arrayWithCapacity:eventsCount];
+        }
+
+        [nextEvents addObject:event];
+    }
+
+    return nextEvents;
+}
+
+- (MXEvent *)nextEvent
+{
+    MXEvent *event, *nextEvent;
+
+    // Loop until an event matches the criteria
+    while ((event = [allMessagesEnumerator nextEvent]))
+    {
+        if (event.eventId && (!types || (NSNotFound != [types indexOfObject:event.type])))
+        {
+            if (!ignoreMemberProfileChanges || !event.isUserProfileChange)
+            {
+                nextEvent = event;
+                break;
+            }
+        }
+    }
+
+    return nextEvent;
+}
+
+- (NSUInteger)remaining
+{
+    // We are in the case of a filtered result, we can return NSUIntegerMax
+    // because it would take too much time to compute.
+    return NSUIntegerMax;
+}
+
+@end

MatrixSDK/Data/EventsEnumerator/MXEventsEnumerator.h

@@ -0,0 +1,55 @@
+/*
+ Copyright 2016 OpenMarket 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 "MXEvent.h"
+
+/**
+ The `MXStoreEventsEnumerator` protocol defines an interface that must be implemented 
+ in order to iterate on a list of events.
+ 
+ This interface is used in the MXStore to manage the results of requests on the store
+ database.
+
+ The `MXStoreEventsEnumerator` implementation must start the iteration on the most recent
+ events of the list.
+ */
+@protocol MXEventsEnumerator <NSObject>
+
+/**
+ Return next events in the enumerator.
+ 
+ @eventsCount the number of events to get.
+ @return an array of events in chronological order. Nil if there is no more events.
+ */
+- (NSArray<MXEvent*>*)nextEventsBatch:(NSUInteger)eventsCount;
+
+/**
+ The next event in the enumerator.
+ Nil if there is no more events.
+ */
+@property (nonatomic, readonly) MXEvent *nextEvent;
+
+/**
+ The number of events that still remain to get from this enumerator.
+ 
+ @discussion
+ For performance reason, the value may be not garanteed when the enumarator is done on a 
+ filtered list of events.
+ In this case, the implementation returns NSUIntegerMax.
+ */
+@property (nonatomic, readonly) NSUInteger remaining;
+
+@end

MatrixSDK/Data/EventsEnumerator/MXEventsEnumeratorOnArray.h

@@ -0,0 +1,34 @@
+/*
+ Copyright 2016 OpenMarket 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/Foundation.h>
+
+#import "MXEventsEnumerator.h"
+
+/**
+ Generic events enumerator on an array of events.
+ */
+@interface MXEventsEnumeratorOnArray : NSObject <MXEventsEnumerator>
+
+/**
+ Construct an enumerator based on a events array.
+ 
+ @param messages the list of messages to enumerate.
+ @return the newly created instance.
+ */
+- (instancetype)initWithMessages:(NSArray<MXEvent*> *)messages;
+
+@end