Adding ability to rebroadcast myPresence as an atomic operation.

acekiller · Mar 20, 2012 · d3ea255 · d3ea255
1 parent 4421f3a
commit d3ea255
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 19 deletions.
diff --git a/Core/XMPPStream.h b/Core/XMPPStream.h
@@ -229,6 +229,8 @@ typedef enum XMPPStreamErrorCode XMPPStreamErrorCode;
  * In other words, it represents the presence as others see us.
  * 
  * This excludes presence elements sent concerning subscriptions, MUC rooms, etc.
+ * 
+ * @see resendMyPresence
 **/
 @property (strong, readonly) XMPPPresence *myPresence;
 
@@ -515,6 +517,20 @@ typedef enum XMPPStreamErrorCode XMPPStreamErrorCode;
 **/
 - (void)sendElement:(NSXMLElement *)element andGetReceipt:(XMPPElementReceipt **)receiptPtr;
 
+/**
+ * Fetches and resends the myPresence element (if available) in a single atomic operation.
+ * 
+ * There are various xmpp extensions that hook into the xmpp stream and append information to outgoing presence stanzas.
+ * For example, the XMPPCapabilities module automatically appends capabilities information (as a hash).
+ * When these modules need to update/change their appended information,
+ * they should use this method to do so.
+ * 
+ * The alternative is to fetch the myPresence element, and resend it manually using the sendElement method.
+ * However, that is 2 seperate operations, and the user, may send a different presence element inbetween.
+ * Using this method guarantees everything is done as an atomic operation.
+**/
+- (void)resendMyPresence;
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 #pragma mark Module Plug-In System
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

diff --git a/Core/XMPPStream.m b/Core/XMPPStream.m
@@ -2289,7 +2289,7 @@ - (void)sendElement:(NSXMLElement *)element withTag:(long)tag
 }
 
 /**
- * This methods handles sending an XML fragment.
+ * This methods handles sending an XML stanza.
  * If the XMPPStream is not connected, this method does nothing.
 **/
 - (void)sendElement:(NSXMLElement *)element
@@ -2311,7 +2311,7 @@ - (void)sendElement:(NSXMLElement *)element
 }
 
 /**
- * This method handles sending an XML fragment.
+ * This method handles sending an XML stanza.
  * If the XMPPStream is not connected, this method does nothing.
  * 
  * After the element has been successfully sent,
@@ -2350,6 +2350,22 @@ - (void)sendElement:(NSXMLElement *)element andGetReceipt:(XMPPElementReceipt **
 	}
 }
 
+- (void)resendMyPresence
+{
+	dispatch_block_t block = ^{ @autoreleasepool {
+
+		if (myPresence && [[myPresence type] isEqualToString:@"available"])
+		{
+			[self sendElement:myPresence];
+		}
+	}};
+
+	if (dispatch_get_current_queue() == xmppQueue)
+		block();
+	else
+		dispatch_async(xmppQueue, block);
+}
+
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 #pragma mark Stream Negotiation
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

diff --git a/Extensions/XEP-0115/XMPPCapabilities.m b/Extensions/XEP-0115/XMPPCapabilities.m
@@ -737,11 +737,7 @@ - (void)continueCollectMyCapabilities:(NSXMLElement *)query
 	// and ended up taking so long as to not be available when the presence was sent,
 	// we should re-broadcast our presence now that we know what our capabilities are.
 
-	XMPPPresence *myPresence = [xmppStream myPresence];
-	if (myPresence)
-	{
-		[xmppStream sendElement:myPresence];
-	}
+	[xmppStream resendMyPresence];
 }
 
 - (void)recollectMyCapabilities

diff --git a/Extensions/XEP-0199/XMPPPing.m b/Extensions/XEP-0199/XMPPPing.m
@@ -110,12 +110,7 @@ - (void)setRespondsToQueries:(BOOL)flag
 		#ifdef _XMPP_CAPABILITIES_H
 			@autoreleasepool {
 				// Capabilities may have changed, need to notify others.
-
-				XMPPPresence *presence = xmppStream.myPresence;
-				if (presence)
-				{
-					[xmppStream sendElement:presence];
-				}
+				[xmppStream resendMyPresence];
 			}
 		#endif
 		}

diff --git a/Extensions/XEP-0202/XMPPTime.m b/Extensions/XEP-0202/XMPPTime.m
@@ -110,12 +110,7 @@ - (void)setRespondsToQueries:(BOOL)flag
 		#ifdef _XMPP_CAPABILITIES_H
 			@autoreleasepool {
 				// Capabilities may have changed, need to notify others.
-
-				XMPPPresence *presence = xmppStream.myPresence;
-				if (presence)
-				{
-					[xmppStream sendElement:presence];
-				}
+				[xmppStream resendMyPresence];
 			}
 		#endif
 		}