apply r2876 on pubsub_odbc

SVN Revision: 2879

src/mod_pubsub/mod_pubsub_odbc.erl

@@ -86,7 +86,7 @@
 	 get_items/2,
 	 get_item/3,
 	 get_cached_item/2,
-	 broadcast_stanza/8,
+	 broadcast_stanza/9,
 	 get_configure/5,
 	 set_configure/5,
 	 tree_action/3,
@@ -2745,7 +2745,7 @@ broadcast_publish_item(Host, Node, NodeId, Type, NodeOptions, Removed, ItemId, _
 		[{xmlelement, "items", nodeAttr(Node),
 		    [{xmlelement, "item", itemAttr(ItemId), Content}]}]),
 	    broadcast_stanza(Host, Node, NodeId, Type,
-			     NodeOptions, SubsByDepth, items, Stanza),
+			     NodeOptions, SubsByDepth, items, Stanza, true),
 	    case Removed of
 		[] ->
 		    ok;
@@ -2757,7 +2757,7 @@ broadcast_publish_item(Host, Node, NodeId, Type, NodeOptions, Removed, ItemId, _
 				    [{xmlelement, "retract", itemAttr(RId), []} || RId <- Removed]}]),
 			    broadcast_stanza(Host, Node, NodeId, Type,
 					     NodeOptions, SubsByDepth,
-					     items, RetractStanza);
+					     items, RetractStanza, true);
 			_ ->
 			    ok
 		    end
@@ -2781,7 +2781,7 @@ broadcast_retract_items(Host, Node, NodeId, Type, NodeOptions, ItemIds, ForceNot
 			[{xmlelement, "items", nodeAttr(Node),
 			    [{xmlelement, "retract", itemAttr(ItemId), []} || ItemId <- ItemIds]}]),
 		    broadcast_stanza(Host, Node, NodeId, Type,
-				     NodeOptions, SubsByDepth, items, Stanza),
+				     NodeOptions, SubsByDepth, items, Stanza, true),
 		    {result, true};
 		_ ->
 		    {result, false}
@@ -2800,7 +2800,7 @@ broadcast_purge_node(Host, Node, NodeId, Type, NodeOptions) ->
 			[{xmlelement, "purge", nodeAttr(Node),
 			    []}]),
 		    broadcast_stanza(Host, Node, NodeId, Type,
-				     NodeOptions, SubsByDepth, nodes, Stanza),
+				     NodeOptions, SubsByDepth, nodes, Stanza, false),
 		    {result, true};
 		_ -> 
 		    {result, false}
@@ -2821,7 +2821,7 @@ broadcast_removed_node(Host, Node, NodeId, Type, NodeOptions, SubsByDepth) ->
 			[{xmlelement, "delete", nodeAttr(Node),
 			    []}]),
 		    broadcast_stanza(Host, Node, NodeId, Type,
-				     NodeOptions, SubsByDepth, nodes, Stanza),
+				     NodeOptions, SubsByDepth, nodes, Stanza, false),
 		    {result, true}
 	    end;
 	_ ->
@@ -2844,7 +2844,7 @@ broadcast_config_notification(Host, Node, NodeId, Type, NodeOptions, Lang) ->
 		    Stanza = event_stanza(
 			[{xmlelement, "configuration", nodeAttr(Node), Content}]),
 		    broadcast_stanza(Host, Node, NodeId, Type,
-				     NodeOptions, SubsByDepth, nodes, Stanza),
+				     NodeOptions, SubsByDepth, nodes, Stanza, false),
 		    {result, true};
 		_ -> 
 		    {result, false}
@@ -2900,7 +2900,7 @@ get_options_for_subs(NodeID, Subs) ->
 %	    {result, false}
 %    end
 
-broadcast_stanza(Host, Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza) ->
+broadcast_stanza(Host, Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza, SHIM) ->
     NotificationType = get_option(NodeOptions, notification_type, headline),
     BroadcastAll = get_option(NodeOptions, broadcast_all_resources), %% XXX this is not standard, but usefull
     From = service_jid(Host),
