2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
9 if module:get_host_type() ~= "component" then
10 error("MUC should be loaded as a component, please see https://prosody.im/doc/components", 0);
13 local muclib = module:require "muc";
14 room_mt = muclib.room_mt; -- Yes, global.
16 local affiliation_notify = module:require "muc/affiliation_notify"; -- luacheck: ignore 211
18 local name = module:require "muc/name";
19 room_mt.get_name = name.get;
20 room_mt.set_name = name.set;
22 local description = module:require "muc/description";
23 room_mt.get_description = description.get;
24 room_mt.set_description = description.set;
26 local hidden = module:require "muc/hidden";
27 room_mt.get_hidden = hidden.get;
28 room_mt.set_hidden = hidden.set;
29 function room_mt:get_public()
30 return not self:get_hidden();
32 function room_mt:set_public(public)
33 return self:set_hidden(not public);
36 local password = module:require "muc/password";
37 room_mt.get_password = password.get;
38 room_mt.set_password = password.set;
40 local members_only = module:require "muc/members_only";
41 room_mt.get_members_only = members_only.get;
42 room_mt.set_members_only = members_only.set;
44 local moderated = module:require "muc/moderated";
45 room_mt.get_moderated = moderated.get;
46 room_mt.set_moderated = moderated.set;
48 local persistent = module:require "muc/persistent";
49 room_mt.get_persistent = persistent.get;
50 room_mt.set_persistent = persistent.set;
52 local subject = module:require "muc/subject";
53 room_mt.get_changesubject = subject.get_changesubject;
54 room_mt.set_changesubject = subject.set_changesubject;
55 room_mt.get_subject = subject.get;
56 room_mt.set_subject = subject.set;
57 room_mt.send_subject = subject.send;
59 local history = module:require "muc/history";
60 room_mt.send_history = history.send;
61 room_mt.get_historylength = history.get_length;
62 room_mt.set_historylength = history.set_length;
64 local iterators = require "util.iterators";
65 local jid_split = require "util.jid".split;
66 local jid_bare = require "util.jid".bare;
67 local st = require "util.stanza";
68 local um_is_admin = require "core.usermanager".is_admin;
70 local rooms = module:shared "rooms";
72 module:depends("disco");
73 module:add_identity("conference", "text", module:get_option_string("name", "Prosody Chatrooms"));
74 module:add_feature("http://jabber.org/protocol/muc");
75 module:depends "muc_unique"
76 module:require "muc/lock";
78 local function is_admin(jid)
79 return um_is_admin(jid, module.host);
82 do -- Monkey patch to make server admins room owners
83 local _get_affiliation = room_mt.get_affiliation;
84 function room_mt:get_affiliation(jid)
85 if is_admin(jid) then return "owner"; end
86 return _get_affiliation(self, jid);
89 local _set_affiliation = room_mt.set_affiliation;
90 function room_mt:set_affiliation(actor, jid, affiliation, reason)
91 if affiliation ~= "owner" and is_admin(jid) then return nil, "modify", "not-acceptable"; end
92 return _set_affiliation(self, actor, jid, affiliation, reason);
96 local persistent_rooms_storage = module:open_store("persistent");
97 local persistent_rooms = module:open_store("persistent", "map");
98 local room_configs = module:open_store("config");
100 local function room_save(room, forced)
101 local node = jid_split(room.jid);
102 local is_persistent = persistent.get(room);
103 persistent_rooms:set(nil, room.jid, is_persistent);
104 if is_persistent then
108 _affiliations = room._affiliations;
110 room_configs:set(node, data);
112 room_configs:set(node, nil);
113 if not next(room._occupants) then -- Room empty
114 rooms[room.jid] = nil;
119 -- Automatically destroy empty non-persistent rooms
120 module:hook("muc-occupant-left",function(event)
121 local room = event.room
122 if not room:has_occupant() and not persistent.get(room) then -- empty, non-persistent room
123 module:fire_event("muc-room-destroyed", { room = room });
127 function track_room(room)
128 rooms[room.jid] = room;
129 -- When room is created, over-ride 'save' method
130 room.save = room_save;
133 local function restore_room(jid)
134 local node = jid_split(jid);
135 local data = room_configs:get(node);
137 local room = muclib.new_room(jid);
138 room._data = data._data;
139 room._affiliations = data._affiliations;
145 function forget_room(room)
146 local room_jid = room.jid;
147 local node = jid_split(room.jid);
148 rooms[room_jid] = nil;
149 room_configs:set(node, nil);
150 if persistent.get(room) then
151 persistent_rooms:set(nil, room_jid, nil);
155 function get_room_from_jid(room_jid)
156 local room = rooms[room_jid];
158 -- Check if in persistent storage
159 if persistent_rooms:get(nil, room_jid) then
160 room = restore_room(room_jid);
162 module:log("error", "Missing data for room '%s', removing from persistent room list", room_jid);
163 persistent_rooms:set(nil, room_jid, nil);
170 function each_room(local_only)
171 if not local_only then
172 for room_jid in pairs(persistent_rooms_storage:get(nil) or {}) do
173 if rooms[room_jid] == nil then -- Don't restore rooms that already exist
174 local room = restore_room(room_jid);
176 module:log("error", "Missing data for room '%s', omitting from iteration", room_jid);
181 return iterators.values(rooms);
184 module:hook("host-disco-items", function(event)
185 local reply = event.reply;
186 module:log("debug", "host-disco-items called");
187 for room in each_room() do
188 if not room:get_hidden() then
189 reply:tag("item", {jid=room.jid, name=room:get_name()}):up();
194 module:hook("muc-room-pre-create", function(event)
195 track_room(event.room);
198 module:hook("muc-room-destroyed",function(event)
199 return forget_room(event.room);
203 local restrict_room_creation = module:get_option("restrict_room_creation");
204 if restrict_room_creation == true then
205 restrict_room_creation = "admin";
207 if restrict_room_creation then
208 local host_suffix = module.host:gsub("^[^%.]+%.", "");
209 module:hook("muc-room-pre-create", function(event)
210 local origin, stanza = event.origin, event.stanza;
211 local user_jid = stanza.attr.from;
212 if not is_admin(user_jid) and not (
213 restrict_room_creation == "local" and
214 select(2, jid_split(user_jid)) == host_suffix
216 origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
223 for event_name, method in pairs {
224 -- Normal room interactions
225 ["iq-get/bare/http://jabber.org/protocol/disco#info:query"] = "handle_disco_info_get_query" ;
226 ["iq-get/bare/http://jabber.org/protocol/disco#items:query"] = "handle_disco_items_get_query" ;
227 ["iq-set/bare/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_set_command" ;
228 ["iq-get/bare/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_get_command" ;
229 ["iq-set/bare/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_set_to_room" ;
230 ["iq-get/bare/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_get_to_room" ;
231 ["message/bare"] = "handle_message_to_room" ;
232 ["presence/bare"] = "handle_presence_to_room" ;
234 ["iq-get/host/http://jabber.org/protocol/disco#info:query"] = "handle_disco_info_get_query" ;
235 ["iq-get/host/http://jabber.org/protocol/disco#items:query"] = "handle_disco_items_get_query" ;
236 ["iq-set/host/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_set_command" ;
237 ["iq-get/host/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_get_command" ;
238 ["iq-set/host/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_set_to_room" ;
239 ["iq-get/host/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_get_to_room" ;
240 ["message/host"] = "handle_message_to_room" ;
241 ["presence/host"] = "handle_presence_to_room" ;
242 -- Direct to occupant (normal rooms and host room)
243 ["presence/full"] = "handle_presence_to_occupant" ;
244 ["iq/full"] = "handle_iq_to_occupant" ;
245 ["message/full"] = "handle_message_to_occupant" ;
247 module:hook(event_name, function (event)
248 local origin, stanza = event.origin, event.stanza;
249 local room_jid = jid_bare(stanza.attr.to);
250 local room = get_room_from_jid(room_jid);
252 -- Watch presence to create rooms
253 if stanza.attr.type == nil and stanza.name == "presence" then
254 room = muclib.new_room(room_jid);
255 elseif stanza.attr.type ~= "error" then
256 origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
262 return room[method](room, origin, stanza);
266 function shutdown_component()
267 local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
268 :tag("status", { code = "332"}):up();
269 for room in each_room(true) do
273 module:hook_global("server-stopping", shutdown_component);
275 do -- Ad-hoc commands
276 module:depends "adhoc";
277 local t_concat = table.concat;
278 local adhoc_new = module:require "adhoc".new;
279 local adhoc_initial = require "util.adhoc".new_initial_data_form;
280 local array = require "util.array";
281 local dataforms_new = require "util.dataforms".new;
283 local destroy_rooms_layout = dataforms_new {
284 title = "Destroy rooms";
285 instructions = "Select the rooms to destroy";
287 { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/muc#destroy" };
288 { name = "rooms", type = "list-multi", required = true, label = "Rooms to destroy:"};
291 local destroy_rooms_handler = adhoc_initial(destroy_rooms_layout, function()
292 return { rooms = array.collect(each_room()):pluck("jid"):sort(); };
293 end, function(fields, errors)
296 for field, err in pairs(errors) do
297 errmsg[#errmsg + 1] = field .. ": " .. err;
299 return { status = "completed", error = { message = t_concat(errmsg, "\n") } };
301 for _, room in ipairs(fields.rooms) do
302 get_room_from_jid(room):destroy();
304 return { status = "completed", info = "The following rooms were destroyed:\n"..t_concat(fields.rooms, "\n") };
306 local destroy_rooms_desc = adhoc_new("Destroy Rooms", "http://prosody.im/protocol/muc#destroy", destroy_rooms_handler, "admin");
308 module:provides("adhoc", destroy_rooms_desc);