From 9a69512d819d05bd96987ac95b5f88517d3f6e7d Mon Sep 17 00:00:00 2001
From: Matthew Wild <mwild1@gmail.com>
Date: Wed, 31 Oct 2018 13:13:05 +0000
Subject: MUC: Announce affiliation changes for JIDs that are not in the room

---
 plugins/muc/muc.lib.lua                  |  35 +++++---
 plugins/muc/util.lib.lua                 |   9 ++
 spec/scansion/muc_affiliation_notify.scs | 137 +++++++++++++++++++++++++++++++
 3 files changed, 169 insertions(+), 12 deletions(-)
 create mode 100644 spec/scansion/muc_affiliation_notify.scs

diff --git a/plugins/muc/muc.lib.lua b/plugins/muc/muc.lib.lua
index f69e518b..65f339ed 100644
--- a/plugins/muc/muc.lib.lua
+++ b/plugins/muc/muc.lib.lua
@@ -1313,20 +1313,31 @@ function room_mt:set_affiliation(actor, jid, affiliation, reason, data)
 		end
 	end
 	local is_semi_anonymous = self:get_whois() == "moderators";
-	for occupant, old_role in pairs(occupants_updated) do
-		self:publicise_occupant_status(occupant, x, nil, actor, reason);
-		if occupant.role == nil then
-			module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
-		elseif is_semi_anonymous and
-			(old_role == "moderator" and occupant.role ~= "moderator") or
-			(old_role ~= "moderator" and occupant.role == "moderator") then -- Has gained or lost moderator status
-			-- Send everyone else's presences (as jid visibility has changed)
-			for real_jid in occupant:each_session() do
-				self:send_occupant_list(real_jid, function(occupant_jid, occupant) --luacheck: ignore 212 433
-					return occupant.bare_jid ~= jid;
-				end);
+
+	if next(occupants_updated) ~= nil then
+		for occupant, old_role in pairs(occupants_updated) do
+			self:publicise_occupant_status(occupant, x, nil, actor, reason);
+			if occupant.role == nil then
+				module:fire_event("muc-occupant-left", {room = self; nick = occupant.nick; occupant = occupant;});
+			elseif is_semi_anonymous and
+				(old_role == "moderator" and occupant.role ~= "moderator") or
+				(old_role ~= "moderator" and occupant.role == "moderator") then -- Has gained or lost moderator status
+				-- Send everyone else's presences (as jid visibility has changed)
+				for real_jid in occupant:each_session() do
+					self:send_occupant_list(real_jid, function(occupant_jid, occupant) --luacheck: ignore 212 433
+						return occupant.bare_jid ~= jid;
+					end);
+				end
 			end
 		end
+	else
+		-- Announce affiliation change for a user that is not currently in the room,
+		-- XEP-0045 (v1.31.2) example 195
+		-- add_item(x, affiliation, role, jid, nick, actor_nick, actor_jid, reason)
+		local announce_msg = st.message({ from = self.jid })
+			:add_child(add_item(st.clone(x), affiliation, nil, jid, nil, nil, nil, reason));
+		local min_role = is_semi_anonymous and "moderator" or "none";
+		self:broadcast(announce_msg, muc_util.only_with_min_role(min_role));
 	end
 
 	self:save(true);
diff --git a/plugins/muc/util.lib.lua b/plugins/muc/util.lib.lua
index 16deb543..d03b4d6b 100644
--- a/plugins/muc/util.lib.lua
+++ b/plugins/muc/util.lib.lua
@@ -55,4 +55,13 @@ function _M.filter_muc_x(stanza)
 	return stanza:maptags(muc_x_filter);
 end
 
+function _M.only_with_min_role(role)
+	local min_role_value = _M.valid_roles[role];
+	return function (nick, occupant)
+		if _M.valid_roles[occupant.role or "none"] >= min_role_value then
+			return true;
+		end
+	end;
+end
+
 return _M;
