oc: Update predecessor change list on saving

There were cases where only the change key was updated (GCS) or
others were the change key was updated with wrong info.

This changeset has as goal to update the predecessor change list
and, change key if required, on saving taking into account the latest information
given by the client in high level ROPs such as ImportMessageMove
or SetProperties, and merge it with information provided by the server
backend (IMAP server, SOGo DB) using `synchroniseCache`.

For more details about `PidTagChangeKey` and `PidTagPredecessorChangeList`
property values check [MS-OXCFXICS] Section 2.2.1.2

OpenChange/MAPIStoreMailFolder.m

@@ -68,6 +68,8 @@
 
 static Class SOGoMailFolderK, MAPIStoreMailFolderK, MAPIStoreOutboxFolderK;
 
+#include <gen_ndr/exchange.h>
+
 #undef DEBUG
 #include <util/attr.h>
 #include <libmapi/libmapi.h>
@@ -516,6 +518,44 @@ _compareFetchResultsByMODSEQ (id entry1, id entry2, void *data)
   return [modseq1 compare: modseq2];
 }
 
+- (void) _updatePredecessorChangeListWith: (NSData *) predecessorChangeList
+                          forMessageEntry: (NSMutableDictionary *) messageEntry
+{
+  NSData *globCnt, *oldGlobCnt;
+  NSMutableDictionary *changeList;
+  NSString *guid;
+  struct SizedXid *sizedXIDList;
+  struct XID xid;
+  uint32_t i, length;
+
+  sizedXIDList = [predecessorChangeList asSizedXidArrayInMemCtx: NULL with: &length];
+
+  changeList = [messageEntry objectForKey: @"PredecessorChangeList"];
+  if (!changeList)
+    {
+      changeList = [NSMutableDictionary new];
+      [messageEntry setObject: changeList
+                    forKey: @"PredecessorChangeList"];
+      [changeList release];
+    }
+
+  if (sizedXIDList) {
+    for (i = 0; i < length; i++)
+      {
+        xid = sizedXIDList[i].XID;
+        guid = [NSString stringWithGUID: &xid.NameSpaceGuid];
+        globCnt = [NSData dataWithBytes: xid.LocalId.data length: xid.LocalId.length];
+        oldGlobCnt = [changeList objectForKey: guid];
+        if (!oldGlobCnt || ([globCnt compare: oldGlobCnt] == NSOrderedDescending))
+          [changeList setObject: globCnt forKey: guid];
+      }
+
+    talloc_free (sizedXIDList);
+  }
+
+  [versionsMessage save];
+}
+
 - (void) _setChangeKey: (NSData *) changeKey
        forMessageEntry: (NSMutableDictionary *) messageEntry
 {
@@ -924,8 +964,7 @@ _compareFetchResultsByMODSEQ (id entry1, id entry2, void *data)
   return changeNumber;
 }
 
-- (void) setChangeKey: (NSData *) changeKey
-    forMessageWithKey: (NSString *) messageKey
+- (NSMutableDictionary *) _messageEntryFromMessageKey: (NSString *) messageKey
 {
   NSMutableDictionary *messages, *messageEntry;
   NSString *messageUid;
@@ -936,7 +975,7 @@ _compareFetchResultsByMODSEQ (id entry1, id entry2, void *data)
   messageEntry = [messages objectForKey: messageUid];
   if (!messageEntry)
     {
-      [self warnWithFormat: @"attempting to synchronise to set the change key for "
+      [self warnWithFormat: @"attempting to synchronise to get the message entry for "
                             @"this message %@", messageKey];
       synced = [self synchroniseCacheForUID: messageUid];
       if (synced)
@@ -947,7 +986,15 @@ _compareFetchResultsByMODSEQ (id entry1, id entry2, void *data)
           abort ();
         }
     }
-  [self _setChangeKey: changeKey forMessageEntry: messageEntry];
+
+  return messageEntry;
+}
+
+- (void) setChangeKey: (NSData *) changeKey
+    forMessageWithKey: (NSString *) messageKey
+{
+  [self _setChangeKey: changeKey
+      forMessageEntry: [self _messageEntryFromMessageKey: messageKey]];
 
   [versionsMessage save];
 }
@@ -1232,7 +1279,7 @@ _parseCOPYUID (NSString *line, NSArray **destUIDsP)
   NSDictionary *result;
   NSUInteger count;
   NSArray *a;
-  NSData *changeKey;
+  NSData *changeList;
 
   if (![sourceFolder isKindOfClass: [MAPIStoreMailFolder class]])
     return [super moveCopyMessagesWithMIDs: srcMids andCount: midCount
@@ -1327,11 +1374,11 @@ _parseCOPYUID (NSString *line, NSArray **destUIDsP)
       [self synchroniseCache];
       for (count = 0; count < midCount; count++)
         {
-          changeKey = [NSData dataWithBinary: targetChangeKeys[count]];
+          changeList = [NSData dataWithBinary: targetPredecessorChangeLists[count]];
           messageKey = [NSString stringWithFormat: @"%@.eml",
                                  [destUIDs objectAtIndex: count]];
-          [self   setChangeKey: changeKey
-             forMessageWithKey: messageKey];
+          [self _updatePredecessorChangeListWith: changeList
+                                 forMessageEntry: [self _messageEntryFromMessageKey: messageKey]];
         }
     }