XMPPRoster autoClearAllUsersAndResources API

Fixes robbiehanson#238
Fixes an Issue where deleting a resource wouldn't update a User's primary resource

Author: ObjColumnist

Extensions/Roster/CoreDataStorage/XMPPRosterCoreDataStorage.m

@@ -48,6 +48,7 @@ - (void)commonInit
 	[super commonInit];
 
 	// This method is invoked by all public init methods of the superclass
+    autoRemovePreviousDatabaseFile = YES;
 	autoRecreateDatabaseFile = YES;
 
 	rosterPopulationSet = [[NSMutableSet alloc] init];
@@ -119,8 +120,10 @@ - (void)_clearAllResourcesForXMPPStream:(XMPPStream *)stream
 
 	for (XMPPResourceCoreDataStorageObject *resource in allResources)
 	{
+        XMPPUserCoreDataStorageObject *user = resource.user;
 		[moc deleteObject:resource];
-		
+        [user recalculatePrimaryResource];
+        
 		if (++unsavedCount >= saveThreshold)
 		{
 			[self save];
@@ -133,24 +136,6 @@ - (void)_clearAllResourcesForXMPPStream:(XMPPStream *)stream
 #pragma mark Overrides
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-- (void)willCreatePersistentStoreWithPath:(NSString *)filePath options:(NSDictionary *)theStoreOptions
-{
-	// This method is overriden from the XMPPCoreDataStore superclass.
-	// From the documentation:
-	// 
-	// Override me, if needed, to provide customized behavior.
-	// 
-	// For example, if you are using the database for pure non-persistent data you may want to delete the database
-	// file if it already exists on disk.
-	// 
-	// The default implementation does nothing.
-	
-	if ([[NSFileManager defaultManager] fileExistsAtPath:filePath])
-	{
-		[[NSFileManager defaultManager] removeItemAtPath:filePath error:nil];
-	}
-}
-
 - (void)didCreateManagedObjectContext
 {
 	// This method is overriden from the XMPPCoreDataStore superclass.

Extensions/Roster/CoreDataStorage/XMPPUserCoreDataStorageObject.h

@@ -51,6 +51,7 @@
 
 - (void)updateWithItem:(NSXMLElement *)item;
 - (void)updateWithPresence:(XMPPPresence *)presence streamBareJidStr:(NSString *)streamBareJidStr;
+- (void)recalculatePrimaryResource;
 
 - (NSComparisonResult)compareByName:(XMPPUserCoreDataStorageObject *)another;
 - (NSComparisonResult)compareByName:(XMPPUserCoreDataStorageObject *)another options:(NSStringCompareOptions)mask;

Extensions/Roster/CoreDataStorage/XMPPUserCoreDataStorageObject.m

@@ -383,7 +383,17 @@ - (BOOL)isPendingApproval
 
 - (NSArray *)allResources
 {
-	return [[self resources] allObjects];
+    NSMutableArray *allResources = [NSMutableArray array];
+	
+    for (XMPPResourceCoreDataStorageObject *resource in [[self resources] allObjects]) {
+        
+        if(![resource isDeleted])
+        {
+            [allResources addObject:resource];
+        }
+    }
+    
+    return allResources;
 }
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

Extensions/Roster/XMPPRoster.h

@@ -77,6 +77,16 @@
 **/
 @property (assign) BOOL autoFetchRoster;
 
+/**
+ * Whether or not to automatically clear all Users and Resources when the stream disconnects.
+ * If you are using XMPPRosterCoreDataStorage you may want to set autoRemovePreviousDatabaseFile to NO.
+ *
+ * All Users and Resources will be cleared when the roster is next populated regardless of this property.
+ *
+ * The default value is YES.
+**/
+@property (assign) BOOL autoClearAllUsersAndResources;
+
 /**
  * In traditional IM applications, the "buddy" system is rather straightforward.
  * User A sends a request to become "friends" with user B.

Extensions/Roster/XMPPRoster.m

@@ -21,6 +21,7 @@
 	kAutoFetchRoster = 1 << 0,                   // If set, we automatically fetch roster after authentication
 	kAutoAcceptKnownPresenceSubscriptionRequests = 1 << 1, // See big description in header file... :D
 	kRosterlessOperation = 1 << 2,
+    kAutoClearAllUsersAndResources = 1 << 3,
 };
 enum XMPPRosterFlags
 {
@@ -71,7 +72,7 @@ - (id)initWithRosterStorage:(id <XMPPRosterStorage>)storage dispatchQueue:(dispa
 			XMPPLogError(@"%@: %@ - Unable to configure storage!", THIS_FILE, THIS_METHOD);
 		}
 
-		config = kAutoFetchRoster | kAutoAcceptKnownPresenceSubscriptionRequests;
+		config = kAutoFetchRoster | kAutoAcceptKnownPresenceSubscriptionRequests | kAutoClearAllUsersAndResources;
 		flags = 0;
 
 		earlyPresenceElements = [[NSMutableArray alloc] initWithCapacity:2];
@@ -112,7 +113,7 @@ - (BOOL)activate:(XMPPStream *)aXmppStream
 			}];
 		}
 		#endif
-		
+        		
 		return YES;
 	}
 
@@ -188,6 +189,38 @@ - (void)setAutoFetchRoster:(BOOL)flag
 		dispatch_async(moduleQueue, block);
 }
 
+- (BOOL)autoClearAllUsersAndResources
+{
+	__block BOOL result = NO;
+	
+	dispatch_block_t block = ^{
+		result = (config & kAutoClearAllUsersAndResources) ? YES : NO;
+	};
+	
+	if (dispatch_get_specific(moduleQueueTag))
+		block();
+	else
+		dispatch_sync(moduleQueue, block);
+	
+	return result;
+}
+
+- (void)setAutoClearAllUsersAndResources:(BOOL)flag
+{
+	dispatch_block_t block = ^{
+		
+		if (flag)
+			config |= kAutoClearAllUsersAndResources;
+		else
+			config &= ~kAutoClearAllUsersAndResources;
+	};
+	
+	if (dispatch_get_specific(moduleQueueTag))
+		block();
+	else
+		dispatch_async(moduleQueue, block);
+}
+
 - (BOOL)autoAcceptKnownPresenceSubscriptionRequests
 {
 	__block BOOL result = NO;
@@ -672,6 +705,7 @@ - (BOOL)xmppStream:(XMPPStream *)sender didReceiveIQ:(XMPPIQ *)iq
 
 		if (!hasRoster)
 		{
+            [xmppRosterStorage clearAllUsersAndResourcesForXMPPStream:xmppStream];
             [self _setPopulatingRoster:YES];
             [multicastDelegate xmppRosterDidBeginPopulating:self];
 			[xmppRosterStorage beginRosterPopulationForXMPPStream:xmppStream];
@@ -823,7 +857,14 @@ - (void)xmppStreamDidDisconnect:(XMPPStream *)sender withError:(NSError *)error
 
 	XMPPLogTrace();
 
-	[xmppRosterStorage clearAllUsersAndResourcesForXMPPStream:xmppStream];
+    if([self autoClearAllUsersAndResources])
+    {
+        [xmppRosterStorage clearAllUsersAndResourcesForXMPPStream:xmppStream];
+    }
+    else
+    {
+        [xmppRosterStorage clearAllResourcesForXMPPStream:xmppStream];
+    }
 
 	[self _setRequestedRoster:NO];
 	[self _setHasRoster:NO];