MUC: Support MUC voice requests and approvals in moderated rooms (closes #655) (thanks to Lance Stout)

2 files changed, 119 insertions, 0 deletions

diff --git a/plugins/muc/moderated.lib.lua b/plugins/muc/moderated.lib.lua
index 8354c585..9b435bef 100644
--- a/plugins/muc/moderated.lib.lua
+++ b/plugins/muc/moderated.lib.lua
@@ -7,6 +7,10 @@
 -- COPYING file in the source package for more information.
 --
 
+local st = require "util.stanza";
+local dataform = require "util.dataforms";
+
+
 local function get_moderated(room)
 	return room._data.moderated;
 end
@@ -45,6 +49,71 @@ module:hook("muc-get-default-role", function(event)
 	end
 end, 1);
 
+module:hook("muc-voice-request", function(event)
+	if event.occupant.role == "visitor" then
+		local form = dataform.new({
+			title = "Voice Request";
+			{
+				name = "FORM_TYPE";
+				type = "hidden";
+				value = "http://jabber.org/protocol/muc#request";
+			},
+			{
+				name = "muc#role";
+				type = "text-single";
+				label = "Requested Role";
+				value = "participant";
+			},
+			{
+				name = "muc#jid";
+				type = "jid-single";
+				label = "User ID";
+				value = event.stanza.attr.from;
+			},
+			{
+				name = "muc#roomnick";
+				type = "text-single";
+				label = "Room Nickname";
+				value = event.occupant.nick;
+			},
+			{
+				name = "muc#request_allow";
+				type = "boolean";
+				label = "Grant voice to this person?";
+				value = false;
+			}
+		});
+
+		local message = st.message({ type = "normal"; from = event.room.jid }):add_child(form:form()):up();
+
+		event.room:broadcast(message, function (nick, occupant)
+			return occupant.role == "moderator";
+		end);
+	end
+end);
+
+module:hook("muc-voice-response", function(event)
+	local actor = event.stanza.attr.from;
+	local affected_occupant = event.room:get_occupant_by_real_jid(event.fields["muc#jid"]);
+
+	if event.occupant.role ~= "moderator" then
+		return;
+	end
+
+	if not event.fields["muc#request_allow"] then
+		return;
+	end
+
+	if not affected_occupant then
+		return;
+	end
+
+	if affected_occupant.role == "visitor" then
+		event.room:set_role(actor, affected_occupant.nick, "participant", "Voice granted");
+	end
+end);
+
+
 return {
 	get = get_moderated;
 	set = set_moderated;
diff --git a/plugins/muc/muc.lib.lua b/plugins/muc/muc.lib.lua
index 7c3d3af9..83cd9fb5 100644
--- a/plugins/muc/muc.lib.lua
+++ b/plugins/muc/muc.lib.lua
@@ -778,6 +778,34 @@ function room_mt:get_form_layout(actor)
 	return module:fire_event("muc-config-form", { room = self, actor = actor, form = form }) or form;
 end
 
+function room_mt:get_voice_form_layout()
+	local form = dataform.new({
+		{
+			name = "FORM_TYPE";
+			type = "hidden";
+			value = "http://jabber.org/protocol/muc#request";
+		},
+		{
+			name = "muc#jid";
+			type = "jid-single";
+		},
+		{
+			name = "muc#roomnick";
+			type = "text-single";
+		},
+		{
+			name = "muc#role";
+			type = "text-single";
+		},
+		{
+			name = "muc#request_allow";
+			type = "boolean";
+		}
+	});
+
+	return form;
+end
+
 function room_mt:process_form(origin, stanza)
 	local form = stanza.tags[1]:get_child("x", "jabber:x:data");
 	if form.attr.type == "cancel" then
@@ -1143,6 +1171,28 @@ function room_mt:handle_message_to_room(origin, stanza)
 			origin.send(st.error_reply(stanza, "cancel", "bad-request"));
 			return true;
 		end
+
+		local form = stanza:get_child("x", "jabber:x:data");
+		if form and form.attr.type == "submit" then
+			local fields, errors, present = self:get_voice_form_layout():data(form);
+
+			if fields.FORM_TYPE == "http://jabber.org/protocol/muc#request" then
+				local occupant = self:get_occupant_by_real_jid(stanza.attr.from);
+				local event = {
+					room = self;
+					origin = origin;
+					stanza = stanza;
+					fields = fields;
+					occupant = occupant;
+				};
+				if occupant.role == "moderator" then
+					module:fire_event("muc-voice-response", event);
+				else
+					module:fire_event("muc-voice-request", event);
+				end
+				return true;
+			end
+		end
 	end
 end