aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/muc
diff options
context:
space:
mode:
authordaurnimator <quae@daurnimator.com>2014-04-03 15:14:52 -0400
committerdaurnimator <quae@daurnimator.com>2014-04-03 15:14:52 -0400
commitb661ecb24f5e68a3a7af2532f8e91189e305fb82 (patch)
tree49765768de709a3c489e4bcd3cb762b62fa380d7 /plugins/muc
parentbae30c03d41b80b2bd10ca2d0c9b60d2a6913bc3 (diff)
downloadprosody-b661ecb24f5e68a3a7af2532f8e91189e305fb82.tar.gz
prosody-b661ecb24f5e68a3a7af2532f8e91189e305fb82.zip
plugins/muc: Move history to an external module
This resulted in the split up of the main muc-occupant-joined event handler into 3 seperate ones, handling occupant list, history and subject
Diffstat (limited to 'plugins/muc')
-rw-r--r--plugins/muc/history.lib.lua161
-rw-r--r--plugins/muc/muc.lib.lua167
2 files changed, 182 insertions, 146 deletions
diff --git a/plugins/muc/history.lib.lua b/plugins/muc/history.lib.lua
new file mode 100644
index 00000000..417d62a8
--- /dev/null
+++ b/plugins/muc/history.lib.lua
@@ -0,0 +1,161 @@
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
+-- Copyright (C) 2014 Daurnimator
+--
+-- This project is MIT/X11 licensed. Please see the
+-- COPYING file in the source package for more information.
+--
+
+local gettime = os.time;
+local datetime = require "util.datetime";
+local st = require "util.stanza";
+
+local default_history_length, max_history_length = 20, math.huge;
+
+local function set_max_history_length(_max_history_length)
+ max_history_length = _max_history_length or math.huge;
+end
+
+local function get_historylength(room)
+ return math.min(room._data.history_length or default_history_length, max_history_length);
+end
+
+local function set_historylength(room, length)
+ length = assert(tonumber(length), "Length not a valid number");
+ if length == default_history_length then length = nil; end
+ room._data.history_length = length;
+ return true;
+end
+
+module:hook("muc-config-form", function(event)
+ table.insert(event.form, {
+ name = "muc#roomconfig_historylength";
+ type = "text-single";
+ label = "Maximum Number of History Messages Returned by Room";
+ value = tostring(get_historylength(event.room));
+ });
+end);
+
+module:hook("muc-config-submitted", function(event)
+ local new = event.fields["muc#roomconfig_historylength"];
+ if new ~= nil and set_historylength(event.room, new) then
+ event.status_codes["104"] = true;
+ end
+end);
+
+local function parse_history(stanza)
+ local x_tag = 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");
+ if not history_tag then
+ return nil, default_history_length, nil;
+ end
+
+ local maxchars = tonumber(history_tag.attr.maxchars);
+
+ local maxstanzas = tonumber(history_tag.attr.maxstanzas);
+
+ -- messages received since the UTC datetime specified
+ local since = history_tag.attr.since;
+ if since then
+ since = datetime.parse(since);
+ end
+
+ -- messages received in the last "X" seconds.
+ local seconds = tonumber(history_tag.attr.seconds);
+ if seconds then
+ seconds = gettime() - seconds;
+ if since then
+ since = math.max(since, seconds);
+ else
+ since = seconds;
+ end
+ end
+
+ return maxchars, maxstanzas, since;
+end
+
+module:hook("muc-get-history", function(event)
+ local room = event.room;
+ local history = room._data["history"]; -- send discussion history
+ if not history then return nil end
+ local history_len = #history;
+
+ local to = event.to;
+ local maxchars = event.maxchars;
+ local maxstanzas = event.maxstanzas or history_len;
+ local since = event.since;
+ local n = 0;
+ local charcount = 0;
+ for i=history_len,1,-1 do
+ local entry = history[i];
+ if maxchars then
+ if not entry.chars then
+ entry.stanza.attr.to = "";
+ entry.chars = #tostring(entry.stanza);
+ end
+ charcount = charcount + entry.chars + #to;
+ if charcount > maxchars then break; end
+ end
+ if since and since > entry.timestamp then break; end
+ if n + 1 > maxstanzas then break; end
+ n = n + 1;
+ end
+
+ local i = history_len-n+1
+ function event:next_stanza()
+ if i > history_len then return nil end
+ local entry = history[i];
+ local msg = entry.stanza;
+ msg.attr.to = to;
+ i = i + 1;
+ return msg;
+ end
+ return true;
+end);
+
+local function send_history(room, stanza)
+ local maxchars, maxstanzas, since = parse_history(stanza);
+ local event = {
+ room = room;
+ to = stanza.attr.from; -- `to` is required to calculate the character count for `maxchars`
+ maxchars = maxchars, maxstanzas = maxstanzas, since = since;
+ next_stanza = function() end; -- events should define this iterator
+ };
+ module:fire_event("muc-get-history", event);
+ for msg in event.next_stanza, event do
+ room:route_stanza(msg);
+ end
+end
+
+-- Send history on join
+module:hook("muc-occupant-joined", function(event)
+ send_history(event.room, event.stanza);
+end, 50); -- Between occupant list (80) and subject(20)
+
+-- add to history
+module:hook("muc-broadcast-message", function(event)
+ local historic = event.stanza:get_child("body");
+ if historic then
+ local room = event.room
+ local history = room._data["history"];
+ if not history then history = {}; room._data["history"] = history; end
+ local stanza = st.clone(event.stanza);
+ stanza.attr.to = "";
+ local ts = gettime();
+ local stamp = datetime.datetime(ts);
+ stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = module.host, stamp = stamp}):up(); -- XEP-0203
+ stanza:tag("x", {xmlns = "jabber:x:delay", from = module.host, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
+ local entry = { stanza = stanza, timestamp = ts };
+ table.insert(history, entry);
+ while #history > get_historylength(room) do table.remove(history, 1) end
+ end
+end);
+
+return {
+ set_max_length = set_max_history_length;
+ parse_history = parse_history;
+ send = send_history;
+ get_length = get_historylength;
+ set_length = set_historylength;
+};
diff --git a/plugins/muc/muc.lib.lua b/plugins/muc/muc.lib.lua
index 7a8464e5..89953615 100644
--- a/plugins/muc/muc.lib.lua
+++ b/plugins/muc/muc.lib.lua
@@ -11,13 +11,8 @@ local select = select;
local pairs, ipairs = pairs, ipairs;
local next = next;
local setmetatable = setmetatable;
-local t_insert, t_remove = table.insert, table.remove;
-
-local gettime = os.time;
-local datetime = require "util.datetime";
local dataform = require "util.dataforms";
-
local jid_split = require "util.jid".split;
local jid_bare = require "util.jid".bare;
local jid_prep = require "util.jid".prep;
@@ -28,7 +23,6 @@ local md5 = require "util.hashes".md5;
local occupant_lib = module:require "muc/occupant"
-local default_history_length, max_history_length = 20, math.huge;
local is_kickable_error do
local kickable_error_conditions = {
@@ -185,29 +179,11 @@ function room_mt:build_item_list(occupant, x, is_anonymous, nick, actor, reason)
return x
end
-function room_mt:broadcast_message(stanza, historic)
- module:fire_event("muc-broadcast-message", {room = self, stanza = stanza, historic = historic});
+function room_mt:broadcast_message(stanza)
+ module:fire_event("muc-broadcast-message", {room = self, stanza = stanza});
self:broadcast(stanza);
end
--- add to history
-module:hook("muc-broadcast-message", function(event)
- if event.historic then
- local room = event.room
- local history = room._data['history'];
- if not history then history = {}; room._data['history'] = history; end
- local stanza = st.clone(event.stanza);
- stanza.attr.to = "";
- local ts = gettime();
- local stamp = datetime.datetime(ts);
- stanza:tag("delay", {xmlns = "urn:xmpp:delay", from = module.host, stamp = stamp}):up(); -- XEP-0203
- stanza:tag("x", {xmlns = "jabber:x:delay", from = module.host, stamp = datetime.legacy()}):up(); -- XEP-0091 (deprecated)
- local entry = { stanza = stanza, timestamp = ts };
- t_insert(history, entry);
- while #history > room:get_historylength() do t_remove(history, 1) end
- end
-end);
-
-- Broadcast a stanza to all occupants in the room.
-- optionally checks conditional called with (nick, occupant)
function room_mt:broadcast(stanza, cond_func)
@@ -312,90 +288,6 @@ function room_mt:send_occupant_list(to, filter)
end
end
-local function parse_history(stanza)
- local x_tag = 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");
- if not history_tag then
- return nil, 20, nil
- end
-
- local maxchars = tonumber(history_tag.attr.maxchars);
-
- local maxstanzas = tonumber(history_tag.attr.maxstanzas);
-
- -- messages received since the UTC datetime specified
- local since = history_tag.attr.since;
- if since then
- since = datetime.parse(since);
- end
-
- -- messages received in the last "X" seconds.
- local seconds = tonumber(history_tag.attr.seconds);
- if seconds then
- seconds = gettime() - seconds
- if since then
- since = math.max(since, seconds);
- else
- since = seconds;
- end
- end
-
- return maxchars, maxstanzas, since
-end
-
-module:hook("muc-get-history", function(event)
- local room = event.room
- local history = room._data['history']; -- send discussion history
- if not history then return nil end
- local history_len = #history
-
- local to = event.to
- local maxchars = event.maxchars
- local maxstanzas = event.maxstanzas or history_len
- local since = event.since
- local n = 0;
- local charcount = 0;
- for i=history_len,1,-1 do
- local entry = history[i];
- if maxchars then
- if not entry.chars then
- entry.stanza.attr.to = "";
- entry.chars = #tostring(entry.stanza);
- end
- charcount = charcount + entry.chars + #to;
- if charcount > maxchars then break; end
- end
- if since and since > entry.timestamp then break; end
- if n + 1 > maxstanzas then break; end
- n = n + 1;
- end
-
- local i = history_len-n+1
- function event:next_stanza()
- if i > history_len then return nil end
- local entry = history[i]
- local msg = entry.stanza
- msg.attr.to = to;
- i = i + 1
- return msg
- end
- return true;
-end);
-
-function room_mt:send_history(stanza)
- local maxchars, maxstanzas, since = parse_history(stanza)
- local event = {
- room = self;
- to = stanza.attr.from; -- `to` is required to calculate the character count for `maxchars`
- maxchars = maxchars, maxstanzas = maxstanzas, since = since;
- next_stanza = function() end; -- events should define this iterator
- }
- module:fire_event("muc-get-history", event)
- for msg in event.next_stanza , event do
- self:route_stanza(msg);
- end
-end
-
function room_mt:get_disco_info(stanza)
local reply = st.reply(stanza):query("http://jabber.org/protocol/disco#info");
local form = dataform.new {
@@ -451,7 +343,7 @@ function room_mt:set_subject(current_nick, subject)
self._data['subject_from'] = current_nick;
if self.save then self:save(); end
local msg = create_subject_message(current_nick, subject);
- self:broadcast_message(msg, false);
+ self:broadcast_message(msg);
return true;
end
@@ -529,16 +421,6 @@ end
function room_mt:get_changesubject()
return self._data.changesubject;
end
-function room_mt:get_historylength()
- return self._data.history_length or default_history_length;
-end
-function room_mt:set_historylength(length)
- length = math.min(tonumber(length) or default_history_length, max_history_length or math.huge);
- if length == default_history_length then
- length = nil;
- end
- self._data.history_length = length;
-end
-- Give the room creator owner affiliation
module:hook("muc-room-pre-create", function(event)
@@ -569,16 +451,19 @@ module:hook("muc-occupant-pre-join", function(event)
end
end, -10);
+-- Send occupant list to newly joined user
module:hook("muc-occupant-joined", function(event)
- local room, stanza = event.room, event.stanza;
- local real_jid = stanza.attr.from;
- room:send_occupant_list(real_jid, function(nick, occupant)
+ local real_jid = event.stanza.attr.from;
+ event.room:send_occupant_list(real_jid, function(nick, occupant)
-- Don't include self
return occupant:get_presence(real_jid) == nil;
end);
- room:send_history(stanza);
- room:send_subject(real_jid);
-end, -1);
+end, 80);
+
+-- Send subject to joining user
+module:hook("muc-occupant-joined", function(event)
+ event.room:send_subject(event.stanza.attr.from);
+end, 20);
function room_mt:handle_presence_to_occupant(origin, stanza)
local type = stanza.attr.type;
@@ -871,14 +756,6 @@ module:hook("muc-config-form", function(event)
value = event.room:get_members_only()
});
end);
-module:hook("muc-config-form", function(event)
- table.insert(event.form, {
- name = 'muc#roomconfig_historylength',
- type = 'text-single',
- label = 'Maximum Number of History Messages Returned by Room',
- value = tostring(event.room:get_historylength())
- });
-end);
function room_mt:process_form(origin, stanza)
local form = stanza.tags[1]:get_child("x", "jabber:x:data");
@@ -913,7 +790,7 @@ function room_mt:process_form(origin, stanza)
msg:tag("status", {code = code;}):up();
end
msg:up();
- self:broadcast_message(msg, false)
+ self:broadcast_message(msg);
end
else
origin.send(st.error_reply(stanza, "cancel", "bad-request", "Not a submitted form"));
@@ -935,9 +812,6 @@ end);
module:hook("muc-config-submitted", function(event)
event.update_option("changesubject", "muc#roomconfig_changesubject");
end);
-module:hook("muc-config-submitted", function(event)
- event.update_option("historylength", "muc#roomconfig_historylength");
-end);
-- Removes everyone from the room
function room_mt:clear(x)
@@ -1099,7 +973,7 @@ function room_mt:handle_groupchat_to_room(origin, stanza)
origin.send(st.error_reply(stanza, "auth", "forbidden"));
end
else
- self:broadcast_message(stanza, self:get_historylength() > 0 and stanza:get_child("body"));
+ self:broadcast_message(stanza);
end
stanza.attr.from = from;
return true;
@@ -1412,25 +1286,26 @@ local whois = module:require "muc/whois";
room_mt.get_whois = whois.get;
room_mt.set_whois = whois.set;
+local history = module:require "muc/history";
+room_mt.send_history = history.send;
+room_mt.get_historylength = history.get_length;
+room_mt.set_historylength = history.set_length;
+
local _M = {}; -- module "muc"
+_M.set_max_history_length = history.set_max_length;
+
function _M.new_room(jid, config)
return setmetatable({
jid = jid;
_jid_nick = {};
_occupants = {};
_data = {
- history_length = math.min((config and config.history_length)
- or default_history_length, max_history_length);
};
_affiliations = {};
}, room_mt);
end
-function _M.set_max_history_length(_max_history_length)
- max_history_length = _max_history_length or math.huge;
-end
-
_M.room_mt = room_mt;
return _M;