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.new_room(jid);
 134                 room._data = data._data;
 135                 room._affiliations = data._affiliations;
 136                 track_room(room);
 137                 return room;
 138         end
 139 end
 140
 141 function forget_room(room)
 142         local room_jid = room.jid;
 143         local node = jid_split(room.jid);
 144         rooms[room_jid] = nil;
 145         room_configs:set(node, nil);
 146         if persistent.get(room) then
 147                 persistent_rooms:set(nil, room_jid, nil);
 148         end
 149 end
 150
 151 function get_room_from_jid(room_jid)
 152         local room = rooms[room_jid];
 153         if room == nil then
 154                 -- Check if in persistent storage
 155                 if persistent_rooms:get(nil, room_jid) then
 156                         room = restore_room(room_jid);
 157                         if room == nil then
 158                                 module:log("error", "Missing data for room '%s', removing from persistent room list", room_jid);
 159                                 persistent_rooms:set(nil, room_jid, nil);
 160                         end
 161                 end
 162         end
 163         return room
 164 end
 165
 166 function each_room(local_only)
 167         if not local_only then
 168                 for room_jid in pairs(persistent_rooms_storage:get(nil) or {}) do
 169                         if rooms[room_jid] == nil then -- Don't restore rooms that already exist
 170                                 local room = restore_room(room_jid);
 171                                 if room == nil then
 172                                         module:log("error", "Missing data for room '%s', omitting from iteration", room_jid);
 173                                 end
 174                         end
 175                 end
 176         end
 177         return iterators.values(rooms);
 178 end
 179
 180 module:hook("host-disco-items", function(event)
 181         local reply = event.reply;
 182         module:log("debug", "host-disco-items called");
 183         for room in each_room() do
 184                 if not room:get_hidden() then
 185                         reply:tag("item", {jid=room.jid, name=room:get_name()}):up();
 186                 end
 187         end
 188 end);
 189
 190 module:hook("muc-room-pre-create", function(event)
 191         track_room(event.room);
 192 end, -1000);
 193
 194 module:hook("muc-room-destroyed",function(event)
 195         return forget_room(event.room);
 196 end)
 197
 198 do
 199         local restrict_room_creation = module:get_option("restrict_room_creation");
 200         if restrict_room_creation == true then
 201                 restrict_room_creation = "admin";
 202         end
 203         if restrict_room_creation then
 204                 local host_suffix = module.host:gsub("^[^%.]+%.", "");
 205                 module:hook("muc-room-pre-create", function(event)
 206                         local origin, stanza = event.origin, event.stanza;
 207                         local user_jid = stanza.attr.from;
 208                         if not is_admin(user_jid) and not (
 209                                 restrict_room_creation == "local" and
 210                                 select(2, jid_split(user_jid)) == host_suffix
 211                         ) then
 212                                 origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
 213                                 return true;
 214                         end
 215                 end);
 216         end
 217 end
 218
 219 for event_name, method in pairs {
 220         -- Normal room interactions
 221         ["iq-get/bare/http://jabber.org/protocol/disco#info:query"] = "handle_disco_info_get_query" ;
 222         ["iq-get/bare/http://jabber.org/protocol/disco#items:query"] = "handle_disco_items_get_query" ;
 223         ["iq-set/bare/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_set_command" ;
 224         ["iq-get/bare/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_get_command" ;
 225         ["iq-set/bare/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_set_to_room" ;
 226         ["iq-get/bare/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_get_to_room" ;
 227         ["message/bare"] = "handle_message_to_room" ;
 228         ["presence/bare"] = "handle_presence_to_room" ;
 229         -- Host room
 230         ["iq-get/host/http://jabber.org/protocol/disco#info:query"] = "handle_disco_info_get_query" ;
 231         ["iq-get/host/http://jabber.org/protocol/disco#items:query"] = "handle_disco_items_get_query" ;
 232         ["iq-set/host/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_set_command" ;
 233         ["iq-get/host/http://jabber.org/protocol/muc#admin:query"] = "handle_admin_query_get_command" ;
 234         ["iq-set/host/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_set_to_room" ;
 235         ["iq-get/host/http://jabber.org/protocol/muc#owner:query"] = "handle_owner_query_get_to_room" ;
 236         ["message/host"] = "handle_message_to_room" ;
 237         ["presence/host"] = "handle_presence_to_room" ;
 238         -- Direct to occupant (normal rooms and host room)
 239         ["presence/full"] = "handle_presence_to_occupant" ;
 240         ["iq/full"] = "handle_iq_to_occupant" ;
 241         ["message/full"] = "handle_message_to_occupant" ;
 242 } do
 243         module:hook(event_name, function (event)
 244                 local origin, stanza = event.origin, event.stanza;
 245                 local room_jid = jid_bare(stanza.attr.to);
 246                 local room = get_room_from_jid(room_jid);
 247                 if room == nil then
 248                         -- Watch presence to create rooms
 249                         if stanza.attr.type == nil and stanza.name == "presence" then
 250                                 room = muclib.new_room(room_jid);
 251                         elseif stanza.attr.type ~= "error" then
 252                                 origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
 253                                 return true;
 254                         else
 255                                 return;
 256                         end
 257                 end
 258                 return room[method](room, origin, stanza);
 259         end, -2)
 260 end
 261
 262 function shutdown_component()
 263         local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
 264                 :tag("status", { code = "332"}):up();
 265         for room in each_room(true) do
 266                 room:clear(x);
 267         end
 268 end
 269 module:hook_global("server-stopping", shutdown_component);
 270
 271 do -- Ad-hoc commands
 272         module:depends "adhoc";
 273         local t_concat = table.concat;
 274         local adhoc_new = module:require "adhoc".new;
 275         local adhoc_initial = require "util.adhoc".new_initial_data_form;
 276         local array = require "util.array";
 277         local dataforms_new = require "util.dataforms".new;
 278
 279         local destroy_rooms_layout = dataforms_new {
 280                 title = "Destroy rooms";
 281                 instructions = "Select the rooms to destroy";
 282
 283                 { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/muc#destroy" };
 284                 { name = "rooms", type = "list-multi", required = true, label = "Rooms to destroy:"};
 285         };
 286
 287         local destroy_rooms_handler = adhoc_initial(destroy_rooms_layout, function()
 288                 return { rooms = array.collect(each_room()):pluck("jid"):sort(); };
 289         end, function(fields, errors)
 290                 if errors then
 291                         local errmsg = {};
 292                         for field, err in pairs(errors) do
 293                                 errmsg[#errmsg + 1] = field .. ": " .. err;
 294                         end
 295                         return { status = "completed", error = { message = t_concat(errmsg, "\n") } };
 296                 end
 297                 for _, room in ipairs(fields.rooms) do
 298                         get_room_from_jid(room):destroy();
 299                 end
 300                 return { status = "completed", info = "The following rooms were destroyed:\n"..t_concat(fields.rooms, "\n") };
 301         end);
 302         local destroy_rooms_desc = adhoc_new("Destroy Rooms", "http://prosody.im/protocol/muc#destroy", destroy_rooms_handler, "admin");
 303
 304         module:provides("adhoc", destroy_rooms_desc);
 305 end