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
  10 if module:get_host_type() ~= "component" then
  11         error("MUC should be loaded as a component, please see http://prosody.im/doc/components", 0);
  12 end
  13
  14 local muc_host = module:get_host();
  15 local muc_name = module:get_option("name");
  16 if type(muc_name) ~= "string" then muc_name = "Prosody Chatrooms"; end
  17 local restrict_room_creation = module:get_option("restrict_room_creation");
  18 if restrict_room_creation then
  19         if restrict_room_creation == true then
  20                 restrict_room_creation = "admin";
  21         elseif restrict_room_creation ~= "admin" and restrict_room_creation ~= "local" then
  22                 restrict_room_creation = nil;
  23         end
  24 end
  25 local muclib = module:require "muc";
  26 local muc_new_room = muclib.new_room;
  27 local jid_split = require "util.jid".split;
  28 local jid_bare = require "util.jid".bare;
  29 local st = require "util.stanza";
  30 local uuid_gen = require "util.uuid".generate;
  31 local datamanager = require "util.datamanager";
  32 local um_is_admin = require "core.usermanager".is_admin;
  33 local hosts = hosts;
  34
  35 rooms = {};
  36 local rooms = rooms;
  37 local persistent_rooms = datamanager.load(nil, muc_host, "persistent") or {};
  38
  39 -- Configurable options
  40 muclib.set_max_history_length(module:get_option_number("max_history_messages"));
  41
  42 local function is_admin(jid)
  43         return um_is_admin(jid, module.host);
  44 end
  45
  46 local _set_affiliation = muc_new_room.room_mt.set_affiliation;
  47 local _get_affiliation = muc_new_room.room_mt.get_affiliation;
  48 function muclib.room_mt:get_affiliation(jid)
  49         if is_admin(jid) then return "owner"; end
  50         return _get_affiliation(self, jid);
  51 end
  52 function muclib.room_mt:set_affiliation(actor, jid, affiliation, callback, reason)
  53         if is_admin(jid) then return nil, "modify", "not-acceptable"; end
  54         return _set_affiliation(self, actor, jid, affiliation, callback, reason);
  55 end
  56
  57 local function room_route_stanza(room, stanza) module:send(stanza); end
  58 local function room_save(room, forced)
  59         local node = jid_split(room.jid);
  60         persistent_rooms[room.jid] = room._data.persistent;
  61         if room._data.persistent then
  62                 local history = room._data.history;
  63                 room._data.history = nil;
  64                 local data = {
  65                         jid = room.jid;
  66                         _data = room._data;
  67                         _affiliations = room._affiliations;
  68                 };
  69                 datamanager.store(node, muc_host, "config", data);
  70                 room._data.history = history;
  71         elseif forced then
  72                 datamanager.store(node, muc_host, "config", nil);
  73                 if not next(room._occupants) then -- Room empty
  74                         rooms[room.jid] = nil;
  75                 end
  76         end
  77         if forced then datamanager.store(nil, muc_host, "persistent", persistent_rooms); end
  78 end
  79
  80 function create_room(jid)
  81         local room = muc_new_room(jid);
  82         room.route_stanza = room_route_stanza;
  83         room.save = room_save;
  84         rooms[jid] = room;
  85         return room;
  86 end
  87
  88 local persistent_errors = false;
  89 for jid in pairs(persistent_rooms) do
  90         local node = jid_split(jid);
  91         local data = datamanager.load(node, muc_host, "config");
  92         if data then
  93                 local room = create_room(jid);
  94                 room._data = data._data;
  95                 room._affiliations = data._affiliations;
  96         else -- missing room data
  97                 persistent_rooms[jid] = nil;
  98                 module:log("error", "Missing data for room '%s', removing from persistent room list", jid);
  99                 persistent_errors = true;
 100         end
 101 end
 102 if persistent_errors then datamanager.store(nil, muc_host, "persistent", persistent_rooms); end
 103
 104 local host_room = muc_new_room(muc_host);
 105 host_room.route_stanza = room_route_stanza;
 106 host_room.save = room_save;
 107
 108 local function get_disco_info(stanza)
 109         return st.iq({type='result', id=stanza.attr.id, from=muc_host, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#info")
 110                 :tag("identity", {category='conference', type='text', name=muc_name}):up()
 111                 :tag("feature", {var="http://jabber.org/protocol/muc"}); -- TODO cache disco reply
 112 end
 113 local function get_disco_items(stanza)
 114         local reply = st.iq({type='result', id=stanza.attr.id, from=muc_host, to=stanza.attr.from}):query("http://jabber.org/protocol/disco#items");
 115         for jid, room in pairs(rooms) do
 116                 if not room:is_hidden() then
 117                         reply:tag("item", {jid=jid, name=room:get_name()}):up();
 118                 end
 119         end
 120         return reply; -- TODO cache disco reply
 121 end
 122
 123 local function handle_to_domain(event)
 124         local origin, stanza = event.origin, event.stanza;
 125         local type = stanza.attr.type;
 126         if type == "error" or type == "result" then return; end
 127         if stanza.name == "iq" and type == "get" then
 128                 local xmlns = stanza.tags[1].attr.xmlns;
 129                 local node = stanza.tags[1].attr.node;
 130                 if xmlns == "http://jabber.org/protocol/disco#info" and not node then
 131                         origin.send(get_disco_info(stanza));
 132                 elseif xmlns == "http://jabber.org/protocol/disco#items" and not node then
 133                         origin.send(get_disco_items(stanza));
 134                 elseif xmlns == "http://jabber.org/protocol/muc#unique" then
 135                         origin.send(st.reply(stanza):tag("unique", {xmlns = xmlns}):text(uuid_gen())); -- FIXME Random UUIDs can theoretically have collisions
 136                 else
 137                         origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); -- TODO disco/etc
 138                 end
 139         else
 140                 host_room:handle_stanza(origin, stanza);
 141                 --origin.send(st.error_reply(stanza, "cancel", "service-unavailable", "The muc server doesn't deal with messages and presence directed at it"));
 142         end
 143         return true;
 144 end
 145
 146 function stanza_handler(event)
 147         local origin, stanza = event.origin, event.stanza;
 148         local bare = jid_bare(stanza.attr.to);
 149         local room = rooms[bare];
 150         if not room then
 151                 if stanza.name ~= "presence" then
 152                         origin.send(st.error_reply(stanza, "cancel", "item-not-found"));
 153                         return true;
 154                 end
 155                 if not(restrict_room_creation) or
 156                   (restrict_room_creation == "admin" and is_admin(stanza.attr.from)) or
 157                   (restrict_room_creation == "local" and select(2, jid_split(stanza.attr.from)) == module.host:gsub("^[^%.]+%.", "")) then
 158                         room = create_room(bare);
 159                 end
 160         end
 161         if room then
 162                 room:handle_stanza(origin, stanza);
 163                 if not next(room._occupants) and not persistent_rooms[room.jid] then -- empty, non-persistent room
 164                         rooms[bare] = nil; -- discard room
 165                 end
 166         else
 167                 origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
 168         end
 169         return true;
 170 end
 171 module:hook("iq/bare", stanza_handler, -1);
 172 module:hook("message/bare", stanza_handler, -1);
 173 module:hook("presence/bare", stanza_handler, -1);
 174 module:hook("iq/full", stanza_handler, -1);
 175 module:hook("message/full", stanza_handler, -1);
 176 module:hook("presence/full", stanza_handler, -1);
 177 module:hook("iq/host", handle_to_domain, -1);
 178 module:hook("message/host", handle_to_domain, -1);
 179 module:hook("presence/host", handle_to_domain, -1);
 180
 181 hosts[module.host].send = function(stanza) -- FIXME do a generic fix
 182         if stanza.attr.type == "result" or stanza.attr.type == "error" then
 183                 module:send(stanza);
 184         else error("component.send only supports result and error stanzas at the moment"); end
 185 end
 186
 187 hosts[module:get_host()].muc = { rooms = rooms };
 188
 189 local saved = false;
 190 module.save = function()
 191         saved = true;
 192         return {rooms = rooms};
 193 end
 194 module.restore = function(data)
 195         for jid, oldroom in pairs(data.rooms or {}) do
 196                 local room = create_room(jid);
 197                 room._jid_nick = oldroom._jid_nick;
 198                 room._occupants = oldroom._occupants;
 199                 room._data = oldroom._data;
 200                 room._affiliations = oldroom._affiliations;
 201         end
 202         hosts[module:get_host()].muc = { rooms = rooms };
 203 end
 204
 205 function shutdown_room(room, stanza)
 206         for nick, occupant in pairs(room._occupants) do
 207                 stanza.attr.from = nick;
 208                 for jid in pairs(occupant.sessions) do
 209                         stanza.attr.to = jid;
 210                         room:_route_stanza(stanza);
 211                         room._jid_nick[jid] = nil;
 212                 end
 213                 room._occupants[nick] = nil;
 214         end
 215 end
 216 function shutdown_component()
 217         if not saved then
 218                 local stanza = st.presence({type = "unavailable"})
 219                         :tag("x", {xmlns = "http://jabber.org/protocol/muc#user"})
 220                                 :tag("item", { affiliation='none', role='none' }):up();
 221                 for roomjid, room in pairs(rooms) do
 222                         shutdown_room(room, stanza);
 223                 end
 224                 shutdown_room(host_room, stanza);
 225         end
 226 end
 227 module.unload = shutdown_component;
 228 module:hook_global("server-stopping", shutdown_component);