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