2 -- Copyright (C) 2008-2012 Matthew Wild
3 -- Copyright (C) 2008-2012 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
9 local config = require "core.configmanager";
10 local modulemanager = require "modulemanager"; -- This is necessary to avoid require loops
11 local array = require "util.array";
12 local set = require "util.set";
13 local logger = require "util.logger";
14 local pluginloader = require "util.pluginloader";
15 local timer = require "util.timer";
17 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
18 local error, setmetatable, type = error, setmetatable, type;
19 local ipairs, pairs, select = ipairs, pairs, select;
20 local tonumber, tostring = tonumber, tostring;
21 local pack = table.pack or function(...) return {n=select("#",...), ...}; end -- table.pack is only in 5.2
22 local unpack = table.unpack or unpack; -- renamed in 5.2
24 local prosody = prosody;
25 local hosts = prosody.hosts;
27 -- FIXME: This assert() is to try and catch an obscure bug (2013-04-05)
28 local core_post_stanza = assert(prosody.core_post_stanza,
29 "prosody.core_post_stanza is nil, please report this as a bug");
31 -- Registry of shared module data
32 local shared_data = setmetatable({}, { __mode = "v" });
38 -- Returns the name of the current module
39 function api:get_name()
43 -- Returns the host that the current module is serving
44 function api:get_host()
48 function api:get_host_type()
49 return (self.host == "*" and "global") or hosts[self.host].type or "local";
52 function api:set_global()
55 local _log = logger.init("mod_"..self.name);
56 self.log = function (self, ...) return _log(...); end;
61 function api:add_feature(xmlns)
62 self:add_item("feature", xmlns);
64 function api:add_identity(category, type, name)
65 self:add_item("identity", {category = category, type = type, name = name});
67 function api:add_extension(data)
68 self:add_item("extension", data);
70 function api:has_feature(xmlns)
71 for _, feature in ipairs(self:get_host_items("feature")) do
72 if feature == xmlns then return true; end
76 function api:has_identity(category, type, name)
77 for _, id in ipairs(self:get_host_items("identity")) do
78 if id.category == category and id.type == type and id.name == name then
85 function api:fire_event(...)
86 return (hosts[self.host] or prosody).events.fire_event(...);
89 function api:hook_object_event(object, event, handler, priority)
90 self.event_handlers:set(object, event, handler, true);
91 return object.add_handler(event, handler, priority);
94 function api:unhook_object_event(object, event, handler)
95 return object.remove_handler(event, handler);
98 function api:hook(event, handler, priority)
99 return self:hook_object_event((hosts[self.host] or prosody).events, event, handler, priority);
102 function api:hook_global(event, handler, priority)
103 return self:hook_object_event(prosody.events, event, handler, priority);
106 function api:hook_tag(xmlns, name, handler, priority)
107 if not handler and type(name) == "function" then
108 -- If only 2 options then they specified no xmlns
109 xmlns, name, handler, priority = nil, xmlns, name, handler;
110 elseif not (handler and name) then
111 self:log("warn", "Error: Insufficient parameters to module:hook_stanza()");
114 return self:hook("stanza/"..(xmlns and (xmlns..":") or "")..name, function (data) return handler(data.origin, data.stanza, data); end, priority);
116 api.hook_stanza = api.hook_tag; -- COMPAT w/pre-0.9
118 function api:unhook(event, handler)
119 return self:unhook_object_event((hosts[self.host] or prosody).events, event, handler);
122 function api:require(lib)
123 local f, n = pluginloader.load_code(self.name, lib..".lib.lua", self.environment);
125 f, n = pluginloader.load_code(lib, lib..".lib.lua", self.environment);
127 if not f then error("Failed to load plugin library '"..lib.."', error: "..n); end -- FIXME better error message
131 function api:depends(name)
132 if not self.dependencies then
133 self.dependencies = {};
134 self:hook("module-reloaded", function (event)
135 if self.dependencies[event.module] and not self.reloading then
136 self:log("info", "Auto-reloading due to reload of %s:%s", event.host, event.module);
137 modulemanager.reload(self.host, self.name);
141 self:hook("module-unloaded", function (event)
142 if self.dependencies[event.module] then
143 self:log("info", "Auto-unloading due to unload of %s:%s", event.host, event.module);
144 modulemanager.unload(self.host, self.name);
148 local mod = modulemanager.get_module(self.host, name) or modulemanager.get_module("*", name);
149 if mod and mod.module.host == "*" and self.host ~= "*"
150 and modulemanager.module_has_method(mod, "add_host") then
151 mod = nil; -- Target is a shared module, so we still want to load it on our host
155 mod, err = modulemanager.load(self.host, name);
157 return error(("Unable to load required module, mod_%s: %s"):format(name, ((err or "unknown error"):gsub("%-", " ")) ));
160 self.dependencies[name] = true;
164 -- Returns one or more shared tables at the specified virtual paths
165 -- Intentionally does not allow the table at a path to be _set_, it
166 -- is auto-created if it does not exist.
167 function api:shared(...)
168 if not self.shared_data then self.shared_data = {}; end
169 local paths = { n = select("#", ...), ... };
170 local data_array = {};
171 local default_path_components = { self.host, self.name };
172 for i = 1, paths.n do
173 local path = paths[i];
174 if path:sub(1,1) ~= "/" then -- Prepend default components
175 local n_components = select(2, path:gsub("/", "%1"));
176 path = (n_components<#default_path_components and "/" or "")..t_concat(default_path_components, "/", 1, #default_path_components-n_components).."/"..path;
178 local shared = shared_data[path];
181 if path:match("%-cache$") then
182 setmetatable(shared, { __mode = "kv" });
184 shared_data[path] = shared;
186 t_insert(data_array, shared);
187 self.shared_data[path] = shared;
189 return unpack(data_array);
192 function api:get_option(name, default_value)
193 local value = config.get(self.host, name);
195 value = default_value;
200 function api:get_option_string(name, default_value)
201 local value = self:get_option(name, default_value);
202 if type(value) == "table" then
204 self:log("error", "Config option '%s' does not take a list, using just the first item", name);
211 return tostring(value);
214 function api:get_option_number(name, ...)
215 local value = self:get_option(name, ...);
216 if type(value) == "table" then
218 self:log("error", "Config option '%s' does not take a list, using just the first item", name);
222 local ret = tonumber(value);
223 if value ~= nil and ret == nil then
224 self:log("error", "Config option '%s' not understood, expecting a number", name);
229 function api:get_option_boolean(name, ...)
230 local value = self:get_option(name, ...);
231 if type(value) == "table" then
233 self:log("error", "Config option '%s' does not take a list, using just the first item", name);
240 local ret = value == true or value == "true" or value == 1 or nil;
242 ret = (value == false or value == "false" or value == 0);
250 self:log("error", "Config option '%s' not understood, expecting true/false", name);
255 function api:get_option_array(name, ...)
256 local value = self:get_option(name, ...);
262 if type(value) ~= "table" then
263 return array{ value }; -- Assume any non-list is a single-item list
266 return array():append(value); -- Clone
269 function api:get_option_set(name, ...)
270 local value = self:get_option_array(name, ...);
276 return set.new(value);
279 function api:get_option_inherited_set(name, ...)
280 local value = self:get_option_set(name, ...);
281 local global_value = self:context("*"):get_option_set(name, ...);
284 elseif not global_value then
287 value:include(global_value);
291 function api:context(host)
292 return setmetatable({host=host or "*"}, {__index=self,__newindex=self});
295 function api:add_item(key, value)
296 self.items = self.items or {};
297 self.items[key] = self.items[key] or {};
298 t_insert(self.items[key], value);
299 self:fire_event("item-added/"..key, {source = self, item = value});
301 function api:remove_item(key, value)
302 local t = self.items and self.items[key] or NULL;
304 if t[i] == value then
305 t_remove(self.items[key], i);
306 self:fire_event("item-removed/"..key, {source = self, item = value});
312 function api:get_host_items(key)
313 local result = modulemanager.get_items(key, self.host) or {};
317 function api:handle_items(type, added_cb, removed_cb, existing)
318 self:hook("item-added/"..type, added_cb);
319 self:hook("item-removed/"..type, removed_cb);
320 if existing ~= false then
321 for _, item in ipairs(self:get_host_items(type)) do
322 added_cb({ item = item });
327 function api:provides(name, item)
328 -- if not item then item = setmetatable({}, { __index = function(t,k) return rawget(self.environment, k); end }); end
331 for k,v in pairs(self.environment) do
332 if k ~= "module" then item[k] = v; end
335 if not item.name then
336 local item_name = self.name;
337 -- Strip a provider prefix to find the item name
338 -- (e.g. "auth_foo" -> "foo" for an auth provider)
339 if item_name:find(name.."_", 1, true) == 1 then
340 item_name = item_name:sub(#name+2);
342 item.name = item_name;
344 item._provided_by = self.name;
345 self:add_item(name.."-provider", item);
348 function api:send(stanza)
349 return core_post_stanza(hosts[self.host], stanza);
352 local timer_methods = { }
354 __index = timer_methods;
356 function timer_methods:stop( )
359 timer_methods.disarm = timer_methods.stop
360 function timer_methods:reschedule(delay)
361 timer.reschedule(self.id, delay)
364 local function timer_callback(now, id, t)
365 if t.module_env.loaded == false then return; end
366 return t.callback(now, unpack(t, 1, t.n));
369 function api:add_timer(delay, callback, ...)
372 t.callback = callback;
373 t.id = timer.add_task(delay, timer_callback, t);
374 return setmetatable(t, timer_mt);
377 local path_sep = package.config:sub(1,1);
378 function api:get_directory()
379 return self.path and (self.path:gsub("%"..path_sep.."[^"..path_sep.."]*$", "")) or nil;
382 function api:load_resource(path, mode)
383 path = config.resolve_relative_path(self:get_directory(), path);
384 return io.open(path, mode);
387 function api:open_store(name, type)
388 return storagemanager.open(self.host, name or self.name, type);