@@ -2909,8 +2909,8 @@ broadcast_stanza(Host, Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTyp
 	MsgType -> add_message_type(BaseStanza, atom_to_list(MsgType))
 	end,
     %% Handles explicit subscriptions
-    NodesByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth),
+    SubIDsByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth),
-    lists:foreach(fun ({LJID, Nodes}) ->
+    lists:foreach(fun ({LJID, SubIDs}) ->
 			  LJIDs = case BroadcastAll of
 				      true ->
 					  {U, S, _} = LJID,
@@ -2918,11 +2918,18 @@ broadcast_stanza(Host, Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTyp
 				      false ->
 					  [LJID]
 				  end,
-			  SHIMStanza = add_headers(Stanza, collection_shim(Node, Nodes)),
+        %% Determine if the stanza should have SHIM ('SubID' and 'name') headers
+				StanzaToSend = case SHIM of
+				                 true ->
+				                   Headers = lists:append(collection_shim(Node), subid_shim(SubIDs)),
+				                   add_headers(Stanza, Headers);
+				                 false ->
+				                   Stanza
+				               end,
 			  lists:foreach(fun(To) ->
-						ejabberd_router:route(From, jlib:make_jid(To), SHIMStanza)
+						ejabberd_router:route(From, jlib:make_jid(To), StanzaToSend)
 					end, LJIDs)
-		  end, NodesByJID),
+		  end, SubIDsByJID),
     %% Handles implicit presence subscriptions
     case Host of
 	{LUser, LServer, LResource} ->
@@ -2977,21 +2984,44 @@ subscribed_nodes_by_jid(NotifyType, SubsByDepth) ->
 		    Other -> Other
 		end,
 		NodeOptions = Node#pubsub_node.options,
-		lists:foldl(fun({LJID, _SubID, SubOptions}, Acc2) ->
+	  lists:foldl(
-				     case is_to_deliver(LJID, NotifyType, Depth,
+	    fun({LJID, SubID, SubOptions}, {JIDs, Recipients} = Acc) ->
-							NodeOptions, SubOptions) of
+		   case is_to_deliver(LJID, NotifyType, Depth,	NodeOptions, SubOptions) of
-					 true  -> [{LJID, NodeId}|Acc2];
+		    true  ->
-					 false -> Acc2
+		      %% If is to deliver :
-				     end
+		      case lists:member(LJID, JIDs) of
-			     end, Acc, Subs)
+              %% check if the JIDs co-accumulator contains the Subscription Jid,
+		        false ->
+                %%  - if not,
+                %%       - add the Jid to JIDs list co-accumulator ;
+                %%       - create a tuple of the Jid, NodeId, and SubID (as list),
+                %%         and add the tuple to the Recipients list co-accumulator
+		          {[LJID | JIDs], [{LJID, [SubID]} | Recipients]};
+		        true ->
+		          %% - if the JIDs co-accumulator contains the Jid
+		          %%   get the tuple containing the Jid from the Recipient list co-accumulator
+		          {_, {LJID, SubIDs}} = lists:keysearch(LJID, 1, Recipients),
+		          %%   delete the tuple from the Recipients list
+		          % v1 : Recipients1 = lists:keydelete(LJID, 1, Recipients),
+		          % v2 : Recipients1 = lists:keyreplace(LJID, 1, Recipients, {LJID, NodeId1, [SubID | SubIDs]}),
+		          %%   add the SubID to the SubIDs list in the tuple,
+		          %%   and add the tuple back to the Recipients list co-accumulator
+		          % v1.1 : {JIDs, lists:append(Recipients1, [{LJID, NodeId1, lists:append(SubIDs, [SubID])}])}
+		          % v1.2 : {JIDs, [{LJID, NodeId1, [SubID | SubIDs]} | Recipients1]}
+		          % v2: {JIDs, Recipients1}
+		          {JIDs, lists:keyreplace(LJID, 1, Recipients, {LJID, [SubID | SubIDs]})}
+		      end;
+		    false -> {JIDs, Recipients}
+		    end
+		  end, Acc, Subs)
 	end,
     DepthsToDeliver = fun({Depth, SubsByNode}, Acc) ->
 		lists:foldl(fun({Node, Subs}, Acc2) ->
 				    NodesToDeliver(Depth, Node, Subs, Acc2)
 			    end, Acc, SubsByNode)
 	end,
-    JIDSubs = lists:foldl(DepthsToDeliver, [], SubsByDepth),
+  {_, JIDSubs} = lists:foldl(DepthsToDeliver, {[], []}, SubsByDepth),
-    [{LJID, proplists:append_values(LJID, JIDSubs)} || LJID <- proplists:get_keys(JIDSubs)].
+  JIDSubs.
 
 %% If we don't know the resource, just pick first if any
 %% If no resource available, check if caps anyway (remote online)
@@ -3611,10 +3641,34 @@ add_message_type({xmlelement, "message", Attrs, Els}, Type) ->
 add_message_type(XmlEl, _Type) ->
     XmlEl.
 
+%% Place of <headers/> changed at the bottom of the stanza
+%% cf. http://xmpp.org/extensions/xep-0060.html#publisher-publish-success-subid
+%%
+%% "[SHIM Headers] SHOULD be included after the event notification information
+%% (i.e., as the last child of the <message/> stanza)".
+
 add_headers({xmlelement, Name, Attrs, Els}, HeaderEls) ->
     HeaderEl = {xmlelement, "headers", [{"xmlns", ?NS_SHIM}], HeaderEls},
-    {xmlelement, Name, Attrs, [HeaderEl | Els]}.
+    {xmlelement, Name, Attrs, lists:append(Els, [HeaderEl])}.
 
-collection_shim(Node, Nodes) ->
+%% Removed multiple <header name=Collection>Foo</header/> elements
+%% Didn't seem compliant, but not sure. Confirmation required.
+%% cf. http://xmpp.org/extensions/xep-0248.html#notify
+%%
+%% "If an item is published to a node which is also included by a collection,
+%%  and an entity is subscribed to that collection with a subscription type of
+%%  "items" (Is there a way to check that currently ?), then the notifications
+%%  generated by the service MUST contain additional information. The <items/>
+%%  element contained in the notification message MUST specify the node
+%%  identifier of the node that generated the notification (not the collection)
+%%  and the <item/> element MUST contain a SHIM header that specifies the node
+%%  identifier of the collection".
+
+collection_shim(Node) ->
     [{xmlelement, "header", [{"name", "Collection"}],
-      [{xmlcdata, node_to_string(N)}]} || N <- Nodes -- [Node]].
+      [{xmlcdata, node_to_string(Node)}]}].
+
+subid_shim(SubIDs) ->
+    [{xmlelement, "header", [{"name", "SubID"}],
+      [{xmlcdata, SubID}]} || SubID <- SubIDs].
+

