Roster is only accepted if it has been asked for

Relates too robbiehanson#300

Author: ObjColumnist

Extensions/Roster/XMPPRoster.h

@@ -12,6 +12,7 @@
 
 @protocol XMPPRosterStorage;
 @class DDList;
+@class XMPPIDTracker;
 
 /**
  * The XMPPRoster provides the scaffolding for a roster solution.
@@ -41,6 +42,8 @@
 	id multicastDelegate;
  */
 	__strong id <XMPPRosterStorage> xmppRosterStorage;
+    
+    XMPPIDTracker *xmppIDTracker;
 
 	Byte config;
 	Byte flags;

Extensions/Roster/XMPPRoster.m

@@ -1,5 +1,6 @@
 #import "XMPPRoster.h"
 #import "XMPP.h"
+#import "XMPPIDTracker.h"
 #import "XMPPLogging.h"
 #import "XMPPFramework.h"
 #import "DDList.h"
@@ -88,7 +89,9 @@ - (BOOL)activate:(XMPPStream *)aXmppStream
 
 	if ([super activate:aXmppStream])
 	{
-		XMPPLogVerbose(@"%@: Activated", THIS_FILE);
+        XMPPLogVerbose(@"%@: Activated", THIS_FILE);
+
+        xmppIDTracker = [[XMPPIDTracker alloc] initWithDispatchQueue:moduleQueue];
 
 		#ifdef _XMPP_VCARD_AVATAR_MODULE_H
 		{
@@ -113,7 +116,7 @@ - (BOOL)activate:(XMPPStream *)aXmppStream
 			}];
 		}
 		#endif
-        		
+		
 		return YES;
 	}
 
