prosodyctl: Fix import of util.iterators
[prosody.git] / core / moduleapi.lua
index ee960709e117f1683e2d0f5d05e32d42d6c3504b..57367255a32d285321a09225f3d0719ab8c23502 100644 (file)
@@ -12,6 +12,7 @@ local array = require "util.array";
 local set = require "util.set";
 local logger = require "util.logger";
 local pluginloader = require "util.pluginloader";
+local timer = require "util.timer";
 
 local multitable_new = require "util.multitable".new;
 
@@ -22,6 +23,7 @@ local tonumber, tostring = tonumber, tostring;
 
 local prosody = prosody;
 local hosts = prosody.hosts;
+local core_post_stanza = prosody.core_post_stanza;
 
 -- Registry of shared module data
 local shared_data = setmetatable({}, { __mode = "v" });
@@ -41,7 +43,7 @@ function api:get_host()
 end
 
 function api:get_host_type()
-       return hosts[self.host].type;
+       return self.host ~= "*" and hosts[self.host].type or nil;
 end
 
 function api:set_global()
@@ -50,6 +52,7 @@ function api:set_global()
        local _log = logger.init("mod_"..self.name);
        self.log = function (self, ...) return _log(...); end;
        self._log = _log;
+       self.global = true;
 end
 
 function api:add_feature(xmlns)
@@ -66,17 +69,24 @@ function api:fire_event(...)
        return (hosts[self.host] or prosody).events.fire_event(...);
 end
 
+function api:hook_object_event(object, event, handler, priority)
+       self.event_handlers[handler] = { name = event, priority = priority, object = object };
+       return object.add_handler(event, handler, priority);
+end
+
+function api:unhook_object_event(object, event, handler)
+       return object.remove_handler(event, handler);
+end
+
 function api:hook(event, handler, priority)
-       hooks:set(self.host, self.name, event, handler, true);
-       (hosts[self.host] or prosody).events.add_handler(event, handler, priority);
+       return self:hook_object_event((hosts[self.host] or prosody).events, event, handler, priority);
 end
 
 function api:hook_global(event, handler, priority)
-       hooks:set("*", self.name, event, handler, true);
-       prosody.events.add_handler(event, handler, priority);
+       return self:hook_object_event(prosody.events, event, handler, priority);
 end
 
-function api:hook_stanza(xmlns, name, handler, priority)
+function api:hook_tag(xmlns, name, handler, priority)
        if not handler and type(name) == "function" then
                -- If only 2 options then they specified no xmlns
                xmlns, name, handler, priority = nil, xmlns, name, handler;
@@ -86,6 +96,7 @@ function api:hook_stanza(xmlns, name, handler, priority)
        end
        return self:hook("stanza/"..(xmlns and (xmlns..":") or "")..name, function (data) return handler(data.origin, data.stanza, data); end, priority);
 end
+api.hook_stanza = api.hook_tag; -- COMPAT w/pre-0.9
 
 function api:require(lib)
        local f, n = pluginloader.load_code(self.name, lib..".lib.lua");
@@ -97,6 +108,64 @@ function api:require(lib)
        return f();
 end
 
+function api:depends(name)
+       if not self.dependencies then
+               self.dependencies = {};
+               self:hook("module-reloaded", function (event)
+                       if self.dependencies[event.module] then
+                               self:log("info", "Auto-reloading due to reload of %s:%s", event.host, event.module);
+                               modulemanager.reload(self.host, self.name);
+                               return;
+                       end
+               end);
+               self:hook("module-unloaded", function (event)
+                       if self.dependencies[event.module] then
+                               self:log("info", "Auto-unloading due to unload of %s:%s", event.host, event.module);
+                               modulemanager.unload(self.host, self.name);
+                       end
+               end);
+       end
+       local mod = modulemanager.get_module(self.host, name) or modulemanager.get_module("*", name);
+       if mod and mod.module.host == "*" and self.host ~= "*"
+       and modulemanager.module_has_method(mod, "add_host") then
+               mod = nil; -- This is a shared module, so we still want to load it on our host
+       end
+       if not mod then
+               local err;
+               mod, err = modulemanager.load(self.host, name);
+               if not mod then
+                       return error(("Unable to load required module, mod_%s: %s"):format(name, ((err or "unknown error"):gsub("%-", " ")) ));
+               end
+       end
+       self.dependencies[name] = true;
+       return mod;
+end
+
+-- Returns one or more shared tables at the specified virtual paths
+-- Intentionally does not allow the table at a path to be _set_, it
+-- is auto-created if it does not exist.
+function api:shared(...)
+       if not self.shared_data then self.shared_data = {}; end
+       local paths = { n = select("#", ...), ... };
+       local data_array = {};
+       local default_path_components = { self.host, self.name };
+       for i = 1, paths.n do
+               local path = paths[i];
+               if path:sub(1,1) ~= "/" then -- Prepend default components
+                       local n_components = select(2, path:gsub("/", "%1"));
+                       path = (n_components<#default_path_components and "/" or "")..t_concat(default_path_components, "/", 1, #default_path_components-n_components).."/"..path;
+               end
+               local shared = shared_data[path];
+               if not shared then
+                       shared = {};
+                       shared_data[path] = shared;
+               end
+               t_insert(data_array, shared);
+               self.shared_data[path] = shared;
+       end
+       return unpack(data_array);
+end
+
 function api:get_option(name, default_value)
        local value = config.get(self.host, self.name, name);
        if value == nil then
@@ -187,7 +256,6 @@ function api:get_option_set(name, ...)
        return set.new(value);
 end
 
-local module_items = multitable_new();
 function api:add_item(key, value)
        self.items = self.items or {};
        self.items[key] = self.items[key] or {};
@@ -236,4 +304,39 @@ function api:handle_items(type, added_cb, removed_cb, existing)
        end
 end
 
+function api:provides(name, item)
+       if not item then item = self.environment; end
+       if not item.name then
+               local item_name = self.name;
+               -- Strip a provider prefix to find the item name
+               -- (e.g. "auth_foo" -> "foo" for an auth provider)
+               if item_name:find(name.."_", 1, true) == 1 then
+                       item_name = item_name:sub(#name+2);
+               end
+               item.name = item_name;
+       end
+       self:add_item(name.."-provider", item);
+end
+
+function api:send(stanza)
+       return core_post_stanza(hosts[self.host], stanza);
+end
+
+function api:add_timer(delay, callback)
+       return timer.add_task(delay, function (t)
+               if self.loaded == false then return; end
+               return callback(t);
+       end);
+end
+
+local path_sep = package.config:sub(1,1);
+function api:get_directory()
+       return self.path and (self.path:gsub("%"..path_sep.."[^"..path_sep.."]*$", "")) or nil;
+end
+
+function api:load_resource(path, mode)
+       path = config.resolve_relative_path(self:get_directory(), path);
+       return io.open(path, mode);
+end
+
 return api;