Merge 0.9->0.10
authorMatthew Wild <mwild1@gmail.com>
Wed, 16 Dec 2015 16:45:57 +0000 (16:45 +0000)
committerMatthew Wild <mwild1@gmail.com>
Wed, 16 Dec 2015 16:45:57 +0000 (16:45 +0000)
1  2 
plugins/muc/muc.lib.lua

diff --combined plugins/muc/muc.lib.lua
index 6f21ec3a14013afa92cecd899c60bc9ecc51f47d,5879c256c36f1f04bf9090a037a0e5dbae0205fe..b96288edab0f2fa4359ccd8eb3537ade22ca2372
@@@ -1,7 -1,7 +1,7 @@@
  -- Prosody IM
  -- Copyright (C) 2008-2010 Matthew Wild
  -- Copyright (C) 2008-2010 Waqas Hussain
 --- 
 +--
  -- This project is MIT/X11 licensed. Please see the
  -- COPYING file in the source package for more information.
  --
@@@ -27,16 -27,28 +27,16 @@@ local muc_domain = nil; --module:get_ho
  local default_history_length, max_history_length = 20, math.huge;
  
  ------------
 -local function filter_xmlns_from_array(array, filters)
 -      local count = 0;
 -      for i=#array,1,-1 do
 -              local attr = array[i].attr;
 -              if filters[attr and attr.xmlns] then
 -                      t_remove(array, i);
 -                      count = count + 1;
 -              end
 -      end
 -      return count;
 -end
 -local function filter_xmlns_from_stanza(stanza, filters)
 -      if filters then
 -              if filter_xmlns_from_array(stanza.tags, filters) ~= 0 then
 -                      return stanza, filter_xmlns_from_array(stanza, filters);
 -              end
 +local presence_filters = {["http://jabber.org/protocol/muc"]=true;["http://jabber.org/protocol/muc#user"]=true};
 +local function presence_filter(tag)
 +      if presence_filters[tag.attr.xmlns] then
 +              return nil;
        end
 -      return stanza, 0;
 +      return tag;
  end
 -local presence_filters = {["http://jabber.org/protocol/muc"]=true;["http://jabber.org/protocol/muc#user"]=true};
 +
  local function get_filtered_presence(stanza)
 -      return filter_xmlns_from_stanza(st.clone(stanza):reset(), presence_filters);
 +      return st.clone(stanza):maptags(presence_filter);
  end
  local kickable_error_conditions = {
        ["gone"] = true;
@@@ -60,6 -72,17 +60,6 @@@ local function is_kickable_error(stanza
        local cond = get_error_condition(stanza);
        return kickable_error_conditions[cond] and cond;
  end
 -local function getUsingPath(stanza, path, getText)
 -      local tag = stanza;
 -      for _, name in ipairs(path) do
 -              if type(tag) ~= 'table' then return; end
 -              tag = tag:child_with_name(name);
 -      end
 -      if tag and getText then tag = table.concat(tag); end
 -      return tag;
 -end
 -local function getTag(stanza, path) return getUsingPath(stanza, path); end
 -local function getText(stanza, path) return getUsingPath(stanza, path, true); end
  -----------
  
  local room_mt = {};
@@@ -75,8 -98,8 +75,8 @@@ function room_mt:get_default_role(affil
        elseif affiliation == "member" then
                return "participant";
        elseif not affiliation then
 -              if not self:is_members_only() then
 -                      return self:is_moderated() and "visitor" or "participant";
 +              if not self:get_members_only() then
 +                      return self:get_moderated() and "visitor" or "participant";
                end
        end
  end
@@@ -107,21 -130,18 +107,21 @@@ function room_mt:broadcast_message(stan
        end
        stanza.attr.to = to;
        if historic then -- add to history
 -              local history = self._data['history'];
 -              if not history then history = {}; self._data['history'] = history; end
 -              stanza = st.clone(stanza);
 -              stanza.attr.to = "";
 -              local stamp = datetime.datetime();
 -              stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = muc_domain, stamp = stamp}):up(); -- XEP-0203
 -              stanza:tag("x", {xmlns = "jabber:x:delay", from = muc_domain, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
 -              local entry = { stanza = stanza, stamp = stamp };
 -              t_insert(history, entry);
 -              while #history > (self._data.history_length or default_history_length) do t_remove(history, 1) end
 +              return self:save_to_history(stanza)
        end
  end
 +function room_mt:save_to_history(stanza)
 +      local history = self._data['history'];
 +      if not history then history = {}; self._data['history'] = history; end
 +      stanza = st.clone(stanza);
 +      stanza.attr.to = "";
 +      local stamp = datetime.datetime();
 +      stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = muc_domain, stamp = stamp}):up(); -- XEP-0203
 +      stanza:tag("x", {xmlns = "jabber:x:delay", from = muc_domain, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
 +      local entry = { stanza = stanza, stamp = stamp };
 +      t_insert(history, entry);
 +      while #history > (self._data.history_length or default_history_length) do t_remove(history, 1) end
 +end
  function room_mt:broadcast_except_nick(stanza, nick)
        for rnick, occupant in pairs(self._occupants) do
                if rnick ~= nick then
@@@ -150,10 -170,10 +150,10 @@@ function room_mt:send_history(to, stanz
        if history then
                local x_tag = stanza and stanza:get_child("x", "http://jabber.org/protocol/muc");
                local history_tag = x_tag and x_tag:get_child("history", "http://jabber.org/protocol/muc");
 -              
 +
                local maxchars = history_tag and tonumber(history_tag.attr.maxchars);
                if maxchars then maxchars = math.floor(maxchars); end
 -              
 +
                local maxstanzas = math.floor(history_tag and tonumber(history_tag.attr.maxstanzas) or #history);
                if not history_tag then maxstanzas = 20; end
  
  
                local n = 0;
                local charcount = 0;
 -              
 +
                for i=#history,1,-1 do
                        local entry = history[i];
                        if maxchars then
                        self:_route_stanza(msg);
                end
        end
 +end
 +function room_mt:send_subject(to)
        if self._data['subject'] then
                self:_route_stanza(st.message({type='groupchat', from=self._data['subject_from'] or self.jid, to=to}):tag("subject"):text(self._data['subject']));
        end
@@@ -200,10 -218,10 +200,10 @@@ function room_mt:get_disco_info(stanza
                :tag("identity", {category="conference", type="text", name=self:get_name()}):up()
                :tag("feature", {var="http://jabber.org/protocol/muc"}):up()
                :tag("feature", {var=self:get_password() and "muc_passwordprotected" or "muc_unsecured"}):up()
 -              :tag("feature", {var=self:is_moderated() and "muc_moderated" or "muc_unmoderated"}):up()
 -              :tag("feature", {var=self:is_members_only() and "muc_membersonly" or "muc_open"}):up()
 -              :tag("feature", {var=self:is_persistent() and "muc_persistent" or "muc_temporary"}):up()
 -              :tag("feature", {var=self:is_hidden() and "muc_hidden" or "muc_public"}):up()
 +              :tag("feature", {var=self:get_moderated() and "muc_moderated" or "muc_unmoderated"}):up()
 +              :tag("feature", {var=self:get_members_only() and "muc_membersonly" or "muc_open"}):up()
 +              :tag("feature", {var=self:get_persistent() and "muc_persistent" or "muc_temporary"}):up()
 +              :tag("feature", {var=self:get_hidden() and "muc_hidden" or "muc_public"}):up()
                :tag("feature", {var=self._data.whois ~= "anyone" and "muc_semianonymous" or "muc_nonanonymous"}):up()
                :add_child(dataform.new({
                        { name = "FORM_TYPE", type = "hidden", value = "http://jabber.org/protocol/muc#roominfo" },
@@@ -220,6 -238,7 +220,6 @@@ function room_mt:get_disco_items(stanza
        return reply;
  end
  function room_mt:set_subject(current_nick, subject)
 -      -- TODO check nick's authority
        if subject == "" then subject = nil; end
        self._data['subject'] = subject;
        self._data['subject_from'] = current_nick;
@@@ -277,7 -296,7 +277,7 @@@ function room_mt:set_moderated(moderate
                if self.save then self:save(true); end
        end
  end
 -function room_mt:is_moderated()
 +function room_mt:get_moderated()
        return self._data.moderated;
  end
  function room_mt:set_members_only(members_only)
                if self.save then self:save(true); end
        end
  end
 -function room_mt:is_members_only()
 +function room_mt:get_members_only()
        return self._data.members_only;
  end
  function room_mt:set_persistent(persistent)
                if self.save then self:save(true); end
        end
  end
 -function room_mt:is_persistent()
 +function room_mt:get_persistent()
        return self._data.persistent;
  end
  function room_mt:set_hidden(hidden)
                if self.save then self:save(true); end
        end
  end
 -function room_mt:is_hidden()
 +function room_mt:get_hidden()
        return self._data.hidden;
  end
 +function room_mt:get_public()
 +      return not self:get_hidden();
 +end
 +function room_mt:set_public(public)
 +      return self:set_hidden(not public);
 +end
  function room_mt:set_changesubject(changesubject)
        changesubject = changesubject and true or nil;
        if self._data.changesubject ~= changesubject then
@@@ -338,25 -351,12 +338,25 @@@ function room_mt:set_historylength(leng
  end
  
  
 +local valid_whois = { moderators = true, anyone = true };
 +
 +function room_mt:set_whois(whois)
 +      if valid_whois[whois] and self._data.whois ~= whois then
 +              self._data.whois = whois;
 +              if self.save then self:save(true); end
 +      end
 +end
 +
 +function room_mt:get_whois()
 +      return self._data.whois;
 +end
 +
  local function construct_stanza_id(room, stanza)
        local from_jid, to_nick = stanza.attr.from, stanza.attr.to;
        local from_nick = room._jid_nick[from_jid];
        local occupant = room._occupants[to_nick];
        local to_jid = occupant.jid;
 -      
 +
        return from_nick, to_jid, base64.encode(to_jid.."\0"..stanza.attr.id.."\0"..md5(from_jid));
  end
  local function deconstruct_stanza_id(room, stanza)
@@@ -485,12 -485,6 +485,12 @@@ function room_mt:handle_to_occupant(ori
                                        log("debug", "%s joining as %s", from, to);
                                        if not next(self._affiliations) then -- new room, no owners
                                                self._affiliations[jid_bare(from)] = "owner";
 +                                              if self.locked and not stanza:get_child("x", "http://jabber.org/protocol/muc") then
 +                                                      self.locked = nil; -- Older groupchat protocol doesn't lock
 +                                              end
 +                                      elseif self.locked then -- Deny entry
 +                                              origin.send(st.error_reply(stanza, "cancel", "item-not-found"));
 +                                              return;
                                        end
                                        local affiliation = self:get_affiliation(from);
                                        local role = self:get_default_role(affiliation)
                                                if self._data.whois == 'anyone' then
                                                        pr:tag("status", {code='100'}):up();
                                                end
 +                                              if self.locked then
 +                                                      pr:tag("status", {code='201'}):up();
 +                                              end
                                                pr.attr.to = from;
                                                self:_route_stanza(pr);
                                                self:send_history(from, stanza);
 +                                              self:send_subject(from);
                                        elseif not affiliation then -- registration required for entering members-only room
                                                local reply = st.error_reply(stanza, "auth", "registration-required"):up();
                                                reply.tags[1].attr.code = "407";
                                end
                                stanza.attr.from, stanza.attr.to, stanza.attr.id = from, to, id;
                        else -- message
 +                              stanza:tag("x", { xmlns = "http://jabber.org/protocol/muc#user" }):up();
                                stanza.attr.from = current_nick;
                                for jid in pairs(o_data.sessions) do
                                        stanza.attr.to = jid;
@@@ -586,11 -575,11 +586,11 @@@ en
  
  function room_mt:send_form(origin, stanza)
        origin.send(st.reply(stanza):query("http://jabber.org/protocol/muc#owner")
 -              :add_child(self:get_form_layout():form())
 +              :add_child(self:get_form_layout(stanza.attr.from):form())
        );
  end
  
 -function room_mt:get_form_layout()
 +function room_mt:get_form_layout(actor)
        local form = dataform.new({
                title = "Configuration for "..self.jid,
                instructions = "Complete and submit this form to configure the room.",
                        name = 'muc#roomconfig_persistentroom',
                        type = 'boolean',
                        label = 'Make Room Persistent?',
 -                      value = self:is_persistent()
 +                      value = self:get_persistent()
                },
                {
                        name = 'muc#roomconfig_publicroom',
                        type = 'boolean',
                        label = 'Make Room Publicly Searchable?',
 -                      value = not self:is_hidden()
 +                      value = not self:get_hidden()
                },
                {
                        name = 'muc#roomconfig_changesubject',
                        name = 'muc#roomconfig_moderatedroom',
                        type = 'boolean',
                        label = 'Make Room Moderated?',
 -                      value = self:is_moderated()
 +                      value = self:get_moderated()
                },
                {
                        name = 'muc#roomconfig_membersonly',
                        type = 'boolean',
                        label = 'Make Room Members-Only?',
 -                      value = self:is_members_only()
 +                      value = self:get_members_only()
                },
                {
                        name = 'muc#roomconfig_historylength',
                        value = tostring(self:get_historylength())
                }
        });
 -      return module:fire_event("muc-config-form", { room = self, form = form }) or form;
 +      return module:fire_event("muc-config-form", { room = self, actor = actor, form = form }) or form;
  end
  
 -local valid_whois = {
 -      moderators = true,
 -      anyone = true,
 -}
 -
  function room_mt:process_form(origin, stanza)
        local query = stanza.tags[1];
        local form;
        if form.attr.type == "cancel" then origin.send(st.reply(stanza)); return; end
        if form.attr.type ~= "submit" then origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form")); return; end
  
 -      local fields = self:get_form_layout():data(form);
 -      if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration")); return; end
 -
 -      local dirty = false
 -
 -      local event = { room = self, fields = fields, changed = dirty };
 -      module:fire_event("muc-config-submitted", event);
 -      dirty = event.changed or dirty;
 -
 -      local name = fields['muc#roomconfig_roomname'];
 -      if name ~= self:get_name() then
 -              self:set_name(name);
 +      local fields, errors, present = self:get_form_layout(stanza.attr.from):data(form);
 +      if fields.FORM_TYPE ~= "http://jabber.org/protocol/muc#roomconfig" then
 +              origin.send(st.error_reply(stanza, "cancel", "bad-request", "Form is not of type room configuration"));
 +              return;
        end
  
 -      local description = fields['muc#roomconfig_roomdesc'];
 -      if description ~= self:get_description() then
 -              self:set_description(description);
 -      end
 -
 -      local persistent = fields['muc#roomconfig_persistentroom'];
 -      dirty = dirty or (self:is_persistent() ~= persistent)
 -      module:log("debug", "persistent=%s", tostring(persistent));
 -
 -      local moderated = fields['muc#roomconfig_moderatedroom'];
 -      dirty = dirty or (self:is_moderated() ~= moderated)
 -      module:log("debug", "moderated=%s", tostring(moderated));
 +      local changed = {};
  
 -      local membersonly = fields['muc#roomconfig_membersonly'];
 -      dirty = dirty or (self:is_members_only() ~= membersonly)
 -      module:log("debug", "membersonly=%s", tostring(membersonly));
 -
 -      local public = fields['muc#roomconfig_publicroom'];
 -      dirty = dirty or (self:is_hidden() ~= (not public and true or nil))
 -
 -      local changesubject = fields['muc#roomconfig_changesubject'];
 -      dirty = dirty or (self:get_changesubject() ~= (not changesubject and true or nil))
 -      module:log('debug', 'changesubject=%s', changesubject and "true" or "false")
 -
 -      local historylength = tonumber(fields['muc#roomconfig_historylength']);
 -      dirty = dirty or (historylength and (self:get_historylength() ~= historylength));
 -      module:log('debug', 'historylength=%s', historylength)
 -
 -
 -      local whois = fields['muc#roomconfig_whois'];
 -      if not valid_whois[whois] then
 -          origin.send(st.error_reply(stanza, 'cancel', 'bad-request', "Invalid value for 'whois'"));
 -          return;
 +      local function handle_option(name, field, allowed)
 +              if not present[field] then return; end
 +              local new = fields[field];
 +              if allowed and not allowed[new] then return; end
 +              if new == self["get_"..name](self) then return; end
 +              changed[name] = true;
 +              self["set_"..name](self, new);
        end
 -      local whois_changed = self._data.whois ~= whois
 -      self._data.whois = whois
 -      module:log('debug', 'whois=%s', whois)
  
 -      local password = fields['muc#roomconfig_roomsecret'];
 -      if self:get_password() ~= password then
 -              self:set_password(password);
 -      end
 -      self:set_moderated(moderated);
 -      self:set_members_only(membersonly);
 -      self:set_persistent(persistent);
 -      self:set_hidden(not public);
 -      self:set_changesubject(changesubject);
 -      self:set_historylength(historylength);
 +      local event = { room = self, fields = fields, changed = changed, stanza = stanza, origin = origin, update_option = handle_option };
 +      module:fire_event("muc-config-submitted", event);
 +
 +      handle_option("name", "muc#roomconfig_roomname");
 +      handle_option("description", "muc#roomconfig_roomdesc");
 +      handle_option("persistent", "muc#roomconfig_persistentroom");
 +      handle_option("moderated", "muc#roomconfig_moderatedroom");
 +      handle_option("members_only", "muc#roomconfig_membersonly");
 +      handle_option("public", "muc#roomconfig_publicroom");
 +      handle_option("changesubject", "muc#roomconfig_changesubject");
 +      handle_option("historylength", "muc#roomconfig_historylength");
 +      handle_option("whois", "muc#roomconfig_whois", valid_whois);
 +      handle_option("password", "muc#roomconfig_roomsecret");
  
        if self.save then self:save(true); end
 +      if self.locked then
 +              module:fire_event("muc-room-unlocked", { room = self });
 +              self.locked = nil;
 +      end
        origin.send(st.reply(stanza));
  
 -      if dirty or whois_changed then
 +      if next(changed) then
                local msg = st.message({type='groupchat', from=self.jid})
-                       :tag('x', {xmlns='http://jabber.org/protocol/muc#user'}):up()
 -                      :tag('x', {xmlns='http://jabber.org/protocol/muc#user'});
 -
 -              if dirty then
 -                      msg.tags[1]:tag('status', {code = '104'}):up();
 -              end
 -              if whois_changed then
 -                      local code = (whois == 'moderators') and "173" or "172";
++                      :tag('x', {xmlns='http://jabber.org/protocol/muc#user'})
 +                              :tag('status', {code = '104'}):up();
 +              if changed.whois then
 +                      local code = (self:get_whois() == 'moderators') and "173" or "172";
                        msg.tags[1]:tag('status', {code = code}):up();
                end
 -              msg:up();
 -
                self:broadcast_message(msg, false)
        end
  end
@@@ -855,7 -882,7 +855,7 @@@ function room_mt:handle_to_room(origin
                        origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
                end
        elseif stanza.name == "message" and type == "groupchat" then
 -              local from, to = stanza.attr.from, stanza.attr.to;
 +              local from = stanza.attr.from;
                local current_nick = self._jid_nick[from];
                local occupant = self._occupants[current_nick];
                if not occupant then -- not in room
                else
                        local from = stanza.attr.from;
                        stanza.attr.from = current_nick;
 -                      local subject = getText(stanza, {"subject"});
 +                      local subject = stanza:get_child_text("subject");
                        if subject then
                                if occupant.role == "moderator" or
                                        ( self._data.changesubject and occupant.role == "participant" ) then -- and participant
 -                                      self:set_subject(current_nick, subject); -- TODO use broadcast_message_stanza
 +                                      self:set_subject(current_nick, subject);
                                else
                                        stanza.attr.from = from;
                                        origin.send(st.error_reply(stanza, "auth", "forbidden"));
                                        :tag('body') -- Add a plain message for clients which don't support invites
                                                :text(_from..' invited you to the room '.._to..(_reason and (' ('.._reason..')') or ""))
                                        :up();
 -                              if self:is_members_only() and not self:get_affiliation(_invitee) then
 +                              if self:get_members_only() and not self:get_affiliation(_invitee) then
                                        log("debug", "%s invited %s into members only room %s, granting membership", _from, _invitee, _to);
                                        self:set_affiliation(_from, _invitee, "member", nil, "Invited by " .. self._jid_nick[_from])
                                end