3 -- Copyright (C) 2008-2010 Matthew Wild
4 -- Copyright (C) 2008-2010 Waqas Hussain
6 -- This project is MIT/X11 licensed. Please see the
7 -- COPYING file in the source package for more information.
10 -- prosody - main executable for Prosody XMPP server
12 -- Will be modified by configure script if run --
14 CFG_SOURCEDIR=os.getenv("PROSODY_SRCDIR");
15 CFG_CONFIGDIR=os.getenv("PROSODY_CFGDIR");
16 CFG_PLUGINDIR=os.getenv("PROSODY_PLUGINDIR");
17 CFG_DATADIR=os.getenv("PROSODY_DATADIR");
19 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
21 local function is_relative(path)
22 local path_sep = package.config:sub(1,1);
23 return ((path_sep == "/" and path:sub(1,1) ~= "/")
24 or (path_sep == "\\" and (path:sub(1,1) ~= "/" and path:sub(2,3) ~= ":\\")))
27 -- Tell Lua where to find our libraries
29 local function filter_relative_paths(path)
30 if is_relative(path) then return ""; end
32 local function sanitise_paths(paths)
33 return (paths:gsub("[^;]+;?", filter_relative_paths):gsub(";;+", ";"));
35 package.path = sanitise_paths(CFG_SOURCEDIR.."/?.lua;"..package.path);
36 package.cpath = sanitise_paths(CFG_SOURCEDIR.."/?.so;"..package.cpath);
39 -- Substitute ~ with path to home directory in data path
41 if os.getenv("HOME") then
42 CFG_DATADIR = CFG_DATADIR:gsub("^~", os.getenv("HOME"));
46 -- Global 'prosody' object
47 local prosody = { events = require "util.events".new(); };
51 local dependencies = require "util.dependencies";
53 -- Load the config-parsing module
54 config = require "core.configmanager"
57 -- Define the functions we call during startup, the
58 -- actual startup happens right at the end, where these
59 -- functions get called
61 function read_config()
65 if arg[1] == "--config" and arg[2] then
66 table.insert(filenames, arg[2]);
68 table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
70 elseif os.getenv("PROSODY_CONFIG") then -- Passed by prosodyctl
71 table.insert(filenames, os.getenv("PROSODY_CONFIG"));
73 for _, format in ipairs(config.parsers()) do
74 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
77 for _,_filename in ipairs(filenames) do
79 local file = io.open(filename);
82 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
86 prosody.config_file = filename
87 local ok, level, err = config.load(filename);
90 print("**************************");
91 if level == "parser" then
92 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua"..":");
94 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
95 if err:match("chunk has too many syntax levels$") then
96 print("An Include statement in a config file is including an already-included");
97 print("file and causing an infinite loop. An Include statement in a config file is...");
99 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
102 elseif level == "file" then
103 print("Prosody was unable to find the configuration file.");
104 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
105 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
106 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
108 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
110 print("**************************");
116 function check_dependencies()
117 if not dependencies.check_dependencies() then
122 function load_libraries()
123 -- Load socket framework
124 server = require "net.server"
127 function init_logging()
128 -- Initialize logging
129 require "core.loggingmanager"
132 function log_dependency_warnings()
133 dependencies.log_warnings();
136 function sanity_check()
137 for host, host_config in pairs(config.getconfig()) do
139 and host_config.enabled ~= false
140 and not host_config.component_module then
144 log("error", "No enabled VirtualHost entries found in the config file.");
145 log("error", "At least one active host is required for Prosody to function. Exiting...");
149 function sandbox_require()
150 -- Replace require() with one that doesn't pollute _G, required
151 -- for neat sandboxing of modules
153 local _real_require = require;
155 -- FIXME: This is a hack to replace getfenv() in Lua 5.2
157 local name, env = debug.getupvalue(debug.getinfo(f or 1).func, 1);
158 if name == "_ENV" then
163 function require(...)
164 local curr_env = getfenv(2);
165 local curr_env_mt = getmetatable(curr_env);
166 local _realG_mt = getmetatable(_realG);
167 if curr_env_mt and curr_env_mt.__index and not curr_env_mt.__newindex and _realG_mt then
168 local old_newindex, old_index;
169 old_newindex, _realG_mt.__newindex = _realG_mt.__newindex, curr_env;
170 old_index, _realG_mt.__index = _realG_mt.__index, function (_G, k)
171 return rawget(curr_env, k);
173 local ret = _real_require(...);
174 _realG_mt.__newindex = old_newindex;
175 _realG_mt.__index = old_index;
178 return _real_require(...);
182 function set_function_metatable()
184 function mt.__index(f, upvalue)
185 local i, name, value = 0;
188 name, value = debug.getupvalue(f, i);
189 until name == upvalue or name == nil;
192 function mt.__newindex(f, upvalue, value)
196 name = debug.getupvalue(f, i);
197 until name == upvalue or name == nil;
199 debug.setupvalue(f, i, value);
202 function mt.__tostring(f)
203 local info = debug.getinfo(f);
204 return ("function(%s:%d)"):format(info.short_src:match("[^\\/]*$"), info.linedefined);
206 debug.setmetatable(function() end, mt);
209 function init_global_state()
210 -- COMPAT: These globals are deprecated
215 prosody.bare_sessions = bare_sessions;
216 prosody.full_sessions = full_sessions;
217 prosody.hosts = hosts;
219 local data_path = config.get("*", "data_path") or CFG_DATADIR or "data";
220 local custom_plugin_paths = config.get("*", "plugin_paths");
221 if custom_plugin_paths then
222 local path_sep = package.config:sub(3,3);
223 -- path1;path2;path3;defaultpath...
224 CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
226 prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR or ".",
227 plugins = CFG_PLUGINDIR or "plugins", data = data_path };
229 prosody.arg = _G.arg;
231 prosody.platform = "unknown";
232 if os.getenv("WINDIR") then
233 prosody.platform = "windows";
234 elseif package.config:sub(1,1) == "/" then
235 prosody.platform = "posix";
238 prosody.installed = nil;
239 if CFG_SOURCEDIR and (prosody.platform == "windows" or CFG_SOURCEDIR:match("^/")) then
240 prosody.installed = true;
243 if prosody.installed then
244 -- Change working directory to data path.
245 require "lfs".chdir(data_path);
248 -- Function to reload the config file
249 function prosody.reload_config()
250 log("info", "Reloading configuration file");
251 prosody.events.fire_event("reloading-config");
252 local ok, level, err = config.load(prosody.config_file);
254 if level == "parser" then
255 log("error", "There was an error parsing the configuration file: %s", tostring(err));
256 elseif level == "file" then
257 log("error", "Couldn't read the config file when trying to reload: %s", tostring(err));
260 return ok, (err and tostring(level)..": "..tostring(err)) or nil;
263 -- Function to reopen logfiles
264 function prosody.reopen_logfiles()
265 log("info", "Re-opening log files");
266 prosody.events.fire_event("reopen-log-files");
269 -- Function to initiate prosody shutdown
270 function prosody.shutdown(reason)
271 log("info", "Shutting down: %s", reason or "unknown reason");
272 prosody.shutdown_reason = reason;
273 prosody.events.fire_event("server-stopping", {reason = reason});
274 server.setquitting(true);
278 function read_version()
279 -- Try to determine version
280 local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
282 prosody.version = version_file:read("*a"):gsub("%s*$", "");
283 version_file:close();
284 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
285 prosody.version = "hg:"..prosody.version;
288 prosody.version = "unknown";
292 function load_secondary_libraries()
293 --- Load and initialise core modules
294 require "util.import"
295 require "util.xmppstream"
296 require "core.stanza_router"
297 require "core.hostmanager"
298 require "core.portmanager"
299 require "core.modulemanager"
300 require "core.usermanager"
301 require "core.rostermanager"
302 require "core.sessionmanager"
303 package.loaded['core.componentmanager'] = setmetatable({},{__index=function()
304 log("warn", "componentmanager is deprecated: %s", debug.traceback():match("\n[^\n]*\n[ \t]*([^\n]*)"));
305 return function() end
311 require "util.datetime"
312 require "util.iterators"
314 require "util.helpers"
316 pcall(require, "util.signal") -- Not on Windows
318 -- Commented to protect us from
319 -- the second kind of people
321 pcall(require, "remdebug.engine");
322 if remdebug then remdebug.engine.start() end
325 require "util.stanza"
329 function init_data_store()
330 require "core.storagemanager";
333 function prepare_to_start()
334 log("info", "Prosody is using the %s backend for connection handling", server.get_backend());
335 -- Signal to modules that we are ready to start
336 prosody.events.fire_event("server-starting");
337 prosody.start_time = os.time();
340 function init_global_protection()
341 -- Catch global accesses
342 local locked_globals_mt = {
343 __index = function (t, k) log("warn", "%s", debug.traceback("Attempt to read a non-existent global '"..tostring(k).."'", 2)); end;
344 __newindex = function (t, k, v) error("Attempt to set a global: "..tostring(k).." = "..tostring(v), 2); end;
347 function prosody.unlock_globals()
348 setmetatable(_G, nil);
351 function prosody.lock_globals()
352 setmetatable(_G, locked_globals_mt);
356 prosody.lock_globals();
360 -- Error handler for errors that make it this far
361 local function catch_uncaught_error(err)
362 if type(err) == "string" and err:match("interrupted!$") then
366 log("error", "Top-level error, please report:\n%s", tostring(err));
367 local traceback = debug.traceback("", 2);
369 log("error", "%s", traceback);
372 prosody.events.fire_event("very-bad-error", {error = err, traceback = traceback});
375 while select(2, xpcall(server.loop, catch_uncaught_error)) ~= "quitting" do
381 log("info", "Shutdown status: Cleaning up");
382 prosody.events.fire_event("server-cleanup");
386 -- These actions are in a strict order, as many depend on
387 -- previous steps to have already been performed
392 set_function_metatable();
393 check_dependencies();
397 log("info", "Hello and welcome to Prosody version %s", prosody.version);
398 log_dependency_warnings();
399 load_secondary_libraries();
401 init_global_protection();
404 prosody.events.fire_event("server-started");
408 log("info", "Shutting down...");
410 prosody.events.fire_event("server-stopped");
411 log("info", "Shutdown complete");