7ca12ddafc538561c0ea11b9d7cf8a959a1b5cd7
[prosody.git] / core / modulemanager.lua
1 -- Prosody IM
2 -- Copyright (C) 2008-2009 Matthew Wild
3 -- Copyright (C) 2008-2009 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
10
11 local plugin_dir = CFG_PLUGINDIR or "./plugins/";
12
13 local logger = require "util.logger";
14 local log = logger.init("modulemanager");
15 local addDiscoInfoHandler = require "core.discomanager".addDiscoInfoHandler;
16 local eventmanager = require "core.eventmanager";
17 local config = require "core.configmanager";
18 local multitable_new = require "util.multitable".new;
19 local register_actions = require "core.actions".register;
20 local st = require "util.stanza";
21 local pluginloader = require "util.pluginloader";
22
23 local hosts = hosts;
24 local prosody = prosody;
25
26 local loadfile, pcall = loadfile, pcall;
27 local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv;
28 local pairs, ipairs = pairs, ipairs;
29 local t_insert, t_concat = table.insert, table.concat;
30 local type = type;
31 local next = next;
32 local rawget = rawget;
33 local error = error;
34 local tostring = tostring;
35
36 local autoload_modules = {"presence", "message", "iq"};
37
38 -- We need this to let modules access the real global namespace
39 local _G = _G;
40
41 module "modulemanager"
42
43 api = {};
44 local api = api; -- Module API container
45
46 local modulemap = { ["*"] = {} };
47
48 local stanza_handlers = multitable_new();
49 local handler_info = {};
50
51 local modulehelpers = setmetatable({}, { __index = _G });
52
53 local features_table = multitable_new();
54 local identities_table = multitable_new();
55 local handler_table = multitable_new();
56 local hooked = multitable_new();
57 local hooks = multitable_new();
58 local event_hooks = multitable_new();
59
60 local NULL = {};
61
62 -- Load modules when a host is activated
63 function load_modules_for_host(host)
64         if config.get(host, "core", "load_global_modules") ~= false then
65                 -- Load modules from global section
66                 local modules_enabled = config.get("*", "core", "modules_enabled");
67                 local modules_disabled = config.get(host, "core", "modules_disabled");
68                 local disabled_set = {};
69                 if modules_enabled then
70                         if modules_disabled then
71                                 for _, module in ipairs(modules_disabled) do
72                                         disabled_set[module] = true;
73                                 end
74                         end
75                         for _, module in ipairs(autoload_modules) do
76                                 if not disabled_set[module] then
77                                         load(host, module);
78                                 end
79                         end
80                         for _, module in ipairs(modules_enabled) do
81                                 if not disabled_set[module] and not is_loaded(host, module) then
82                                         load(host, module);
83                                 end
84                         end
85                 end
86         end
87         
88         -- Load modules from just this host
89         local modules_enabled = config.get(host, "core", "modules_enabled");
90         if modules_enabled and modules_enabled ~= config.get("*", "core", "modules_enabled") then
91                 for _, module in pairs(modules_enabled) do
92                         if not is_loaded(host, module) then
93                                 load(host, module);
94                         end
95                 end
96         end
97 end
98 eventmanager.add_event_hook("host-activated", load_modules_for_host);
99 eventmanager.add_event_hook("component-activated", load_modules_for_host);
100 --
101
102 function load(host, module_name, config)
103         if not (host and module_name) then
104                 return nil, "insufficient-parameters";
105         end
106         
107         if not modulemap[host] then
108                 modulemap[host] = {};
109                 hosts[host].modules = 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         
131         setfenv(mod, pluginenv);
132         if not hosts[host] then hosts[host] = { type = "component", host = host, connected = false, s2sout = {} }; end
133         
134         local success, ret = pcall(mod);
135         if not success then
136                 log("error", "Error initialising module '%s': %s", module_name or "nil", ret or "nil");
137                 return nil, ret;
138         end
139         
140         if module_has_method(pluginenv, "load") then
141                 local ok, err = call_module_method(pluginenv, "load");
142                 if (not ok) and err then
143                         log("warn", "Error loading module '%s' on '%s': %s", module_name, host, err);
144                 end
145         end
146
147         -- Use modified host, if the module set one
148         modulemap[api_instance.host][module_name] = pluginenv;
149         
150         if api_instance.host == "*" and host ~= "*" then
151                 api_instance:set_global();
152         end
153                 
154         return true;
155 end
156
157 function get_module(host, name)
158         return modulemap[host] and modulemap[host][name];
159 end
160
161 function is_loaded(host, name)
162         return modulemap[host] and modulemap[host][name] and true;
163 end
164
165 function unload(host, name, ...)
166         local mod = get_module(host, name); 
167         if not mod then return nil, "module-not-loaded"; end
168         
169         if module_has_method(mod, "unload") then
170                 local ok, err = call_module_method(mod, "unload");
171                 if (not ok) and err then
172                         log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err);
173                 end
174         end
175         modulemap[host][name] = nil;
176         features_table:remove(host, name);
177         identities_table:remove(host, name);
178         local params = handler_table:get(host, name); -- , {module.host, origin_type, tag, xmlns}
179         for _, param in pairs(params or NULL) do
180                 local handlers = stanza_handlers:get(param[1], param[2], param[3], param[4]);
181                 if handlers then
182                         handler_info[handlers[1]] = nil;
183                         stanza_handlers:remove(param[1], param[2], param[3], param[4]);
184                 end
185         end
186         event_hooks:remove(host, name);
187         -- unhook event handlers hooked by module:hook
188         for event, handlers in pairs(hooks:get(host, name) or NULL) do
189                 for handler in pairs(handlers or NULL) do
190                         (hosts[host] or prosody).events.remove_handler(event, handler);
191                 end
192         end
193         hooks:remove(host, name);
194         return true;
195 end
196
197 function reload(host, name, ...)
198         local mod = get_module(host, name);
199         if not mod then return nil, "module-not-loaded"; end
200
201         local _mod, err = pluginloader.load_code(name); -- checking for syntax errors
202         if not _mod then
203                 log("error", "Unable to load module '%s': %s", name or "nil", err or "nil");
204                 return nil, err;
205         end
206
207         local saved;
208
209         if module_has_method(mod, "save") then
210                 local ok, ret, err = call_module_method(mod, "save");
211                 if ok then
212                         saved = ret;
213                 else
214                         log("warn", "Error saving module '%s:%s' state: %s", host, module, ret);
215                         if not config.get(host, "core", "force_module_reload") then
216                                 log("warn", "Aborting reload due to error, set force_module_reload to ignore this");
217                                 return nil, "save-state-failed";
218                         else
219                                 log("warn", "Continuing with reload (using the force)");
220                         end
221                 end
222         end
223
224         unload(host, name, ...);
225         local ok, err = load(host, name, ...);
226         if ok then
227                 mod = get_module(host, name);
228                 if module_has_method(mod, "restore") then
229                         local ok, err = call_module_method(mod, "restore", saved or {})
230                         if (not ok) and err then
231                                 log("warn", "Error restoring module '%s' from '%s': %s", name, host, err);
232                         end
233                 end
234                 return true;
235         end
236         return ok, err;
237 end
238
239 function handle_stanza(host, origin, stanza)
240         local name, xmlns, origin_type = stanza.name, stanza.attr.xmlns or "jabber:client", origin.type;
241         if name == "iq" and xmlns == "jabber:client" then
242                 if stanza.attr.type == "get" or stanza.attr.type == "set" then
243                         xmlns = stanza.tags[1].attr.xmlns or "jabber:client";
244                         log("debug", "Stanza of type %s from %s has xmlns: %s", name, origin_type, xmlns);
245                 else
246                         log("debug", "Discarding %s from %s of type: %s", name, origin_type, stanza.attr.type);
247                         return true;
248                 end
249         end
250         local handlers = stanza_handlers:get(host, origin_type, name, xmlns);
251         if not handlers then handlers = stanza_handlers:get("*", origin_type, name, xmlns); end
252         if handlers then
253                 log("debug", "Passing stanza to mod_%s", handler_info[handlers[1]].name);
254                 (handlers[1])(origin, stanza);
255                 return true;
256         else
257                 log("debug", "Unhandled %s stanza: %s; xmlns=%s", origin.type, stanza.name, xmlns); -- we didn't handle it
258                 if stanza.attr.xmlns == "jabber:client" then
259                         if stanza.attr.type ~= "error" and stanza.attr.type ~= "result" then
260                                 origin.send(st.error_reply(stanza, "cancel", "service-unavailable"));
261                         end
262                 elseif not((name == "features" or name == "error") and xmlns == "http://etherx.jabber.org/streams") then -- FIXME remove check once we handle S2S features
263                         origin:close("unsupported-stanza-type");
264                 end
265         end
266 end
267
268 function module_has_method(module, method)
269         return type(module.module[method]) == "function";
270 end
271
272 function call_module_method(module, method, ...)
273         if module_has_method(module, method) then       
274                 local f = module.module[method];
275                 return pcall(f, ...);
276         else
277                 return false, "no-such-method";
278         end
279 end
280
281 ----- API functions exposed to modules -----------
282 -- Must all be in api.* 
283
284 -- Returns the name of the current module
285 function api:get_name()
286         return self.name;
287 end
288
289 -- Returns the host that the current module is serving
290 function api:get_host()
291         return self.host;
292 end
293
294 function api:get_host_type()
295         return hosts[self.host].type;
296 end
297
298 function api:set_global()
299         self.host = "*";
300         -- Update the logger
301         local _log = logger.init("mod_"..self.name);
302         self.log = function (self, ...) return _log(...); end;
303         self._log = _log;
304 end
305
306 local function _add_handler(module, origin_type, tag, xmlns, handler)
307         local handlers = stanza_handlers:get(module.host, origin_type, tag, xmlns);
308         local msg = (tag == "iq") and "namespace" or "payload namespace";
309         if not handlers then
310                 stanza_handlers:add(module.host, origin_type, tag, xmlns, handler);
311                 handler_info[handler] = module;
312                 handler_table:add(module.host, module.name, {module.host, origin_type, tag, xmlns});
313                 --module:log("debug", "I now handle tag '%s' [%s] with %s '%s'", tag, origin_type, msg, xmlns);
314         else
315                 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);
316         end
317 end
318
319 function api:add_handler(origin_type, tag, xmlns, handler)
320         if not (origin_type and tag and xmlns and handler) then return false; end
321         if type(origin_type) == "table" then
322                 for _, origin_type in ipairs(origin_type) do
323                         _add_handler(self, origin_type, tag, xmlns, handler);
324                 end
325         else
326                 _add_handler(self, origin_type, tag, xmlns, handler);
327         end
328 end
329 function api:add_iq_handler(origin_type, xmlns, handler)
330         self:add_handler(origin_type, "iq", xmlns, handler);
331 end
332
333 addDiscoInfoHandler("*host", function(reply, to, from, node)
334         if #node == 0 then
335                 local done = {};
336                 for module, identities in pairs(identities_table:get(to) or NULL) do -- for each module
337                         for identity, attr in pairs(identities) do
338                                 if not done[identity] then
339                                         reply:tag("identity", attr):up(); -- TODO cache
340                                         done[identity] = true;
341                                 end
342                         end
343                 end
344                 for module, identities in pairs(identities_table:get("*") or NULL) do -- for each module
345                         for identity, attr in pairs(identities) do
346                                 if not done[identity] then
347                                         reply:tag("identity", attr):up(); -- TODO cache
348                                         done[identity] = true;
349                                 end
350                         end
351                 end
352                 for module, features in pairs(features_table:get(to) or NULL) do -- for each module
353                         for feature in pairs(features) do
354                                 if not done[feature] then
355                                         reply:tag("feature", {var = feature}):up(); -- TODO cache
356                                         done[feature] = true;
357                                 end
358                         end
359                 end
360                 for module, features in pairs(features_table:get("*") or NULL) do -- for each module
361                         for feature in pairs(features) do
362                                 if not done[feature] then
363                                         reply:tag("feature", {var = feature}):up(); -- TODO cache
364                                         done[feature] = true;
365                                 end
366                         end
367                 end
368                 return next(done) ~= nil;
369         end
370 end);
371
372 function api:add_feature(xmlns)
373         features_table:set(self.host, self.name, xmlns, true);
374 end
375 function api:add_identity(category, type)
376         identities_table:set(self.host, self.name, category.."\0"..type, {category = category, type = type});
377 end
378
379 local event_hook = function(host, mod_name, event_name, ...)
380         if type((...)) == "table" and (...).host and (...).host ~= host then return; end
381         for handler in pairs(event_hooks:get(host, mod_name, event_name) or NULL) do
382                 handler(...);
383         end
384 end;
385 function api:add_event_hook(name, handler)
386         if not hooked:get(self.host, self.name, name) then
387                 eventmanager.add_event_hook(name, function(...) event_hook(self.host, self.name, name, ...); end);
388                 hooked:set(self.host, self.name, name, true);
389         end
390         event_hooks:set(self.host, self.name, name, handler, true);
391 end
392
393 function api:fire_event(...)
394         return (hosts[self.host] or prosody).events.fire_event(...);
395 end
396
397 function api:hook(event, handler, priority)
398         hooks:set(self.host, self.name, event, handler, true);
399         (hosts[self.host] or prosody).events.add_handler(event, handler, priority);
400 end
401
402 function api:hook_stanza(xmlns, name, handler, priority)
403         if not handler and type(name) == "function" then
404                 -- If only 2 options then they specified no xmlns
405                 xmlns, name, handler, priority = nil, xmlns, name, handler;
406         elseif not (handler and name) then
407                 self:log("warn", "Error: Insufficient parameters to module:hook_stanza()");
408                 return;
409         end
410         return api.hook(self, "stanza/"..(xmlns and (xmlns..":") or "")..name, function (data) return handler(data.origin, data.stanza, data); end, priority);
411 end
412
413 function api:require(lib)
414         local f, n = pluginloader.load_code(self.name, lib..".lib.lua");
415         if not f then
416                 f, n = pluginloader.load_code(lib, lib..".lib.lua");
417         end
418         if not f then error("Failed to load plugin library '"..lib.."', error: "..n); end -- FIXME better error message
419         setfenv(f, setmetatable({ module = self }, { __index = _G }));
420         return f();
421 end
422
423 --------------------------------------------------------------------
424
425 local actions = {};
426
427 function actions.load(params)
428         --return true, "Module loaded ("..params.module.." on "..params.host..")";
429         return load(params.host, params.module);
430 end
431
432 function actions.unload(params)
433         return unload(params.host, params.module);
434 end
435
436 register_actions("/modules", actions);
437
438 return _M;