diff --git a/spec/scansion/muc_affiliation_notify.scs b/spec/scansion/muc_affiliation_notify.scs
new file mode 100644
index 00000000..3a62e0d2
--- /dev/null
+++ b/spec/scansion/muc_affiliation_notify.scs
@@ -0,0 +1,137 @@
+# MUC: Notification of affiliation changes of non-occupants
+
+[Client] Romeo
+	jid: user@localhost
+	password: password
+
+[Client] Juliet
+	jid: user2@localhost
+	password: password
+
+[Client] Rosaline
+	jid: user3@localhost
+	password: password
+
+-----
+
+Romeo connects
+
+Romeo sends:
+	<presence to="room@conference.localhost/Romeo">
+		<x xmlns="http://jabber.org/protocol/muc"/>
+	</presence>
+
+Romeo receives:
+	<presence from='room@conference.localhost/Romeo'>
+		<x xmlns='http://jabber.org/protocol/muc#user'>
+			<status code='201'/>
+			<item jid="${Romeo's full JID}" affiliation='owner' role='moderator'/>
+			<status code='110'/>
+		</x>
+	</presence>
+
+Romeo receives:
+	<message type='groupchat' from='room@conference.localhost'><subject/></message>
+
+# Submit config form
+Romeo sends:
+	<iq id='config1' to='room@conference.localhost' type='set'>
+		<query xmlns='http://jabber.org/protocol/muc#owner'>
+			<x xmlns='jabber:x:data' type='submit'>
+				<field var='FORM_TYPE'>
+					<value>http://jabber.org/protocol/muc#roomconfig</value>
+				</field>
+			</x>
+		</query>
+	</iq>
+
+Romeo receives:
+	<iq id="config1" from="room@conference.localhost" type="result">
+	</iq>
+
+# Promote Juliet to member
+Romeo sends:
+	<iq id='member1' to='room@conference.localhost' type='set'>
+		<query xmlns='http://jabber.org/protocol/muc#admin'>
+			<item affiliation='member' jid="${Juliet's JID}" />
+		</query>
+	</iq>
+
+# Juliet is not in the room, so an affiliation change message is received
+
+Romeo receives:
+	<message from='room@conference.localhost'>
+		<x xmlns='http://jabber.org/protocol/muc#user'>
+			<item jid="${Juliet's JID}" affiliation='member' xmlns='http://jabber.org/protocol/muc#user'/>
+		</x>
+	</message>
+
+# The affiliation change succeeded
+
+Romeo receives:
+	<iq from='room@conference.localhost' id='member1' type='result'/>
+
+# Juliet connects, and joins the room
+Juliet connects
+
+Juliet sends:
+	<presence to="room@conference.localhost/Juliet">
+		<x xmlns="http://jabber.org/protocol/muc"/>
+	</presence>
+
+Juliet receives:
+	<presence from="room@conference.localhost/Romeo" />
+
+Juliet receives:
+	<presence from="room@conference.localhost/Juliet" />
+
+Juliet receives:
+	<message type='groupchat' from='room@conference.localhost'><subject/></message>
+
+Romeo receives:
+	<presence from="room@conference.localhost/Juliet" />
+
+# To check the status of the room is as expected, Romeo requests the member list
+
+Romeo sends:
+	<iq id='member3' to='room@conference.localhost' type='get'>
+		<query xmlns='http://jabber.org/protocol/muc#admin'>
+			<item affiliation='member'/>
+		</query>
+	</iq>
+
+Romeo receives:
+	<iq from='room@conference.localhost' type='result' id='member3'>
+		<query xmlns='http://jabber.org/protocol/muc#admin'>
+			<item affiliation='member' jid="${Juliet's JID}" />
+		</query>
+	</iq>
+
+# Romeo grants membership to Rosaline, who is not in the room
+
+Romeo sends:
+	<iq id='member2' to='room@conference.localhost' type='set'>
+		<query xmlns='http://jabber.org/protocol/muc#admin'>
+			<item affiliation='member' jid="${Rosaline's JID}" />
+		</query>
+	</iq>
+
+Romeo receives:
+	<message from='room@conference.localhost'>
+		<x xmlns='http://jabber.org/protocol/muc#user'>
+			<item jid="${Rosaline's JID}" affiliation='member' xmlns='http://jabber.org/protocol/muc#user'/>
+		</x>
+	</message>
+
+Romeo receives:
+	<iq type='result' id='member2' from='room@conference.localhost' />
+
+Romeo sends:
+	<message type="groupchat" to="room@conference.localhost">
+		<body>Finished!</body>
+	</message>
+
+Juliet receives: 
+	<message type="groupchat" from="room@conference.localhost/Romeo">
+		<body>Finished!</body>
+	</message>
-- 
cgit v1.2.3