Merge 0.10->trunk
[prosody.git] / plugins / muc / mod_muc.lua
index 8b40d6adc1a7d3896604b32393391aa34ba8423a..5428d2707e09097faa9f19115f4f50eaab6e1021 100644 (file)
@@ -6,68 +6,54 @@
 -- COPYING file in the source package for more information.
 --
 
-local array = require "util.array";
-
 if module:get_host_type() ~= "component" then
        error("MUC should be loaded as a component, please see http://prosody.im/doc/components", 0);
 end
 
-local muc_host = module:get_host();
-local muc_name = module:get_option("name");
-if type(muc_name) ~= "string" then muc_name = "Prosody Chatrooms"; end
-local restrict_room_creation = module:get_option("restrict_room_creation");
-if restrict_room_creation then
-       if restrict_room_creation == true then
-               restrict_room_creation = "admin";
-       elseif restrict_room_creation ~= "admin" and restrict_room_creation ~= "local" then
-               restrict_room_creation = nil;
-       end
-end
-local lock_rooms = module:get_option_boolean("muc_room_locking", false);
-local lock_room_timeout = module:get_option_number("muc_room_lock_timeout", 300);
-
 local muclib = module:require "muc";
-local muc_new_room = muclib.new_room;
+room_mt = muclib.room_mt; -- Yes, global.
+local iterators = require "util.iterators";
 local jid_split = require "util.jid".split;
 local jid_bare = require "util.jid".bare;
 local st = require "util.stanza";
 local um_is_admin = require "core.usermanager".is_admin;
-local hosts = prosody.hosts;
-
-rooms = {};
-local rooms = rooms;
-local persistent_rooms_storage = module:open_store("persistent");
-local persistent_rooms = persistent_rooms_storage:get() or {};
-local room_configs = module:open_store("config");
 
--- Configurable options
-muclib.set_max_history_length(module:get_option_number("max_history_messages"));
+local rooms = module:shared "rooms";
 
 module:depends("disco");
-module:add_identity("conference", "text", muc_name);
+module:add_identity("conference", "text", module:get_option_string("name", "Prosody Chatrooms"));
 module:add_feature("http://jabber.org/protocol/muc");
 module:depends "muc_unique"
+module:require "muc/lock";
 
 local function is_admin(jid)
        return um_is_admin(jid, module.host);
 end
 
-room_mt = muclib.room_mt; -- Yes, global.
-local _set_affiliation = room_mt.set_affiliation;
-local _get_affiliation = room_mt.get_affiliation;
-function muclib.room_mt:get_affiliation(jid)
-       if is_admin(jid) then return "owner"; end
-       return _get_affiliation(self, jid);
-end
-function muclib.room_mt:set_affiliation(actor, jid, affiliation, callback, reason)
-       if is_admin(jid) then return nil, "modify", "not-acceptable"; end
-       return _set_affiliation(self, actor, jid, affiliation, callback, reason);
+do -- Monkey patch to make server admins room owners
+       local _get_affiliation = room_mt.get_affiliation;
+       function room_mt:get_affiliation(jid)
+               if is_admin(jid) then return "owner"; end
+               return _get_affiliation(self, jid);
+       end
+
+       local _set_affiliation = room_mt.set_affiliation;
+       function room_mt:set_affiliation(actor, jid, ...)
+               if is_admin(jid) then return nil, "modify", "not-acceptable"; end
+               return _set_affiliation(self, actor, jid, ...);
+       end
 end
 
+local persistent = module:require "muc/persistent";
+local persistent_rooms_storage = module:open_store("persistent");
+local persistent_rooms = module:open_store("persistent", "map");
+local room_configs = module:open_store("config");
+
 local function room_save(room, forced)
        local node = jid_split(room.jid);
