core/moduleapi.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2012 Matthew Wild
   3 -- Copyright (C) 2008-2012 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   9 local array = require "util.array";
  10 local set = require "util.set";
  11 local it = require "util.iterators";
  12 local logger = require "util.logger";
  13 local pluginloader = require "util.pluginloader";
  14 local timer = require "util.timer";
  15 local resolve_relative_path = require"util.paths".resolve_relative_path;
  16 local st = require "util.stanza";
  17 local cache = require "util.cache";
  18 local errutil = require "util.error";
  19 local promise = require "util.promise";
  20 local time_now = require "util.time".now;
  21 local format = require "util.format".format;
  22
  23 local t_insert, t_remove, t_concat = table.insert, table.remove, table.concat;
  24 local error, setmetatable, type = error, setmetatable, type;
  25 local ipairs, pairs, select = ipairs, pairs, select;
  26 local tonumber, tostring = tonumber, tostring;
  27 local require = require;
  28 local pack = table.pack or require "util.table".pack; -- table.pack is only in 5.2
  29 local unpack = table.unpack or unpack; --luacheck: ignore 113 -- renamed in 5.2
  30
  31 local prosody = prosody;
  32 local hosts = prosody.hosts;
  33
  34 -- FIXME: This assert() is to try and catch an obscure bug (2013-04-05)
  35 local core_post_stanza = assert(prosody.core_post_stanza,
  36         "prosody.core_post_stanza is nil, please report this as a bug");
  37
  38 -- Registry of shared module data
  39 local shared_data = setmetatable({}, { __mode = "v" });
  40
  41 local NULL = {};
  42
  43 local api = {};
  44
  45 -- Returns the name of the current module
  46 function api:get_name()
  47         return self.name;
  48 end
  49
  50 -- Returns the host that the current module is serving
  51 function api:get_host()
  52         return self.host;
  53 end
  54
  55 function api:get_host_type()
  56         return (self.host == "*" and "global") or hosts[self.host].type or "local";
  57 end
  58
  59 function api:set_global()
  60         self.host = "*";
  61         -- Update the logger
  62         local _log = logger.init("mod_"..self.name);
  63         self.log = function (self, ...) return _log(...); end; --luacheck: ignore self
  64         self._log = _log;
  65         self.global = true;
  66 end
  67
  68 function api:add_feature(xmlns)
  69         self:add_item("feature", xmlns);
  70 end
  71 function api:add_identity(category, identity_type, name)
  72         self:add_item("identity", {category = category, type = identity_type, name = name});
  73 end
  74 function api:add_extension(data)
  75         self:add_item("extension", data);
  76 end
  77
  78 function api:fire_event(...)
  79         return (hosts[self.host] or prosody).events.fire_event(...);
  80 end
  81
  82 function api:hook_object_event(object, event, handler, priority)
  83         self.event_handlers:set(object, event, handler, true);
  84         return object.add_handler(event, handler, priority);
  85 end
  86
  87 function api:unhook_object_event(object, event, handler)
  88         self.event_handlers:set(object, event, handler, nil);
  89         return object.remove_handler(event, handler);
  90 end
  91
  92 function api:hook(event, handler, priority)
  93         return self:hook_object_event((hosts[self.host] or prosody).events, event, handler, priority);
  94 end
  95
  96 function api:hook_global(event, handler, priority)
  97         return self:hook_object_event(prosody.events, event, handler, priority);
  98 end
  99
 100 function api:hook_tag(xmlns, name, handler, priority)
 101         if not handler and type(name) == "function" then
 102                 -- If only 2 options then they specified no xmlns
 103                 xmlns, name, handler, priority = nil, xmlns, name, handler;
 104         elseif not (handler and name) then
 105                 self:log("warn", "Error: Insufficient parameters to module:hook_stanza()");
 106                 return;
 107         end
 108         return self:hook("stanza/"..(xmlns and (xmlns..":") or "")..name,
 109                 function (data) return handler(data.origin, data.stanza, data); end, priority);
 110 end
 111 api.hook_stanza = api.hook_tag; -- COMPAT w/pre-0.9
 112
 113 function api:unhook(event, handler)
 114         return self:unhook_object_event((hosts[self.host] or prosody).events, event, handler);
 115 end
 116
 117 function api:wrap_object_event(events_object, event, handler)
 118         return self:hook_object_event(assert(events_object.wrappers, "no wrappers"), event, handler);
 119 end
 120
 121 function api:wrap_event(event, handler)
 122         return self:wrap_object_event((hosts[self.host] or prosody).events, event, handler);
 123 end
 124
 125 function api:wrap_global(event, handler)
 126         return self:hook_object_event(prosody.events, event, handler);
 127 end
 128
 129 function api:require(lib)
 130         local f, n = pluginloader.load_code_ext(self.name, lib, "lib.lua", self.environment);
 131         if not f then error("Failed to load plugin library '"..lib.."', error: "..n); end -- FIXME better error message
 132         return f();
 133 end
 134
 135 function api:depends(name)
 136         local modulemanager = require"core.modulemanager";
 137         if self:get_option_inherited_set("modules_disabled", {}):contains(name) then
 138                 error("Dependency on disabled module mod_"..name);
 139         end
 140         if not self.dependencies then
 141                 self.dependencies = {};
 142                 self:hook("module-reloaded", function (event)
 143                         if self.dependencies[event.module] and not self.reloading then
 144                                 self:log("info", "Auto-reloading due to reload of %s:%s", event.host, event.module);
 145                                 modulemanager.reload(self.host, self.name);
 146                                 return;
 147                         end
 148                 end);
 149                 self:hook("module-unloaded", function (event)
 150                         if self.dependencies[event.module] then
 151                                 self:log("info", "Auto-unloading due to unload of %s:%s", event.host, event.module);
 152                                 modulemanager.unload(self.host, self.name);
 153                         end
 154                 end);
 155         end
 156         local mod = modulemanager.get_module(self.host, name) or modulemanager.get_module("*", name);
 157         if mod and mod.module.host == "*" and self.host ~= "*"
 158         and modulemanager.module_has_method(mod, "add_host") then
 159                 mod = nil; -- Target is a shared module, so we still want to load it on our host
 160         end
 161         if not mod then
 162                 local err;
 163                 mod, err = modulemanager.load(self.host, name);
 164                 if not mod then
 165                         return error(("Unable to load required module, mod_%s: %s"):format(name, ((err or "unknown error"):gsub("%-", " ")) ));
 166                 end
 167         end
 168         self.dependencies[name] = true;
 169         return mod;
 170 end
 171
 172 local function get_shared_table_from_path(module, tables, path)
 173         if path:sub(1,1) ~= "/" then -- Prepend default components
 174                 local default_path_components = { module.host, module.name };
 175                 local n_components = select(2, path:gsub("/", "%1"));
 176                 path = (n_components<#default_path_components and "/" or "")
 177                         ..t_concat(default_path_components, "/", 1, #default_path_components-n_components).."/"..path;
 178         end
 179         local shared = tables[path];
 180         if not shared then
 181                 shared = {};
 182                 if path:match("%-cache$") then
 183                         setmetatable(shared, { __mode = "kv" });
 184                 end
 185                 tables[path] = shared;
 186         end
 187         return shared;
 188 end
 189
 190 -- Returns a shared table at the specified virtual path
 191 -- Intentionally does not allow the table to be _set_, it
 192 -- is auto-created if it does not exist.
 193 function api:shared(path)
 194         if not self.shared_data then self.shared_data = {}; end
 195         local shared = get_shared_table_from_path(self, shared_data, path);
 196         self.shared_data[path] = shared;
 197         return shared;
 198 end
 199
 200 function api:get_option(name, default_value)
 201         local config = require "core.configmanager";
 202         local value = config.get(self.host, name);
 203         if value == nil then
 204                 value = default_value;
 205         end
 206         return value;
 207 end
 208
 209 function api:get_option_scalar(name, default_value)
 210         local value = self:get_option(name, default_value);
 211         if type(value) == "table" then
 212                 if #value > 1 then
 213                         self:log("error", "Config option '%s' does not take a list, using just the first item", name);
 214                 end
 215                 value = value[1];
 216         end
 217         return value;
 218 end
 219
 220 function api:get_option_string(name, default_value)
 221         local value = self:get_option_scalar(name, default_value);
 222         if value == nil then
 223                 return nil;
 224         end
 225         return tostring(value);
 226 end
 227
 228 function api:get_option_number(name, ...)
 229         local value = self:get_option_scalar(name, ...);
 230         local ret = tonumber(value);
 231         if value ~= nil and ret == nil then
 232                 self:log("error", "Config option '%s' not understood, expecting a number", name);
 233         end
 234         return ret;
 235 end
 236
 237 function api:get_option_boolean(name, ...)
 238         local value = self:get_option_scalar(name, ...);
 239         if value == nil then
 240                 return nil;
 241         end
 242         local ret = value == true or value == "true" or value == 1 or nil;
 243         if ret == nil then
 244                 ret = (value == false or value == "false" or value == 0);
 245                 if ret then
 246                         ret = false;
 247                 else
 248                         ret = nil;
 249                 end
 250         end
 251         if ret == nil then
 252                 self:log("error", "Config option '%s' not understood, expecting true/false", name);
 253         end
 254         return ret;
 255 end
 256
 257 function api:get_option_array(name, ...)
 258         local value = self:get_option(name, ...);
 259
 260         if value == nil then
 261                 return nil;
 262         end
 263
 264         if type(value) ~= "table" then
 265                 return array{ value }; -- Assume any non-list is a single-item list
 266         end
 267
 268         return array():append(value); -- Clone
 269 end
 270
 271 function api:get_option_set(name, ...)
 272         local value = self:get_option_array(name, ...);
 273
 274         if value == nil then
 275                 return nil;
 276         end
 277
 278         return set.new(value);
 279 end
 280
 281 function api:get_option_inherited_set(name, ...)
 282         local value = self:get_option_set(name, ...);
 283         local global_value = self:context("*"):get_option_set(name, ...);
 284         if not value then
 285                 return global_value;
 286         elseif not global_value then
 287                 return value;
 288         end
 289         value:include(global_value);
 290         return value;
 291 end
 292
 293 function api:get_option_path(name, default, parent)
 294         if parent == nil then
 295                 parent = self:get_directory();
 296         elseif prosody.paths[parent] then
 297                 parent = prosody.paths[parent];
 298         end
 299         local value = self:get_option_string(name, default);
 300         if value == nil then
 301                 return nil;
 302         end
 303         return resolve_relative_path(parent, value);
 304 end
 305
 306
 307 function api:context(host)
 308         return setmetatable({host=host or "*"}, {__index=self,__newindex=self});
 309 end
 310
 311 function api:add_item(key, value)
 312         self.items = self.items or {};
 313         self.items[key] = self.items[key] or {};
 314         t_insert(self.items[key], value);
 315         self:fire_event("item-added/"..key, {source = self, item = value});
 316 end
 317 function api:remove_item(key, value)
 318         local t = self.items and self.items[key] or NULL;
 319         for i = #t,1,-1 do
 320                 if t[i] == value then
 321                         t_remove(self.items[key], i);
 322                         self:fire_event("item-removed/"..key, {source = self, item = value});
 323                         return value;
 324                 end
 325         end
 326 end
 327
 328 function api:get_host_items(key)
 329         local modulemanager = require"core.modulemanager";
 330         local result = modulemanager.get_items(key, self.host) or {};
 331         return result;
 332 end
 333
 334 function api:handle_items(item_type, added_cb, removed_cb, existing)
 335         self:hook("item-added/"..item_type, added_cb);
 336         self:hook("item-removed/"..item_type, removed_cb);
 337         if existing ~= false then
 338                 for _, item in ipairs(self:get_host_items(item_type)) do
 339                         added_cb({ item = item });
 340                 end
 341         end
 342 end
 343
 344 function api:provides(name, item)
 345         -- if not item then item = setmetatable({}, { __index = function(t,k) return rawget(self.environment, k); end }); end
 346         if not item then
 347                 item = {}
 348                 for k,v in pairs(self.environment) do
 349                         if k ~= "module" then item[k] = v; end
 350                 end
 351         end
 352         if not item.name then
 353                 local item_name = self.name;
 354                 -- Strip a provider prefix to find the item name
 355                 -- (e.g. "auth_foo" -> "foo" for an auth provider)
 356                 if item_name:find(name.."_", 1, true) == 1 then
 357                         item_name = item_name:sub(#name+2);
 358                 end
 359                 item.name = item_name;
 360         end
 361         item._provided_by = self.name;
 362         self:add_item(name.."-provider", item);
 363 end
 364
 365 function api:send(stanza, origin)
 366         return core_post_stanza(origin or hosts[self.host], stanza);
 367 end
 368
 369 function api:send_iq(stanza, origin, timeout)
 370         local iq_cache = self._iq_cache;
 371         if not iq_cache then
 372                 iq_cache = cache.new(256, function (_, iq)
 373                         iq.reject(errutil.new({
 374                                 type = "wait", condition = "resource-constraint",
 375                                 text = "evicted from iq tracking cache"
 376                         }));
 377                 end);
 378                 self._iq_cache = iq_cache;
 379         end
 380
 381         local event_type;
 382         if stanza.attr.from == self.host then
 383                 event_type = "host";
 384         else -- assume bare since we can't hook full jids
 385                 event_type = "bare";
 386         end
 387         local result_event = "iq-result/"..event_type.."/"..stanza.attr.id;
 388         local error_event = "iq-error/"..event_type.."/"..stanza.attr.id;
 389         local cache_key = event_type.."/"..stanza.attr.id;
 390
 391         local p = promise.new(function (resolve, reject)
 392                 local function result_handler(event)
 393                         if event.stanza.attr.from == stanza.attr.to then
 394                                 resolve(event);
 395                                 return true;
 396                         end
 397                 end
 398
 399                 local function error_handler(event)
 400                         if event.stanza.attr.from == stanza.attr.to then
 401                                 reject(errutil.from_stanza(event.stanza), event);
 402                                 return true;
 403                         end
 404                 end
 405
 406                 if iq_cache:get(cache_key) then
 407                         reject(errutil.new({
 408                                 type = "modify", condition = "conflict",
 409                                 text = "IQ stanza id attribute already used",
 410                         }));
 411                         return;
 412                 end
 413
 414                 self:hook(result_event, result_handler);
 415                 self:hook(error_event, error_handler);
 416
 417                 local timeout_handle = self:add_timer(timeout or 120, function ()
 418                         reject(errutil.new({
 419                                 type = "wait", condition = "remote-server-timeout",
 420                                 text = "IQ stanza timed out",
 421                         }));
 422                 end);
 423
 424                 local ok = iq_cache:set(cache_key, {
 425                         reject = reject, resolve = resolve,
 426                         timeout_handle = timeout_handle,
 427                         result_handler = result_handler, error_handler = error_handler;
 428                 });
 429
 430                 if not ok then
 431                         reject(errutil.new({
 432                                 type = "wait", condition = "internal-server-error",
 433                                 text = "Could not store IQ tracking data"
 434                         }));
 435                         return;
 436                 end
 437
 438                 self:send(stanza, origin);
 439         end);
 440
 441         p:finally(function ()
 442                 local iq = iq_cache:get(cache_key);
 443                 if iq then
 444                         self:unhook(result_event, iq.result_handler);
 445                         self:unhook(error_event, iq.error_handler);
 446                         iq.timeout_handle:stop();
 447                         iq_cache:set(cache_key, nil);
 448                 end
 449         end);
 450
 451         return p;
 452 end
 453
 454 function api:broadcast(jids, stanza, iter)
 455         for jid in (iter or it.values)(jids) do
 456                 local new_stanza = st.clone(stanza);
 457                 new_stanza.attr.to = jid;
 458                 self:send(new_stanza);
 459         end
 460 end
 461
 462 local timer_methods = { }
 463 local timer_mt = {
 464         __index = timer_methods;
 465 }
 466 function timer_methods:stop( )
 467         timer.stop(self.id);
 468 end
 469 timer_methods.disarm = timer_methods.stop
 470 function timer_methods:reschedule(delay)
 471         timer.reschedule(self.id, delay)
 472 end
 473
 474 local function timer_callback(now, id, t) --luacheck: ignore 212/id
 475         if t.module_env.loaded == false then return; end
 476         return t.callback(now, unpack(t, 1, t.n));
 477 end
 478
 479 function api:add_timer(delay, callback, ...)
 480         local t = pack(...)
 481         t.module_env = self;
 482         t.callback = callback;
 483         t.id = timer.add_task(delay, timer_callback, t);
 484         return setmetatable(t, timer_mt);
 485 end
 486
 487 local path_sep = package.config:sub(1,1);
 488 function api:get_directory()
 489         return self.path and (self.path:gsub("%"..path_sep.."[^"..path_sep.."]*$", "")) or nil;
 490 end
 491
 492 function api:load_resource(path, mode)
 493         path = resolve_relative_path(self:get_directory(), path);
 494         return io.open(path, mode);
 495 end
 496
 497 function api:open_store(name, store_type)
 498         return require"core.storagemanager".open(self.host, name or self.name, store_type);
 499 end
 500
 501 function api:measure(name, stat_type)
 502         local measure = require "core.statsmanager".measure;
 503         return measure(stat_type, "/"..self.host.."/mod_"..self.name.."/"..name);
 504 end
 505
 506 function api:measure_object_event(events_object, event_name, stat_name)
 507         local m = self:measure(stat_name or event_name, "times");
 508         local function handler(handlers, _event_name, _event_data)
 509                 local finished = m();
 510                 local ret = handlers(_event_name, _event_data);
 511                 finished();
 512                 return ret;
 513         end
 514         return self:hook_object_event(events_object, event_name, handler);
 515 end
 516
 517 function api:measure_event(event_name, stat_name)
 518         return self:measure_object_event((hosts[self.host] or prosody).events.wrappers, event_name, stat_name);
 519 end
 520
 521 function api:measure_global_event(event_name, stat_name)
 522         return self:measure_object_event(prosody.events.wrappers, event_name, stat_name);
 523 end
 524
 525 local status_priorities = { error = 3, warn = 2, info = 1, core = 0 };
 526
 527 function api:set_status(status_type, status_message, override)
 528         local priority = status_priorities[status_type];
 529         if not priority then
 530                 self:log("error", "set_status: Invalid status type '%s', assuming 'info'");
 531                 status_type, priority = "info", status_priorities.info;
 532         end
 533         local current_priority = status_priorities[self.status_type] or 0;
 534         -- By default an 'error' status can only be overwritten by another 'error' status
 535         if (current_priority >= status_priorities.error and priority < current_priority and override ~= true)
 536         or (override == false and current_priority > priority) then
 537                 self:log("debug", "moduleapi: ignoring status [prio %d override %s]: %s", priority, override, status_message);
 538                 return;
 539         end
 540         self.status_type, self.status_message, self.status_time = status_type, status_message, time_now();
 541         self:fire_event("module-status/updated", { name = self.name });
 542 end
 543
 544 function api:log_status(level, msg, ...)
 545         self:set_status(level, format(msg, ...));
 546         return self:log(level, msg, ...);
 547 end
 548
 549 function api:get_status()
 550         return self.status_type, self.status_message, self.status_time;
 551 end
 552
 553 return api;