-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
XMPPCoreDataStorage.m
828 lines (669 loc) · 24.9 KB
/
XMPPCoreDataStorage.m
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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
#import "XMPPCoreDataStorage.h"
#import "XMPPStream.h"
#import "XMPPInternal.h"
#import "XMPPJID.h"
#import "XMPPLogging.h"
#import "NSNumber+XMPP.h"
#import <objc/runtime.h>
#import <libkern/OSAtomic.h>
#if ! __has_feature(objc_arc)
#warning This file must be compiled with ARC. Use -fobjc-arc flag (or convert project to ARC).
#endif
// Log levels: off, error, warn, info, verbose
#if DEBUG
static const int xmppLogLevel = XMPP_LOG_LEVEL_WARN;
#else
static const int xmppLogLevel = XMPP_LOG_LEVEL_WARN;
#endif
@implementation XMPPCoreDataStorage
static NSMutableSet *databaseFileNames;
+ (void)initialize
{
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
databaseFileNames = [[NSMutableSet alloc] init];
});
}
+ (BOOL)registerDatabaseFileName:(NSString *)dbFileName
{
BOOL result = NO;
@synchronized(databaseFileNames)
{
if (![databaseFileNames containsObject:dbFileName])
{
[databaseFileNames addObject:dbFileName];
result = YES;
}
}
return result;
}
+ (void)unregisterDatabaseFileName:(NSString *)dbFileName
{
@synchronized(databaseFileNames)
{
[databaseFileNames removeObject:dbFileName];
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Override Me
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
- (NSString *)managedObjectModelName
{
// Override me, if needed, to provide customized behavior.
//
// This method is queried to get the name of the ManagedObjectModel within the app bundle.
// It should return the name of the appropriate file (*.xdatamodel / *.mom / *.momd) sans file extension.
//
// The default implementation returns the name of the subclass, stripping any suffix of "CoreDataStorage".
// E.g., if your subclass was named "XMPPExtensionCoreDataStorage", then this method would return "XMPPExtension".
//
// Note that a file extension should NOT be included.
NSString *className = NSStringFromClass([self class]);
NSString *suffix = @"CoreDataStorage";
if ([className hasSuffix:suffix] && ([className length] > [suffix length]))
{
return [className substringToIndex:([className length] - [suffix length])];
}
else
{
return className;
}
}
- (NSString *)defaultDatabaseFileName
{
// Override me, if needed, to provide customized behavior.
//
// This method is queried if the initWithDatabaseFileName method is invoked with a nil parameter.
//
// You are encouraged to use the sqlite file extension.
return [NSString stringWithFormat:@"%@.sqlite", [self managedObjectModelName]];
}
- (void)willCreatePersistentStoreWithPath:(NSString *)storePath
{
// Override me, if needed, to provide customized behavior.
//
// If you are using a database file with pure non-persistent data (e.g. for memory optimization purposes on iOS),
// you may want to delete the database file if it already exists on disk.
//
// If this instance was created via initWithDatabaseFilename, then the storePath parameter will be non-nil.
// If this instance was created via initWithInMemoryStore, then the storePath parameter will be nil.
}
- (BOOL)addPersistentStoreWithPath:(NSString *)storePath error:(NSError **)errorPtr
{
// Override me, if needed, to completely customize the persistent store.
//
// Adds the persistent store path to the persistent store coordinator.
// Returns true if the persistent store is created.
//
// If this instance was created via initWithDatabaseFilename, then the storePath parameter will be non-nil.
// If this instance was created via initWithInMemoryStore, then the storePath parameter will be nil.
NSPersistentStore *persistentStore;
if (storePath)
{
// SQLite persistent store
NSURL *storeUrl = [NSURL fileURLWithPath:storePath];
// Default support for automatic lightweight migrations
NSDictionary *options = [NSDictionary dictionaryWithObjectsAndKeys:
[NSNumber numberWithBool:YES], NSMigratePersistentStoresAutomaticallyOption,
[NSNumber numberWithBool:YES], NSInferMappingModelAutomaticallyOption,
nil];
persistentStore = [persistentStoreCoordinator addPersistentStoreWithType:NSSQLiteStoreType
configuration:nil
URL:storeUrl
options:options
error:errorPtr];
}
else
{
// In-Memory persistent store
persistentStore = [persistentStoreCoordinator addPersistentStoreWithType:NSInMemoryStoreType
configuration:nil
URL:nil
options:nil
error:errorPtr];
}
return persistentStore != nil;
}
- (void)didNotAddPersistentStoreWithPath:(NSString *)storePath error:(NSError *)error
{
// Override me, if needed, to provide customized behavior.
//
// For example, if you are using the database for non-persistent data and the model changes,
// you may want to delete the database file if it already exists on disk.
//
// E.g:
//
// [[NSFileManager defaultManager] removeItemAtPath:storePath error:NULL];
// [self addPersistentStoreWithPath:storePath error:NULL];
//
// This method is invoked on the storageQueue.
#if TARGET_OS_IPHONE
XMPPLogError(@"%@:\n"
@"=====================================================================================\n"
@"Error creating persistent store:\n%@\n"
@"Chaned core data model recently?\n"
@"Quick Fix: Delete the app from device and reinstall.\n"
@"=====================================================================================",
[self class], error);
#else
XMPPLogError(@"%@:\n"
@"=====================================================================================\n"
@"Error creating persistent store:\n%@\n"
@"Chaned core data model recently?\n"
@"Quick Fix: Delete the database: %@\n"
@"=====================================================================================",
[self class], error, storePath);
#endif
}
- (void)didCreateManagedObjectContext
{
// Override me to provide customized behavior.
// For example, you may want to perform cleanup of any non-persistent data before you start using the database.
//
// This method is invoked on the storageQueue.
}
- (void)willSaveManagedObjectContext
{
// Override me if you need to do anything special just before changes are saved to disk.
//
// This method is invoked on the storageQueue.
}
- (void)didSaveManagedObjectContext
{
// Override me if you need to do anything special after changes have been saved to disk.
//
// This method is invoked on the storageQueue.
}
- (void)mainThreadManagedObjectContextDidMergeChanges
{
// Override me if you want to do anything special when changes get propogated to the main thread.
//
// This method is invoked on the main thread.
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Setup
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@synthesize databaseFileName;
- (void)commonInit
{
saveThreshold = 500;
storageQueue = dispatch_queue_create(class_getName([self class]), NULL);
myJidCache = [[NSMutableDictionary alloc] init];
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(updateJidCache:)
name:XMPPStreamDidChangeMyJIDNotification
object:nil];
}
- (id)init
{
return [self initWithDatabaseFilename:nil];
}
- (id)initWithDatabaseFilename:(NSString *)aDatabaseFileName
{
if ((self = [super init]))
{
if (aDatabaseFileName)
databaseFileName = [aDatabaseFileName copy];
else
databaseFileName = [[self defaultDatabaseFileName] copy];
if (![[self class] registerDatabaseFileName:databaseFileName])
{
return nil;
}
[self commonInit];
NSAssert(storageQueue != NULL, @"Subclass forgot to invoke [super commonInit]");
}
return self;
}
- (id)initWithInMemoryStore
{
if ((self = [super init]))
{
[self commonInit];
NSAssert(storageQueue != NULL, @"Subclass forgot to invoke [super commonInit]");
}
return self;
}
- (BOOL)configureWithParent:(id)aParent queue:(dispatch_queue_t)queue
{
// This is the standard configure method used by xmpp extensions to configure a storage class.
//
// Feel free to override this method if needed,
// and just invoke super at some point to make sure everything is kosher at this level as well.
NSParameterAssert(aParent != nil);
NSParameterAssert(queue != NULL);
if (queue == storageQueue)
{
// This class is designed to be run on a separate dispatch queue from its parent.
// This allows us to optimize the database save operations by buffering them,
// and executing them when demand on the storage instance is low.
return NO;
}
return YES;
}
- (NSUInteger)saveThreshold
{
if (dispatch_get_current_queue() == storageQueue)
{
return saveThreshold;
}
else
{
__block NSUInteger result;
dispatch_sync(storageQueue, ^{
result = saveThreshold;
});
return result;
}
}
- (void)setSaveThreshold:(NSUInteger)newSaveThreshold
{
dispatch_block_t block = ^{
saveThreshold = newSaveThreshold;
};
if (dispatch_get_current_queue() == storageQueue)
block();
else
dispatch_async(storageQueue, block);
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Stream JID Caching
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// We cache a stream's myJID to avoid constantly querying the xmppStream for it.
//
// The motivation behind this is the fact that to query the xmppStream for its myJID
// requires going through the xmppStream's internal dispatch queue. (A dispatch_sync).
// It's not necessarily that this is an expensive operation,
// but the storage classes sometimes require this information for just about every operation they perform.
// For a variable that changes infrequently, caching the value can reduce some overhead.
// In addition, if we can stay out of xmppStream's internal dispatch queue,
// we free it to perform more xmpp processing tasks.
- (XMPPJID *)myJIDForXMPPStream:(XMPPStream *)stream
{
if (stream == nil) return nil;
__block XMPPJID *result = nil;
dispatch_block_t block = ^{ @autoreleasepool {
NSNumber *key = [NSNumber numberWithPtr:(__bridge void *)stream];
result = (XMPPJID *)[myJidCache objectForKey:key];
if (!result)
{
result = [stream myJID];
if (result)
{
[myJidCache setObject:result forKey:key];
}
}
}};
if (dispatch_get_current_queue() == storageQueue)
block();
else
dispatch_sync(storageQueue, block);
return result;
}
- (void)didChangeCachedMyJID:(XMPPJID *)cachedMyJID forXMPPStream:(XMPPStream *)stream
{
// Override me if you'd like to do anything special when this happens.
//
// For example, if your custom storage class prefetches data related to the current user.
}
- (void)updateJidCache:(NSNotification *)notification
{
// Notifications are delivered on the thread/queue that posted them.
// In this case, they are delivered on xmppStream's internal processing queue.
XMPPStream *stream = (XMPPStream *)[notification object];
dispatch_block_t block = ^{ @autoreleasepool {
NSNumber *key = [NSNumber numberWithPtr:(__bridge void *)stream];
XMPPJID *cachedJID = [myJidCache objectForKey:key];
if (cachedJID)
{
XMPPJID *newJID = [stream myJID];
if (newJID)
{
if (![cachedJID isEqualToJID:newJID])
{
[myJidCache setObject:newJID forKey:key];
[self didChangeCachedMyJID:newJID forXMPPStream:stream];
}
}
else
{
[myJidCache removeObjectForKey:key];
[self didChangeCachedMyJID:nil forXMPPStream:stream];
}
}
}};
if (dispatch_get_current_queue() == storageQueue)
block();
else
dispatch_async(storageQueue, block);
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Core Data Setup
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
- (NSString *)persistentStoreDirectory
{
NSArray *paths = NSSearchPathForDirectoriesInDomains(NSApplicationSupportDirectory, NSUserDomainMask, YES);
NSString *basePath = ([paths count] > 0) ? [paths objectAtIndex:0] : NSTemporaryDirectory();
// Attempt to find a name for this application
NSString *appName = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleDisplayName"];
if (appName == nil) {
appName = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"CFBundleName"];
}
if (appName == nil) {
appName = @"xmppframework";
}
NSString *result = [basePath stringByAppendingPathComponent:appName];
NSFileManager *fileManager = [NSFileManager defaultManager];
if (![fileManager fileExistsAtPath:result])
{
[fileManager createDirectoryAtPath:result withIntermediateDirectories:YES attributes:nil error:nil];
}
return result;
}
- (NSManagedObjectModel *)managedObjectModel
{
// This is a public method.
// It may be invoked on any thread/queue.
__block NSManagedObjectModel *result = nil;
dispatch_block_t block = ^{ @autoreleasepool {
if (managedObjectModel)
{
result = managedObjectModel;
return;
}
NSString *momName = [self managedObjectModelName];
XMPPLogVerbose(@"%@: Creating managedObjectModel (%@)", [self class], momName);
NSString *momPath = [[NSBundle mainBundle] pathForResource:momName ofType:@"mom"];
if (momPath == nil)
{
// The model may be versioned or created with Xcode 4, try momd as an extension.
momPath = [[NSBundle mainBundle] pathForResource:momName ofType:@"momd"];
}
if (momPath)
{
// If path is nil, then NSURL or NSManagedObjectModel will throw an exception
NSURL *momUrl = [NSURL fileURLWithPath:momPath];
managedObjectModel = [[NSManagedObjectModel alloc] initWithContentsOfURL:momUrl];
}
else
{
XMPPLogWarn(@"%@: Couldn't find managedObjectModel file - %@", [self class], momName);
}
result = managedObjectModel;
}};
if (dispatch_get_current_queue() == storageQueue)
block();
else
dispatch_sync(storageQueue, block);
return result;
}
- (NSPersistentStoreCoordinator *)persistentStoreCoordinator
{
// This is a public method.
// It may be invoked on any thread/queue.
__block NSPersistentStoreCoordinator *result = nil;
dispatch_block_t block = ^{ @autoreleasepool {
if (persistentStoreCoordinator)
{
result = persistentStoreCoordinator;
return;
}
NSManagedObjectModel *mom = [self managedObjectModel];
if (mom == nil)
{
return;
}
XMPPLogVerbose(@"%@: Creating persistentStoreCoordinator", [self class]);
persistentStoreCoordinator = [[NSPersistentStoreCoordinator alloc] initWithManagedObjectModel:mom];
if (databaseFileName)
{
// SQLite persistent store
NSString *docsPath = [self persistentStoreDirectory];
NSString *storePath = [docsPath stringByAppendingPathComponent:databaseFileName];
if (storePath)
{
// If storePath is nil, then NSURL will throw an exception
[self willCreatePersistentStoreWithPath:storePath];
NSError *error = nil;
if (![self addPersistentStoreWithPath:storePath error:&error])
{
[self didNotAddPersistentStoreWithPath:storePath error:error];
}
}
else
{
XMPPLogWarn(@"%@: Error creating persistentStoreCoordinator - Nil persistentStoreDirectory",
[self class]);
}
}
else
{
// In-Memory persistent store
[self willCreatePersistentStoreWithPath:nil];
NSError *error = nil;
if (![self addPersistentStoreWithPath:nil error:&error])
{
[self didNotAddPersistentStoreWithPath:nil error:error];
}
}
result = persistentStoreCoordinator;
}};
if (dispatch_get_current_queue() == storageQueue)
block();
else
dispatch_sync(storageQueue, block);
return result;
}
- (NSManagedObjectContext *)managedObjectContext
{
// This is a private method.
//
// NSManagedObjectContext is NOT thread-safe.
// Therefore it is VERY VERY BAD to use our private managedObjectContext outside our private storageQueue.
//
// You should NOT remove the assert statement below!
// You should NOT give external classes access to the storageQueue! (Excluding subclasses obviously.)
//
// When you want a managedObjectContext of your own (again, excluding subclasses),
// you can use the mainThreadManagedObjectContext (below),
// or you should create your own using the public persistentStoreCoordinator.
//
// If you even comtemplate ignoring this warning,
// then you need to go read the documentation for core data,
// specifically the section entitled "Concurrency with Core Data".
//
NSAssert(dispatch_get_current_queue() == storageQueue, @"Invoked on incorrect queue");
//
// Do NOT remove the assert statment above!
// Read the comments above!
//
if (managedObjectContext)
{
return managedObjectContext;
}
NSPersistentStoreCoordinator *coordinator = [self persistentStoreCoordinator];
if (coordinator)
{
XMPPLogVerbose(@"%@: Creating managedObjectContext", [self class]);
if ([NSManagedObjectContext instancesRespondToSelector:@selector(initWithConcurrencyType:)])
managedObjectContext =
[[NSManagedObjectContext alloc] initWithConcurrencyType:NSConfinementConcurrencyType];
else
managedObjectContext = [[NSManagedObjectContext alloc] init];
managedObjectContext.persistentStoreCoordinator = coordinator;
managedObjectContext.undoManager = nil;
[self didCreateManagedObjectContext];
}
return managedObjectContext;
}
- (NSManagedObjectContext *)mainThreadManagedObjectContext
{
// NSManagedObjectContext is NOT thread-safe.
// Therefore it is VERY VERY BAD to use this managedObjectContext outside the main thread.
//
// You should NOT remove the assert statement below!
//
// When you want a managedObjectContext of your own for non-main-thread use,
// you should create your own using the public persistentStoreCoordinator.
//
// If you even comtemplate ignoring this warning,
// then you need to go read the documentation for core data,
// specifically the section entitled "Concurrency with Core Data".
//
NSAssert(dispatch_get_current_queue() == dispatch_get_main_queue(), @"Context reserved for main thread only");
//
// Do NOT remove the assert statment above!
// Read the comments above!
//
if (mainThreadManagedObjectContext)
{
return mainThreadManagedObjectContext;
}
NSPersistentStoreCoordinator *coordinator = [self persistentStoreCoordinator];
if (coordinator)
{
XMPPLogVerbose(@"%@: Creating mainThreadManagedObjectContext", [self class]);
if ([NSManagedObjectContext instancesRespondToSelector:@selector(initWithConcurrencyType:)])
mainThreadManagedObjectContext =
[[NSManagedObjectContext alloc] initWithConcurrencyType:NSMainQueueConcurrencyType];
else
mainThreadManagedObjectContext = [[NSManagedObjectContext alloc] init];
mainThreadManagedObjectContext.persistentStoreCoordinator = coordinator;
mainThreadManagedObjectContext.undoManager = nil;
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(managedObjectContextDidSave:)
name:NSManagedObjectContextDidSaveNotification
object:nil];
// Todo: If we knew that our private managedObjectContext was going to be the only one writing to the database,
// then a small optimization would be to use it as the object when registering above.
}
return mainThreadManagedObjectContext;
}
- (void)managedObjectContextDidSave:(NSNotification *)notification
{
NSManagedObjectContext *sender = (NSManagedObjectContext *)[notification object];
if ((sender != mainThreadManagedObjectContext) &&
(sender.persistentStoreCoordinator == mainThreadManagedObjectContext.persistentStoreCoordinator))
{
XMPPLogVerbose(@"%@: %@ - Merging changes into mainThreadManagedObjectContext", THIS_FILE, THIS_METHOD);
dispatch_async(dispatch_get_main_queue(), ^{
[mainThreadManagedObjectContext mergeChangesFromContextDidSaveNotification:notification];
[self mainThreadManagedObjectContextDidMergeChanges];
});
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Utilities
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
- (NSUInteger)numberOfUnsavedChanges
{
NSManagedObjectContext *moc = [self managedObjectContext];
NSUInteger unsavedCount = 0;
unsavedCount += [[moc updatedObjects] count];
unsavedCount += [[moc insertedObjects] count];
unsavedCount += [[moc deletedObjects] count];
return unsavedCount;
}
- (void)save
{
// I'm fairly confident that the implementation of [NSManagedObjectContext save:]
// internally checks to see if it has anything to save before it actually does anthing.
// So there's no need for us to do it here, especially since this method is usually
// called from maybeSave below, which already does this check.
[self willSaveManagedObjectContext];
NSError *error = nil;
if ([[self managedObjectContext] save:&error])
{
saveCount++;
[self didSaveManagedObjectContext];
}
else
{
XMPPLogWarn(@"%@: Error saving - %@ %@", [self class], error, [error userInfo]);
[[self managedObjectContext] rollback];
}
}
- (void)maybeSave:(int32_t)currentPendingRequests
{
NSAssert(dispatch_get_current_queue() == storageQueue, @"Invoked on incorrect queue");
if ([[self managedObjectContext] hasChanges])
{
if (currentPendingRequests == 0)
{
XMPPLogVerbose(@"%@: Triggering save (pendingRequests=%i)", [self class], currentPendingRequests);
[self save];
}
else
{
NSUInteger unsavedCount = [self numberOfUnsavedChanges];
if (unsavedCount >= saveThreshold)
{
XMPPLogVerbose(@"%@: Triggering save (unsavedCount=%lu)", [self class], (unsigned long)unsavedCount);
[self save];
}
}
}
}
- (void)maybeSave
{
// Convenience method in the very rare case that a subclass would need to invoke maybeSave manually.
[self maybeSave:OSAtomicAdd32(0, &pendingRequests)];
}
- (void)executeBlock:(dispatch_block_t)block
{
// By design this method should not be invoked from the storageQueue.
//
// If you remove the assert statement below, you are destroying the sole purpose for this class,
// which is to optimize the disk IO by buffering save operations.
//
NSAssert(dispatch_get_current_queue() != storageQueue, @"Invoked on incorrect queue");
//
// For a full discussion of this method, please see XMPPCoreDataStorageProtocol.h
//
// dispatch_Sync
// ^
OSAtomicIncrement32(&pendingRequests);
dispatch_sync(storageQueue, ^{ @autoreleasepool {
block();
// Since this is a synchronous request, we want to return as quickly as possible.
// So we delay the maybeSave operation til later.
dispatch_async(storageQueue, ^{ @autoreleasepool {
[self maybeSave:OSAtomicDecrement32(&pendingRequests)];
}});
}});
}
- (void)scheduleBlock:(dispatch_block_t)block
{
// By design this method should not be invoked from the storageQueue.
//
// If you remove the assert statement below, you are destroying the sole purpose for this class,
// which is to optimize the disk IO by buffering save operations.
//
NSAssert(dispatch_get_current_queue() != storageQueue, @"Invoked on incorrect queue");
//
// For a full discussion of this method, please see XMPPCoreDataStorageProtocol.h
//
// dispatch_Async
// ^
OSAtomicIncrement32(&pendingRequests);
dispatch_async(storageQueue, ^{ @autoreleasepool {
block();
[self maybeSave:OSAtomicDecrement32(&pendingRequests)];
}});
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark Memory Management
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
- (void)dealloc
{
[[NSNotificationCenter defaultCenter] removeObserver:self];
if (databaseFileName)
{
[[self class] unregisterDatabaseFileName:databaseFileName];
}
#if !OS_OBJECT_USE_OBJC
if (storageQueue)
dispatch_release(storageQueue);
#endif
}
@end