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