cloudkit 0.3.3

Safe Rust bindings for Apple's CloudKit framework — iCloud databases and sync on macOS
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
import CloudKit
import Foundation

@_cdecl("ck_database_execute_modify_records_sync")
public func ckDatabaseExecuteModifyRecordsSync(
    _ containerIdentifier: UnsafePointer<CChar>?,
    _ databaseScope: Int32,
    _ operationJSON: UnsafePointer<CChar>?,
    _ outJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?,
    _ outErrorJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> Int32 {
    do {
        let database = try ckMakeDatabase(containerIdentifier: containerIdentifier, scopeRaw: databaseScope)
        let payload = try ckDecodeJSON(operationJSON, as: CKModifyRecordsOperationPayload.self)
        let operation = CKModifyRecordsOperation(
            recordsToSave: try payload.recordsToSave.map(ckDecodeRecord),
            recordIDsToDelete: payload.recordIDsToDelete.map(ckDecodeRecordID)
        )
        if let savePolicy = CKModifyRecordsOperation.RecordSavePolicy(rawValue: Int(payload.savePolicy)) {
            operation.savePolicy = savePolicy
        }
        operation.isAtomic = payload.atomic

        var savedRecords: [CKRecordPayload] = []
        var deletedRecordIDs: [CKRecordIDPayload] = []
        var saveResults: [CKRecordSaveResultPayload] = []
        var deleteResults: [CKRecordDeleteResultPayload] = []
        let completion = CKResultHolder<CKModifyRecordsResultPayload>()
        let semaphore = DispatchSemaphore(value: 0)

        operation.perRecordSaveBlock = { recordID, saveResult in
            switch saveResult {
            case .success(let record):
                let payload = try? ckEncodeRecord(record)
                if let payload { savedRecords.append(payload) }
                saveResults.append(
                    CKRecordSaveResultPayload(
                        recordID: ckEncodeRecordID(recordID),
                        record: payload,
                        error: nil
                    )
                )
            case .failure(let error):
                saveResults.append(
                    CKRecordSaveResultPayload(
                        recordID: ckEncodeRecordID(recordID),
                        record: nil,
                        error: ckErrorPayload(from: error as NSError)
                    )
                )
            }
        }
        operation.perRecordDeleteBlock = { recordID, deleteResult in
            switch deleteResult {
            case .success:
                deletedRecordIDs.append(ckEncodeRecordID(recordID))
                deleteResults.append(
                    CKRecordDeleteResultPayload(recordID: ckEncodeRecordID(recordID), error: nil)
                )
            case .failure(let error):
                deleteResults.append(
                    CKRecordDeleteResultPayload(
                        recordID: ckEncodeRecordID(recordID),
                        error: ckErrorPayload(from: error as NSError)
                    )
                )
            }
        }
        operation.modifyRecordsResultBlock = { operationResult in
            let operationError: CKErrorPayload?
            switch operationResult {
            case .success:
                operationError = nil
            case .failure(let error):
                operationError = ckErrorPayload(from: error as NSError)
            }
            completion.value = CKModifyRecordsResultPayload(
                savedRecords: savedRecords,
                deletedRecordIDs: deletedRecordIDs,
                saveResults: saveResults,
                deleteResults: deleteResults,
                operationError: operationError
            )
            semaphore.signal()
        }

        database.add(operation)
        if semaphore.wait(timeout: .now() + 30) == .timedOut {
            throw ckTimeoutNSError("CloudKit CKModifyRecordsOperation")
        }
        guard let result = completion.value else {
            throw ckBridgeNSError(code: CKR_FAILURE, message: "CKModifyRecordsOperation completed without a result payload")
        }
        outJSON?.pointee = ckCString(try ckEncodeJSON(result))
        return CKR_OK
    } catch let error as NSError {
        ckWriteError(error, to: outErrorJSON)
        return Int32(error.code)
    }
}

@_cdecl("ck_database_execute_query_operation_sync")
public func ckDatabaseExecuteQueryOperationSync(
    _ containerIdentifier: UnsafePointer<CChar>?,
    _ databaseScope: Int32,
    _ operationJSON: UnsafePointer<CChar>?,
    _ outJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?,
    _ outErrorJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> Int32 {
    do {
        let database = try ckMakeDatabase(containerIdentifier: containerIdentifier, scopeRaw: databaseScope)
        let payload = try ckDecodeJSON(operationJSON, as: CKQueryOperationPayload.self)
        let operation = CKQueryOperation(query: ckDecodeQuery(payload.query))
        operation.zoneID = payload.zoneID.map(ckDecodeZoneID)
        operation.desiredKeys = payload.desiredKeys
        if let resultsLimit = payload.resultsLimit {
            operation.resultsLimit = resultsLimit
        }

        var records: [CKRecordPayload] = []
        var matches: [CKQueryMatchResultPayload] = []
        let completion = CKResultHolder<CKQueryOperationResultPayload>()
        let semaphore = DispatchSemaphore(value: 0)

        operation.recordMatchedBlock = { recordID, recordResult in
            switch recordResult {
            case .success(let record):
                let payload = try? ckEncodeRecord(record)
                if let payload { records.append(payload) }
                matches.append(
                    CKQueryMatchResultPayload(
                        recordID: ckEncodeRecordID(recordID),
                        record: payload,
                        error: nil
                    )
                )
            case .failure(let error):
                matches.append(
                    CKQueryMatchResultPayload(
                        recordID: ckEncodeRecordID(recordID),
                        record: nil,
                        error: ckErrorPayload(from: error as NSError)
                    )
                )
            }
        }
        operation.queryResultBlock = { operationResult in
            let cursorReturned: Bool
            let operationError: CKErrorPayload?
            switch operationResult {
            case .success(let cursor):
                cursorReturned = cursor != nil
                operationError = nil
            case .failure(let error):
                cursorReturned = false
                operationError = ckErrorPayload(from: error as NSError)
            }
            completion.value = CKQueryOperationResultPayload(
                records: records,
                matches: matches,
                cursorReturned: cursorReturned,
                operationError: operationError
            )
            semaphore.signal()
        }

        database.add(operation)
        if semaphore.wait(timeout: .now() + 30) == .timedOut {
            throw ckTimeoutNSError("CloudKit CKQueryOperation")
        }
        guard let result = completion.value else {
            throw ckBridgeNSError(code: CKR_FAILURE, message: "CKQueryOperation completed without a result payload")
        }
        outJSON?.pointee = ckCString(try ckEncodeJSON(result))
        return CKR_OK
    } catch let error as NSError {
        ckWriteError(error, to: outErrorJSON)
        return Int32(error.code)
    }
}

@_cdecl("ck_database_execute_fetch_records_sync")
public func ckDatabaseExecuteFetchRecordsSync(
    _ containerIdentifier: UnsafePointer<CChar>?,
    _ databaseScope: Int32,
    _ operationJSON: UnsafePointer<CChar>?,
    _ outJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?,
    _ outErrorJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> Int32 {
    do {
        let database = try ckMakeDatabase(containerIdentifier: containerIdentifier, scopeRaw: databaseScope)
        let payload = try ckDecodeJSON(operationJSON, as: CKFetchRecordsOperationPayload.self)
        let operation = CKFetchRecordsOperation(recordIDs: payload.recordIDs.map(ckDecodeRecordID))
        operation.desiredKeys = payload.desiredKeys

        var records: [CKRecordPayload] = []
        var results: [CKRecordResultPayload] = []
        let completion = CKResultHolder<CKFetchRecordsResultPayload>()
        let semaphore = DispatchSemaphore(value: 0)

        operation.perRecordCompletionBlock = { record, recordID, error in
            guard let recordID else { return }
            if let error = error as NSError? {
                results.append(
                    CKRecordResultPayload(
                        recordID: ckEncodeRecordID(recordID),
                        record: nil,
                        error: ckErrorPayload(from: error)
                    )
                )
                return
            }
            let payload = record.flatMap { try? ckEncodeRecord($0) }
            if let payload { records.append(payload) }
            results.append(
                CKRecordResultPayload(
                    recordID: ckEncodeRecordID(recordID),
                    record: payload,
                    error: nil
                )
            )
        }
        operation.fetchRecordsCompletionBlock = { _, error in
            completion.value = CKFetchRecordsResultPayload(
                records: records,
                results: results,
                operationError: (error as NSError?).map(ckErrorPayload)
            )
            semaphore.signal()
        }

        database.add(operation)
        if semaphore.wait(timeout: .now() + 30) == .timedOut {
            throw ckTimeoutNSError("CloudKit CKFetchRecordsOperation")
        }
        guard let result = completion.value else {
            throw ckBridgeNSError(code: CKR_FAILURE, message: "CKFetchRecordsOperation completed without a result payload")
        }
        outJSON?.pointee = ckCString(try ckEncodeJSON(result))
        return CKR_OK
    } catch let error as NSError {
        ckWriteError(error, to: outErrorJSON)
        return Int32(error.code)
    }
}

@_cdecl("ck_database_execute_fetch_database_changes_sync")
public func ckDatabaseExecuteFetchDatabaseChangesSync(
    _ containerIdentifier: UnsafePointer<CChar>?,
    _ databaseScope: Int32,
    _ operationJSON: UnsafePointer<CChar>?,
    _ outJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?,
    _ outErrorJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> Int32 {
    do {
        let database = try ckMakeDatabase(containerIdentifier: containerIdentifier, scopeRaw: databaseScope)
        let payload = try ckDecodeJSON(operationJSON, as: CKFetchDatabaseChangesOperationPayload.self)
        let operation = CKFetchDatabaseChangesOperation(previousServerChangeToken: try payload.previousServerChangeToken.map(ckDecodeServerChangeToken))
        if let resultsLimit = payload.resultsLimit {
            operation.resultsLimit = resultsLimit
        }
        operation.fetchAllChanges = payload.fetchAllChanges

        var changedZoneIDs: [CKRecordZoneIDPayload] = []
        var deletedZoneIDs: [CKRecordZoneIDPayload] = []
        var purgedZoneIDs: [CKRecordZoneIDPayload] = []
        var encryptedDataResetZoneIDs: [CKRecordZoneIDPayload] = []
        var updatedServerChangeTokens: [CKServerChangeTokenPayload] = []
        let completion = CKResultHolder<CKFetchDatabaseChangesResultPayload>()
        let semaphore = DispatchSemaphore(value: 0)

        operation.recordZoneWithIDChangedBlock = { zoneID in
            changedZoneIDs.append(ckEncodeZoneID(zoneID))
        }
        operation.recordZoneWithIDWasDeletedBlock = { zoneID in
            deletedZoneIDs.append(ckEncodeZoneID(zoneID))
        }
        operation.recordZoneWithIDWasPurgedBlock = { zoneID in
            purgedZoneIDs.append(ckEncodeZoneID(zoneID))
        }
        operation.recordZoneWithIDWasDeletedDueToUserEncryptedDataResetBlock = { zoneID in
            encryptedDataResetZoneIDs.append(ckEncodeZoneID(zoneID))
        }
        operation.changeTokenUpdatedBlock = { serverChangeToken in
            updatedServerChangeTokens.append(ckEncodeServerChangeToken(serverChangeToken))
        }
        operation.fetchDatabaseChangesCompletionBlock = { serverChangeToken, moreComing, error in
            completion.value = CKFetchDatabaseChangesResultPayload(
                changedZoneIDs: changedZoneIDs,
                deletedZoneIDs: deletedZoneIDs,
                purgedZoneIDs: purgedZoneIDs,
                encryptedDataResetZoneIDs: encryptedDataResetZoneIDs,
                updatedServerChangeTokens: updatedServerChangeTokens,
                serverChangeToken: serverChangeToken.map(ckEncodeServerChangeToken),
                moreComing: moreComing,
                operationError: (error as NSError?).map(ckErrorPayload)
            )
            semaphore.signal()
        }

        database.add(operation)
        if semaphore.wait(timeout: .now() + 30) == .timedOut {
            throw ckTimeoutNSError("CloudKit CKFetchDatabaseChangesOperation")
        }
        guard let result = completion.value else {
            throw ckBridgeNSError(code: CKR_FAILURE, message: "CKFetchDatabaseChangesOperation completed without a result payload")
        }
        outJSON?.pointee = ckCString(try ckEncodeJSON(result))
        return CKR_OK
    } catch let error as NSError {
        ckWriteError(error, to: outErrorJSON)
        return Int32(error.code)
    }
}

@_cdecl("ck_database_execute_fetch_record_zone_changes_sync")
public func ckDatabaseExecuteFetchRecordZoneChangesSync(
    _ containerIdentifier: UnsafePointer<CChar>?,
    _ databaseScope: Int32,
    _ operationJSON: UnsafePointer<CChar>?,
    _ outJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?,
    _ outErrorJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> Int32 {
    do {
        let database = try ckMakeDatabase(containerIdentifier: containerIdentifier, scopeRaw: databaseScope)
        let payload = try ckDecodeJSON(operationJSON, as: CKFetchRecordZoneChangesOperationPayload.self)

        let zoneIDs = payload.zones.map { ckDecodeZoneID($0.zoneID) }
        let configurations = Dictionary(uniqueKeysWithValues: try payload.zones.map { entry in
            let configuration = CKFetchRecordZoneChangesOperation.ZoneConfiguration()
            configuration.previousServerChangeToken = try entry.configuration.previousServerChangeToken.map(ckDecodeServerChangeToken)
            if let resultsLimit = entry.configuration.resultsLimit {
                configuration.resultsLimit = resultsLimit
            }
            configuration.desiredKeys = entry.configuration.desiredKeys
            return (ckDecodeZoneID(entry.zoneID), configuration)
        })
        let operation = CKFetchRecordZoneChangesOperation(recordZoneIDs: zoneIDs, configurationsByRecordZoneID: configurations)
        operation.fetchAllChanges = payload.fetchAllChanges

        var zoneResults: [String: CKFetchRecordZoneResultPayload] = [:]
        let completion = CKResultHolder<CKFetchRecordZoneChangesResultPayload>()
        let semaphore = DispatchSemaphore(value: 0)

        func zoneKey(for zoneID: CKRecordZone.ID) -> String {
            "\(zoneID.zoneName)|\(zoneID.ownerName)"
        }

        func updateZoneResult(_ zoneID: CKRecordZone.ID, _ body: (inout CKFetchRecordZoneResultPayload) -> Void) {
            let key = zoneKey(for: zoneID)
            var result = zoneResults[key] ?? CKFetchRecordZoneResultPayload(
                zoneID: ckEncodeZoneID(zoneID),
                changedRecords: [],
                deletedRecords: [],
                updatedServerChangeTokens: [],
                serverChangeToken: nil,
                clientChangeTokenData: nil,
                moreComing: false,
                zoneError: nil
            )
            body(&result)
            zoneResults[key] = result
        }

        operation.recordChangedBlock = { record in
            updateZoneResult(record.recordID.zoneID) { result in
                if let payload = try? ckEncodeRecord(record) {
                    result.changedRecords.append(payload)
                }
            }
        }
        operation.recordWithIDWasDeletedBlock = { recordID, recordType in
            updateZoneResult(recordID.zoneID) { result in
                result.deletedRecords.append(
                    CKDeletedRecordPayload(recordID: ckEncodeRecordID(recordID), recordType: recordType)
                )
            }
        }
        operation.recordZoneChangeTokensUpdatedBlock = { zoneID, serverChangeToken, clientChangeTokenData in
            updateZoneResult(zoneID) { result in
                if let serverChangeToken {
                    result.updatedServerChangeTokens.append(ckEncodeServerChangeToken(serverChangeToken))
                }
                result.clientChangeTokenData = clientChangeTokenData.map { [UInt8]($0) }
            }
        }
        operation.recordZoneFetchCompletionBlock = { zoneID, serverChangeToken, clientChangeTokenData, moreComing, error in
            updateZoneResult(zoneID) { result in
                result.serverChangeToken = serverChangeToken.map(ckEncodeServerChangeToken)
                result.clientChangeTokenData = clientChangeTokenData.map { [UInt8]($0) }
                result.moreComing = moreComing
                result.zoneError = (error as NSError?).map(ckErrorPayload)
            }
        }
        operation.fetchRecordZoneChangesCompletionBlock = { error in
            let sortedZones = zoneResults.values.sorted {
                ($0.zoneID.zoneName, $0.zoneID.ownerName) < ($1.zoneID.zoneName, $1.zoneID.ownerName)
            }
            completion.value = CKFetchRecordZoneChangesResultPayload(
                zones: sortedZones,
                operationError: (error as NSError?).map(ckErrorPayload)
            )
            semaphore.signal()
        }

        database.add(operation)
        if semaphore.wait(timeout: .now() + 30) == .timedOut {
            throw ckTimeoutNSError("CloudKit CKFetchRecordZoneChangesOperation")
        }
        guard let result = completion.value else {
            throw ckBridgeNSError(code: CKR_FAILURE, message: "CKFetchRecordZoneChangesOperation completed without a result payload")
        }
        outJSON?.pointee = ckCString(try ckEncodeJSON(result))
        return CKR_OK
    } catch let error as NSError {
        ckWriteError(error, to: outErrorJSON)
        return Int32(error.code)
    }
}

@_cdecl("ck_database_execute_fetch_web_auth_token_sync")
public func ckDatabaseExecuteFetchWebAuthTokenSync(
    _ containerIdentifier: UnsafePointer<CChar>?,
    _ databaseScope: Int32,
    _ apiToken: UnsafePointer<CChar>?,
    _ outJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?,
    _ outErrorJSON: UnsafeMutablePointer<UnsafeMutablePointer<CChar>?>?
) -> Int32 {
    do {
        let database = try ckMakeDatabase(containerIdentifier: containerIdentifier, scopeRaw: databaseScope)
        guard let apiToken else {
            throw ckBridgeNSError(code: CKR_INVALID_ARGUMENT, message: "Missing API token")
        }
        let operation = CKFetchWebAuthTokenOperation(apiToken: String(cString: apiToken))
        let completion = CKResultHolder<String>()
        let semaphore = DispatchSemaphore(value: 0)
        operation.fetchWebAuthTokenResultBlock = { operationResult in
            switch operationResult {
            case .success(let webAuthToken):
                completion.value = webAuthToken
            case .failure(let error):
                completion.error = error as NSError
            }
            semaphore.signal()
        }
        database.add(operation)
        if semaphore.wait(timeout: .now() + 30) == .timedOut {
            throw ckTimeoutNSError("CloudKit CKFetchWebAuthTokenOperation")
        }
        if let error = completion.error {
            throw error
        }
        guard let webAuthToken = completion.value else {
            throw ckBridgeNSError(code: CKR_FAILURE, message: "Missing web auth token result")
        }
        outJSON?.pointee = ckCString(try ckEncodeJSON(webAuthToken))
        return CKR_OK
    } catch let error as NSError {
        ckWriteError(error, to: outErrorJSON)
        return Int32(error.code)
    }
}