Universal Roster Item API

A Universal API for both Memory and Core Data Roster Storage for
getting information about a Roster Item:

- Subscription
- Ask
- Nickname
- Groups

Author: ObjColumnist

Extensions/Roster/CoreDataStorage/XMPPRosterCoreDataStorage.m

@@ -522,5 +522,52 @@ - (NSArray *)jidsForXMPPStream:(XMPPStream *)stream{
     return results;
 }
 
+- (void)getSubscription:(NSString **)subscription
+                    ask:(NSString **)ask
+               nickname:(NSString **)nickname
+                 groups:(NSArray **)groups
+                 forJID:(XMPPJID *)jid
+             xmppStream:(XMPPStream *)stream
+{
+    XMPPLogTrace();
+        
+    [self executeBlock:^{
+        
+        NSManagedObjectContext *moc = [self managedObjectContext];
+        XMPPUserCoreDataStorageObject *user = [self userForJID:jid xmppStream:stream managedObjectContext:moc];
+        
+        if(user)
+        {
+            if(subscription)
+            {
+                *subscription = user.subscription;
+            }
+            
+            if(ask)
+            {
+                *ask = user.ask;
+            }
+            
+            if(nickname)
+            {
+                *nickname = user.nickname;
+            }
+            
+            if(groups)
+            {
+                if([user.groups count])
+                {
+                    NSMutableArray *groupNames = [NSMutableArray array];
+                    
+                    for(XMPPGroupCoreDataStorageObject *group in user.groups){
+                        [groupNames addObject:group.name];
+                    }
+                    
+                    *groups = groupNames;
+                }
+            }
+        }
+    }];
+}
 
 @end

Extensions/Roster/MemoryStorage/XMPPRosterMemoryStorage.m

@@ -819,4 +819,42 @@ - (NSArray *)jidsForXMPPStream:(XMPPStream *)stream
     return results;
 }
 
+- (void)getSubscription:(NSString **)subscription
+					ask:(NSString **)ask
+			   nickname:(NSString **)nickname
+				 groups:(NSArray **)groups
+				 forJID:(XMPPJID *)jid
+			 xmppStream:(XMPPStream *)stream
+{
+
+	XMPPLogTrace();
+	AssertParentQueue();
+
+	XMPPJID *jidKey = [jid bareJID];
+	XMPPUserMemoryStorageObject *rosterUser = [roster objectForKey:jidKey];
+
+	if(rosterUser)
+	{
+		if(subscription)
+		{
+			*subscription = rosterUser.subscription;
+		}
+
+		if(ask)
+		{
+			*ask = rosterUser.ask;
+		}
+
+		if(nickname)
+		{
+			*nickname = rosterUser.nickname;
+		}
+		
+		if(groups)
+		{
+			*groups = rosterUser.groups;
+		}
+	}
+}
+
 @end

Extensions/Roster/MemoryStorage/XMPPUserMemoryStorageObject.h

