plugins/muc/mod_muc.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2010 Matthew Wild
   3 -- Copyright (C) 2008-2010 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   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);
  11 end
  12
  13 local muclib = module:require "muc";
  14 room_mt = muclib.room_mt; -- Yes, global.
  15
  16 local affiliation_notify = module:require "muc/affiliation_notify"; -- luacheck: ignore 211
  17
  18 local name = module:require "muc/name";
  19 room_mt.get_name = name.get;
  20 room_mt.set_name = name.set;
  21
  22 local description = module:require "muc/description";
  23 room_mt.get_description = description.get;
  24 room_mt.set_description = description.set;
  25
  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();
  31 end
  32 function room_mt:set_public(public)
  33         return self:set_hidden(not public);
  34 end
  35
  36 local password = module:require "muc/password";
  37 room_mt.get_password = password.get;
  38 room_mt.set_password = password.set;
  39
  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;
  43
  44 local moderated = module:require "muc/moderated";
  45 room_mt.get_moderated = moderated.get;
  46 room_mt.set_moderated = moderated.set;
  47
  48 local persistent = module:require "muc/persistent";
  49 room_mt.get_persistent = persistent.get;
  50 room_mt.set_persistent = persistent.set;
  51
  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;
  58
  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;
  63
  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;
  69
  70 local rooms = module:shared "rooms";
  71
  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";
  77
  78 local function is_admin(jid)
  79         return um_is_admin(jid, module.host);
  80 end
  81
  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);
  87         end
  88
  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);
  93         end
  94 end
  95
  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");
  99
 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
 105                 local data = room:freeze();
 106                 room_configs:set(node, data);
 107         elseif forced then
 108                 room_configs:set(node, nil);
 109                 if not next(room._occupants) then -- Room empty
 110                         rooms[room.jid] = nil;
 111                 end
 112         end
 113 end
 114
 115 -- Automatically destroy empty non-persistent rooms
 116 module:hook("muc-occupant-left",function(event)
 117         local room = event.room
 118         if not room:has_occupant() and not persistent.get(room) then -- empty, non-persistent room
 119                 module:fire_event("muc-room-destroyed", { room = room });
 120         end
 121 end);
 122
 123 function track_room(room)
 124         rooms[room.jid] = room;
 125         -- When room is created, over-ride 'save' method
 126         room.save = room_save;
 127 end
 128
 129 local function restore_room(jid)
 130         local node = jid_split(jid);
 131         local data = room_configs:get(node);
 132         if data then
 133                 local room = muclib.restore_room(data);
 134                 track_room(room);
 135                 return room;
 136         end
 137 end
 138
 139 function forget_room(room)
 140         local room_jid = room.jid;
 141         local node = jid_split(room.jid);
 142         rooms[room_jid] = nil;
 143         room_configs:set(node, nil);
 144         if persistent.get(room) then
 145                 persistent_rooms:set(nil, room_jid, nil);
 146         end
 147 end
 148
 149 function get_room_from_jid(room_jid)
 150         local room = rooms[room_jid];
 151         if room == nil then
 152                 -- Check if in persistent storage
 153                 if persistent_rooms:get(nil, room_jid) then
 154                         room = restore_room(room_jid);
 155                         if room == nil then
 156                                 module:log("error", "Missing data for room '%s', removing from persistent room list", room_jid);
 157                                 persistent_rooms:set(nil, room_jid, nil);
 158                         end
 159                 end
 160         end
 161         return room
 162 end
 163
 164 function each_room(local_only)
 165         if not local_only then
 166                 for room_jid in pairs(persistent_rooms_storage:get(nil) or {}) do
 167                         if rooms[room_jid] == nil then -- Don't restore rooms that already exist
 168                                 local room = restore_room(room_jid);
 169                                 if room == nil then
 170                                         module:log("error", "Missing data for room '%s', omitting from iteration", room_jid);
 171                                 end
 172                         end
 173                 end
 174         end
 175         return iterators.values(rooms);
 176 end
 177
 178 module:hook("host-disco-items", function(event)
 179         local reply = event.reply;
 180         module:log("debug", "host-disco-items called");
 181         for room in each_room() do
 182                 if not room:get_hidden() then
 183                         reply:tag("item", {jid=room.jid, name=room:get_name()}):up();
 184                 end
 185         end
 186 end);
 187
 188 module:hook("muc-room-pre-create", function(event)
 189         track_room(event.room);
 190 end, -1000);
 191
 192 module:hook("muc-room-destroyed",function(event)
 193         return forget_room(event.room);
 194 end)
 195
 196 do
 197         local restrict_room_creation = module:get_option("restrict_room_creation");
 198         if restrict_room_creation == true then
 199                 restrict_room_creation = "admin";
 200         end
 201         if restrict_room_creation then
 202                 local host_suffix = module.host:gsub("^[^%.]+%.", "");
 203                 module:hook("muc-room-pre-create", function(event)
 204                         local origin, stanza = event.origin, event.stanza;
 205                         local user_jid = stanza.attr.from;
 206                         if not is_admin(user_jid) and not (
 207                                 restrict_room_creation == "local" and
 208                                 select(2, jid_split(user_jid)) == host_suffix
 209                         ) then
 210                                 origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
 211                                 return true;
 212                         end
 213                 end);
 214         end
 215 end
 216
 217 for event_name, method in pairs {
 218         -- Normal room interactions
 219         ["iq-get/bare/http://jabber.org/protocol/disco#info:query"] = "handle_disco_info_get_query" ;
 220         ["iq-get/bare/http://jabber.org/protocol/disco#items:query"] = "handle_disco_items_get_query" ;
 221         ["iq-set/bare/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_set_command" ;
 222         ["iq-get/bare/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_get_command" ;
 223         ["iq-set/bare/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_set_to_room" ;
 224         ["iq-get/bare/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_get_to_room" ;
 225         ["message/bare"] = "handle_message_to_room" ;
 226         ["presence/bare"] = "handle_presence_to_room" ;
 227         -- Host room
 228         ["iq-get/host/http://jabber.org/protocol/disco#info:query"] = "handle_disco_info_get_query" ;
 229         ["iq-get/host/http://jabber.org/protocol/disco#items:query"] = "handle_disco_items_get_query" ;
 230         ["iq-set/host/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_set_command" ;
 231         ["iq-get/host/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_get_command" ;
 232         ["iq-set/host/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_set_to_room" ;
 233         ["iq-get/host/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_get_to_room" ;
 234         ["message/host"] = "handle_message_to_room" ;
 235         ["presence/host"] = "handle_presence_to_room" ;
 236         -- Direct to occupant (normal rooms and host room)
 237         ["presence/full"] = "handle_presence_to_occupant" ;
 238         ["iq/full"] = "handle_iq_to_occupant" ;
 239         ["message/full"] = "handle_message_to_occupant" ;
 240 } do
 241         module:hook(event_name, function (event)
 242                 local origin, stanza = event.origin, event.stanza;
 243                 local room_jid = jid_bare(stanza.attr.to);
 244                 local room = get_room_from_jid(room_jid);
 245                 if room == nil then
 246                         -- Watch presence to create rooms
 247                         if stanza.attr.type == nil and stanza.name == "presence" then
 248                                 room = muclib.new_room(room_jid);
 249                         elseif stanza.attr.type ~= "error" then
 250                                 origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
 251                                 return true;
 252                         else
 253                                 return;
 254                         end
 255                 end
 256                 return room[method](room, origin, stanza);
 257         end, -2)
 258 end
 259
 260 function shutdown_component()
 261         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
 262                 :tag("status", { code = "332"}):up();
 263         for room in each_room(true) do
 264                 room:clear(x);
 265         end
 266 end
 267 module:hook_global("server-stopping", shutdown_component);
 268
 269 do -- Ad-hoc commands
 270         module:depends "adhoc";
 271         local t_concat = table.concat;
 272         local adhoc_new = module:require "adhoc".new;
 273         local adhoc_initial = require "util.adhoc".new_initial_data_form;
 274         local array = require "util.array";
 275         local dataforms_new = require "util.dataforms".new;
 276
 277         local destroy_rooms_layout = dataforms_new {
 278                 title = "Destroy rooms";
 279                 instructions = "Select the rooms to destroy";
 280
 281                 { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/muc#destroy" };
 282                 { name = "rooms", type = "list-multi", required = true, label = "Rooms to destroy:"};
 283         };
 284
 285         local destroy_rooms_handler = adhoc_initial(destroy_rooms_layout, function()
 286                 return { rooms = array.collect(each_room()):pluck("jid"):sort(); };
 287         end, function(fields, errors)
 288                 if errors then
 289                         local errmsg = {};
 290                         for field, err in pairs(errors) do
 291                                 errmsg[#errmsg + 1] = field .. ": " .. err;
 292                         end
 293                         return { status = "completed", error = { message = t_concat(errmsg, "\n") } };
 294                 end
 295                 for _, room in ipairs(fields.rooms) do
 296                         get_room_from_jid(room):destroy();
 297                 end
 298                 return { status = "completed", info = "The following rooms were destroyed:\n"..t_concat(fields.rooms, "\n") };
 299         end);
 300         local destroy_rooms_desc = adhoc_new("Destroy Rooms", "http://prosody.im/protocol/muc#destroy", destroy_rooms_handler, "admin");
 301
 302         module:provides("adhoc", destroy_rooms_desc);
 303 end