-       persistent_rooms[room.jid] = room._data.persistent;
-       if room._data.persistent then
+       local is_persistent = persistent.get(room);
+       persistent_rooms:set(nil, room.jid, is_persistent);
+       if is_persistent then
                local history = room._data.history;
                room._data.history = nil;
                local data = {
@@ -83,101 +69,109 @@ local function room_save(room, forced)
                        rooms[room.jid] = nil;
                end
        end
-       if forced then persistent_rooms_storage:set(nil, persistent_rooms); end
 end
 
-function create_room(jid)
-       local room = muc_new_room(jid);
+-- Automatically destroy empty non-persistent rooms
+module:hook("muc-occupant-left",function(event)
+       local room = event.room
+       if not room:has_occupant() and not persistent.get(room) then -- empty, non-persistent room
+               module:fire_event("muc-room-destroyed", { room = room });
+       end
+end);
+
+function track_room(room)
+       rooms[room.jid] = room;
+       -- When room is created, over-ride 'save' method
        room.save = room_save;
-       rooms[jid] = room;
-       module:fire_event("muc-room-created", { room = room });
-       return room;
 end
 
-if lock_rooms then
-       module:hook("muc-room-created", function(event)
-               local room = event.room;
-               room:lock();
-               if lock_room_timeout and lock_room_timeout > 0 then
-                       module:add_timer(lock_room_timeout, function ()
-                               if room:is_locked() then
-                                       room:destroy(); -- Not unlocked in time
-                               end
-                       end);
-               end
-       end);
+local function restore_room(jid)
+       local node = jid_split(jid);
+       local data = room_configs:get(node);
+       if data then
+               local room = muclib.new_room(jid);
+               room._data = data._data;
+               room._affiliations = data._affiliations;
+               track_room(room);
+               return room;
+       end
 end
 
-function forget_room(jid)
-       rooms[jid] = nil;
+function forget_room(room)
+       local room_jid = room.jid;
+       local node = jid_split(room.jid);
+       rooms[room_jid] = nil;
+       room_configs:set(node, nil);
+       if persistent.get(room) then
+               persistent_rooms:set(nil, room_jid, nil);
+       end
 end
 
 function get_room_from_jid(room_jid)
-       return rooms[room_jid]
+       local room = rooms[room_jid];
+       if room == nil then
+               -- Check if in persistent storage
+               if persistent_rooms:get(nil, room_jid) then
+                       room = restore_room(room_jid);
+                       if room == nil then
+                               module:log("error", "Missing data for room '%s', removing from persistent room list", room_jid);
+                               persistent_rooms:set(nil, room_jid, nil);
+                       end
+               end
+       end
+       return room
 end
 
-local persistent_errors = false;
-for jid in pairs(persistent_rooms) do
-       local node = jid_split(jid);
-       local data = room_configs:get(node);
-       if data then
-               local room = create_room(jid);
-               room._data = data._data;
-               room._affiliations = data._affiliations;
-       else -- missing room data
-               persistent_rooms[jid] = nil;
-               module:log("error", "Missing data for room '%s', removing from persistent room list", jid);
-               persistent_errors = true;
+function each_room()
+       for room_jid in pairs(persistent_rooms_storage:get(nil) or {}) do
+               if rooms[room_jid] == nil then -- Don't restore rooms that already exist
+                       local room = restore_room(room_jid);
+                       if room == nil then
+                               module:log("error", "Missing data for room '%s', omitting from iteration", room_jid);
+                       end
+               end
        end
+       return iterators.values(rooms);
 end
-if persistent_errors then persistent_rooms_storage:set(nil, persistent_rooms); end
-
-local host_room = muc_new_room(muc_host);
-host_room.save = room_save;
-rooms[muc_host] = host_room;
 
 module:hook("host-disco-items", function(event)
        local reply = event.reply;
        module:log("debug", "host-disco-items called");
-       for jid, room in pairs(rooms) do
+       for room in each_room() do
                if not room:get_hidden() then
-                       reply:tag("item", {jid=jid, name=room:get_name()}):up();
+                       reply:tag("item", {jid=room.jid, name=room:get_name()}):up();
                end
        end
 end);
 
+module:hook("muc-room-pre-create", function(event)
+       track_room(event.room);
+end, -1000);
+
 module:hook("muc-room-destroyed",function(event)
-       local room = event.room
-       forget_room(room.jid)
+       return forget_room(event.room);
 end)
 
-module:hook("muc-occupant-left",function(event)
-       local room = event.room
-       if not next(room._occupants) and not persistent_rooms[room.jid] then -- empty, non-persistent room
-               module:fire_event("muc-room-destroyed", { room = room });
+do
+       local restrict_room_creation = module:get_option("restrict_room_creation");
+       if restrict_room_creation == true then
+               restrict_room_creation = "admin";
        end
-end);
-
--- Watch presence to create rooms
-local function attempt_room_creation(event)
-       local origin, stanza = event.origin, event.stanza;
-       local room_jid = jid_bare(stanza.attr.to);
-       if stanza.attr.type == nil and
-               get_room_from_jid(room_jid) == nil and
-               (
-                       not(restrict_room_creation) or
-                       is_admin(stanza.attr.from) or
-                       (
+       if restrict_room_creation then
+               local host_suffix = module.host:gsub("^[^%.]+%.", "");
+               module:hook("muc-room-pre-create", function(event)
+                       local origin, stanza = event.origin, event.stanza;
+                       local user_jid = stanza.attr.from;
+                       if not is_admin(user_jid) and not (
                                restrict_room_creation == "local" and
-                               select(2, jid_split(stanza.attr.from)) == module.host:gsub("^[^%.]+%.", "")
-                       )
-               ) then
-               create_room(room_jid);
+                               select(2, jid_split(user_jid)) == host_suffix
+                       ) then
+                               origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
+                               return true;
+                       end
+               end);
        end
 end
-module:hook("presence/full", attempt_room_creation, -1)
-module:hook("presence/bare", attempt_room_creation, -1)
-module:hook("presence/host", attempt_room_creation, -1)
 
 for event_name, method in pairs {
        -- Normal room interactions
@@ -205,78 +199,62 @@ for event_name, method in pairs {
 } do
        module:hook(event_name, function (event)
                local origin, stanza = event.origin, event.stanza;
-               local room = get_room_from_jid(jid_bare(stanza.attr.to))
+               local room_jid = jid_bare(stanza.attr.to);
+               local room = get_room_from_jid(room_jid);
                if room == nil then
-                       origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
-                       return true;
+                       -- Watch presence to create rooms
+                       if stanza.attr.type == nil and stanza.name == "presence" then
+                               room = muclib.new_room(room_jid);
+                       else
+                               origin.send(st.error_reply(stanza, "cancel", "not-allowed"));
+                               return true;
+                       end
                end
                return room[method](room, origin, stanza);
        end, -2)
 end
 
-hosts[module:get_host()].muc = { rooms = rooms };
-
-local saved = false;
-module.save = function()
-       saved = true;
-       return {rooms = rooms};
-end
-module.restore = function(data)
-       for jid, oldroom in pairs(data.rooms or {}) do
-               local room = create_room(jid);
-               room._jid_nick = oldroom._jid_nick;
-               room._occupants = oldroom._occupants;
-               room._data = oldroom._data;
-               room._affiliations = oldroom._affiliations;
-       end
-       hosts[module:get_host()].muc = { rooms = rooms };
-end
-
 function shutdown_component()
-       if not saved then
-               local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
-                               :tag("status", { code = "332"}):up();
-               for roomjid, room in pairs(rooms) do
-                       room:clear(x);
-               end
-               host_room:clear(x);
+       local x = st.stanza("x", {xmlns = "http://jabber.org/protocol/muc#user"})
+               :tag("status", { code = "332"}):up();
+       for room in each_room() do
+               room:clear(x);
        end
 end
-module.unload = shutdown_component;
 module:hook_global("server-stopping", shutdown_component);
 
--- Ad-hoc commands
-module:depends("adhoc")
-local t_concat = table.concat;
-local keys = require "util.iterators".keys;
-local adhoc_new = module:require "adhoc".new;
-local adhoc_initial = require "util.adhoc".new_initial_data_form;
-local dataforms_new = require "util.dataforms".new;
+do -- Ad-hoc commands
+       module:depends "adhoc";
+       local t_concat = table.concat;
+       local adhoc_new = module:require "adhoc".new;
+       local adhoc_initial = require "util.adhoc".new_initial_data_form;
+       local array = require "util.array";
+       local dataforms_new = require "util.dataforms".new;
 
-local destroy_rooms_layout = dataforms_new {
-       title = "Destroy rooms";
-       instructions = "Select the rooms to destroy";
+       local destroy_rooms_layout = dataforms_new {
+               title = "Destroy rooms";
+               instructions = "Select the rooms to destroy";
 
-       { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/muc#destroy" };
-       { name = "rooms", type = "list-multi", required = true, label = "Rooms to destroy:"};
-};
+               { name = "FORM_TYPE", type = "hidden", value = "http://prosody.im/protocol/muc#destroy" };
+               { name = "rooms", type = "list-multi", required = true, label = "Rooms to destroy:"};
+       };
 
-local destroy_rooms_handler = adhoc_initial(destroy_rooms_layout, function()
-       return { rooms = array.collect(keys(rooms)):sort() };
-end, function(fields, errors)
-       if errors then
-               local errmsg = {};
-               for name, err in pairs(errors) do
-                       errmsg[#errmsg + 1] = name .. ": " .. err;
+       local destroy_rooms_handler = adhoc_initial(destroy_rooms_layout, function()
+               return { rooms = array.collect(each_room()):pluck("jid"):sort(); };
+       end, function(fields, errors)
+               if errors then
+                       local errmsg = {};
+                       for name, err in pairs(errors) do
+                               errmsg[#errmsg + 1] = name .. ": " .. err;
+                       end
+                       return { status = "completed", error = { message = t_concat(errmsg, "\n") } };
                end
-               return { status = "completed", error = { message = t_concat(errmsg, "\n") } };
-       end
-       for _, room in ipairs(fields.rooms) do
-               rooms[room]:destroy();
-               rooms[room] = nil;
-       end
-       return { status = "completed", info = "The following rooms were destroyed:\n"..t_concat(fields.rooms, "\n") };
-end);
-local destroy_rooms_desc = adhoc_new("Destroy Rooms", "http://prosody.im/protocol/muc#destroy", destroy_rooms_handler, "admin");
+               for _, room in ipairs(fields.rooms) do
+                       get_room_from_jid(room):destroy();
+               end
+               return { status = "completed", info = "The following rooms were destroyed:\n"..t_concat(fields.rooms, "\n") };
+       end);
+       local destroy_rooms_desc = adhoc_new("Destroy Rooms", "http://prosody.im/protocol/muc#destroy", destroy_rooms_handler, "admin");
 
-module:provides("adhoc", destroy_rooms_desc);
+       module:provides("adhoc", destroy_rooms_desc);
+end