Merge 0.7->trunk
[prosody.git] / core / modulemanager.lua
1 -- Prosody IM
2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 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 plugin_dir = CFG_PLUGINDIR or "./plugins/";
10
11 local logger = require "util.logger";
12 local log = logger.init("modulemanager");
13 local eventmanager = require "core.eventmanager";
14 local config = require "core.configmanager";
15 local multitable_new = require "util.multitable".new;
16 local st = require "util.stanza";
17 local pluginloader = require "util.pluginloader";
18
19 local hosts = hosts;
20 local prosody = prosody;
21
22 local loadfile, pcall = loadfile, pcall;
23 local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv;
24 local pairs, ipairs = pairs, ipairs;
25 local t_insert, t_concat = table.insert, table.concat;
26 local type = type;
27 local next = next;
28 local rawget = rawget;
29 local error = error;
30 local tostring, tonumber = tostring, tonumber;
31
32 local array, set = require "util.array", require "util.set";
33
34 local autoload_modules = {"presence", "message", "iq"};
35
36 -- We need this to let modules access the real global namespace
37 local _G = _G;
38
39 module "modulemanager"
40
41 api = {};
42 local api = api; -- Module API container
43
44 local modulemap = { ["*"] = {} };
45
46 local stanza_handlers = multitable_new();
47 local handler_info = {};
48
49 local modulehelpers = setmetatable({}, { __index = _G });
50
51 local handler_table = multitable_new();
52 local hooked = multitable_new();
53 local hooks = multitable_new();
54 local event_hooks = multitable_new();
55
56 local NULL = {};
57
58 -- Load modules when a host is activated
59 function load_modules_for_host(host)
60         local disabled_set = {};
61         local modules_disabled = config.get(host, "core", "modules_disabled");
62         if modules_disabled then
63                 for _, module in ipairs(modules_disabled) do
64                         disabled_set[module] = true;
65                 end
66         end
67
68         -- Load auto-loaded modules for this host
69         if hosts[host].type == "local" then
70                 for _, module in ipairs(autoload_modules) do
71                         if not disabled_set[module] then
72                                 load(host, module);
73                         end
74                 end
75         end
76
77         -- Load modules from global section
78         if config.get(host, "core", "load_global_modules") ~= false then
79                 local modules_enabled = config.get("*", "core", "modules_enabled");
80                 if modules_enabled then
81                         for _, module in ipairs(modules_enabled) do
82                                 if not disabled_set[module] and not is_loaded(host, module) then
83                                         load(host, module);
84                                 end
85                         end
86                 end
87         end
88         
89         -- Load modules from just this host
90         local modules_enabled = config.get(host, "core", "modules_enabled");
91         if modules_enabled and modules_enabled ~= config.get("*", "core", "modules_enabled") then
92                 for _, module in pairs(modules_enabled) do
93                         if not is_loaded(host, module) then
94                                 load(host, module);
95                         end
96                 end
97         end
98 end
99 eventmanager.add_event_hook("host-activated", load_modules_for_host);
100 eventmanager.add_event_hook("component-activated", load_modules_for_host);
101 --
102
103 function load(host, module_name, config)
104         if not (host and module_name) then
105                 return nil, "insufficient-parameters";
106         end
107         
108         if not modulemap[host] then
109                 modulemap[host] = {};
110         end
111         
112         if modulemap[host][module_name] then
113                 log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
114                 return nil, "module-already-loaded";
115         elseif modulemap["*"][module_name] then
116                 return nil, "global-module-already-loaded";
117         end
118         
119
120         local mod, err = pluginloader.load_code(module_name);
121         if not mod then
122                 log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
123                 return nil, err;
124         end
125
126         local _log = logger.init(host..":"..module_name);
127         local api_instance = setmetatable({ name = module_name, host = host, config = config,  _log = _log, log = function (self, ...) return _log(...); end }, { __index = api });
128
129         local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
130         api_instance.environment = pluginenv;
131         
132         setfenv(mod, pluginenv);
133         if not hosts[host] then
134                 local create_component = _G.require "core.componentmanager".create_component;
135                 hosts[host] = create_component(host);
136                 hosts[host].connected = false;
137                 log("debug", "Created new component: %s", host);
138         end
139         hosts[host].modules = modulemap[host];
140         modulemap[host][module_name] = pluginenv;
141         
142         local success, err = pcall(mod);
143         if success then
144                 if module_has_method(pluginenv, "load") then
145                         success, err = call_module_method(pluginenv, "load");
146                         if not success then
147                                 log("warn", "Error loading module '%s' on '%s': %s", module_name, host, err or "nil");
148                         end
149                 end
150
151                 -- Use modified host, if the module set one
152                 if api_instance.host == "*" and host ~= "*" then
153                         modulemap[host][module_name] = nil;
154                         modulemap["*"][module_name] = pluginenv;
155                         api_instance:set_global();
156                 end
157         else
158                 log("error", "Error initializing module '%s' on '%s': %s", module_name, host, err or "nil");
159         end
160         if success then
161                 (hosts[api_instance.host] or prosody).events.fire_event("module-loaded", { module = module_name, host = host });
162                 return true;
163         else -- load failed, unloading
164                 unload(api_instance.host, module_name);
165                 return nil, err;
166         end
167 end
168
169 function get_module(host, name)
170         return modulemap[host] and modulemap[host][name];
171 end
172
173 function is_loaded(host, name)
174         return modulemap[host] and modulemap[host][name] and true;
175 end
176
177 function unload(host, name, ...)
178         local mod = get_module(host, name);
179         if not mod then return nil, "module-not-loaded"; end
180         
181         if module_has_method(mod, "unload") then
182                 local ok, err = call_module_method(mod, "unload");
183                 if (not ok) and err then
184                         log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err);
185                 end
186         end
187         local params = handler_table:get(host, name); -- , {module.host, origin_type, tag, xmlns}
188         for _, param in pairs(params or NULL) do
189                 local handlers = stanza_handlers:get(param[1], param[2], param[3], param[4]);
190                 if handlers then
191                         handler_info[handlers[1]] = nil;
192                         stanza_handlers:remove(param[1], param[2], param[3], param[4]);
193                 end
194         end
195         event_hooks:remove(host, name);
196         -- unhook event handlers hooked by module:hook
197         for event, handlers in pairs(hooks:get(host, name) or NULL) do
198                 for handler in pairs(handlers or NULL) do
199                         (hosts[host] or prosody).events.remove_handler(event, handler);
200                 end
201         end
202         hooks:remove(host, name);
203         if mod.module.items then -- remove items
204                 for key,t in pairs(mod.module.items) do
205                         for i = #t,1,-1 do
206                                 local value = t[i];
207                                 t[i] = nil;
208                                 hosts[host].events.fire_event("item-removed/"..key, {source = self, item = value});
209                         end
210                 end
211         end
212         modulemap[host][name] = nil;
213         (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
214         return true;
215 end
216
217 function reload(host, name, ...)
218         local mod = get_module(host, name);
219         if not mod then return nil, "module-not-loaded"; end
220
221         local _mod, err = pluginloader.load_code(name); -- checking for syntax errors
222         if not _mod then
223                 log("error", "Unable to load module '%s': %s", name or "nil", err or "nil");
224                 return nil, err;
225         end
226
227         local saved;
228
229         if module_has_method(mod, "save") then
230                 local ok, ret, err = call_module_method(mod, "save");
231                 if ok then
232                         saved = ret;
233                 else
234                         log("warn", "Error saving module '%s:%s' state: %s", host, module, ret);
235                         if not config.get(host, "core", "force_module_reload") then
236                                 log("warn", "Aborting reload due to error, set force_module_reload to ignore this");
237                                 return nil, "save-state-failed";
238                         else
239                                 log("warn", "Continuing with reload (using the force)");
240                         end
241                 end
242         end
243
244         unload(host, name, ...);
245         local ok, err = load(host, name, ...);
246         if ok then
247                 mod = get_module(host, name);
248                 if module_has_method(mod, "restore") then
249                         local ok, err = call_module_method(mod, "restore", saved or {})
250                         if (not ok) and err then
251                                 log("warn", "Error restoring module '%s' from '%s': %s", name, host, err);
252                         end
253                 end
254                 return true;
255         end
256         return ok, err;
257 end
258
259 function handle_stanza(host, origin, stanza)
260         local name, xmlns, origin_type = stanza.name, stanza.attr.xmlns or "jabber:client", origin.type;
261         if name == "iq" and xmlns == "jabber:client" then
262                 if stanza.attr.type == "get" or stanza.attr.type == "set" then
263                         xmlns = stanza.tags[1].attr.xmlns or "jabber:client";
264                         log("debug", "Stanza of type %s from %s has xmlns: %s", name, origin_type, xmlns);
265                 else
266                         log("debug", "Discarding %s from %s of type: %s", name, origin_type, stanza.attr.type);
267                         return true;
268                 end
269         end
270         local handlers = stanza_handlers:get(host, origin_type, name, xmlns);
271         if not handlers then handlers = stanza_handlers:get("*", origin_type, name, xmlns); end
272         if handlers then
273                 log("debug", "Passing stanza to mod_%s", handler_info[handlers[1]].name);
274                 (handlers[1])(origin, stanza);
275                 return true;
276         else
277                 if stanza.attr.xmlns == nil then
278                         log("debug", "Unhandled %s stanza: %s; xmlns=%s", origin.type, stanza.name, xmlns); -- we didn't handle it
279                         if stanza.attr.type ~= "error" and stanza.attr.type ~= "result" then
280                                 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
281                         end
282                 elseif not((name == "features" or name == "error") and xmlns == "http://etherx.jabber.org/streams") then -- FIXME remove check once we handle S2S features
283                         log("warn", "Unhandled %s stream element: %s; xmlns=%s: %s", origin.type, stanza.name, xmlns, tostring(stanza)); -- we didn't handle it
284                         origin:close("unsupported-stanza-type");
285                 end
286         end
287 end
288
289 function module_has_method(module, method)
290         return type(module.module[method]) == "function";
291 end
292
293 function call_module_method(module, method, ...)
294         if module_has_method(module, method) then
295                 local f = module.module[method];
296                 return pcall(f, ...);
297         else
298                 return false, "no-such-method";
299         end
300 end
301
302 ----- API functions exposed to modules -----------
303 -- Must all be in api.*
304
305 -- Returns the name of the current module
306 function api:get_name()
307         return self.name;
308 end
309
310 -- Returns the host that the current module is serving
311 function api:get_host()
312         return self.host;
313 end
314
315 function api:get_host_type()
316         return hosts[self.host].type;
317 end
318
319 function api:set_global()
320         self.host = "*";
321         -- Update the logger
322         local _log = logger.init("mod_"..self.name);
323         self.log = function (self, ...) return _log(...); end;
324         self._log = _log;
325 end
326
327 local function _add_handler(module, origin_type, tag, xmlns, handler)
328         local handlers = stanza_handlers:get(module.host, origin_type, tag, xmlns);
329         local msg = (tag == "iq") and "namespace" or "payload namespace";
330         if not handlers then
331                 stanza_handlers:add(module.host, origin_type, tag, xmlns, handler);
332                 handler_info[handler] = module;
333                 handler_table:add(module.host, module.name, {module.host, origin_type, tag, xmlns});
334                 --module:log("debug", "I now handle tag '%s' [%s] with %s '%s'", tag, origin_type, msg, xmlns);
335         else
336                 module:log("warn", "I wanted to handle tag '%s' [%s] with %s '%s' but mod_%s already handles that", tag, origin_type, msg, xmlns, handler_info[handlers[1]].module.name);
337         end
338 end
339
340 function api:add_handler(origin_type, tag, xmlns, handler)
341         if not (origin_type and tag and xmlns and handler) then return false; end
342         if type(origin_type) == "table" then
343                 for _, origin_type in ipairs(origin_type) do
344                         _add_handler(self, origin_type, tag, xmlns, handler);
345                 end
346         else
347                 _add_handler(self, origin_type, tag, xmlns, handler);
348         end
349 end
350 function api:add_iq_handler(origin_type, xmlns, handler)
351         self:add_handler(origin_type, "iq", xmlns, handler);
352 end
353
354 function api:add_feature(xmlns)
355         self:add_item("feature", xmlns);
356 end
357 function api:add_identity(category, type, name)
358         self:add_item("identity", {category = category, type = type, name = name});
359 end
360
361 local event_hook = function(host, mod_name, event_name, ...)
362         if type((...)) == "table" and (...).host and (...).host ~= host then return; end
363         for handler in pairs(event_hooks:get(host, mod_name, event_name) or NULL) do
364                 handler(...);
365         end
366 end;
367 function api:add_event_hook(name, handler)
368         if not hooked:get(self.host, self.name, name) then
369                 eventmanager.add_event_hook(name, function(...) event_hook(self.host, self.name, name, ...); end);
370                 hooked:set(self.host, self.name, name, true);
371         end
372         event_hooks:set(self.host, self.name, name, handler, true);
373 end
374
375 function api:fire_event(...)
376         return (hosts[self.host] or prosody).events.fire_event(...);
377 end
378
379 function api:hook(event, handler, priority)
380         hooks:set(self.host, self.name, event, handler, true);
381         (hosts[self.host] or prosody).events.add_handler(event, handler, priority);
382 end
383
384 function api:hook_stanza(xmlns, name, handler, priority)
385         if not handler and type(name) == "function" then
386                 -- If only 2 options then they specified no xmlns
387                 xmlns, name, handler, priority = nil, xmlns, name, handler;
388         elseif not (handler and name) then
389                 self:log("warn", "Error: Insufficient parameters to module:hook_stanza()");
390                 return;
391         end
392         return api.hook(self, "stanza/"..(xmlns and (xmlns..":") or "")..name, function (data) return handler(data.origin, data.stanza, data); end, priority);
393 end
394
395 function api:require(lib)
396         local f, n = pluginloader.load_code(self.name, lib..".lib.lua");
397         if not f then
398                 f, n = pluginloader.load_code(lib, lib..".lib.lua");
399         end
400         if not f then error("Failed to load plugin library '"..lib.."', error: "..n); end -- FIXME better error message
401         setfenv(f, self.environment);
402         return f();
403 end
404
405 function api:get_option(name, default_value)
406         local value = config.get(self.host, self.name, name);
407         if value == nil then
408                 value = config.get(self.host, "core", name);
409                 if value == nil then
410                         value = default_value;
411                 end
412         end
413         return value;
414 end
415
416 function api:get_option_string(name, default_value)
417         local value = self:get_option(name, default_value);
418         if type(value) == "table" then
419                 if #value > 1 then
420                         self:log("error", "Config option '%s' does not take a list, using just the first item", name);
421                 end
422                 value = value[1];
423         end
424         if value == nil then
425                 return nil;
426         end
427         return tostring(value);
428 end
429
430 function api:get_option_number(name, ...)
431         local value = self:get_option(name, ...);
432         if type(value) == "table" then
433                 if #value > 1 then
434                         self:log("error", "Config option '%s' does not take a list, using just the first item", name);
435                 end
436                 value = value[1];
437         end
438         local ret = tonumber(value);
439         if value ~= nil and ret == nil then
440                 self:log("error", "Config option '%s' not understood, expecting a number", name);
441         end
442         return ret;
443 end
444
445 function api:get_option_boolean(name, ...)
446         local value = self:get_option(name, ...);
447         if type(value) == "table" then
448                 if #value > 1 then
449                         self:log("error", "Config option '%s' does not take a list, using just the first item", name);
450                 end
451                 value = value[1];
452         end
453         if value == nil then
454                 return nil;
455         end
456         local ret = value == true or value == "true" or value == 1 or nil;
457         if ret == nil then
458                 ret = (value == false or value == "false" or value == 0);
459                 if ret then
460                         ret = false;
461                 else
462                         ret = nil;
463                 end
464         end
465         if ret == nil then
466                 self:log("error", "Config option '%s' not understood, expecting true/false", name);
467         end
468         return ret;
469 end
470
471 function api:get_option_array(name, ...)
472         local value = self:get_option(name, ...);
473
474         if value == nil then
475                 return nil;
476         end
477         
478         if type(value) ~= "table" then
479                 return array{ value }; -- Assume any non-list is a single-item list
480         end
481         
482         return array():append(value); -- Clone
483 end
484
485 function api:get_option_set(name, ...)
486         local value = self:get_option_array(name, ...);
487         
488         if value == nil then
489                 return nil;
490         end
491         
492         return set.new(value);
493 end
494
495 local t_remove = _G.table.remove;
496 local module_items = multitable_new();
497 function api:add_item(key, value)
498         self.items = self.items or {};
499         self.items[key] = self.items[key] or {};
500         t_insert(self.items[key], value);
501         self:fire_event("item-added/"..key, {source = self, item = value});
502 end
503 function api:remove_item(key, value)
504         local t = self.items and self.items[key] or NULL;
505         for i = #t,1,-1 do
506                 if t[i] == value then
507                         t_remove(self.items[key], i);
508                         self:fire_event("item-removed/"..key, {source = self, item = value});
509                         return value;
510                 end
511         end
512 end
513
514 function api:get_host_items(key)
515         local result = {};
516         for mod_name, module in pairs(modulemap[self.host]) do
517                 module = module.module;
518                 if module.items then
519                         for _, item in ipairs(module.items[key] or NULL) do
520                                 t_insert(result, item);
521                         end
522                 end
523         end
524         for mod_name, module in pairs(modulemap["*"]) do
525                 module = module.module;
526                 if module.items then
527                         for _, item in ipairs(module.items[key] or NULL) do
528                                 t_insert(result, item);
529                         end
530                 end
531         end
532         return result;
533 end
534
535 return _M;