Mercurial > prosody-modules
changeset 4783:6ca1117b81a5
mod_mam: Obsolete this module, it is included in Prosody since 0.10
| author | Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> |
|---|---|
| date | Fri, 09 Jul 2021 18:25:07 +0200 |
| parents | b935276ab1b4 |
| children | 9a41cf08de24 |
| files | mod_mam/README.markdown mod_mam/fallback_archive.lib.lua mod_mam/mamprefs.lib.lua mod_mam/mamprefsxml.lib.lua mod_mam/mod_mam.lua mod_mam/rsm.lib.lua |
| diffstat | 6 files changed, 3 insertions(+), 830 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_mam/README.markdown Fri Jul 09 20:54:40 2021 +0200 +++ b/mod_mam/README.markdown Fri Jul 09 18:25:07 2021 +0200 @@ -1,129 +1,8 @@ --- labels: -- 'Stage-Merged' +- 'Stage-Obsolete' summary: 'XEP-0313: Message Archive Management' +superseded_by: mod_mam ... -Introduction -============ - -Implementation of [XEP-0313: Message Archive Management]. - -Details -======= - -This module will archive all messages that match the simple rules setup -by the user, and allow the user to access this archive. - -Usage -===== - -First copy the module to the prosody plugins directory. - -Then add "mam" to your modules\_enabled list: - -``` {.lua} -modules_enabled = { - -- ... - "mam", - -- ... -} -``` - -Configuration -============= - -Option summary --------------- - - option type default - ------------------------------ ----------------------- ----------- - max\_archive\_query\_results number `50` - default\_archive\_policy boolean or `"roster"` `true` - archive\_expires\_after string `"1w"` - archive\_cleanup\_interval number `4*60*60` - - -Storage backend ---------------- - -mod\_mam uses the store "archive2"[^1]. See [Prosodys data storage -documentation][doc:storage] for information on how to configure storage. - -For example, to use mod\_storage\_sql (requires Prosody 0.10 or later): - -``` {.lua} -storage = { - archive2 = "sql"; -} -``` - -If no archive-capable storage backend can be opened then an in-memory -one will be used as fallback. - -Query size limits ------------------ - - max_archive_query_results = 20; - -This is the largest number of messages that are allowed to be retrieved -in one request *page*. A query that does not fit in one page will -include a reference to the next page, letting clients page through the -result set. Setting large number is not recommended, as Prosody will be -blocked while processing the request and will not be able to do anything -else. - -Archive expiry --------------- - -Messages in the archive will expire after some time, by default one -week. This can be changed by setting `archive_expires_after`: - -``` {.lua} -archive_expires_after = "1d" -- one day - -archive_expires_after = "1w" -- one week, the default - -archive_expires_after = "2m" -- two months - -archive_expires_after = "1y" -- one year - -archive_expires_after = 60 * 60 -- one hour - -archive_expires_after = "never" -- forever -``` - -The format is an integer number of seconds or a multiple of a period -given by a suffix that can be one of `d` (day), `w` (week), `m` (month) -or `y` (year). No multiplier means seconds. - -Message matching policy ------------------------ - -The MAM protocol includes a way for clients to control what messages -should be stored. This allows users to enable or disable archiving by -default or for specific contacts. - -``` {.lua} -default_archive_policy = true -``` - - `default_archive_policy =` Meaning - ---------------------------- ------------------------------------------------------ - `false` Store no messages. - `"roster"` Store messages to/from contacts in the users roster. - `true` Store all messages. This is the default. - -Compatibility -============= - - ------- ----------------------- - trunk Included with Prosody - 0.10 Included with Prosody - 0.9 Works - 0.8 Does not work - ------- ----------------------- - - -[^1]: Might be changed to "mam" at some point - +Since Prosody 0.10, this module is [included in Prosody](https://prosody.im/doc/modules/mod_mam), you will be redirected there shortly.
--- a/mod_mam/fallback_archive.lib.lua Fri Jul 09 20:54:40 2021 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,83 +0,0 @@ --- luacheck: ignore 212/self - -local uuid = require "util.uuid".generate; -local store = module:shared("archive"); -local archive_store = { _provided_by = "mam"; name = "fallback"; }; - -function archive_store:append(username, key, value, when, with) - local archive = store[username]; - if not archive then - archive = { [0] = 0 }; - store[username] = archive; - end - local index = (archive[0] or #archive)+1; - local item = { key = key, when = when, with = with, value = value }; - if not key or archive[key] then - key = uuid(); - item.key = key; - end - archive[index] = item; - archive[key] = index; - archive[0] = index; - return key; -end - -function archive_store:find(username, query) - local archive = store[username] or {}; - local start, stop, step = 1, archive[0] or #archive, 1; - local qstart, qend, qwith = -math.huge, math.huge; - local limit; - - if query then - if query.reverse then - start, stop, step = stop, start, -1; - if query.before and archive[query.before] then - start = archive[query.before] - 1; - end - elseif query.after and archive[query.after] then - start = archive[query.after] + 1; - end - qwith = query.with; - limit = query.limit; - qstart = query.start or qstart; - qend = query["end"] or qend; - end - - return function () - if limit and limit <= 0 then return end - for i = start, stop, step do - local item = archive[i]; - if (not qwith or qwith == item.with) and item.when >= qstart and item.when <= qend then - if limit then limit = limit - 1; end - start = i + step; -- Start on next item - return item.key, item.value, item.when, item.with; - end - end - end -end - -function archive_store:delete(username, query) - if not query or next(query) == nil then - -- no specifics, delete everything - store[username] = nil; - return true; - end - local archive = store[username]; - if not archive then return true; end -- no messages, nothing to delete - - local qstart = query.start or -math.huge; - local qend = query["end"] or math.huge; - local qwith = query.with; - store[username] = nil; - for i = 1, #archive do - local item = archive[i]; - local when, with = item.when, item.when; - -- Add things that don't match the query - if not ((not qwith or qwith == item.with) and item.when >= qstart and item.when <= qend) then - self:append(username, item.key, item.value, when, with); - end - end - return true; -end - -return archive_store;
--- a/mod_mam/mamprefs.lib.lua Fri Jul 09 20:54:40 2021 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,46 +0,0 @@ --- XEP-0313: Message Archive Management for Prosody --- Copyright (C) 2011-2013 Kim Alvefur --- --- This file is MIT/X11 licensed. --- luacheck: ignore 122/prosody - -local global_default_policy = module:get_option("default_archive_policy", true); - -do - -- luacheck: ignore 211/prefs_format - local prefs_format = { - [false] = "roster", - -- default ::= true | false | "roster" - -- true = always, false = never, nil = global default - ["romeo@montague.net"] = true, -- always - ["montague@montague.net"] = false, -- newer - }; -end - -local sessions = prosody.hosts[module.host].sessions; -local archive_store = module:get_option_string("archive_store", "archive"); -local prefs = module:open_store(archive_store .. "_prefs"); - -local function get_prefs(user) - local user_sessions = sessions[user]; - local user_prefs = user_sessions and user_sessions.archive_prefs - if not user_prefs then - user_prefs = prefs:get(user); - if user_sessions then - user_sessions.archive_prefs = user_prefs; - end - end - return user_prefs or { [false] = global_default_policy }; -end -local function set_prefs(user, user_prefs) - local user_sessions = sessions[user]; - if user_sessions then - user_sessions.archive_prefs = user_prefs; - end - return prefs:set(user, user_prefs); -end - -return { - get = get_prefs, - set = set_prefs, -}
--- a/mod_mam/mamprefsxml.lib.lua Fri Jul 09 20:54:40 2021 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,57 +0,0 @@ --- XEP-0313: Message Archive Management for Prosody --- Copyright (C) 2011-2013 Kim Alvefur --- --- This file is MIT/X11 licensed. - -local st = require"util.stanza"; - -local default_attrs = { - always = true, [true] = "always", - never = false, [false] = "never", - roster = "roster", -} - -local function tostanza(prefs, xmlns_mam) - local default = prefs[false]; - default = default_attrs[default]; - local prefstanza = st.stanza("prefs", { xmlns = xmlns_mam, default = default }); - local always = st.stanza("always"); - local never = st.stanza("never"); - for jid, choice in pairs(prefs) do - if jid then - (choice and always or never):tag("jid"):text(jid):up(); - end - end - prefstanza:add_child(always):add_child(never); - return prefstanza; -end -local function fromstanza(prefstanza) - local prefs = {}; - local default = prefstanza.attr.default; - if default then - prefs[false] = default_attrs[default]; - end - - local always = prefstanza:get_child("always"); - if always then - for rule in always:childtags("jid") do - local jid = rule:get_text(); - prefs[jid] = true; - end - end - - local never = prefstanza:get_child("never"); - if never then - for rule in never:childtags("jid") do - local jid = rule:get_text(); - prefs[jid] = false; - end - end - - return prefs; -end - -return { - tostanza = tostanza; - fromstanza = fromstanza; -}
--- a/mod_mam/mod_mam.lua Fri Jul 09 20:54:40 2021 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,433 +0,0 @@ --- XEP-0313: Message Archive Management for Prosody --- Copyright (C) 2011-2016 Kim Alvefur --- --- This file is MIT/X11 licensed. - -local xmlns_mam0 = "urn:xmpp:mam:0"; -local xmlns_mam1 = "urn:xmpp:mam:1"; -local xmlns_mam2 = "urn:xmpp:mam:2"; -local xmlns_delay = "urn:xmpp:delay"; -local xmlns_forward = "urn:xmpp:forward:0"; -local xmlns_st_id = "urn:xmpp:sid:0"; - -local um = require "core.usermanager"; -local st = require "util.stanza"; -local rsm = module:require "rsm"; -local get_prefs = module:require"mamprefs".get; -local set_prefs = module:require"mamprefs".set; -local prefs_to_stanza = module:require"mamprefsxml".tostanza; -local prefs_from_stanza = module:require"mamprefsxml".fromstanza; -local jid_bare = require "util.jid".bare; -local jid_split = require "util.jid".split; -local jid_prepped_split = require "util.jid".prepped_split; -local dataform = require "util.dataforms".new; -local host = module.host; - -local rm_load_roster = require "core.rostermanager".load_roster; - -local getmetatable = getmetatable; -local function is_stanza(x) - return getmetatable(x) == st.stanza_mt; -end - -local tostring = tostring; -local time_now = os.time; -local m_min = math.min; -local timestamp, timestamp_parse = require "util.datetime".datetime, require "util.datetime".parse; -local default_max_items, max_max_items = 20, module:get_option_number("max_archive_query_results", 50); -local global_default_policy = module:get_option("default_archive_policy", true); -if global_default_policy ~= "roster" then - global_default_policy = module:get_option_boolean("default_archive_policy", global_default_policy); -end - -local archive_store = module:get_option_string("archive_store", "archive2"); -local archive = module:open_store(archive_store, "archive"); - -if archive.name == "null" or not archive.find then - -- luacheck: ignore 631 - if not archive.find then - module:log("debug", "Attempt to open archive storage returned a valid driver but it does not seem to implement the storage API"); - module:log("debug", "mod_%s does not support archiving", archive._provided_by or archive.name and "storage_"..archive.name.."(?)" or "<unknown>"); - else - module:log("debug", "Attempt to open archive storage returned null driver"); - end - module:log("debug", "See https://prosody.im/doc/storage and https://prosody.im/doc/archiving for more information"); - module:log("info", "Using in-memory fallback archive driver"); - archive = module:require "fallback_archive"; -end - -local use_total = true; - -local cleanup; - -local function schedule_cleanup(username) - if cleanup and not cleanup[username] then - table.insert(cleanup, username); - cleanup[username] = true; - end -end - --- Handle prefs. -local function handle_prefs(event) - local origin, stanza = event.origin, event.stanza; - local xmlns_mam = stanza.tags[1].attr.xmlns; - local user = origin.username; - if stanza.attr.type == "get" then - local prefs = prefs_to_stanza(get_prefs(user), xmlns_mam); - local reply = st.reply(stanza):add_child(prefs); - origin.send(reply); - else -- type == "set" - local new_prefs = stanza:get_child("prefs", xmlns_mam); - local prefs = prefs_from_stanza(new_prefs); - local ok, err = set_prefs(user, prefs); - if not ok then - origin.send(st.error_reply(stanza, "cancel", "internal-server-error", "Error storing preferences: "..tostring(err))); - else - origin.send(st.reply(stanza)); - end - end - return true; -end - -module:hook("iq/self/"..xmlns_mam0..":prefs", handle_prefs); -module:hook("iq/self/"..xmlns_mam1..":prefs", handle_prefs); -module:hook("iq/self/"..xmlns_mam2..":prefs", handle_prefs); - -local query_form = dataform { - { name = "FORM_TYPE"; type = "hidden"; value = xmlns_mam0; }; - { name = "with"; type = "jid-single"; }; - { name = "start"; type = "text-single" }; - { name = "end"; type = "text-single"; }; -}; - --- Serve form -local function handle_get_form(event) - local origin, stanza = event.origin, event.stanza; - local xmlns_mam = stanza.tags[1].attr.xmlns; - query_form[1].value = xmlns_mam; - origin.send(st.reply(stanza):query(xmlns_mam):add_child(query_form:form())); - return true; -end - -module:hook("iq-get/self/"..xmlns_mam0..":query", handle_get_form); -module:hook("iq-get/self/"..xmlns_mam1..":query", handle_get_form); -module:hook("iq-get/self/"..xmlns_mam2..":query", handle_get_form); - --- Handle archive queries -local function handle_mam_query(event) - local origin, stanza = event.origin, event.stanza; - local xmlns_mam = stanza.tags[1].attr.xmlns; - local query = stanza.tags[1]; - local qid = query.attr.queryid; - - origin.mam_requested = true; - - schedule_cleanup(origin.username); - - -- Search query parameters - local qwith, qstart, qend; - local form = query:get_child("x", "jabber:x:data"); - if form then - local err; - query_form[1].value = xmlns_mam; - form, err = query_form:data(form); - if err then - origin.send(st.error_reply(stanza, "modify", "bad-request", select(2, next(err)))); - return true; - end - qwith, qstart, qend = form["with"], form["start"], form["end"]; - qwith = qwith and jid_bare(qwith); -- dataforms does jidprep - end - - if qstart or qend then -- Validate timestamps - local vstart, vend = (qstart and timestamp_parse(qstart)), (qend and timestamp_parse(qend)); - if (qstart and not vstart) or (qend and not vend) then - origin.send(st.error_reply(stanza, "modify", "bad-request", "Invalid timestamp")) - return true; - end - qstart, qend = vstart, vend; - end - - module:log("debug", "Archive query, id %s with %s from %s until %s)", - tostring(qid), qwith or "anyone", qstart or "the dawn of time", qend or "now"); - - -- RSM stuff - local qset = rsm.get(query); - local qmax = m_min(qset and qset.max or default_max_items, max_max_items); - local reverse = qset and qset.before or false; - local before, after = qset and qset.before, qset and qset.after; - if type(before) ~= "string" then before = nil; end - - -- Load all the data! - local data, err = archive:find(origin.username, { - start = qstart; ["end"] = qend; -- Time range - with = qwith; - limit = qmax + 1; - before = before; after = after; - reverse = reverse; - total = use_total; - }); - - if not data then - origin.send(st.error_reply(stanza, "cancel", "internal-server-error", err)); - return true; - end - local total = tonumber(err); - - if xmlns_mam == xmlns_mam0 then - origin.send(st.reply(stanza)); - end - local msg_reply_attr = { to = stanza.attr.from, from = stanza.attr.to }; - - local results = {}; - - -- Wrap it in stuff and deliver - local first, last; - local count = 0; - local complete = "true"; - for id, item, when in data do - count = count + 1; - if count > qmax then - complete = nil; - break; - end - local fwd_st = st.message(msg_reply_attr) - :tag("result", { xmlns = xmlns_mam, queryid = qid, id = id }) - :tag("forwarded", { xmlns = xmlns_forward }) - :tag("delay", { xmlns = xmlns_delay, stamp = timestamp(when) }):up(); - - if not is_stanza(item) then - item = st.deserialize(item); - end - item.attr.xmlns = "jabber:client"; - fwd_st:add_child(item); - - if not first then first = id; end - last = id; - - if reverse then - results[count] = fwd_st; - else - origin.send(fwd_st); - end - end - - if reverse then - for i = #results, 1, -1 do - origin.send(results[i]); - end - first, last = last, first; - end - - -- That's all folks! - module:log("debug", "Archive query %s completed", tostring(qid)); - - local fin; - if xmlns_mam == xmlns_mam0 then - fin = st.message(msg_reply_attr); - else - fin = st.reply(stanza); - end - do - fin:tag("fin", { xmlns = xmlns_mam, queryid = qid, complete = complete }) - :add_child(rsm.generate { - first = first, last = last, count = total }) - end - origin.send(fin); - return true; -end -module:hook("iq-set/self/"..xmlns_mam0..":query", handle_mam_query); -module:hook("iq-set/self/"..xmlns_mam1..":query", handle_mam_query); -module:hook("iq-set/self/"..xmlns_mam2..":query", handle_mam_query); - -local function has_in_roster(user, who) - local roster = rm_load_roster(user, host); - module:log("debug", "%s has %s in roster? %s", user, who, roster[who] and "yes" or "no"); - return roster[who]; -end - -local function shall_store(user, who) - -- TODO Cache this? - if not um.user_exists(user, host) then - return false; - end - local prefs = get_prefs(user); - local rule = prefs[who]; - module:log("debug", "%s's rule for %s is %s", user, who, tostring(rule)); - if rule ~= nil then - return rule; - end - -- Below could be done by a metatable - local default = prefs[false]; - module:log("debug", "%s's default rule is %s", user, tostring(default)); - if default == nil then - default = global_default_policy; - module:log("debug", "Using global default rule, %s", tostring(default)); - end - if default == "roster" then - return has_in_roster(user, who); - end - return default; -end - --- Handle messages -local function message_handler(event, c2s) - local origin, stanza = event.origin, event.stanza; - local log = c2s and origin.log or module._log; - local orig_type = stanza.attr.type or "normal"; - local orig_from = stanza.attr.from; - local orig_to = stanza.attr.to or orig_from; - -- Stanza without 'to' are treated as if it was to their own bare jid - - -- Whos storage do we put it in? - local store_user = c2s and origin.username or jid_split(orig_to); - -- And who are they chatting with? - local with = jid_bare(c2s and orig_to or orig_from); - - -- Filter out <stanza-id> that claim to be from us - if stanza:get_child("stanza-id", xmlns_st_id) then - stanza = st.clone(stanza); - stanza:maptags(function (tag) - if tag.name == "stanza-id" and tag.attr.xmlns == xmlns_st_id then - local by_user, by_host, res = jid_prepped_split(tag.attr.by); - if not res and by_host == module.host and by_user == store_user then - return nil; - end - end - return tag; - end); - event.stanza = stanza; - end - - -- We store chat messages or normal messages that have a body - if not(orig_type == "chat" or (orig_type == "normal" and stanza:get_child("body")) ) then - log("debug", "Not archiving stanza: %s (type)", stanza:top_tag()); - return; - end - - -- or if hints suggest we shouldn't - if not stanza:get_child("store", "urn:xmpp:hints") then -- No hint telling us we should store - if stanza:get_child("no-permanent-store", "urn:xmpp:hints") - or stanza:get_child("no-store", "urn:xmpp:hints") then -- Hint telling us we should NOT store - log("debug", "Not archiving stanza: %s (hint)", stanza:top_tag()); - return; - end - end - - -- Check with the users preferences - if shall_store(store_user, with) then - log("debug", "Archiving stanza: %s", stanza:top_tag()); - - -- And stash it - local ok = archive:append(store_user, nil, stanza, time_now(), with); - if ok then - local clone_for_other_handlers = st.clone(stanza); - local id = ok; - clone_for_other_handlers:tag("stanza-id", { xmlns = xmlns_st_id, by = store_user.."@"..host, id = id }):up(); - event.stanza = clone_for_other_handlers; - schedule_cleanup(store_user); - module:fire_event("archive-message-added", { origin = origin, stanza = stanza, for_user = store_user, id = id }); - end - else - log("debug", "Not archiving stanza: %s (prefs)", stanza:top_tag()); - end -end - -local function c2s_message_handler(event) - return message_handler(event, true); -end - -local function strip_stanza_id(event) - local strip_by = jid_bare(event.origin.full_jid); - event.stanza = st.clone(event.stanza); - event.stanza:maptags(function(tag) - if not ( tag.attr.xmlns == xmlns_st_id and tag.attr.by == strip_by ) then - return tag; - end - end); -end - -module:hook("pre-message/bare", strip_stanza_id, 0.01); -module:hook("pre-message/full", strip_stanza_id, 0.01); - -local cleanup_after = module:get_option_string("archive_expires_after", "1w"); -local cleanup_interval = module:get_option_number("archive_cleanup_interval", 4 * 60 * 60); -if cleanup_after ~= "never" then - local day = 86400; - local multipliers = { d = day, w = day * 7, m = 31 * day, y = 365.2425 * day }; - local n, m = cleanup_after:lower():match("(%d+)%s*([dwmy]?)"); - if not n then - module:log("error", "Could not parse archive_expires_after string %q", cleanup_after); - return false; - end - - cleanup_after = tonumber(n) * ( multipliers[m] or 1 ); - - module:log("debug", "archive_expires_after = %d -- in seconds", cleanup_after); - - if not archive.delete then - module:log("error", "archive_expires_after set but mod_%s does not support deleting", archive._provided_by); - return false; - end - - -- Set of known users to do message expiry for - -- Populated either below or when new messages are added - cleanup = {}; - - -- Iterating over users is not supported by all authentication modules - -- Catch and ignore error if not supported - pcall(function () - -- If this works, then we schedule cleanup for all known users on startup - for user in um.users(module.host) do - schedule_cleanup(user); - end - end); - - -- At odd intervals, delete old messages for one user - module:add_timer(math.random(10, 60), function() - local user = table.remove(cleanup, 1); - if user then - module:log("debug", "Removing old messages for user %q", user); - local ok, err = archive:delete(user, { ["end"] = os.time() - cleanup_after; }) - if not ok then - module:log("warn", "Could not expire archives for user %s: %s", user, err); - else - -- :affected() is a recent addition for eg SQLite3 in LuaDBI - pcall(function(stmt) - module:log("debug", "Removed %d messages", stmt:affected()); - end, err); - end - cleanup[user] = nil; - end - return math.random(cleanup_interval, cleanup_interval * 2); - end); -else - -- Don't ask the backend to count the potentially unbounded number of items, - -- it'll get slow. - use_total = false; -end - --- Stanzas sent by local clients -local priority = 0.075 -assert(priority < 0.1, "priority must be after mod_firewall"); -assert(priority > 0.05, "priority must be before mod_carbons"); -assert(priority > 0.01, "priority must be before strip_stanza_id"); -module:hook("pre-message/bare", c2s_message_handler, priority); -module:hook("pre-message/full", c2s_message_handler, priority); --- Stanszas to local clients -priority = 0.075 -assert(priority > 0, "priority must be before mod_message"); -assert(priority < 0.1, "priority must be after mod_firewall"); -assert(priority > 0.05, "priority must be before mod_carbons"); -module:hook("message/bare", message_handler, priority); -module:hook("message/full", message_handler, priority); - -module:add_feature(xmlns_mam0); -- COMPAT with XEP-0313 v 0.1 - -module:hook("account-disco-info", function(event) - (event.reply or event.stanza):tag("feature", {var=xmlns_mam0}):up(); - (event.reply or event.stanza):tag("feature", {var=xmlns_mam1}):up(); - (event.reply or event.stanza):tag("feature", {var=xmlns_mam2}):up(); - (event.reply or event.stanza):tag("feature", {var=xmlns_st_id}):up(); -end); -
--- a/mod_mam/rsm.lib.lua Fri Jul 09 20:54:40 2021 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,87 +0,0 @@ -local stanza = require"util.stanza".stanza; -local tostring, tonumber = tostring, tonumber; -local type = type; -local pairs = pairs; - -local xmlns_rsm = 'http://jabber.org/protocol/rsm'; - -local element_parsers = {}; - -do - local parsers = element_parsers; - local function xs_int(st) - return tonumber((st:get_text())); - end - local function xs_string(st) - return st:get_text(); - end - - parsers.after = xs_string; - parsers.before = function(st) - local text = st:get_text(); - return text == "" or text; - end; - parsers.max = xs_int; - parsers.index = xs_int; - - parsers.first = function(st) - return { index = tonumber(st.attr.index); st:get_text() }; - end; - parsers.last = xs_string; - parsers.count = xs_int; -end - -local element_generators = setmetatable({ - first = function(st, data) - if type(data) == "table" then - st:tag("first", { index = data.index }):text(data[1]):up(); - else - st:tag("first"):text(tostring(data)):up(); - end - end; - before = function(st, data) - if data == true then - st:tag("before"):up(); - else - st:tag("before"):text(tostring(data)):up(); - end - end -}, { - __index = function(_, name) - return function(st, data) - st:tag(name):text(tostring(data)):up(); - end - end; -}); - - -local function parse(set) - local rs = {}; - for tag in set:childtags() do - local name = tag.name; - local parser = name and element_parsers[name]; - if parser then - rs[name] = parser(tag); - end - end - return rs; -end - -local function generate(t) - local st = stanza("set", { xmlns = xmlns_rsm }); - for k,v in pairs(t) do - if element_parsers[k] then - element_generators[k](st, v); - end - end - return st; -end - -local function get(st) - local set = st:get_child("set", xmlns_rsm); - if set and #set.tags > 0 then - return parse(set); - end -end - -return { parse = parse, generate = generate, get = get };