@@ -123,6 +126,18 @@ - (BOOL)activate:(XMPPStream *)aXmppStream
 - (void)deactivate
 {
 	XMPPLogTrace();
+    
+    dispatch_block_t block = ^{ @autoreleasepool {
+        
+		[xmppIDTracker removeAllIDs];
+		xmppIDTracker = nil;
+        
+	}};
+    
+	if (dispatch_get_specific(moduleQueueTag))
+		block();
+	else
+		dispatch_sync(moduleQueue, block);
 
 	#ifdef _XMPP_VCARD_AVATAR_MODULE_H
 	{
@@ -371,6 +386,28 @@ - (void)_setPopulatingRoster:(BOOL)flag
 	else
 		flags &= ~kPopulatingRoster;
 }
+
+- (void)_addRosterItems:(NSArray *)rosterItems
+{
+    NSAssert(dispatch_get_specific(moduleQueueTag) , @"Invoked on incorrect queue");
+    
+    BOOL hasRoster = [self _hasRoster];
+    
+    for (NSXMLElement *item in rosterItems)
+    {
+        // During roster population, we need to filter out items for users who aren't actually in our roster.
+        // That is, those users who have requested to be our buddy, but we haven't approved yet.
+        // This is described in more detail in the method isRosterItem above.
+        
+        [multicastDelegate xmppRoster:self didReceiveRosterItem:item];
+        
+        if (hasRoster || [self isRosterItem:item])
+        {
+            [xmppRosterStorage handleRosterItem:item xmppStream:xmppStream];
+        }
+    }
+}
+
 /**
  * Some server's include in our roster the JID's of user's NOT in our roster.
  * This happens when another user adds us to their roster, and requests permission to receive our presence.
@@ -652,9 +689,13 @@ - (void)fetchRoster
 
 		NSXMLElement *query = [NSXMLElement elementWithName:@"query" xmlns:@"jabber:iq:roster"];
 
-		NSXMLElement *iq = [NSXMLElement elementWithName:@"iq"];
-		[iq addAttributeWithName:@"type" stringValue:@"get"];
+		XMPPIQ *iq = [XMPPIQ iqWithType:@"get" elementID:[xmppStream generateUUID]];
 		[iq addChild:query];
+        
+        [xmppIDTracker addElement:iq
+                           target:self
+                         selector:@selector(handleFetchRosterQueryIQ:withInfo:)
+                          timeout:60];
 
 		[xmppStream sendElement:iq];
 
@@ -668,38 +709,14 @@ - (void)fetchRoster
 }
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-#pragma mark XMPPStream Delegate
+#pragma mark XMPPIDTracker
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender
-{
-	// This method is invoked on the moduleQueue.
-	
-	XMPPLogTrace();
-	
-	if ([self autoFetchRoster])
-	{
-		[self fetchRoster];
-	}
-}
-
-- (BOOL)xmppStream:(XMPPStream *)sender didReceiveIQ:(XMPPIQ *)iq
-{
-	// This method is invoked on the moduleQueue.
-	
-	XMPPLogTrace();
-	
-	// Note: Some jabber servers send an iq element with an xmlns.
-	// Because of the bug in Apple's NSXML (documented in our elementForName method),
-	// it is important we specify the xmlns for the query.
-	
-	NSXMLElement *query = [iq elementForName:@"query" xmlns:@"jabber:iq:roster"];
-	if (query)
-	{
-        if([iq isSetIQ])
-        {
-            [multicastDelegate xmppRoster:self didReceiveRosterPush:iq];
-        }
+- (void)handleFetchRosterQueryIQ:(XMPPIQ *)iq withInfo:(XMPPBasicTrackingInfo *)basicTrackingInfo{
+    
+    dispatch_block_t block = ^{ @autoreleasepool {
+        
+        NSXMLElement *query = [iq elementForName:@"query" xmlns:@"jabber:iq:roster"];
 
 		BOOL hasRoster = [self _hasRoster];
 
@@ -712,19 +729,7 @@ - (BOOL)xmppStream:(XMPPStream *)sender didReceiveIQ:(XMPPIQ *)iq
 		}
 
 		NSArray *items = [query elementsForName:@"item"];
-		for (NSXMLElement *item in items)
-		{
-			// During roster population, we need to filter out items for users who aren't actually in our roster.
-			// That is, those users who have requested to be our buddy, but we haven't approved yet.
-			// This is described in more detail in the method isRosterItem above.
-			
-            [multicastDelegate xmppRoster:self didReceiveRosterItem:item];
-            
-			if (hasRoster || [self isRosterItem:item])
-			{
-				[xmppRosterStorage handleRosterItem:item xmppStream:xmppStream];
-			}
-		}
+        [self _addRosterItems:items];
 
 		if (!hasRoster)
 		{
@@ -741,8 +746,60 @@ - (BOOL)xmppStream:(XMPPStream *)sender didReceiveIQ:(XMPPIQ *)iq
 			{
 				[self xmppStream:xmppStream didReceivePresence:presence];
 			}
+            
 			[earlyPresenceElements removeAllObjects];
 		}
+        
+    }};
+	
+	if (dispatch_get_specific(moduleQueueTag))
+		block();
+	else
+		dispatch_async(moduleQueue, block);
+    
+}
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+#pragma mark XMPPStream Delegate
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+- (void)xmppStreamDidAuthenticate:(XMPPStream *)sender
+{
+	// This method is invoked on the moduleQueue.
+	
+	XMPPLogTrace();
+	
+	if ([self autoFetchRoster])
+	{
+		[self fetchRoster];
+	}
+}
+
+- (BOOL)xmppStream:(XMPPStream *)sender didReceiveIQ:(XMPPIQ *)iq
+{
+	// This method is invoked on the moduleQueue.
+	
+	XMPPLogTrace();
+	
+	// Note: Some jabber servers send an iq element with an xmlns.
+	// Because of the bug in Apple's NSXML (documented in our elementForName method),
+	// it is important we specify the xmlns for the query.
+	
+	NSXMLElement *query = [iq elementForName:@"query" xmlns:@"jabber:iq:roster"];
+	
+    if (query)
+	{
+        if([iq isSetIQ])
+        {
+            [multicastDelegate xmppRoster:self didReceiveRosterPush:iq];
+            
+            NSArray *items = [query elementsForName:@"item"];
+            [self _addRosterItems:items];
+        }
+        else if([iq isResultIQ])
+        {
+            [xmppIDTracker invokeForID:[iq elementID] withObject:iq];
+        }
 
 		return YES;
 	}