Decouple XMPPRoster and XMPPConnection

src/XMPPConnection.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2010, 2011, 2012, Jonathan Schleifer <js@webkeks.org>
- * Copyright (c) 2011, Florian Zeitz <florob@babelmonkeys.de>
+ * Copyright (c) 2011, 2012, Florian Zeitz <florob@babelmonkeys.de>
  *
  * https://webkeks.org/hg/objxmpp/
  *
@@ -29,8 +29,6 @@
 @class XMPPMessage;
 @class XMPPPresence;
 @class XMPPAuthenticator;
-@class XMPPRoster;
-@class XMPPRosterItem;
 @class SSLSocket;
 @class XMPPMulticastDelegate;
 
@@ -48,15 +46,12 @@
 - (void)connectionWasAuthenticated: (XMPPConnection*)connection;
 - (void)connection: (XMPPConnection*)connection
      wasBoundToJID: (XMPPJID*)JID;
-- (void)connectionDidReceiveRoster: (XMPPConnection*)connection;
 - (BOOL)connection: (XMPPConnection*)connection
       didReceiveIQ: (XMPPIQ*)iq;
 -   (void)connection: (XMPPConnection*)connection
   didReceivePresence: (XMPPPresence*)presence;
 -  (void)connection: (XMPPConnection*)connection
   didReceiveMessage: (XMPPMessage*)message;
--     (void)connection: (XMPPConnection*)connection
-  didReceiveRosterItem: (XMPPRosterItem*)rosterItem;
 - (void)connectionWasClosed: (XMPPConnection*)connection;
 - (void)connectionWillUpgradeToTLS: (XMPPConnection*)connection;
 - (void)connectionDidUpgradeToTLS: (XMPPConnection*)connection;
@@ -85,7 +80,6 @@
 	BOOL needsSession;
 	BOOL encryptionRequired, encrypted;
 	unsigned int lastID;
-	XMPPRoster *roster;
 }
 
 #ifdef OF_HAVE_PROPERTIES
@@ -93,7 +87,6 @@
 @property (copy) OFString *privateKeyFile, *certificateFile;
 @property (copy, readonly) XMPPJID *JID;
 @property (assign) uint16_t port;
-@property (readonly, retain) XMPPRoster *roster;
 @property (readonly, retain, getter=socket) OFTCPSocket *sock;
 @property (assign) BOOL encryptionRequired;
 @property (readonly) BOOL encrypted;
@@ -222,7 +215,6 @@
 - (XMPPJID*)JID;
 - (void)setPort: (uint16_t)port;
 - (uint16_t)port;
-- (XMPPRoster*)roster;
 
 - (void)XMPP_startStream;
 - (void)XMPP_handleStream: (OFXMLElement*)element;

src/XMPPConnection.m

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2010, 2011, 2012, Jonathan Schleifer <js@webkeks.org>
- * Copyright (c) 2011, Florian Zeitz <florob@babelmonkeys.de>
+ * Copyright (c) 2011, 2012, Florian Zeitz <florob@babelmonkeys.de>
  *
  * https://webkeks.org/hg/objxmpp/
  *
@@ -47,8 +47,6 @@
 #import "XMPPIQ.h"
 #import "XMPPMessage.h"
 #import "XMPPPresence.h"
-#import "XMPPRoster.h"
-#import "XMPPRosterItem.h"
 #import "XMPPMulticastDelegate.h"
 #import "XMPPExceptions.h"
 #import "namespaces.h"
@@ -94,7 +92,6 @@
 	[delegates release];
 	[callbacks release];
 	[authModule release];
-	[roster release];
 
 	[super dealloc];
 }
@@ -533,16 +530,12 @@
 	oldParser = parser;
 	oldElementBuilder = elementBuilder;
 
-	[roster release];
-
 	parser = [[OFXMLParser alloc] init];
 	[parser setDelegate: self];
 
 	elementBuilder = [[OFXMLElementBuilder alloc] init];
 	[elementBuilder setDelegate: self];
 
-	roster = [[XMPPRoster alloc] initWithConnection: self];
-
 	[sock writeFormat: @"<?xml version='1.0'?>\n"
 			   @"<stream:stream to='%@' "
 			   @"xmlns='" XMPP_NS_CLIENT @"' "
@@ -782,11 +775,6 @@
 		return;
 	}
 
