Adding ability for XMPPStream to handle custom stanzas (non iq, message, presence), along with corresponding delegate methods.

Author: robbiehanson

Core/XMPPInternal.h

@@ -61,6 +61,20 @@ extern NSString *const XMPPStreamDidChangeMyJIDNotification;
 **/
 - (void)injectElement:(NSXMLElement *)element;
 
+/**
+ * The XMPP standard only supports <iq>, <message> and <presence> stanzas (excluding session setup stuff).
+ * But some extensions use non-standard element types.
+ * The standard example is XEP-0198, which uses <r> & <a> elements.
+ * 
+ * XMPPStream will assume that any non-standard element types are errors, unless you register them.
+ * Once registered the stream can recognize them, and will use the following delegate methods:
+ * 
+ * xmppStream:didSendCustomElement:
+ * xmppStream:didReceiveCustomElement:
+**/
+- (void)registerCustomElementNames:(NSSet *)names;
+- (void)unregisterCustomElementNames:(NSSet *)names;
+
 @end
 
 @interface XMPPModule (/* Internal */)

Core/XMPPStream.h

@@ -1061,4 +1061,20 @@ extern const NSTimeInterval XMPPStreamTimeoutNone;
 - (void)xmppStream:(XMPPStream *)sender didRegisterModule:(id)module;
 - (void)xmppStream:(XMPPStream *)sender willUnregisterModule:(id)module;
 
+/**
+ * Custom elements are Non-XMPP elements.
+ * In other words, not <iq>, <message> or <presence> elements.
+ * 
+ * Typically these kinds of elements are not allowed by the XMPP server.
+ * But some custom implementations may use them.
+ * The standard example is XEP-0198, which uses <r> & <a> elements.
+ * 
+ * If you're using custom elements, you must register the custom element name(s).
+ * Otherwise the xmppStream will treat an non-XMPP elements as errors (xmppStream:didReceiveError:).
+ * 
+ * @see registerCustomElementNames (in XMPPInternal.h)
+**/
+- (void)xmppStream:(XMPPStream *)sender didSendCustomElement:(NSXMLElement *)element;
+- (void)xmppStream:(XMPPStream *)sender didReceiveCustomElement:(NSXMLElement *)element;
+
 @end

Core/XMPPStream.m

@@ -138,6 +138,7 @@ @interface XMPPStream ()
     XMPPIDTracker *idTracker;
 
 	NSMutableArray *receipts;
+	NSCountedSet *customElementNames;
 
 	id userTag;
 }
@@ -2473,6 +2474,11 @@ - (void)continueSendElement:(NSXMLElement *)element withTag:(long)tag
 	[asyncSocket writeData:outgoingData
 	           withTimeout:TIMEOUT_XMPP_WRITE
 	                   tag:tag];
+	
+	if ([customElementNames countForObject:[element name]])
+	{
+		[multicastDelegate xmppStream:self didSendCustomElement:element];
+	}
 }
 
 /**
@@ -3027,6 +3033,10 @@ - (void)injectElement:(NSXMLElement *)element
 			{
 				[self receivePresence:[XMPPPresence presenceFromElement:element]];
 			}
+			else if ([customElementNames countForObject:elementName])
+			{
+				[multicastDelegate xmppStream:self didReceiveCustomElement:element];
+			}
 			else
 			{
 				[multicastDelegate xmppStream:self didReceiveError:element];
@@ -3040,6 +3050,41 @@ - (void)injectElement:(NSXMLElement *)element
 		dispatch_async(xmppQueue, block);
 }
 
+- (void)registerCustomElementNames:(NSSet *)names
+{
+	dispatch_block_t block = ^{
+		
+		if (customElementNames == nil)
+			customElementNames = [[NSCountedSet alloc] init];
+		
+		for (NSString *name in names)
+		{
+			[customElementNames addObject:name];
+		}
+	};
+	
+	if (dispatch_get_specific(xmppQueueTag))
+		block();
+	else
+		dispatch_sync(xmppQueue, block);
+}
+
+- (void)unregisterCustomElementNames:(NSSet *)names
+{
+	dispatch_block_t block = ^{
+		
+		for (NSString *name in names)
+		{
+			[customElementNames removeObject:name];
+		}
+	};
+	
+	if (dispatch_get_specific(xmppQueueTag))
+		block();
+	else
+		dispatch_sync(xmppQueue, block);
+}
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 #pragma mark Stream Negotiation
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -4235,6 +4280,10 @@ - (void)xmppParser:(XMPPParser *)sender didReadElement:(NSXMLElement *)element
 		{
 			[multicastDelegate xmppStream:self didReceiveP2PFeatures:element];
 		}
+		else if ([customElementNames countForObject:elementName])
+		{
+			[multicastDelegate xmppStream:self didReceiveCustomElement:element];
+		}
 		else
 		{
 			[multicastDelegate xmppStream:self didReceiveError:element];