@@ -13,6 +13,7 @@
 {
 	XMPPJID *jid;
 	NSMutableDictionary *itemAttributes;
+	NSMutableArray *groups;
 
 	NSMutableDictionary *resources;
 	XMPPResourceMemoryStorageObject *primaryResource;
@@ -39,13 +40,22 @@
 
 */
 
+- (NSString *)subscription;
+
+- (NSString *)ask;
+
 /**
  * Simple convenience method.
  * If a nickname exists for the user, the nickname is returned.
  * Otherwise the jid is returned (as a string).
 **/
 - (NSString *)displayName;
 
+/**
+ * An array of Group Names.
+**/
+- (NSArray *)groups;
+
 /**
  * If XMPPvCardAvatarModule is included in the framework, the XMPPRoster will automatically integrate with it,
  * and we'll save the the user photos after they've been downloaded.

Extensions/Roster/MemoryStorage/XMPPUserMemoryStorageObject.m

@@ -33,6 +33,8 @@ - (id)initWithJID:(XMPPJID *)aJid
 
 		itemAttributes = [[NSMutableDictionary alloc] initWithCapacity:0];
 
+		groups = [[NSMutableArray alloc] initWithCapacity:0];
+		
 		[self commonInit];
 	}
 	return self;
@@ -47,6 +49,19 @@ - (id)initWithItem:(NSXMLElement *)item
 
 		itemAttributes = [item attributesAsDictionary];
 
+		groups = [[NSMutableArray alloc] initWithCapacity:0];
+		
+		NSArray *groupElements = [item elementsForName:@"group"];
+		
+		for (NSXMLElement *groupElement in groupElements) {
+			NSString *groupName = [groupElement stringValue];
+		
+			if ([groupName length])
+			{
+				[groups addObject:groupName];
+			}
+		}
+		
 		[self commonInit];
 	}
 	return self;
@@ -65,6 +80,7 @@ - (id)copyWithZone:(NSZone *)zone
 
 	deepCopy->jid = [jid copy];
 	deepCopy->itemAttributes = [itemAttributes mutableCopy];
+	deepCopy->groups = [groups mutableCopy];
 
 	deepCopy->resources = [[NSMutableDictionary alloc] initWithCapacity:[resources count]];
 
@@ -106,6 +122,7 @@ - (id)initWithCoder:(NSCoder *)coder
             {
                 jid             = [coder decodeObjectOfClass:[XMPPJID class] forKey:@"jid"];
                 itemAttributes  = [[coder decodeObjectOfClass:[NSDictionary class] forKey:@"itemAttributes"] mutableCopy];
+                groups          = [[coder decodeObjectOfClass:[NSArray class] forKey:@"groups"] mutableCopy];
 #if TARGET_OS_IPHONE
                 photo           = [[UIImage alloc] initWithData:[coder decodeObjectOfClass:[NSData class] forKey:@"photo"]];
 #else
@@ -118,6 +135,7 @@ - (id)initWithCoder:(NSCoder *)coder
             {
                 jid             = [coder decodeObjectForKey:@"jid"];
                 itemAttributes  = [[coder decodeObjectForKey:@"itemAttributes"] mutableCopy];
+                groups          = [[coder decodeObjectForKey:@"groups"] mutableCopy];
 #if TARGET_OS_IPHONE
                 photo           = [[UIImage alloc] initWithData:[coder decodeObjectForKey:@"photo"]];
 #else
@@ -131,6 +149,7 @@ - (id)initWithCoder:(NSCoder *)coder
 		{
 			jid             = [coder decodeObject];
 			itemAttributes  = [[coder decodeObject] mutableCopy];
+			groups          = [[coder decodeObject] mutableCopy];
 		#if TARGET_OS_IPHONE
 			photo           = [[UIImage alloc] initWithData:[coder decodeObject]];
 		#else
@@ -149,6 +168,7 @@ - (void)encodeWithCoder:(NSCoder *)coder
 	{
 		[coder encodeObject:jid forKey:@"jid"];
 		[coder encodeObject:itemAttributes forKey:@"itemAttributes"];
+		[coder encodeObject:groups forKey:@"groups"];
 	#if TARGET_OS_IPHONE
 		[coder encodeObject:UIImagePNGRepresentation(photo) forKey:@"photo"];
 	#else
@@ -161,6 +181,7 @@ - (void)encodeWithCoder:(NSCoder *)coder
 	{
 		[coder encodeObject:jid];
 		[coder encodeObject:itemAttributes];
+		[coder encodeObject:groups];
 	#if TARGET_OS_IPHONE
 		[coder encodeObject:UIImagePNGRepresentation(photo)];
 	#else
@@ -192,6 +213,16 @@ - (NSString *)nickname
 	return (NSString *)[itemAttributes objectForKey:@"name"];
 }
 
+- (NSString *)subscription
+{
+	return (NSString *)[itemAttributes objectForKey:@"subscription"];
+}
+
+- (NSString *)ask
+{
+	return (NSString *)[itemAttributes objectForKey:@"ask"];
+}
+
 - (NSString *)displayName
 {
 	NSString *nickname = [self nickname];
@@ -201,6 +232,11 @@ - (NSString *)displayName
 		return [jid bare];
 }
 
+- (NSArray *)groups
+{
+	return [groups copy];
+}
+
 - (BOOL)isOnline
 {
 	return (primaryResource != nil);
@@ -309,6 +345,19 @@ - (void)updateWithItem:(NSXMLElement *)item
 
 		[itemAttributes setObject:value forKey:key];
 	}
+	
+	[groups removeAllObjects];
+	
+	NSArray *groupElements = [item elementsForName:@"group"];
+	
+	for (NSXMLElement *groupElement in groupElements) {
+		NSString *groupName = [groupElement stringValue];
+		
+		if ([groupName length])
+		{
+			[groups addObject:groupName];
+		}
+	}
 }
 
 - (int)updateWithPresence:(XMPPPresence *)presence

Extensions/Roster/XMPPRoster.h

@@ -333,6 +333,13 @@
 
 - (NSArray *)jidsForXMPPStream:(XMPPStream *)stream;
 
+- (void)getSubscription:(NSString **)subscription
+                    ask:(NSString **)ask
+               nickname:(NSString **)nickname
+                 groups:(NSArray **)groups
+                 forJID:(XMPPJID *)jid
+             xmppStream:(XMPPStream *)stream;
+
 @optional
 
 /**