prosody
05f5ec99da77
core/modulemanager.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Comparison

core/modulemanager.lua @ 4541:05f5ec99da77

Merge with trunk
author Matthew Wild <mwild1@gmail.com>
date Sun, 22 Jan 2012 22:55:49 +0000
parent 4537:d8d257c13562
child 4565:5a2212d3468e
comparison
equal deleted inserted replaced
4530:40905e7bf680 4541:05f5ec99da77
7 -- 7 --
8 8
9 local logger = require "util.logger"; 9 local logger = require "util.logger";
10 local log = logger.init("modulemanager"); 10 local log = logger.init("modulemanager");
11 local config = require "core.configmanager"; 11 local config = require "core.configmanager";
12 local multitable_new = require "util.multitable".new;
13 local st = require "util.stanza";
14 local pluginloader = require "util.pluginloader"; 12 local pluginloader = require "util.pluginloader";
15 13
16 local hosts = hosts; 14 local hosts = hosts;
17 local prosody = prosody; 15 local prosody = prosody;
18 local prosody_events = prosody.events;
19 16
20 local loadfile, pcall, xpcall = loadfile, pcall, xpcall; 17 local loadfile, pcall, xpcall = loadfile, pcall, xpcall;
21 local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv; 18 local setmetatable, setfenv, getfenv = setmetatable, setfenv, getfenv;
22 local pairs, ipairs = pairs, ipairs; 19 local pairs, ipairs = pairs, ipairs;
23 local t_insert, t_concat = table.insert, table.concat; 20 local t_insert, t_concat = table.insert, table.concat;
43 -- We need this to let modules access the real global namespace 40 -- We need this to let modules access the real global namespace
44 local _G = _G; 41 local _G = _G;
45 42
46 module "modulemanager" 43 module "modulemanager"
47 44
48 api = {}; 45 local api = _G.require "core.moduleapi"; -- Module API container
49 local api = api; -- Module API container 46
50 47 -- [host] = { [module] = module_env }
51 local modulemap = { ["*"] = {} }; 48 local modulemap = { ["*"] = {} };
52
53 local modulehelpers = setmetatable({}, { __index = _G });
54
55 local hooks = multitable_new();
56 49
57 local NULL = {}; 50 local NULL = {};
58 51
59 -- Load modules when a host is activated 52 -- Load modules when a host is activated
60 function load_modules_for_host(host) 53 function load_modules_for_host(host)
86 end 79 end
87 for module in modules do 80 for module in modules do
88 load(host, module); 81 load(host, module);
89 end 82 end
90 end 83 end
91 prosody_events.add_handler("host-activated", load_modules_for_host); 84 prosody.events.add_handler("host-activated", load_modules_for_host);
92 -- 85
93 86 --- Private helpers ---
94 function load(host, module_name, config) 87
95 if not (host and module_name) then 88 local function do_unload_module(host, name)
96 return nil, "insufficient-parameters";
97 elseif not hosts[host] then
98 return nil, "unknown-host";
99 end
100
101 if not modulemap[host] then
102 modulemap[host] = {};
103 end
104
105 if modulemap[host][module_name] then
106 log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
107 return nil, "module-already-loaded";
108 elseif modulemap["*"][module_name] then
109 return nil, "global-module-already-loaded";
110 end
111
112
113 local mod, err = pluginloader.load_code(module_name);
114 if not mod then
115 log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
116 return nil, err;
117 end
118
119 local _log = logger.init(host..":"..module_name);
120 local api_instance = setmetatable({ name = module_name, host = host, path = err, config = config, _log = _log, log = function (self, ...) return _log(...); end }, { __index = api });
121
122 local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
123 api_instance.environment = pluginenv;
124
125 setfenv(mod, pluginenv);
126 hosts[host].modules = modulemap[host];
127 modulemap[host][module_name] = pluginenv;
128
129 local success, err = pcall(mod);
130 if success then
131 if module_has_method(pluginenv, "load") then
132 success, err = call_module_method(pluginenv, "load");
133 if not success then
134 log("warn", "Error loading module '%s' on '%s': %s", module_name, host, err or "nil");
135 end
136 end
137
138 -- Use modified host, if the module set one
139 if api_instance.host == "*" and host ~= "*" then
140 modulemap[host][module_name] = nil;
141 modulemap["*"][module_name] = pluginenv;
142 api_instance:set_global();
143 end
144 else
145 log("error", "Error initializing module '%s' on '%s': %s", module_name, host, err or "nil");
146 end
147 if success then
148 (hosts[api_instance.host] or prosody).events.fire_event("module-loaded", { module = module_name, host = host });
149 return true;
150 else -- load failed, unloading
151 unload(api_instance.host, module_name);
152 return nil, err;
153 end
154 end
155
156 function get_module(host, name)
157 return modulemap[host] and modulemap[host][name];
158 end
159
160 function is_loaded(host, name)
161 return modulemap[host] and modulemap[host][name] and true;
162 end
163
164 function unload(host, name, ...)
165 local mod = get_module(host, name); 89 local mod = get_module(host, name);
166 if not mod then return nil, "module-not-loaded"; end 90 if not mod then return nil, "module-not-loaded"; end
167 91
168 if module_has_method(mod, "unload") then 92 if module_has_method(mod, "unload") then
169 local ok, err = call_module_method(mod, "unload"); 93 local ok, err = call_module_method(mod, "unload");
170 if (not ok) and err then 94 if (not ok) and err then
171 log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err); 95 log("warn", "Non-fatal error unloading module '%s' on '%s': %s", name, host, err);
172 end 96 end
173 end 97 end
174 -- unhook event handlers hooked by module:hook 98
175 for event, handlers in pairs(hooks:get(host, name) or NULL) do 99 for handler, event in pairs(mod.module.event_handlers) do
176 for handler in pairs(handlers or NULL) do 100 event.object.remove_handler(event.name, handler);
177 (hosts[host] or prosody).events.remove_handler(event, handler); 101 end
178 end 102
179 end
180 -- unhook event handlers hooked by module:hook_global
181 for event, handlers in pairs(hooks:get("*", name) or NULL) do
182 for handler in pairs(handlers or NULL) do
183 prosody.events.remove_handler(event, handler);
184 end
185 end
186 hooks:remove(host, name);
187 if mod.module.items then -- remove items 103 if mod.module.items then -- remove items
188 for key,t in pairs(mod.module.items) do 104 for key,t in pairs(mod.module.items) do
189 for i = #t,1,-1 do 105 for i = #t,1,-1 do
190 local value = t[i]; 106 local value = t[i];
191 t[i] = nil; 107 t[i] = nil;
192 hosts[host].events.fire_event("item-removed/"..key, {source = mod.module, item = value}); 108 hosts[host].events.fire_event("item-removed/"..key, {source = mod.module, item = value});
193 end 109 end
194 end 110 end
195 end 111 end
196 modulemap[host][name] = nil; 112 modulemap[host][name] = nil;
197 (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
198 return true; 113 return true;
199 end 114 end
200 115
201 function reload(host, name, ...) 116 local function do_load_module(host, module_name)
117 if not (host and module_name) then
118 return nil, "insufficient-parameters";
119 elseif not hosts[host] then
120 return nil, "unknown-host";
121 end
122
123 if not modulemap[host] then
124 modulemap[host] = {};
125 end
126
127 if modulemap[host][module_name] then
128 log("warn", "%s is already loaded for %s, so not loading again", module_name, host);
129 return nil, "module-already-loaded";
130 elseif modulemap["*"][module_name] then
131 return nil, "global-module-already-loaded";
132 end
133
134
135 local mod, err = pluginloader.load_code(module_name);
136 if not mod then
137 log("error", "Unable to load module '%s': %s", module_name or "nil", err or "nil");
138 return nil, err;
139 end
140
141 local _log = logger.init(host..":"..module_name);
142 local api_instance = setmetatable({ name = module_name, host = host, path = err,
143 _log = _log, log = function (self, ...) return _log(...); end, event_handlers = {} }
144 , { __index = api });
145
146 local pluginenv = setmetatable({ module = api_instance }, { __index = _G });
147 api_instance.environment = pluginenv;
148
149 setfenv(mod, pluginenv);
150 hosts[host].modules = modulemap[host];
151 modulemap[host][module_name] = pluginenv;
152
153 local ok, err = pcall(mod);
154 if ok then
155 -- Call module's "load"
156 if module_has_method(pluginenv, "load") then
157 ok, err = call_module_method(pluginenv, "load");
158 if not ok then
159 log("warn", "Error loading module '%s' on '%s': %s", module_name, host, err or "nil");
160 end
161 end
162
163 -- Use modified host, if the module set one
164 if api_instance.host == "*" and host ~= "*" then
165 modulemap[host][module_name] = nil;
166 modulemap["*"][module_name] = pluginenv;
167 api_instance:set_global();
168 end
169 else
170 log("error", "Error initializing module '%s' on '%s': %s", module_name, host, err or "nil");
171 do_unload_module(api_instance.host, module_name); -- Ignore error, module may be partially-loaded
172 end
173 return ok and pluginenv, err;
174 end
175
176 local function do_reload_module(host, name)
202 local mod = get_module(host, name); 177 local mod = get_module(host, name);
203 if not mod then return nil, "module-not-loaded"; end 178 if not mod then return nil, "module-not-loaded"; end
204 179
205 local _mod, err = pluginloader.load_code(name); -- checking for syntax errors 180 local _mod, err = pluginloader.load_code(name); -- checking for syntax errors
206 if not _mod then 181 if not _mod then
207 log("error", "Unable to load module '%s': %s", name or "nil", err or "nil"); 182 log("error", "Unable to load module '%s': %s", name or "nil", err or "nil");
208 return nil, err; 183 return nil, err;
209 end 184 end
210 185
211 local saved; 186 local saved;
212
213 if module_has_method(mod, "save") then 187 if module_has_method(mod, "save") then
214 local ok, ret, err = call_module_method(mod, "save"); 188 local ok, ret, err = call_module_method(mod, "save");
215 if ok then 189 if ok then
216 saved = ret; 190 saved = ret;
217 else 191 else
223 log("warn", "Continuing with reload (using the force)"); 197 log("warn", "Continuing with reload (using the force)");
224 end 198 end
225 end 199 end
226 end 200 end
227 201
228 unload(host, name, ...); 202 do_unload_module(host, name);
229 local ok, err = load(host, name, ...); 203 local ok, err = do_load_module(host, name);
230 if ok then 204 if ok then
231 mod = get_module(host, name); 205 mod = get_module(host, name);
232 if module_has_method(mod, "restore") then 206 if module_has_method(mod, "restore") then
233 local ok, err = call_module_method(mod, "restore", saved or {}) 207 local ok, err = call_module_method(mod, "restore", saved or {})
234 if (not ok) and err then 208 if (not ok) and err then
235 log("warn", "Error restoring module '%s' from '%s': %s", name, host, err); 209 log("warn", "Error restoring module '%s' from '%s': %s", name, host, err);
236 end 210 end
237 end 211 end
238 return true; 212 end
213 return ok and mod, err;
214 end
215
216 --- Public API ---
217
218 -- Load a module and fire module-loaded event
219 function load(host, name)
220 local mod, err = do_load_module(host, name);
221 if mod then
222 (hosts[mod.module.host] or prosody).events.fire_event("module-loaded", { module = name, host = host });
223 end
224 return mod, err;
225 end
226
227 -- Unload a module and fire module-unloaded
228 function unload(host, name)
229 local ok, err = do_unload_module(host, name);
230 if ok then
231 (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
239 end 232 end
240 return ok, err; 233 return ok, err;
234 end
235
236 function reload(host, name)
237 local ok, err = do_reload_module(host, name);
238 if ok then
239 (hosts[host] or prosody).events.fire_event("module-reloaded", { module = name, host = host });
240 elseif not is_loaded(host, name) then
241 (hosts[host] or prosody).events.fire_event("module-unloaded", { module = name, host = host });
242 end
243 return ok, err;
244 end
245
246 function get_module(host, name)
247 return modulemap[host] and modulemap[host][name];
248 end
249
250 function get_modules(host)
251 return modulemap[host];
252 end
253
254 function is_loaded(host, name)
255 return modulemap[host] and modulemap[host][name] and true;
241 end 256 end
242 257
243 function module_has_method(module, method) 258 function module_has_method(module, method)
244 return type(module.module[method]) == "function"; 259 return type(module.module[method]) == "function";
245 end 260 end
251 else 266 else
252 return false, "no-such-method"; 267 return false, "no-such-method";
253 end 268 end
254 end 269 end
255 270
256 ----- API functions exposed to modules -----------
257 -- Must all be in api.*
258
259 -- Returns the name of the current module
260 function api:get_name()
261 return self.name;
262 end
263
264 -- Returns the host that the current module is serving
265 function api:get_host()
266 return self.host;
267 end
268
269 function api:get_host_type()
270 return hosts[self.host].type;
271 end
272
273 function api:set_global()
274 self.host = "*";
275 -- Update the logger
276 local _log = logger.init("mod_"..self.name);
277 self.log = function (self, ...) return _log(...); end;
278 self._log = _log;
279 end
280
281 function api:add_feature(xmlns)
282 self:add_item("feature", xmlns);
283 end
284 function api:add_identity(category, type, name)
285 self:add_item("identity", {category = category, type = type, name = name});
286 end
287 function api:add_extension(data)
288 self:add_item("extension", data);
289 end
290
291 function api:fire_event(...)
292 return (hosts[self.host] or prosody).events.fire_event(...);
293 end
294
295 function api:hook(event, handler, priority)
296 hooks:set(self.host, self.name, event, handler, true);
297 (hosts[self.host] or prosody).events.add_handler(event, handler, priority);
298 end
299
300 function api:hook_global(event, handler, priority)
301 hooks:set("*", self.name, event, handler, true);
302 prosody.events.add_handler(event, handler, priority);
303 end
304
305 function api:hook_stanza(xmlns, name, handler, priority)
306 if not handler and type(name) == "function" then
307 -- If only 2 options then they specified no xmlns
308 xmlns, name, handler, priority = nil, xmlns, name, handler;
309 elseif not (handler and name) then
310 self:log("warn", "Error: Insufficient parameters to module:hook_stanza()");
311 return;
312 end
313 return api.hook(self, "stanza/"..(xmlns and (xmlns..":") or "")..name, function (data) return handler(data.origin, data.stanza, data); end, priority);
314 end
315
316 function api:require(lib)
317 local f, n = pluginloader.load_code(self.name, lib..".lib.lua");
318 if not f then
319 f, n = pluginloader.load_code(lib, lib..".lib.lua");
320 end
321 if not f then error("Failed to load plugin library '"..lib.."', error: "..n); end -- FIXME better error message
322 setfenv(f, self.environment);
323 return f();
324 end
325
326 function api:get_option(name, default_value)
327 local value = config.get(self.host, self.name, name);
328 if value == nil then
329 value = config.get(self.host, "core", name);
330 if value == nil then
331 value = default_value;
332 end
333 end
334 return value;
335 end
336
337 function api:get_option_string(name, default_value)
338 local value = self:get_option(name, default_value);
339 if type(value) == "table" then
340 if #value > 1 then
341 self:log("error", "Config option '%s' does not take a list, using just the first item", name);
342 end
343 value = value[1];
344 end
345 if value == nil then
346 return nil;
347 end
348 return tostring(value);
349 end
350
351 function api:get_option_number(name, ...)
352 local value = self:get_option(name, ...);
353 if type(value) == "table" then
354 if #value > 1 then
355 self:log("error", "Config option '%s' does not take a list, using just the first item", name);
356 end
357 value = value[1];
358 end
359 local ret = tonumber(value);
360 if value ~= nil and ret == nil then
361 self:log("error", "Config option '%s' not understood, expecting a number", name);
362 end
363 return ret;
364 end
365
366 function api:get_option_boolean(name, ...)
367 local value = self:get_option(name, ...);
368 if type(value) == "table" then
369 if #value > 1 then
370 self:log("error", "Config option '%s' does not take a list, using just the first item", name);
371 end
372 value = value[1];
373 end
374 if value == nil then
375 return nil;
376 end
377 local ret = value == true or value == "true" or value == 1 or nil;
378 if ret == nil then
379 ret = (value == false or value == "false" or value == 0);
380 if ret then
381 ret = false;
382 else
383 ret = nil;
384 end
385 end
386 if ret == nil then
387 self:log("error", "Config option '%s' not understood, expecting true/false", name);
388 end
389 return ret;
390 end
391
392 function api:get_option_array(name, ...)
393 local value = self:get_option(name, ...);
394
395 if value == nil then
396 return nil;
397 end
398
399 if type(value) ~= "table" then
400 return array{ value }; -- Assume any non-list is a single-item list
401 end
402
403 return array():append(value); -- Clone
404 end
405
406 function api:get_option_set(name, ...)
407 local value = self:get_option_array(name, ...);
408
409 if value == nil then
410 return nil;
411 end
412
413 return set.new(value);
414 end
415
416 local t_remove = _G.table.remove;
417 local module_items = multitable_new();
418 function api:add_item(key, value)
419 self.items = self.items or {};
420 self.items[key] = self.items[key] or {};
421 t_insert(self.items[key], value);
422 self:fire_event("item-added/"..key, {source = self, item = value});
423 end
424 function api:remove_item(key, value)
425 local t = self.items and self.items[key] or NULL;
426 for i = #t,1,-1 do
427 if t[i] == value then
428 t_remove(self.items[key], i);
429 self:fire_event("item-removed/"..key, {source = self, item = value});
430 return value;
431 end
432 end
433 end
434
435 function api:get_host_items(key)
436 local result = {};
437 for mod_name, module in pairs(modulemap[self.host]) do
438 module = module.module;
439 if module.items then
440 for _, item in ipairs(module.items[key] or NULL) do
441 t_insert(result, item);
442 end
443 end
444 end
445 for mod_name, module in pairs(modulemap["*"]) do
446 module = module.module;
447 if module.items then
448 for _, item in ipairs(module.items[key] or NULL) do
449 t_insert(result, item);
450 end
451 end
452 end
453 return result;
454 end
455
456 function api:handle_items(type, added_cb, removed_cb, existing)
457 self:hook("item-added/"..type, added_cb);
458 self:hook("item-removed/"..type, removed_cb);
459 if existing ~= false then
460 for _, item in ipairs(self:get_host_items(type)) do
461 added_cb({ item = item });
462 end
463 end
464 end
465
466 return _M; 271 return _M;