-	if ([iq elementForName: @"query"
-		     namespace: XMPP_NS_ROSTER])
-		if ([roster handleIQ: iq])
-			return;
-
 	handled = [delegates broadcastSelector: @selector(
 						    connection:didReceiveIQ:)
 				 forConnection: self
@@ -1059,11 +1047,6 @@
 {
 	return delegates;
 }
-
-- (XMPPRoster*)roster
-{
-	return [[roster retain] autorelease];
-}
 @end
 
 @implementation OFObject (XMPPConnectionDelegate)
@@ -1086,10 +1069,6 @@
 {
 }
 
-- (void)connectionDidReceiveRoster: (XMPPConnection*)connection
-{
-}
-
 - (BOOL)connection: (XMPPConnection*)connection
       didReceiveIQ: (XMPPIQ*)iq
 {
@@ -1106,11 +1085,6 @@
 {
 }
 
--     (void)connection: (XMPPConnection*)connection
-  didReceiveRosterItem: (XMPPRosterItem*)rosterItem
-{
-}
-
 - (void)connectionWasClosed: (XMPPConnection*)connection
 {
 }

src/XMPPRoster.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2011, Jonathan Schleifer <js@webkeks.org>
+ * Copyright (c) 2012, Florian Zeitz <florob@babelmonkeys.de>
  *
  * https://webkeks.org/hg/objxmpp/
  *
@@ -22,25 +23,53 @@
 
 #import <ObjFW/ObjFW.h>
 
-@class XMPPConnection;
+#import "XMPPConnection.h"
+
 @class XMPPRosterItem;
 @class XMPPIQ;
+@class XMPPRoster;
+
+@protocol XMPPRosterDelegate
+#ifndef XMPP_ROSTER_M
+    <OFObject>
+#endif
+#ifdef OF_HAVE_OPTIONAL_PROTOCOLS
+@optional
+#endif
+- (void)rosterWasReceived: (XMPPRoster*)roster;
+-         (void)roster: (XMPPRoster*)roster
+  didReceiveRosterItem: (XMPPRosterItem*)rosterItem;
+@end
+
 
 @interface XMPPRoster: OFObject
+#ifdef OF_HAVE_OPTIONAL_PROTOCOLS
+    <XMPPConnectionDelegate>
+#endif
 {
 	XMPPConnection *connection;
 	OFMutableDictionary *rosterItems;
-	OFString *rosterID;
+	id <XMPPRosterDelegate, OFObject> delegate;
 }
 
+#ifdef OF_HAVE_PROPERTIES
+@property (assign) id <XMPPRosterDelegate> delegate;
+#endif
+
 - initWithConnection: (XMPPConnection*)conn;
-- (void)XMPP_addRosterItem: (XMPPRosterItem*)rosterItem;
-- (void)XMPP_updateRosterItem: (XMPPRosterItem*)rosterItem;
-- (void)XMPP_deleteRosterItem: (XMPPRosterItem*)rosterItem;
 - (OFDictionary*)rosterItems;
-- (BOOL)handleIQ: (XMPPIQ*)iq;
 - (void)requestRoster;
 - (void)addRosterItem: (XMPPRosterItem*)rosterItem;
 - (void)updateRosterItem: (XMPPRosterItem*)rosterItem;
 - (void)deleteRosterItem: (XMPPRosterItem*)rosterItem;
+- (void)setDelegate: (id <XMPPRosterDelegate>)delegate;
+- (id <XMPPRosterDelegate>)delegate;
+- (void)XMPP_addRosterItem: (XMPPRosterItem*)rosterItem;
+- (void)XMPP_updateRosterItem: (XMPPRosterItem*)rosterItem;
+- (void)XMPP_deleteRosterItem: (XMPPRosterItem*)rosterItem;
+- (void)XMPP_handleInitialRoster: (XMPPIQ*)iq;
+- (XMPPRosterItem*)XMPP_rosterItemWithXMLElement: (OFXMLElement*)element;
+@end
+
+@interface OFObject (XMPPRosterDelegate) <XMPPRosterDelegate>
 @end

src/XMPPRoster.m

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2011, Jonathan Schleifer <js@webkeks.org>
+ * Copyright (c) 2012, Florian Zeitz <florob@babelmonkeys.de>
  *
  * https://webkeks.org/hg/objxmpp/
  *
@@ -24,6 +25,8 @@
 # include "config.h"
 #endif
 
+#define XMPP_ROSTER_M
+
 #include <assert.h>
 
 #import "XMPPRoster.h"
@@ -35,12 +38,14 @@
 #import "namespaces.h"
 
 @implementation XMPPRoster
-- initWithConnection: (XMPPConnection*)conn
+- initWithConnection: (XMPPConnection*)connection_
 {
 	self = [super init];
 
 	@try {
 		rosterItems = [[OFMutableDictionary alloc] init];
+		connection = connection_;
+		[connection addDelegate: self];
 	} @catch (id e) {
 		[self release];
 		@throw e;
@@ -52,26 +57,10 @@
 - (void)dealloc
 {
 	[rosterItems release];
-	[rosterID release];
 
 	[super dealloc];
 }
 
-- (void)XMPP_addRosterItem: (XMPPRosterItem*)rosterItem
-{
-	return [self XMPP_updateRosterItem: rosterItem];
-}
-
-- (void)XMPP_updateRosterItem: (XMPPRosterItem*)rosterItem
-{
-	[rosterItems setObject: rosterItem
-			forKey: [[rosterItem JID] bareJID]];
-}
-
-- (void)XMPP_deleteRosterItem: (XMPPRosterItem*)rosterItem
-{
-	[rosterItems removeObjectForKey: [[rosterItem JID] bareJID]];
-}
 
 - (OFDictionary*)rosterItems
 {
@@ -82,25 +71,21 @@
 {
 	XMPPIQ *iq;
 
-	if (rosterID != nil)
-		assert(0);
-
-	rosterID = [[connection generateStanzaID] retain];
 	iq = [XMPPIQ IQWithType: @"get"
-			     ID: rosterID];
+			     ID: [connection generateStanzaID]];
 	[iq addChild: [OFXMLElement elementWithName: @"query"
 					  namespace: XMPP_NS_ROSTER]];
-	[connection sendStanza: iq];
+	[connection     sendIQ: iq
+	    withCallbackObject: self
+		      selector: @selector(XMPP_handleInitialRoster:)];
 }
 
-- (BOOL)handleIQ: (XMPPIQ*)iq
+- (BOOL)connection: (XMPPConnection*)connection_
+      didReceiveIQ: (XMPPIQ*)iq
 {
 	OFXMLElement *rosterElement;
 	OFXMLElement *element;
-	XMPPRosterItem *rosterItem = nil;
+	XMPPRosterItem *rosterItem;
-	OFString *subscription;
-	OFEnumerator *enumerator;
-	BOOL isPush = ![[iq ID] isEqual: rosterID];
 
 	rosterElement = [iq elementForName: @"query"
 				 namespace: XMPP_NS_ROSTER];
@@ -108,76 +93,27 @@
 	if (rosterElement == nil)
 		return NO;
 
-	if (isPush) {
+	if (![[iq type] isEqual: @"set"])
-		if (![[iq type] isEqual: @"set"])
+		return NO;
-			return NO;
-	} else {
-		if (![[iq type] isEqual: @"result"])
-			return NO;
-	}
 
-	enumerator = [[rosterElement children] objectEnumerator];
+	element = [rosterElement elementForName: @"item"
-	while ((element = [enumerator nextObject]) != nil) {
+				      namespace: XMPP_NS_ROSTER];
-		OFMutableArray *groups = [OFMutableArray array];
-		OFEnumerator *groupEnumerator;
-		OFXMLElement *groupElement;
 
-		if (![[element name] isEqual: @"item"] ||
+	if (element != nil) {
-		    ![[element namespace] isEqual: XMPP_NS_ROSTER])
+		rosterItem = [self XMPP_rosterItemWithXMLElement: element];
-			continue;
 
-		rosterItem = [XMPPRosterItem rosterItem];
+		if ([[rosterItem subscription] isEqual: @"remove"])
-		[rosterItem setJID: [XMPPJID JIDWithString:
-		    [[element attributeForName: @"jid"] stringValue]]];
-		[rosterItem setName:
-		    [[element attributeForName: @"name"] stringValue]];
-
-		subscription = [[element attributeForName:
-		    @"subscription"] stringValue];
-
-		if (![subscription isEqual: @"none"] &&
-		    ![subscription isEqual: @"to"] &&
-		    ![subscription isEqual: @"from"] &&
-		    ![subscription isEqual: @"both"] &&
-		    (![subscription isEqual: @"remove"] || !isPush))
-			subscription = @"none";
-
-		[rosterItem setSubscription: subscription];
-
-		groupEnumerator = [[element
-		    elementsForName: @"group"
-			  namespace: XMPP_NS_ROSTER] objectEnumerator];
-		while ((groupElement = [groupEnumerator nextObject]) != nil)
-			[groups addObject: [groupElement stringValue]];
-
-		if ([groups count] > 0)
-			[rosterItem setGroups: groups];
-
-		if ([subscription isEqual: @"remove"])
 			[self XMPP_deleteRosterItem: rosterItem];
 		else
 			[self XMPP_addRosterItem: rosterItem];
 
-		if (isPush) {
+		if ([delegate respondsToSelector:
-			SEL sel = @selector(connection:didReceiveRosterItem:);
+		    @selector(roster:didReceiveRosterItem:)])
-
+			[delegate         roster: self
-			[[connection XMPP_delegates]
+			    didReceiveRosterItem: rosterItem];
-			    broadcastSelector: sel
-				forConnection: connection
-				   withObject: rosterItem];
-		}
 	}
 
-	if (isPush) {
+	[connection_ sendStanza: [iq resultIQ]];
-		[connection sendStanza: [iq resultIQ]];
-	} else {
-		[[connection XMPP_delegates]
-		    broadcastSelector: @selector(connectionDidReceiveRoster:)
-			forConnection: connection];
-
-		[rosterID release];
-		rosterID = nil;
-	}
 
 	return YES;
 }
@@ -235,4 +171,105 @@
 
 	[connection sendStanza: iq];
 }
+
+- (void)setDelegate: (id <XMPPRosterDelegate>)delegate_
+{
+	delegate = (id <XMPPRosterDelegate, OFObject>)delegate_;
+}
+
+- (id <XMPPRosterDelegate>)delegate
+{
+	return delegate;
+}
+
+- (void)XMPP_addRosterItem: (XMPPRosterItem*)rosterItem
+{
+	return [self XMPP_updateRosterItem: rosterItem];
+}
+
+- (void)XMPP_updateRosterItem: (XMPPRosterItem*)rosterItem
+{
+	[rosterItems setObject: rosterItem
+			forKey: [[rosterItem JID] bareJID]];
+}
+
+- (void)XMPP_deleteRosterItem: (XMPPRosterItem*)rosterItem
+{
+	[rosterItems removeObjectForKey: [[rosterItem JID] bareJID]];
+}
+
+- (XMPPRosterItem*)XMPP_rosterItemWithXMLElement: (OFXMLElement*)element
+{
+	OFString *subscription;
+	OFEnumerator *groupEnumerator;
+	OFXMLElement *groupElement;
+	OFMutableArray *groups = [OFMutableArray array];
+	XMPPRosterItem *rosterItem = [XMPPRosterItem rosterItem];
+	[rosterItem setJID: [XMPPJID JIDWithString:
+	    [[element attributeForName: @"jid"] stringValue]]];
+	[rosterItem setName:
+	    [[element attributeForName: @"name"] stringValue]];
+
+	subscription = [[element attributeForName:
+	    @"subscription"] stringValue];
+
+	if (![subscription isEqual: @"none"] &&
+	    ![subscription isEqual: @"to"] &&
+	    ![subscription isEqual: @"from"] &&
+	    ![subscription isEqual: @"both"] &&
+	    ![subscription isEqual: @"remove"])
+		subscription = @"none";
+
+	[rosterItem setSubscription: subscription];
+
+	groupEnumerator = [[element
+	    elementsForName: @"group"
+		  namespace: XMPP_NS_ROSTER] objectEnumerator];
+	while ((groupElement = [groupEnumerator nextObject]) != nil)
+		[groups addObject: [groupElement stringValue]];
+
+	if ([groups count] > 0)
+		[rosterItem setGroups: groups];
+
+	return rosterItem;
+}
+
+- (void)XMPP_handleInitialRoster: (XMPPIQ*)iq
+{
+	OFXMLElement *rosterElement;
+	OFEnumerator *enumerator;
+	OFXMLElement *element;
+	XMPPRosterItem *rosterItem = nil;
+
+	rosterElement = [iq elementForName: @"query"
+				 namespace: XMPP_NS_ROSTER];
+
+	enumerator = [[rosterElement children] objectEnumerator];
+	while ((element = [enumerator nextObject]) != nil) {
+		if (![[element name] isEqual: @"item"] ||
+		    ![[element namespace] isEqual: XMPP_NS_ROSTER])
+			continue;
+
+		rosterItem = [self XMPP_rosterItemWithXMLElement: element];
+
+		if ([[rosterItem subscription] isEqual: @"remove"])
+			[self XMPP_deleteRosterItem: rosterItem];
+		else
+			[self XMPP_addRosterItem: rosterItem];
+	}
+
+	if ([delegate respondsToSelector: @selector(rosterWasReceived:)])
+		[delegate rosterWasReceived: self];
+}
+@end
+
+@implementation OFObject (XMPPRosterDelegate)
+- (void)rosterWasReceived: (XMPPRoster*)roster
+{
+}
+
+-         (void)roster: (XMPPRoster*)roster
+  didReceiveRosterItem: (XMPPRosterItem*)rosterItem
+{
+}
 @end

tests/test.m

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2010, 2011, Jonathan Schleifer <js@webkeks.org>
- * Copyright (c) 2011, Florian Zeitz <florob@babelmonkeys.de>
+ * Copyright (c) 2011, 2012, Florian Zeitz <florob@babelmonkeys.de>
  *
  * https://webkeks.org/hg/objxmpp/
  *
@@ -36,8 +36,12 @@
 
 @interface AppDelegate: OFObject
 #ifdef OF_HAVE_OPTIONAL_PROTOCOLS
-    <OFApplicationDelegate, XMPPConnectionDelegate>
+    <OFApplicationDelegate, XMPPConnectionDelegate, XMPPRosterDelegate>
 #endif
+{
+	XMPPConnection * conn;
+	XMPPRoster *roster;
+}
 @end
 
 OF_APPLICATION_DELEGATE(AppDelegate)
@@ -45,7 +49,6 @@ OF_APPLICATION_DELEGATE(AppDelegate)
 @implementation AppDelegate
 - (void)applicationDidFinishLaunching
 {
-	XMPPConnection *conn;
 	OFArray *arguments = [OFApplication arguments];
 
 	XMPPPresence *pres = [XMPPPresence presence];
@@ -91,7 +94,10 @@ OF_APPLICATION_DELEGATE(AppDelegate)
 	    [stanza ID]] isEqual: @"bob@localhost, alice@localhost, get, 42"]));
 
 	conn = [[XMPPConnection alloc] init];
+	roster = [[XMPPRoster alloc] initWithConnection: conn];
+
 	[conn addDelegate: self];
+	[roster setDelegate: self];
 
 	if ([arguments count] != 3) {
 		of_log(@"Invalid count of command line arguments!");
@@ -133,14 +139,14 @@ OF_APPLICATION_DELEGATE(AppDelegate)
 {
 	of_log(@"Bound to JID: %@", [jid fullJID]);
 
-	[[conn roster] requestRoster];
+	[roster requestRoster];
 }
 
-- (void)connectionDidReceiveRoster: (XMPPConnection*)conn
+- (void)rosterWasReceived: (XMPPRoster*)roster_
 {
 	XMPPPresence *pres;
 
-	of_log(@"Got roster: %@", [[conn roster] rosterItems]);
+	of_log(@"Got roster: %@", [roster_ rosterItems]);
 
 	pres = [XMPPPresence presence];
 	[pres addPriority: 10];
@@ -160,10 +166,10 @@ OF_APPLICATION_DELEGATE(AppDelegate)
 #endif
 }
 
-- (void)connectionDidUpgradeToTLS: (XMPPConnection*)conn
+- (void)connectionDidUpgradeToTLS: (XMPPConnection*)conn_
 {
 	@try {
-		[conn checkCertificate];
+		[conn_ checkCertificate];
 	} @catch (SSLInvalidCertificateException *e) {
 		OFString *answer;
 		[of_stdout writeString: @"Couldn't verify certificate: "];
@@ -175,7 +181,7 @@ OF_APPLICATION_DELEGATE(AppDelegate)
 	}
 }
 
--     (void)connection: (XMPPConnection*)conn
+-         (void)roster: (XMPPRoster*)roster_
   didReceiveRosterItem: (XMPPRosterItem*)rosterItem
 {
 	of_log(@"Got roster push: %@", rosterItem);