Software `/` code `/` prosody

Annotate

core/moduleapi.lua @ 12905:8473a516004f

core.usermanager: Add methods for enabling and disabling users Calling into the auth module, where available.

author	Kim Alvefur <zash@zash.se>
date	Thu, 23 Feb 2023 16:24:41 +0100
parent	12874:b9468c8ac1d3
child	12921:d238633a9d67

rev	line source
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	1 -- Prosody IM
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	2 -- Copyright (C) 2008-2012 Matthew Wild
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	3 -- Copyright (C) 2008-2012 Waqas Hussain
5776 bd0ff8ae98a8 Remove all trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 5771 diff changeset	4 --
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	5 -- This project is MIT/X11 licensed. Please see the
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	6 -- COPYING file in the source package for more information.
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	7 --
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	8
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	9 local array = require "util.array";
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	10 local set = require "util.set";
6651 deaa3d66dc2c moduleapi: Add module:broadcast() to send a stanza to a list of JIDs Matthew Wild <mwild1@gmail.com> parents: 6640 diff changeset	11 local it = require "util.iterators";
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	12 local logger = require "util.logger";
4750 b3525f3c2fee moduleapi: Import util.timer Matthew Wild <mwild1@gmail.com> parents: 4747 diff changeset	13 local timer = require "util.timer";
6165 6a184b16b717 core.certmanager, core.moduleapi, mod_storage_sql, mod_storage_sql2: Import from util.paths Kim Alvefur <zash@zash.se> parents: 5825 diff changeset	14 local resolve_relative_path = require"util.paths".resolve_relative_path;
6659 0a494394cd3e moduleapi: Import util.stanza required for module:broadcast() Matthew Wild <mwild1@gmail.com> parents: 6656 diff changeset	15 local st = require "util.stanza";
9747 c8240f931a68 core.moduleapi: Move util imports to top Kim Alvefur <zash@zash.se> parents: 9733 diff changeset	16 local cache = require "util.cache";
10576 f88f1151bc72 core.moduleapi: Rename local name for util.error for consistency Kim Alvefur <zash@zash.se> parents: 10575 diff changeset	17 local errors = require "util.error";
9747 c8240f931a68 core.moduleapi: Move util imports to top Kim Alvefur <zash@zash.se> parents: 9733 diff changeset	18 local promise = require "util.promise";
9866 09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	19 local time_now = require "util.time".now;
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	20 local format = require "util.format".format;
10595 17bab303daf5 core.moduleapi: Hook correct event type in some cases Kim Alvefur <zash@zash.se> parents: 10576 diff changeset	21 local jid_node = require "util.jid".node;
12642 9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	22 local jid_split = require "util.jid".split;
11822 bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	23 local jid_resource = require "util.jid".resource;
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	24
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	25 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
5021 85b2689dbcfe Eliminate direct setfenv usage Florian Zeitz <florob@babelmonkeys.de> parents: 4896 diff changeset	26 local error, setmetatable, type = error, setmetatable, type;
7162 d0b64f1e4f5d loggingmanager,modulemanager,moduleapi: Localize unpack compatible with Lua 5.2+ Kim Alvefur <zash@zash.se> parents: 7127 diff changeset	27 local ipairs, pairs, select = ipairs, pairs, select;
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	28 local tonumber, tostring = tonumber, tostring;
6414 31c15004bfb0 core.moduleapi: Use require instead of global to get storagemanager in module:open_store() Kim Alvefur <zash@zash.se> parents: 6165 diff changeset	29 local require = require;
12590 5eaf77114fdb compat: Use table.pack (there since Lua 5.2) over our util.table Kim Alvefur <zash@zash.se> parents: 12589 diff changeset	30 local pack = table.pack;
12589 39ae08180c81 compat: Remove handling of Lua 5.1 location of 'unpack' function Kim Alvefur <zash@zash.se> parents: 12479 diff changeset	31 local unpack = table.unpack;
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	32
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	33 local prosody = prosody;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	34 local hosts = prosody.hosts;
5434 9dd36e20c1e3 moduleapi: assert() that prosody.core_post_stanza is not nil Matthew Wild <mwild1@gmail.com> parents: 5412 diff changeset	35
9dd36e20c1e3 moduleapi: assert() that prosody.core_post_stanza is not nil Matthew Wild <mwild1@gmail.com> parents: 5412 diff changeset	36 -- FIXME: This assert() is to try and catch an obscure bug (2013-04-05)
9dd36e20c1e3 moduleapi: assert() that prosody.core_post_stanza is not nil Matthew Wild <mwild1@gmail.com> parents: 5412 diff changeset	37 local core_post_stanza = assert(prosody.core_post_stanza,
9dd36e20c1e3 moduleapi: assert() that prosody.core_post_stanza is not nil Matthew Wild <mwild1@gmail.com> parents: 5412 diff changeset	38 "prosody.core_post_stanza is nil, please report this as a bug");
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	39
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	40 -- Registry of shared module data
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	41 local shared_data = setmetatable({}, { __mode = "v" });
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	42
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	43 local NULL = {};
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	44
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	45 local api = {};
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	46
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	47 -- Returns the name of the current module
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	48 function api:get_name()
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	49 return self.name;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	50 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	51
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	52 -- Returns the host that the current module is serving
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	53 function api:get_host()
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	54 return self.host;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	55 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	56
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	57 function api:get_host_type()
5771 c4ed6680bf8d moduleapi: module:get_host_type() now returns 'global' for * and 'local' for non-components Matthew Wild <mwild1@gmail.com> parents: 5530 diff changeset	58 return (self.host == "*" and "global") or hosts[self.host].type or "local";
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	59 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	60
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	61 function api:set_global()
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	62 self.host = "*";
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	63 -- Update the logger
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	64 local _log = logger.init("mod_"..self.name);
6656 58c111a39d27 moduleapi: Add luacheck annotation Matthew Wild <mwild1@gmail.com> parents: 6655 diff changeset	65 self.log = function (self, ...) return _log(...); end; --luacheck: ignore self
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	66 self._log = _log;
4605 69746db53125 moduleapi: Set module.global = true when module:set_global() is called Matthew Wild <mwild1@gmail.com> parents: 4539 diff changeset	67 self.global = true;
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	68 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	69
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	70 function api:add_feature(xmlns)
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	71 self:add_item("feature", xmlns);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	72 end
6655 a99ed5f5f709 moduleapi: Minor variable renaming to avoid clashes with the 'type' function Matthew Wild <mwild1@gmail.com> parents: 6654 diff changeset	73 function api:add_identity(category, identity_type, name)
a99ed5f5f709 moduleapi: Minor variable renaming to avoid clashes with the 'type' function Matthew Wild <mwild1@gmail.com> parents: 6654 diff changeset	74 self:add_item("identity", {category = category, type = identity_type, name = name});
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	75 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	76 function api:add_extension(data)
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	77 self:add_item("extension", data);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	78 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	79
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	80 function api:fire_event(...)
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	81 return (hosts[self.host] or prosody).events.fire_event(...);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	82 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	83
4534 7a0a31c4f6c5 modulemanager, moduleapi: Replace hooks multitable with an event_handlers map stored in individual modules. Also adds module:hook_object_event() to hook events on any util.events compatible object. Matthew Wild <mwild1@gmail.com> parents: 4531 diff changeset	84 function api:hook_object_event(object, event, handler, priority)
4896 27cda15104f2 modulemanager, moduleapi: Turn module.event_handlers into a multitable and track object->event->handler associations correctly (thanks Zash) Matthew Wild <mwild1@gmail.com> parents: 4893 diff changeset	85 self.event_handlers:set(object, event, handler, true);
4534 7a0a31c4f6c5 modulemanager, moduleapi: Replace hooks multitable with an event_handlers map stored in individual modules. Also adds module:hook_object_event() to hook events on any util.events compatible object. Matthew Wild <mwild1@gmail.com> parents: 4531 diff changeset	86 return object.add_handler(event, handler, priority);
7a0a31c4f6c5 modulemanager, moduleapi: Replace hooks multitable with an event_handlers map stored in individual modules. Also adds module:hook_object_event() to hook events on any util.events compatible object. Matthew Wild <mwild1@gmail.com> parents: 4531 diff changeset	87 end
7a0a31c4f6c5 modulemanager, moduleapi: Replace hooks multitable with an event_handlers map stored in individual modules. Also adds module:hook_object_event() to hook events on any util.events compatible object. Matthew Wild <mwild1@gmail.com> parents: 4531 diff changeset	88
4708 0e324923ff95 moduleapi: Fix parameters to unhook_object_event() Matthew Wild <mwild1@gmail.com> parents: 4707 diff changeset	89 function api:unhook_object_event(object, event, handler)
6654 22a7ee3379bc moduleapi: Clear self.event_handlers when unhooking an event, to prevent leaks Matthew Wild <mwild1@gmail.com> parents: 6653 diff changeset	90 self.event_handlers:set(object, event, handler, nil);
4695 838ad61c6b2c moduleapi: Add module:unhook_object_event() Matthew Wild <mwild1@gmail.com> parents: 4666 diff changeset	91 return object.remove_handler(event, handler);
838ad61c6b2c moduleapi: Add module:unhook_object_event() Matthew Wild <mwild1@gmail.com> parents: 4666 diff changeset	92 end
838ad61c6b2c moduleapi: Add module:unhook_object_event() Matthew Wild <mwild1@gmail.com> parents: 4666 diff changeset	93
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	94 function api:hook(event, handler, priority)
4534 7a0a31c4f6c5 modulemanager, moduleapi: Replace hooks multitable with an event_handlers map stored in individual modules. Also adds module:hook_object_event() to hook events on any util.events compatible object. Matthew Wild <mwild1@gmail.com> parents: 4531 diff changeset	95 return self:hook_object_event((hosts[self.host] or prosody).events, event, handler, priority);
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	96 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	97
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	98 function api:hook_global(event, handler, priority)
4534 7a0a31c4f6c5 modulemanager, moduleapi: Replace hooks multitable with an event_handlers map stored in individual modules. Also adds module:hook_object_event() to hook events on any util.events compatible object. Matthew Wild <mwild1@gmail.com> parents: 4531 diff changeset	99 return self:hook_object_event(prosody.events, event, handler, priority);
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	100 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	101
4719 2087d42f1e77 moduleapi: Rename module:hook_stanza() -> module:hook_tag() (hook_stanza works for compat) Matthew Wild <mwild1@gmail.com> parents: 4718 diff changeset	102 function api:hook_tag(xmlns, name, handler, priority)
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	103 if not handler and type(name) == "function" then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	104 -- If only 2 options then they specified no xmlns
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	105 xmlns, name, handler, priority = nil, xmlns, name, handler;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	106 elseif not (handler and name) then
11921 89aef37fca54 core.moduleapi: Fix name of renamed API in log message Kim Alvefur <zash@zash.se> parents: 11823 diff changeset	107 self:log("warn", "Error: Insufficient parameters to module:hook_tag()");
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	108 return;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	109 end
7947 24170d74b00b core: Split some very long lines [luacheck] Kim Alvefur <zash@zash.se> parents: 7646 diff changeset	110 return self:hook("stanza/"..(xmlns and (xmlns..":") or "")..name,
24170d74b00b core: Split some very long lines [luacheck] Kim Alvefur <zash@zash.se> parents: 7646 diff changeset	111 function (data) return handler(data.origin, data.stanza, data); end, priority);
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	112 end
4719 2087d42f1e77 moduleapi: Rename module:hook_stanza() -> module:hook_tag() (hook_stanza works for compat) Matthew Wild <mwild1@gmail.com> parents: 4718 diff changeset	113 api.hook_stanza = api.hook_tag; -- COMPAT w/pre-0.9
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	114
5825 ac5e05ffc921 moduleapi: Add module:unhook() Matthew Wild <mwild1@gmail.com> parents: 5776 diff changeset	115 function api:unhook(event, handler)
ac5e05ffc921 moduleapi: Add module:unhook() Matthew Wild <mwild1@gmail.com> parents: 5776 diff changeset	116 return self:unhook_object_event((hosts[self.host] or prosody).events, event, handler);
ac5e05ffc921 moduleapi: Add module:unhook() Matthew Wild <mwild1@gmail.com> parents: 5776 diff changeset	117 end
ac5e05ffc921 moduleapi: Add module:unhook() Matthew Wild <mwild1@gmail.com> parents: 5776 diff changeset	118
6640 859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	119 function api:wrap_object_event(events_object, event, handler)
859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	120 return self:hook_object_event(assert(events_object.wrappers, "no wrappers"), event, handler);
859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	121 end
859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	122
859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	123 function api:wrap_event(event, handler)
859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	124 return self:wrap_object_event((hosts[self.host] or prosody).events, event, handler);
859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	125 end
859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	126
859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	127 function api:wrap_global(event, handler)
6652 06116b2789f0 moduleapi: Remove accidental use of undefined and unnecessary 'priority' variable Matthew Wild <mwild1@gmail.com> parents: 6651 diff changeset	128 return self:hook_object_event(prosody.events, event, handler);
6640 859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	129 end
859e9af53aa1 moduleapi: New methods for modules to conveniently wrap events Matthew Wild <mwild1@gmail.com> parents: 6639 diff changeset	130
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	131 function api:require(lib)
12253 57d35fcde488 modulemanager, moduleapi: Switch to new pluginloader interface Matthew Wild <mwild1@gmail.com> parents: 12095 diff changeset	132 local modulemanager = require"core.modulemanager";
57d35fcde488 modulemanager, moduleapi: Switch to new pluginloader interface Matthew Wild <mwild1@gmail.com> parents: 12095 diff changeset	133 local f, n = modulemanager.loader:load_code_ext(self.name, lib, "lib.lua", self.environment);
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	134 if not f then error("Failed to load plugin library '"..lib.."', error: "..n); end -- FIXME better error message
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	135 return f();
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	136 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	137
4538 d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	138 function api:depends(name)
6779 6236668da30a core.: Remove use of module() function Kim Alvefur <zash@zash.se>* parents: 6659 diff changeset	139 local modulemanager = require"core.modulemanager";
9556 e4c09e335bd9 moduleapi: Prevent loading disabled module as dependency of enabled one Kim Alvefur <zash@zash.se> parents: 9509 diff changeset	140 if self:get_option_inherited_set("modules_disabled", {}):contains(name) then
e4c09e335bd9 moduleapi: Prevent loading disabled module as dependency of enabled one Kim Alvefur <zash@zash.se> parents: 9509 diff changeset	141 error("Dependency on disabled module mod_"..name);
e4c09e335bd9 moduleapi: Prevent loading disabled module as dependency of enabled one Kim Alvefur <zash@zash.se> parents: 9509 diff changeset	142 end
4538 d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	143 if not self.dependencies then
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	144 self.dependencies = {};
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	145 self:hook("module-reloaded", function (event)
4854 dab55c6f7710 moduleapi: Don't auto-reload self when already reloading (fixes reload of modules with cyclic dependencies) Matthew Wild <mwild1@gmail.com> parents: 4790 diff changeset	146 if self.dependencies[event.module] and not self.reloading then
4538 d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	147 self:log("info", "Auto-reloading due to reload of %s:%s", event.host, event.module);
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	148 modulemanager.reload(self.host, self.name);
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	149 return;
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	150 end
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	151 end);
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	152 self:hook("module-unloaded", function (event)
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	153 if self.dependencies[event.module] then
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	154 self:log("info", "Auto-unloading due to unload of %s:%s", event.host, event.module);
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	155 modulemanager.unload(self.host, self.name);
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	156 end
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	157 end);
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	158 end
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	159 local mod = modulemanager.get_module(self.host, name) or modulemanager.get_module("*", name);
4707 d8fc9a1aabeb moduleapi: module:depends(): Don't load shared modules onto the current host if the current host is ''... Matthew Wild <mwild1@gmail.com>* parents: 4695 diff changeset	160 if mod and mod.module.host == "" and self.host ~= ""
d8fc9a1aabeb moduleapi: module:depends(): Don't load shared modules onto the current host if the current host is ''... Matthew Wild <mwild1@gmail.com>* parents: 4695 diff changeset	161 and modulemanager.module_has_method(mod, "add_host") then
5077 6c2c8bf36d22 moduleapi: Clarify comment Matthew Wild <mwild1@gmail.com> parents: 5053 diff changeset	162 mod = nil; -- Target is a shared module, so we still want to load it on our host
4663 24524d70a50a moduleapi: module:depends(): Load shared modules onto the current host even if they are loaded globally already Matthew Wild <mwild1@gmail.com> parents: 4661 diff changeset	163 end
4538 d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	164 if not mod then
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	165 local err;
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	166 mod, err = modulemanager.load(self.host, name);
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	167 if not mod then
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	168 return error(("Unable to load required module, mod_%s: %s"):format(name, ((err or "unknown error"):gsub("%-", " ")) ));
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	169 end
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	170 end
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	171 self.dependencies[name] = true;
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	172 return mod;
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	173 end
d0a89c1c43fd moduleapi: Add module:depends(), a way to safely depend upon another module at runtime Matthew Wild <mwild1@gmail.com> parents: 4534 diff changeset	174
9149 d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	175 local function get_shared_table_from_path(module, tables, path)
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	176 if path:sub(1,1) ~= "/" then -- Prepend default components
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	177 local default_path_components = { module.host, module.name };
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	178 local n_components = select(2, path:gsub("/", "%1"));
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	179 path = (n_components<#default_path_components and "/" or "")
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	180 ..t_concat(default_path_components, "/", 1, #default_path_components-n_components).."/"..path;
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	181 end
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	182 local shared = tables[path];
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	183 if not shared then
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	184 shared = {};
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	185 if path:match("%-cache$") then
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	186 setmetatable(shared, { __mode = "kv" });
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	187 end
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	188 tables[path] = shared;
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	189 end
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	190 return shared;
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	191 end
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	192
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	193 -- Returns a shared table at the specified virtual path
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	194 -- Intentionally does not allow the table to be _set_, it
4539 3cbfa768eb06 moduleapi: Add module:shared(), a way to easily share data between multiple loaded modules Matthew Wild <mwild1@gmail.com> parents: 4538 diff changeset	195 -- is auto-created if it does not exist.
9149 d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	196 function api:shared(path)
4651 d1739d72100a moduleapi: Have modules internally store a reference to shared tables they use, to ensure they don't get collected while any module that had access to that table is still loaded (thanks Zash) Matthew Wild <mwild1@gmail.com> parents: 4614 diff changeset	197 if not self.shared_data then self.shared_data = {}; end
9149 d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	198 local shared = get_shared_table_from_path(self, shared_data, path);
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	199 self.shared_data[path] = shared;
d03f21729b2c moduleapi: Remove multiple-parameters feature from module:shared() Matthew Wild <mwild1@gmail.com> parents: 9042 diff changeset	200 return shared;
4539 3cbfa768eb06 moduleapi: Add module:shared(), a way to easily share data between multiple loaded modules Matthew Wild <mwild1@gmail.com> parents: 4538 diff changeset	201 end
3cbfa768eb06 moduleapi: Add module:shared(), a way to easily share data between multiple loaded modules Matthew Wild <mwild1@gmail.com> parents: 4538 diff changeset	202
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	203 function api:get_option(name, default_value)
8993 bd9b67f742c9 moduleapi: Lazy-load configmanager on demand simplify dependency graph Kim Alvefur <zash@zash.se> parents: 8533 diff changeset	204 local config = require "core.configmanager";
5377 898454038524 core.: Complete removal of all traces of the "core" section and section-related code. Kim Alvefur <zash@zash.se>* parents: 5163 diff changeset	205 local value = config.get(self.host, name);
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	206 if value == nil then
5377 898454038524 core.: Complete removal of all traces of the "core" section and section-related code. Kim Alvefur <zash@zash.se>* parents: 5163 diff changeset	207 value = default_value;
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	208 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	209 return value;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	210 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	211
7975 c64ddee9d671 core.moduleapi: Factor out code for getting a scalar config option Kim Alvefur <zash@zash.se> parents: 7947 diff changeset	212 function api:get_option_scalar(name, default_value)
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	213 local value = self:get_option(name, default_value);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	214 if type(value) == "table" then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	215 if #value > 1 then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	216 self:log("error", "Config option '%s' does not take a list, using just the first item", name);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	217 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	218 value = value[1];
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	219 end
7975 c64ddee9d671 core.moduleapi: Factor out code for getting a scalar config option Kim Alvefur <zash@zash.se> parents: 7947 diff changeset	220 return value;
c64ddee9d671 core.moduleapi: Factor out code for getting a scalar config option Kim Alvefur <zash@zash.se> parents: 7947 diff changeset	221 end
c64ddee9d671 core.moduleapi: Factor out code for getting a scalar config option Kim Alvefur <zash@zash.se> parents: 7947 diff changeset	222
c64ddee9d671 core.moduleapi: Factor out code for getting a scalar config option Kim Alvefur <zash@zash.se> parents: 7947 diff changeset	223 function api:get_option_string(name, default_value)
c64ddee9d671 core.moduleapi: Factor out code for getting a scalar config option Kim Alvefur <zash@zash.se> parents: 7947 diff changeset	224 local value = self:get_option_scalar(name, default_value);
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	225 if value == nil then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	226 return nil;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	227 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	228 return tostring(value);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	229 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	230
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	231 function api:get_option_number(name, ...)
7975 c64ddee9d671 core.moduleapi: Factor out code for getting a scalar config option Kim Alvefur <zash@zash.se> parents: 7947 diff changeset	232 local value = self:get_option_scalar(name, ...);
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	233 local ret = tonumber(value);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	234 if value ~= nil and ret == nil then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	235 self:log("error", "Config option '%s' not understood, expecting a number", name);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	236 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	237 return ret;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	238 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	239
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	240 function api:get_option_boolean(name, ...)
7975 c64ddee9d671 core.moduleapi: Factor out code for getting a scalar config option Kim Alvefur <zash@zash.se> parents: 7947 diff changeset	241 local value = self:get_option_scalar(name, ...);
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	242 if value == nil then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	243 return nil;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	244 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	245 local ret = value == true or value == "true" or value == 1 or nil;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	246 if ret == nil then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	247 ret = (value == false or value == "false" or value == 0);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	248 if ret then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	249 ret = false;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	250 else
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	251 ret = nil;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	252 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	253 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	254 if ret == nil then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	255 self:log("error", "Config option '%s' not understood, expecting true/false", name);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	256 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	257 return ret;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	258 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	259
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	260 function api:get_option_array(name, ...)
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	261 local value = self:get_option(name, ...);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	262
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	263 if value == nil then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	264 return nil;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	265 end
5776 bd0ff8ae98a8 Remove all trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 5771 diff changeset	266
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	267 if type(value) ~= "table" then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	268 return array{ value }; -- Assume any non-list is a single-item list
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	269 end
5776 bd0ff8ae98a8 Remove all trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 5771 diff changeset	270
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	271 return array():append(value); -- Clone
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	272 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	273
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	274 function api:get_option_set(name, ...)
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	275 local value = self:get_option_array(name, ...);
5776 bd0ff8ae98a8 Remove all trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 5771 diff changeset	276
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	277 if value == nil then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	278 return nil;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	279 end
5776 bd0ff8ae98a8 Remove all trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 5771 diff changeset	280
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	281 return set.new(value);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	282 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	283
5527 7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	284 function api:get_option_inherited_set(name, ...)
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	285 local value = self:get_option_set(name, ...);
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	286 local global_value = self:context("*"):get_option_set(name, ...);
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	287 if not value then
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	288 return global_value;
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	289 elseif not global_value then
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	290 return value;
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	291 end
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	292 value:include(global_value);
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	293 return value;
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	294 end
7e7f45f587a1 moduleapi: Add module:get_option_inherited_set() to return a set that inherits items from a globally set set, if set Matthew Wild <mwild1@gmail.com> parents: 5526 diff changeset	295
7127 27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	296 function api:get_option_path(name, default, parent)
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	297 if parent == nil then
9509 b57353f76c83 core.moduleapi: Remove redundant condition Kim Alvefur <zash@zash.se> parents: 9149 diff changeset	298 parent = self:get_directory();
7127 27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	299 elseif prosody.paths[parent] then
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	300 parent = prosody.paths[parent];
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	301 end
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	302 local value = self:get_option_string(name, default);
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	303 if value == nil then
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	304 return nil;
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	305 end
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	306 return resolve_relative_path(parent, value);
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	307 end
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	308
27557dd7b460 moduleapi: Add API method for getting a file path Kim Alvefur <zash@zash.se> parents: 7115 diff changeset	309
5526 d54011a23b20 moduleapi: Add module:context(host) to produce a fake API context for a given host (or global). module:context(""):get_option("foo") to get global options. Matthew Wild <mwild1@gmail.com>* parents: 5498 diff changeset	310 function api:context(host)
12479 4d36fbcdd210 core.moduleapi: Fix 'global' property via :context() - #1748 Kim Alvefur <zash@zash.se> parents: 12253 diff changeset	311 return setmetatable({ host = host or "", global = "" == host }, { __index = self, __newindex = self });
5526 d54011a23b20 moduleapi: Add module:context(host) to produce a fake API context for a given host (or global). module:context(""):get_option("foo") to get global options. Matthew Wild <mwild1@gmail.com>* parents: 5498 diff changeset	312 end
d54011a23b20 moduleapi: Add module:context(host) to produce a fake API context for a given host (or global). module:context(""):get_option("foo") to get global options. Matthew Wild <mwild1@gmail.com>* parents: 5498 diff changeset	313
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	314 function api:add_item(key, value)
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	315 self.items = self.items or {};
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	316 self.items[key] = self.items[key] or {};
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	317 t_insert(self.items[key], value);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	318 self:fire_event("item-added/"..key, {source = self, item = value});
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	319 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	320 function api:remove_item(key, value)
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	321 local t = self.items and self.items[key] or NULL;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	322 for i = #t,1,-1 do
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	323 if t[i] == value then
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	324 t_remove(self.items[key], i);
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	325 self:fire_event("item-removed/"..key, {source = self, item = value});
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	326 return value;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	327 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	328 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	329 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	330
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	331 function api:get_host_items(key)
6779 6236668da30a core.: Remove use of module() function Kim Alvefur <zash@zash.se>* parents: 6659 diff changeset	332 local modulemanager = require"core.modulemanager";
5412 a5fcda77c6b1 moduleapi: have get_host_items wrap on get_items from modulemanager, also add has_{feature/identity} to the API. Marco Cirillo <maranda@lightwitch.org> parents: 5377 diff changeset	333 local result = modulemanager.get_items(key, self.host) or {};
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	334 return result;
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	335 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	336
6655 a99ed5f5f709 moduleapi: Minor variable renaming to avoid clashes with the 'type' function Matthew Wild <mwild1@gmail.com> parents: 6654 diff changeset	337 function api:handle_items(item_type, added_cb, removed_cb, existing)
a99ed5f5f709 moduleapi: Minor variable renaming to avoid clashes with the 'type' function Matthew Wild <mwild1@gmail.com> parents: 6654 diff changeset	338 self:hook("item-added/"..item_type, added_cb);
a99ed5f5f709 moduleapi: Minor variable renaming to avoid clashes with the 'type' function Matthew Wild <mwild1@gmail.com> parents: 6654 diff changeset	339 self:hook("item-removed/"..item_type, removed_cb);
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	340 if existing ~= false then
6655 a99ed5f5f709 moduleapi: Minor variable renaming to avoid clashes with the 'type' function Matthew Wild <mwild1@gmail.com> parents: 6654 diff changeset	341 for _, item in ipairs(self:get_host_items(item_type)) do
4531 c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	342 added_cb({ item = item });
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	343 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	344 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	345 end
c778ce7e3c78 modulemanager: Move in-module API functions to core.moduleapi (half the file size, yay) Matthew Wild <mwild1@gmail.com> parents: diff changeset	346
4613 27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	347 function api:provides(name, item)
5529 af58eea131b4 moduleapi: module:provides called without an item makes a copy of the environment instead. Fixes warnings about non-existent globals Kim Alvefur <zash@zash.se> parents: 5527 diff changeset	348 -- if not item then item = setmetatable({}, { __index = function(t,k) return rawget(self.environment, k); end }); end
af58eea131b4 moduleapi: module:provides called without an item makes a copy of the environment instead. Fixes warnings about non-existent globals Kim Alvefur <zash@zash.se> parents: 5527 diff changeset	349 if not item then
af58eea131b4 moduleapi: module:provides called without an item makes a copy of the environment instead. Fixes warnings about non-existent globals Kim Alvefur <zash@zash.se> parents: 5527 diff changeset	350 item = {}
af58eea131b4 moduleapi: module:provides called without an item makes a copy of the environment instead. Fixes warnings about non-existent globals Kim Alvefur <zash@zash.se> parents: 5527 diff changeset	351 for k,v in pairs(self.environment) do
af58eea131b4 moduleapi: module:provides called without an item makes a copy of the environment instead. Fixes warnings about non-existent globals Kim Alvefur <zash@zash.se> parents: 5527 diff changeset	352 if k ~= "module" then item[k] = v; end
af58eea131b4 moduleapi: module:provides called without an item makes a copy of the environment instead. Fixes warnings about non-existent globals Kim Alvefur <zash@zash.se> parents: 5527 diff changeset	353 end
af58eea131b4 moduleapi: module:provides called without an item makes a copy of the environment instead. Fixes warnings about non-existent globals Kim Alvefur <zash@zash.se> parents: 5527 diff changeset	354 end
4613 27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	355 if not item.name then
4660 96b40b5e8ea8 moduleapi: module:provides(): Fix usage of wrong table Matthew Wild <mwild1@gmail.com> parents: 4651 diff changeset	356 local item_name = self.name;
4613 27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	357 -- Strip a provider prefix to find the item name
27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	358 -- (e.g. "auth_foo" -> "foo" for an auth provider)
12095 c1d2bc6603ae moduleapi: Support stripping of multi-word from module names Matthew Wild <mwild1@gmail.com> parents: 12002 diff changeset	359 if item_name:find((name:gsub("%-", "_")).."_", 1, true) == 1 then
4613 27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	360 item_name = item_name:sub(#name+2);
27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	361 end
27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	362 item.name = item_name;
27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	363 end
5530 d83482fc4a81 moduleapi: in module:provides(), add the name of the module in item._provided_by Kim Alvefur <zash@zash.se> parents: 5529 diff changeset	364 item._provided_by = self.name;
4661 76db5d0a2104 moduleapi: module:provides(): Add "-provider" onto the key name Matthew Wild <mwild1@gmail.com> parents: 4660 diff changeset	365 self:add_item(name.."-provider", item);
4613 27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	366 end
27fbc9c69eb5 moduleapi: Add module:provides(), a shortcut to add an item with the current module's name Matthew Wild <mwild1@gmail.com> parents: 4605 diff changeset	367
7342 79a5db780e8b moduleapi: Allow an origin session to be passed to module:send() Kim Alvefur <zash@zash.se> parents: 7163 diff changeset	368 function api:send(stanza, origin)
79a5db780e8b moduleapi: Allow an origin session to be passed to module:send() Kim Alvefur <zash@zash.se> parents: 7163 diff changeset	369 return core_post_stanza(origin or hosts[self.host], stanza);
4614 20940729c1b4 moduleapi: Add module:send() as an alias for core_post_stanza() from the current host's origin Matthew Wild <mwild1@gmail.com> parents: 4613 diff changeset	370 end
20940729c1b4 moduleapi: Add module:send() as an alias for core_post_stanza() from the current host's origin Matthew Wild <mwild1@gmail.com> parents: 4613 diff changeset	371
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	372 function api:send_iq(stanza, origin, timeout)
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	373 local iq_cache = self._iq_cache;
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	374 if not iq_cache then
9747 c8240f931a68 core.moduleapi: Move util imports to top Kim Alvefur <zash@zash.se> parents: 9733 diff changeset	375 iq_cache = cache.new(256, function (_, iq)
10576 f88f1151bc72 core.moduleapi: Rename local name for util.error for consistency Kim Alvefur <zash@zash.se> parents: 10575 diff changeset	376 iq.reject(errors.new({
9748 99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	377 type = "wait", condition = "resource-constraint",
99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	378 text = "evicted from iq tracking cache"
99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	379 }));
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	380 end);
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	381 self._iq_cache = iq_cache;
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	382 end
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	383
10214 f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	384 local event_type;
10595 17bab303daf5 core.moduleapi: Hook correct event type in some cases Kim Alvefur <zash@zash.se> parents: 10576 diff changeset	385 if not jid_node(stanza.attr.from) then
10214 f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	386 event_type = "host";
11822 bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	387 elseif jid_resource(stanza.attr.from) then
bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	388 event_type = "full";
10214 f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	389 else -- assume bare since we can't hook full jids
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	390 event_type = "bare";
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	391 end
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	392 local result_event = "iq-result/"..event_type.."/"..stanza.attr.id;
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	393 local error_event = "iq-error/"..event_type.."/"..stanza.attr.id;
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	394 local cache_key = event_type.."/"..stanza.attr.id;
11822 bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	395 if event_type == "full" then
bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	396 result_event = "iq/" .. event_type;
bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	397 error_event = "iq/" .. event_type;
bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	398 end
10214 f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	399
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	400 local p = promise.new(function (resolve, reject)
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	401 local function result_handler(event)
11822 bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	402 local response = event.stanza;
bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	403 if response.attr.type == "result" and response.attr.from == stanza.attr.to and response.attr.id == stanza.attr.id then
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	404 resolve(event);
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	405 return true;
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	406 end
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	407 end
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	408
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	409 local function error_handler(event)
11822 bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	410 local response = event.stanza;
bdabb0425d77 core.moduleapi: Enable full JID origin queries with module:send_iq() Kim Alvefur <zash@zash.se> parents: 11821 diff changeset	411 if response.attr.type == "error" and response.attr.from == stanza.attr.to and response.attr.id == stanza.attr.id then
10576 f88f1151bc72 core.moduleapi: Rename local name for util.error for consistency Kim Alvefur <zash@zash.se> parents: 10575 diff changeset	412 reject(errors.from_stanza(event.stanza, event));
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	413 return true;
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	414 end
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	415 end
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	416
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	417 if iq_cache:get(cache_key) then
10576 f88f1151bc72 core.moduleapi: Rename local name for util.error for consistency Kim Alvefur <zash@zash.se> parents: 10575 diff changeset	418 reject(errors.new({
9748 99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	419 type = "modify", condition = "conflict",
10213 ee62754b0233 core.moduleapi: Uppercase "IQ stanza" for consistency Kim Alvefur <zash@zash.se> parents: 9930 diff changeset	420 text = "IQ stanza id attribute already used",
9748 99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	421 }));
99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	422 return;
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	423 end
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	424
11823 36a7a3137d41 core.moduleapi: Ensure module:send_iq() handler priority over mod_iq Kim Alvefur <zash@zash.se> parents: 11822 diff changeset	425 self:hook(result_event, result_handler, 1);
36a7a3137d41 core.moduleapi: Ensure module:send_iq() handler priority over mod_iq Kim Alvefur <zash@zash.se> parents: 11822 diff changeset	426 self:hook(error_event, error_handler, 1);
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	427
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	428 local timeout_handle = self:add_timer(timeout or 120, function ()
10576 f88f1151bc72 core.moduleapi: Rename local name for util.error for consistency Kim Alvefur <zash@zash.se> parents: 10575 diff changeset	429 reject(errors.new({
9748 99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	430 type = "wait", condition = "remote-server-timeout",
99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	431 text = "IQ stanza timed out",
99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	432 }));
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	433 end);
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	434
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	435 local ok = iq_cache:set(cache_key, {
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	436 reject = reject, resolve = resolve,
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	437 timeout_handle = timeout_handle,
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	438 result_handler = result_handler, error_handler = error_handler;
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	439 });
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	440
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	441 if not ok then
10576 f88f1151bc72 core.moduleapi: Rename local name for util.error for consistency Kim Alvefur <zash@zash.se> parents: 10575 diff changeset	442 reject(errors.new({
9748 99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	443 type = "wait", condition = "internal-server-error",
99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	444 text = "Could not store IQ tracking data"
99199b53019f core.moduleapi: Use util.error for :send_iq errors Kim Alvefur <zash@zash.se> parents: 9747 diff changeset	445 }));
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	446 return;
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	447 end
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	448
10705 2cffb5ce9f7a moduleapi: Fix handling of replies to :send_iq from internal modules Kim Alvefur <zash@zash.se> parents: 10595 diff changeset	449 local wrapped_origin = setmetatable({
2cffb5ce9f7a moduleapi: Fix handling of replies to :send_iq from internal modules Kim Alvefur <zash@zash.se> parents: 10595 diff changeset	450 -- XXX Needed in some cases for replies to work correctly when sending queries internally.
10706 0230ceecb8a9 moduleapi: Rename argument to silence luacheck Kim Alvefur <zash@zash.se> parents: 10705 diff changeset	451 send = function (reply)
11821 a9ad287c3388 core.moduleapi: Filter out unrelated direct replies to module:send_iq Kim Alvefur <zash@zash.se> parents: 11523 diff changeset	452 if reply.name == stanza.name and reply.attr.id == stanza.attr.id then
a9ad287c3388 core.moduleapi: Filter out unrelated direct replies to module:send_iq Kim Alvefur <zash@zash.se> parents: 11523 diff changeset	453 resolve({ stanza = reply });
a9ad287c3388 core.moduleapi: Filter out unrelated direct replies to module:send_iq Kim Alvefur <zash@zash.se> parents: 11523 diff changeset	454 end
a9ad287c3388 core.moduleapi: Filter out unrelated direct replies to module:send_iq Kim Alvefur <zash@zash.se> parents: 11523 diff changeset	455 return (origin or hosts[self.host]).send(reply)
10705 2cffb5ce9f7a moduleapi: Fix handling of replies to :send_iq from internal modules Kim Alvefur <zash@zash.se> parents: 10595 diff changeset	456 end;
2cffb5ce9f7a moduleapi: Fix handling of replies to :send_iq from internal modules Kim Alvefur <zash@zash.se> parents: 10595 diff changeset	457 }, {
2cffb5ce9f7a moduleapi: Fix handling of replies to :send_iq from internal modules Kim Alvefur <zash@zash.se> parents: 10595 diff changeset	458 __index = origin or hosts[self.host];
2cffb5ce9f7a moduleapi: Fix handling of replies to :send_iq from internal modules Kim Alvefur <zash@zash.se> parents: 10595 diff changeset	459 });
2cffb5ce9f7a moduleapi: Fix handling of replies to :send_iq from internal modules Kim Alvefur <zash@zash.se> parents: 10595 diff changeset	460
2cffb5ce9f7a moduleapi: Fix handling of replies to :send_iq from internal modules Kim Alvefur <zash@zash.se> parents: 10595 diff changeset	461 self:send(stanza, wrapped_origin);
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	462 end);
10214 f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	463
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	464 p:finally(function ()
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	465 local iq = iq_cache:get(cache_key);
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	466 if iq then
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	467 self:unhook(result_event, iq.result_handler);
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	468 self:unhook(error_event, iq.error_handler);
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	469 iq.timeout_handle:stop();
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	470 iq_cache:set(cache_key, nil);
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	471 end
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	472 end);
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	473
f864e685e618 core.moduleapi: Restructure send_iq method for more atomic cleanup Kim Alvefur <zash@zash.se> parents: 10213 diff changeset	474 return p;
9733 9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	475 end
9ab9aabafa80 core.moduleapi: Add a promise-based API for tracking IQ stanzas (fixes #714) Kim Alvefur <zash@zash.se> parents: 9686 diff changeset	476
6651 deaa3d66dc2c moduleapi: Add module:broadcast() to send a stanza to a list of JIDs Matthew Wild <mwild1@gmail.com> parents: 6640 diff changeset	477 function api:broadcast(jids, stanza, iter)
deaa3d66dc2c moduleapi: Add module:broadcast() to send a stanza to a list of JIDs Matthew Wild <mwild1@gmail.com> parents: 6640 diff changeset	478 for jid in (iter or it.values)(jids) do
deaa3d66dc2c moduleapi: Add module:broadcast() to send a stanza to a list of JIDs Matthew Wild <mwild1@gmail.com> parents: 6640 diff changeset	479 local new_stanza = st.clone(stanza);
deaa3d66dc2c moduleapi: Add module:broadcast() to send a stanza to a list of JIDs Matthew Wild <mwild1@gmail.com> parents: 6640 diff changeset	480 new_stanza.attr.to = jid;
9042 734ba7080b35 moduleapi: Use :send API from :broadcast for compactness Kim Alvefur <zash@zash.se> parents: 8994 diff changeset	481 self:send(new_stanza);
6651 deaa3d66dc2c moduleapi: Add module:broadcast() to send a stanza to a list of JIDs Matthew Wild <mwild1@gmail.com> parents: 6640 diff changeset	482 end
deaa3d66dc2c moduleapi: Add module:broadcast() to send a stanza to a list of JIDs Matthew Wild <mwild1@gmail.com> parents: 6640 diff changeset	483 end
deaa3d66dc2c moduleapi: Add module:broadcast() to send a stanza to a list of JIDs Matthew Wild <mwild1@gmail.com> parents: 6640 diff changeset	484
5899 26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	485 local timer_methods = { }
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	486 local timer_mt = {
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	487 __index = timer_methods;
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	488 }
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	489 function timer_methods:stop( )
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	490 timer.stop(self.id);
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	491 end
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	492 timer_methods.disarm = timer_methods.stop
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	493 function timer_methods:reschedule(delay)
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	494 timer.reschedule(self.id, delay)
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	495 end
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	496
7142 67226eaef97c moduleapi: Silence luacheck warning about unused 'id' parameter Matthew Wild <mwild1@gmail.com> parents: 7141 diff changeset	497 local function timer_callback(now, id, t) --luacheck: ignore 212/id
5899 26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	498 if t.module_env.loaded == false then return; end
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	499 return t.callback(now, unpack(t, 1, t.n));
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	500 end
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	501
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	502 function api:add_timer(delay, callback, ...)
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	503 local t = pack(...)
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	504 t.module_env = self;
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	505 t.callback = callback;
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	506 t.id = timer.add_task(delay, timer_callback, t);
26f54b462601 core/moduleapi: Return timer object from module:add_timer daurnimator <quae@daurnimator.com> parents: 5825 diff changeset	507 return setmetatable(t, timer_mt);
4666 fb522fbd495e moduleapi: Add module:add_timer(delay, callback) - automatically halts the timer on module unload Matthew Wild <mwild1@gmail.com> parents: 4663 diff changeset	508 end
fb522fbd495e moduleapi: Add module:add_timer(delay, callback) - automatically halts the timer on module unload Matthew Wild <mwild1@gmail.com> parents: 4663 diff changeset	509
11987 4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	510 function api:cron(task_spec)
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	511 self:depends("cron");
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	512 self:add_item("task", task_spec);
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	513 end
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	514
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	515 function api:hourly(name, fun)
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	516 if type(name) == "function" then fun, name = name, nil; end
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	517 self:cron({ name = name; when = "hourly"; run = fun });
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	518 end
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	519
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	520 function api:daily(name, fun)
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	521 if type(name) == "function" then fun, name = name, nil; end
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	522 self:cron({ name = name; when = "daily"; run = fun });
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	523 end
4b519c575ad0 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron Kim Alvefur <zash@zash.se> parents: 11931 diff changeset	524
12002 cbed7d8d8f35 mod_cron: Add a 'weekly' job frequency Kim Alvefur <zash@zash.se> parents: 11987 diff changeset	525 function api:weekly(name, fun)
cbed7d8d8f35 mod_cron: Add a 'weekly' job frequency Kim Alvefur <zash@zash.se> parents: 11987 diff changeset	526 if type(name) == "function" then fun, name = name, nil; end
cbed7d8d8f35 mod_cron: Add a 'weekly' job frequency Kim Alvefur <zash@zash.se> parents: 11987 diff changeset	527 self:cron({ name = name; when = "weekly"; run = fun });
cbed7d8d8f35 mod_cron: Add a 'weekly' job frequency Kim Alvefur <zash@zash.se> parents: 11987 diff changeset	528 end
cbed7d8d8f35 mod_cron: Add a 'weekly' job frequency Kim Alvefur <zash@zash.se> parents: 11987 diff changeset	529
4790 8bf710b19f65 moduleapi: Add module:get_directory() to get module file's directory, and module:load_resource() to load a file relative to that directory Matthew Wild <mwild1@gmail.com> parents: 4750 diff changeset	530 local path_sep = package.config:sub(1,1);
8bf710b19f65 moduleapi: Add module:get_directory() to get module file's directory, and module:load_resource() to load a file relative to that directory Matthew Wild <mwild1@gmail.com> parents: 4750 diff changeset	531 function api:get_directory()
11148 1dc49accb58e core.moduleapi: Return resource path from module:get_directory() (API BC) Kim Alvefur <zash@zash.se> parents: 11146 diff changeset	532 return self.resource_path or self.path and (self.path:gsub("%"..path_sep.."[^"..path_sep.."]*$", "")) or nil;
4790 8bf710b19f65 moduleapi: Add module:get_directory() to get module file's directory, and module:load_resource() to load a file relative to that directory Matthew Wild <mwild1@gmail.com> parents: 4750 diff changeset	533 end
8bf710b19f65 moduleapi: Add module:get_directory() to get module file's directory, and module:load_resource() to load a file relative to that directory Matthew Wild <mwild1@gmail.com> parents: 4750 diff changeset	534
8bf710b19f65 moduleapi: Add module:get_directory() to get module file's directory, and module:load_resource() to load a file relative to that directory Matthew Wild <mwild1@gmail.com> parents: 4750 diff changeset	535 function api:load_resource(path, mode)
11148 1dc49accb58e core.moduleapi: Return resource path from module:get_directory() (API BC) Kim Alvefur <zash@zash.se> parents: 11146 diff changeset	536 path = resolve_relative_path(self:get_directory(), path);
4790 8bf710b19f65 moduleapi: Add module:get_directory() to get module file's directory, and module:load_resource() to load a file relative to that directory Matthew Wild <mwild1@gmail.com> parents: 4750 diff changeset	537 return io.open(path, mode);
8bf710b19f65 moduleapi: Add module:get_directory() to get module file's directory, and module:load_resource() to load a file relative to that directory Matthew Wild <mwild1@gmail.com> parents: 4750 diff changeset	538 end
8bf710b19f65 moduleapi: Add module:get_directory() to get module file's directory, and module:load_resource() to load a file relative to that directory Matthew Wild <mwild1@gmail.com> parents: 4750 diff changeset	539
6655 a99ed5f5f709 moduleapi: Minor variable renaming to avoid clashes with the 'type' function Matthew Wild <mwild1@gmail.com> parents: 6654 diff changeset	540 function api:open_store(name, store_type)
12662 07424992d7fc mod_authz_internal, and more: New iteration of role API Matthew Wild <mwild1@gmail.com> parents: 12652 diff changeset	541 if self.host == "*" then return nil, "global-storage-not-supported"; end
6655 a99ed5f5f709 moduleapi: Minor variable renaming to avoid clashes with the 'type' function Matthew Wild <mwild1@gmail.com> parents: 6654 diff changeset	542 return require"core.storagemanager".open(self.host, name or self.name, store_type);
5496 7a0b81b5ca71 moduleapi: Add module:open_store() as a front-end to storagemanager.open() Matthew Wild <mwild1@gmail.com> parents: 5434 diff changeset	543 end
7a0b81b5ca71 moduleapi: Add module:open_store() as a front-end to storagemanager.open() Matthew Wild <mwild1@gmail.com> parents: 5434 diff changeset	544
10885 2f751880767c core.moduleapi: Allow passing a config table trough :measure Kim Alvefur <zash@zash.se> parents: 10706 diff changeset	545 function api:measure(name, stat_type, conf)
8994 f17e768c1a99 moduleapi: Lazy-load statsmanager on demand Kim Alvefur <zash@zash.se> parents: 8993 diff changeset	546 local measure = require "core.statsmanager".measure;
11523 5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	547 local fixed_label_key, fixed_label_value
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	548 if self.host ~= "*" then
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	549 fixed_label_key = "host"
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	550 fixed_label_value = self.host
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	551 end
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	552 -- new_legacy_metric takes care of scoping for us, as it does not accept
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	553 -- an array of labels
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	554 -- the prosody_ prefix is automatically added by statsmanager for legacy
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	555 -- metrics.
11931 c65d5da8e99a mod_admin_shell: List collected metrics in module:info Kim Alvefur <zash@zash.se> parents: 11921 diff changeset	556 self:add_item("measure", { name = name, type = stat_type, conf = conf });
11523 5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	557 return measure(stat_type, "mod_"..self.name.."/"..name, conf, fixed_label_key, fixed_label_value)
6556 74253c7beb9c moduleapi: Module API for statsmanager Matthew Wild <mwild1@gmail.com> parents: 6422 diff changeset	558 end
74253c7beb9c moduleapi: Module API for statsmanager Matthew Wild <mwild1@gmail.com> parents: 6422 diff changeset	559
11523 5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	560 function api:metric(type_, name, unit, description, label_keys, conf)
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	561 local metric = require "core.statsmanager".metric;
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	562 local is_scoped = self.host ~= "*"
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	563 if is_scoped then
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	564 -- prepend `host` label to label keys if this is not a global module
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	565 local orig_labels = label_keys
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	566 label_keys = array { "host" }
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	567 label_keys:append(orig_labels)
6639 3003d041c159 moduleapi: Experimental API for modules to measure the rate+duration of events Matthew Wild <mwild1@gmail.com> parents: 6556 diff changeset	568 end
11523 5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	569 local mf = metric(type_, "prosody_mod_"..self.name.."/"..name, unit, description, label_keys, conf)
11931 c65d5da8e99a mod_admin_shell: List collected metrics in module:info Kim Alvefur <zash@zash.se> parents: 11921 diff changeset	570 self:add_item("metric", { name = name, mf = mf });
11523 5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	571 if is_scoped then
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	572 -- make sure to scope the returned metric family to the current host
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	573 return mf:with_partial_label(self.host)
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	574 end
5f15ab7c6ae5 Statistics: Rewrite statistics backends to use OpenMetrics Jonas Schäfer <jonas@wielicki.name> parents: 11148 diff changeset	575 return mf
6639 3003d041c159 moduleapi: Experimental API for modules to measure the rate+duration of events Matthew Wild <mwild1@gmail.com> parents: 6556 diff changeset	576 end
3003d041c159 moduleapi: Experimental API for modules to measure the rate+duration of events Matthew Wild <mwild1@gmail.com> parents: 6556 diff changeset	577
9866 09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	578 local status_priorities = { error = 3, warn = 2, info = 1, core = 0 };
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	579
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	580 function api:set_status(status_type, status_message, override)
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	581 local priority = status_priorities[status_type];
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	582 if not priority then
12874 b9468c8ac1d3 core.moduleapi: Fix passing variable to logging Kim Alvefur <zash@zash.se> parents: 12690 diff changeset	583 self:log("error", "set_status: Invalid status type '%s', assuming 'info'", status_type);
9866 09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	584 status_type, priority = "info", status_priorities.info;
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	585 end
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	586 local current_priority = status_priorities[self.status_type] or 0;
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	587 -- By default an 'error' status can only be overwritten by another 'error' status
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	588 if (current_priority >= status_priorities.error and priority < current_priority and override ~= true)
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	589 or (override == false and current_priority > priority) then
9930 12a31296d63d moduleapi: Log suppressed status priority and message when not overriding Matthew Wild <mwild1@gmail.com> parents: 9929 diff changeset	590 self:log("debug", "moduleapi: ignoring status [prio %d override %s]: %s", priority, override, status_message);
9866 09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	591 return;
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	592 end
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	593 self.status_type, self.status_message, self.status_time = status_type, status_message, time_now();
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	594 self:fire_event("module-status/updated", { name = self.name });
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	595 end
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	596
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	597 function api:log_status(level, msg, ...)
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	598 self:set_status(level, format(msg, ...));
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	599 return self:log(level, msg, ...);
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	600 end
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	601
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	602 function api:get_status()
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	603 return self.status_type, self.status_message, self.status_time;
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	604 end
09cc8c856e5e moduleapi: New API for modules to set a status Matthew Wild <mwild1@gmail.com> parents: 9750 diff changeset	605
12642 9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	606 function api:default_permission(role_name, permission)
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	607 permission = permission:gsub("^:", self.name..":");
12650 e08bf2ad67da moduleapi: Distribute permissions set from global modules to all hosts Kim Alvefur <zash@zash.se> parents: 12645 diff changeset	608 if self.host == "*" then
e08bf2ad67da moduleapi: Distribute permissions set from global modules to all hosts Kim Alvefur <zash@zash.se> parents: 12645 diff changeset	609 for _, host in pairs(hosts) do
e08bf2ad67da moduleapi: Distribute permissions set from global modules to all hosts Kim Alvefur <zash@zash.se> parents: 12645 diff changeset	610 if host.authz then
e08bf2ad67da moduleapi: Distribute permissions set from global modules to all hosts Kim Alvefur <zash@zash.se> parents: 12645 diff changeset	611 host.authz.add_default_permission(role_name, permission);
e08bf2ad67da moduleapi: Distribute permissions set from global modules to all hosts Kim Alvefur <zash@zash.se> parents: 12645 diff changeset	612 end
e08bf2ad67da moduleapi: Distribute permissions set from global modules to all hosts Kim Alvefur <zash@zash.se> parents: 12645 diff changeset	613 end
e08bf2ad67da moduleapi: Distribute permissions set from global modules to all hosts Kim Alvefur <zash@zash.se> parents: 12645 diff changeset	614 return
e08bf2ad67da moduleapi: Distribute permissions set from global modules to all hosts Kim Alvefur <zash@zash.se> parents: 12645 diff changeset	615 end
12642 9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	616 hosts[self.host].authz.add_default_permission(role_name, permission);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	617 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	618
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	619 function api:default_permissions(role_name, permissions)
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	620 for _, permission in ipairs(permissions) do
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	621 self:default_permission(role_name, permission);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	622 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	623 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	624
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	625 function api:may(action, context)
12645 a741183eec97 core.moduleapi: Expand permission name ':' prefix earlier Kim Alvefur <zash@zash.se> parents: 12644 diff changeset	626 if action:byte(1) == 58 then -- action begins with ':'
a741183eec97 core.moduleapi: Expand permission name ':' prefix earlier Kim Alvefur <zash@zash.se> parents: 12644 diff changeset	627 action = self.name..action; -- prepend module name
a741183eec97 core.moduleapi: Expand permission name ':' prefix earlier Kim Alvefur <zash@zash.se> parents: 12644 diff changeset	628 end
12642 9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	629 if type(context) == "string" then -- check JID permissions
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	630 local role;
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	631 local node, host = jid_split(context);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	632 if host == self.host then
12662 07424992d7fc mod_authz_internal, and more: New iteration of role API Matthew Wild <mwild1@gmail.com> parents: 12652 diff changeset	633 role = hosts[host].authz.get_user_role(node);
12642 9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	634 else
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	635 role = hosts[self.host].authz.get_jid_role(context);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	636 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	637 if not role then
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	638 self:log("debug", "Access denied: JID <%s> may not %s (no role found)", context, action);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	639 return false;
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	640 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	641 local permit = role:may(action);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	642 if not permit then
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	643 self:log("debug", "Access denied: JID <%s> may not %s (not permitted by role %s)", context, action, role.name);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	644 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	645 return permit;
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	646 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	647
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	648 local session = context.origin or context.session;
12652 30e2a0107217 moduleapi: Stricter type check for actor in permission check Kim Alvefur <zash@zash.se> parents: 12651 diff changeset	649 if type(session) ~= "table" then
12642 9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	650 error("Unable to identify actor session from context");
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	651 end
12690 546c7e0f3f31 core.moduleapi: Check for local role-aware sessions before e.g. s2s Kim Alvefur <zash@zash.se> parents: 12662 diff changeset	652 if session.role and session.type == "c2s" and session.host == self.host then
546c7e0f3f31 core.moduleapi: Check for local role-aware sessions before e.g. s2s Kim Alvefur <zash@zash.se> parents: 12662 diff changeset	653 local permit = session.role:may(action, context);
546c7e0f3f31 core.moduleapi: Check for local role-aware sessions before e.g. s2s Kim Alvefur <zash@zash.se> parents: 12662 diff changeset	654 if not permit then
546c7e0f3f31 core.moduleapi: Check for local role-aware sessions before e.g. s2s Kim Alvefur <zash@zash.se> parents: 12662 diff changeset	655 self:log("debug", "Access denied: session %s (%s) may not %s (not permitted by role %s)",
546c7e0f3f31 core.moduleapi: Check for local role-aware sessions before e.g. s2s Kim Alvefur <zash@zash.se> parents: 12662 diff changeset	656 session.id, session.full_jid, action, session.role.name
546c7e0f3f31 core.moduleapi: Check for local role-aware sessions before e.g. s2s Kim Alvefur <zash@zash.se> parents: 12662 diff changeset	657 );
546c7e0f3f31 core.moduleapi: Check for local role-aware sessions before e.g. s2s Kim Alvefur <zash@zash.se> parents: 12662 diff changeset	658 end
546c7e0f3f31 core.moduleapi: Check for local role-aware sessions before e.g. s2s Kim Alvefur <zash@zash.se> parents: 12662 diff changeset	659 return permit;
546c7e0f3f31 core.moduleapi: Check for local role-aware sessions before e.g. s2s Kim Alvefur <zash@zash.se> parents: 12662 diff changeset	660 else
12642 9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	661 local actor_jid = context.stanza.attr.from;
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	662 local role = hosts[self.host].authz.get_jid_role(actor_jid);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	663 if not role then
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	664 self:log("debug", "Access denied: JID <%s> may not %s (no role found)", actor_jid, action);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	665 return false;
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	666 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	667 local permit = role:may(action, context);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	668 if not permit then
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	669 self:log("debug", "Access denied: JID <%s> may not %s (not permitted by role %s)", actor_jid, action, role.name);
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	670 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	671 return permit;
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	672 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	673 end
9061f9621330 Switch to a new role-based authorization framework, removing is_admin() Matthew Wild <mwild1@gmail.com> parents: 12590 diff changeset	674
6422 6d4d87a89026 core.module{manager,api}: Fix for 010b141e91ed (Thanks v1ct0r) Kim Alvefur <zash@zash.se> parents: 6415 diff changeset	675 return api;

prosody

8473a516004f

core/moduleapi.lua

Software / code / prosody

Annotate

core/moduleapi.lua @ 12905:8473a516004f

Software `/` code `/` prosody