src/mod_pubsub/pubsub_odbc.patch

@@ -1,5 +1,5 @@
---- mod_pubsub.erl	2009-12-07 00:17:20.000000000 +0100
+--- mod_pubsub.erl	2010-01-12 11:24:41.169047172 +0100
-+++ mod_pubsub_odbc.erl	2009-12-07 00:17:59.000000000 +0100
++++ mod_pubsub_odbc.erl	2010-01-12 13:11:52.450026878 +0100
 @@ -42,7 +42,7 @@
  %%% 6.2.3.1, 6.2.3.5, and 6.3. For information on subscription leases see
  %%% XEP-0060 section 12.18.
@@ -658,7 +658,7 @@
  			    _ -> Acc
  			end;
  		    (_, Acc) ->
-@@ -3264,6 +3073,30 @@
+@@ -3294,6 +3103,30 @@
  	    Result
      end.
  
@@ -689,7 +689,7 @@
  %% @spec (Host, Options) -> MaxItems
  %%	 Host = host()
  %%	 Options = [Option]
-@@ -3650,7 +3483,13 @@
+@@ -3680,7 +3513,13 @@
  tree_action(Host, Function, Args) ->
      ?DEBUG("tree_action ~p ~p ~p",[Host,Function,Args]),
      Fun = fun() -> tree_call(Host, Function, Args) end,
@@ -704,7 +704,7 @@
  
  %% @doc <p>node plugin call.</p>
  node_call(Type, Function, Args) ->
-@@ -3670,13 +3509,13 @@
+@@ -3700,13 +3539,13 @@
  
  node_action(Host, Type, Function, Args) ->
      ?DEBUG("node_action ~p ~p ~p ~p",[Host,Type,Function,Args]),
@@ -720,7 +720,7 @@
  			case tree_call(Host, get_node, [Host, Node]) of
  			    N when is_record(N, pubsub_node) ->
  				case Action(N) of
-@@ -3689,8 +3528,14 @@
+@@ -3719,8 +3558,14 @@
  			end
  		end, Trans).
  
@@ -737,7 +737,7 @@
  	{result, Result} -> {result, Result};
  	{error, Error} -> {error, Error};
  	{atomic, {result, Result}} -> {result, Result};
-@@ -3698,6 +3543,15 @@
+@@ -3728,6 +3573,15 @@
  	{aborted, Reason} ->
  	    ?ERROR_MSG("transaction return internal error: ~p~n", [{aborted, Reason}]),
  	    {error, ?ERR_INTERNAL_SERVER_ERROR};
@@ -753,7 +753,7 @@
  	{'EXIT', Reason} ->
  	    ?ERROR_MSG("transaction return internal error: ~p~n", [{'EXIT', Reason}]),
  	    {error, ?ERR_INTERNAL_SERVER_ERROR};
-@@ -3706,6 +3560,17 @@
+@@ -3736,6 +3590,17 @@
  	    {error, ?ERR_INTERNAL_SERVER_ERROR}
      end.