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";
52 if not dependencies.check_dependencies() then
56 -- Load the config-parsing module
57 config = require "core.configmanager"
60 -- Define the functions we call during startup, the
61 -- actual startup happens right at the end, where these
62 -- functions get called
64 function read_config()
68 if arg[1] == "--config" and arg[2] then
69 table.insert(filenames, arg[2]);
71 table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
73 elseif os.getenv("PROSODY_CONFIG") then -- Passed by prosodyctl
74 table.insert(filenames, os.getenv("PROSODY_CONFIG"));
76 for _, format in ipairs(config.parsers()) do
77 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
80 for _,_filename in ipairs(filenames) do
82 local file = io.open(filename);
85 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
89 local ok, level, err = config.load(filename);
92 print("**************************");
93 if level == "parser" then
94 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua"..":");
96 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
97 if err:match("chunk has too many syntax levels$") then
98 print("An Include statement in a config file is including an already-included");
99 print("file and causing an infinite loop. An Include statement in a config file is...");
101 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
104 elseif level == "file" then
105 print("Prosody was unable to find the configuration file.");
106 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
107 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
108 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
110 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
112 print("**************************");
118 function load_libraries()
119 -- Load socket framework
120 server = require "net.server"
123 function init_logging()
124 -- Initialize logging
125 require "core.loggingmanager"
128 function log_dependency_warnings()
129 dependencies.log_warnings();
132 function sanity_check()
133 for host, host_config in pairs(config.getconfig()) do
135 and host_config.enabled ~= false
136 and not host_config.component_module then
140 log("error", "No enabled VirtualHost entries found in the config file.");
141 log("error", "At least one active host is required for Prosody to function. Exiting...");
145 function sandbox_require()
146 -- Replace require() with one that doesn't pollute _G, required
147 -- for neat sandboxing of modules
149 local _real_require = require;
151 -- FIXME: This is a hack to replace getfenv() in Lua 5.2
152 function getfenv(f) return debug.getupvalue(debug.getinfo(f or 1).func, 1); end
154 function require(...)
155 local curr_env = getfenv(2);
156 local curr_env_mt = getmetatable(curr_env);
157 local _realG_mt = getmetatable(_realG);
158 if curr_env_mt and curr_env_mt.__index and not curr_env_mt.__newindex and _realG_mt then
159 local old_newindex, old_index;
160 old_newindex, _realG_mt.__newindex = _realG_mt.__newindex, curr_env;
161 old_index, _realG_mt.__index = _realG_mt.__index, function (_G, k)
162 return rawget(curr_env, k);
164 local ret = _real_require(...);
165 _realG_mt.__newindex = old_newindex;
166 _realG_mt.__index = old_index;
169 return _real_require(...);
173 function set_function_metatable()
175 function mt.__index(f, upvalue)
176 local i, name, value = 0;
179 name, value = debug.getupvalue(f, i);
180 until name == upvalue or name == nil;
183 function mt.__newindex(f, upvalue, value)
187 name = debug.getupvalue(f, i);
188 until name == upvalue or name == nil;
190 debug.setupvalue(f, i, value);
193 function mt.__tostring(f)
194 local info = debug.getinfo(f);
195 return ("function(%s:%d)"):format(info.short_src:match("[^\\/]*$"), info.linedefined);
197 debug.setmetatable(function() end, mt);
200 function init_global_state()
201 -- COMPAT: These globals are deprecated
206 prosody.bare_sessions = bare_sessions;
207 prosody.full_sessions = full_sessions;
208 prosody.hosts = hosts;
210 local data_path = config.get("*", "data_path") or CFG_DATADIR or "data";
211 local custom_plugin_paths = config.get("*", "plugin_paths");
212 if custom_plugin_paths then
213 local path_sep = package.config:sub(3,3);
214 -- path1;path2;path3;defaultpath...
215 CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
217 prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR or ".",
218 plugins = CFG_PLUGINDIR or "plugins", data = data_path };
220 prosody.arg = _G.arg;
222 prosody.platform = "unknown";
223 if os.getenv("WINDIR") then
224 prosody.platform = "windows";
225 elseif package.config:sub(1,1) == "/" then
226 prosody.platform = "posix";
229 prosody.installed = nil;
230 if CFG_SOURCEDIR and (prosody.platform == "windows" or CFG_SOURCEDIR:match("^/")) then
231 prosody.installed = true;
234 if prosody.installed then
235 -- Change working directory to data path.
236 require "lfs".chdir(data_path);
239 -- Function to reload the config file
240 function prosody.reload_config()
241 log("info", "Reloading configuration file");
242 prosody.events.fire_event("reloading-config");
243 local ok, level, err = config.load((rawget(_G, "CFG_CONFIGDIR") or ".").."/prosody.cfg.lua");
245 if level == "parser" then
246 log("error", "There was an error parsing the configuration file: %s", tostring(err));
247 elseif level == "file" then
248 log("error", "Couldn't read the config file when trying to reload: %s", tostring(err));
251 return ok, (err and tostring(level)..": "..tostring(err)) or nil;
254 -- Function to reopen logfiles
255 function prosody.reopen_logfiles()
256 log("info", "Re-opening log files");
257 prosody.events.fire_event("reopen-log-files");
260 -- Function to initiate prosody shutdown
261 function prosody.shutdown(reason)
262 log("info", "Shutting down: %s", reason or "unknown reason");
263 prosody.shutdown_reason = reason;
264 prosody.events.fire_event("server-stopping", {reason = reason});
265 server.setquitting(true);
268 -- Load SSL settings from config, and create a ctx table
269 local certmanager = require "core.certmanager";
270 local global_ssl_ctx = certmanager.create_context("*", "server");
271 prosody.global_ssl_ctx = global_ssl_ctx;
275 function read_version()
276 -- Try to determine version
277 local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
279 prosody.version = version_file:read("*a"):gsub("%s*$", "");
280 version_file:close();
281 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
282 prosody.version = "hg:"..prosody.version;
285 prosody.version = "unknown";
289 function load_secondary_libraries()
290 --- Load and initialise core modules
291 require "util.import"
292 require "util.xmppstream"
293 require "core.rostermanager"
294 require "core.stanza_router"
295 require "core.hostmanager"
296 require "core.portmanager"
297 require "core.modulemanager"
298 require "core.usermanager"
299 require "core.sessionmanager"
300 package.loaded['core.componentmanager'] = setmetatable({},{__index=function()
301 log("warn", "componentmanager is deprecated: %s", debug.traceback():match("\n[^\n]*\n[ \t]*([^\n]*)"));
302 return function() end
308 require "util.datetime"
309 require "util.iterators"
311 require "util.helpers"
313 pcall(require, "util.signal") -- Not on Windows
315 -- Commented to protect us from
316 -- the second kind of people
318 pcall(require, "remdebug.engine");
319 if remdebug then remdebug.engine.start() end
322 require "util.stanza"
326 function init_data_store()
327 require "core.storagemanager";
330 function prepare_to_start()
331 log("info", "Prosody is using the %s backend for connection handling", server.get_backend());
332 -- Signal to modules that we are ready to start
333 prosody.events.fire_event("server-starting");
334 prosody.start_time = os.time();
337 function init_global_protection()
338 -- Catch global accesses
339 local locked_globals_mt = {
340 __index = function (t, k) log("warn", "%s", debug.traceback("Attempt to read a non-existent global '"..tostring(k).."'", 2)); end;
341 __newindex = function (t, k, v) error("Attempt to set a global: "..tostring(k).." = "..tostring(v), 2); end;
344 function prosody.unlock_globals()
345 setmetatable(_G, nil);
348 function prosody.lock_globals()
349 setmetatable(_G, locked_globals_mt);
353 prosody.lock_globals();
357 -- Error handler for errors that make it this far
358 local function catch_uncaught_error(err)
359 if type(err) == "string" and err:match("interrupted!$") then
363 log("error", "Top-level error, please report:\n%s", tostring(err));
364 local traceback = debug.traceback("", 2);
366 log("error", "%s", traceback);
369 prosody.events.fire_event("very-bad-error", {error = err, traceback = traceback});
372 while select(2, xpcall(server.loop, catch_uncaught_error)) ~= "quitting" do
378 log("info", "Shutdown status: Cleaning up");
379 prosody.events.fire_event("server-cleanup");
383 -- These actions are in a strict order, as many depend on
384 -- previous steps to have already been performed
389 set_function_metatable();
393 log("info", "Hello and welcome to Prosody version %s", prosody.version);
394 log_dependency_warnings();
395 load_secondary_libraries();
397 init_global_protection();
400 prosody.events.fire_event("server-started");
404 log("info", "Shutting down...");
406 prosody.events.fire_event("server-stopped");
407 log("info", "Shutdown complete");