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 -- Tell Lua where to find our libraries
23 package.path = CFG_SOURCEDIR.."/?.lua;"..package.path;
24 package.cpath = CFG_SOURCEDIR.."/?.so;"..package.cpath;
27 -- Substitute ~ with path to home directory in data path
29 if os.getenv("HOME") then
30 CFG_DATADIR = CFG_DATADIR:gsub("^~", os.getenv("HOME"));
34 -- Global 'prosody' object
35 prosody = { events = require "util.events".new(); };
36 local prosody = prosody;
38 -- Load the config-parsing module
39 config = require "core.configmanager"
42 -- Define the functions we call during startup, the
43 -- actual startup happens right at the end, where these
44 -- functions get called
46 function read_config()
50 if arg[1] == "--config" and arg[2] then
51 table.insert(filenames, arg[2]);
53 table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
56 for _, format in ipairs(config.parsers()) do
57 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
60 for _,_filename in ipairs(filenames) do
62 local file = io.open(filename);
65 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
69 local ok, level, err = config.load(filename);
72 print("**************************");
73 if level == "parser" then
74 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
75 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
76 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
78 elseif level == "file" then
79 print("Prosody was unable to find the configuration file.");
80 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
81 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
82 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
84 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
86 print("**************************");
92 function load_libraries()
93 -- Load socket framework
94 server = require "net.server"
97 function init_logging()
99 require "core.loggingmanager"
102 function check_dependencies()
103 -- Check runtime dependencies
104 if not require "util.dependencies".check_dependencies() then
109 function sandbox_require()
110 -- Replace require() with one that doesn't pollute _G, required
111 -- for neat sandboxing of modules
113 local _real_require = require;
114 function require(...)
115 local curr_env = getfenv(2);
116 local curr_env_mt = getmetatable(getfenv(2));
117 local _realG_mt = getmetatable(_realG);
118 if curr_env_mt and curr_env_mt.__index and not curr_env_mt.__newindex and _realG_mt then
120 old_newindex, _realG_mt.__newindex = _realG_mt.__newindex, curr_env;
121 local ret = _real_require(...);
122 _realG_mt.__newindex = old_newindex;
125 return _real_require(...);
129 function set_function_metatable()
131 function mt.__index(f, upvalue)
132 local i, name, value = 0;
135 name, value = debug.getupvalue(f, i);
136 until name == upvalue or name == nil;
139 function mt.__newindex(f, upvalue, value)
143 name = debug.getupvalue(f, i);
144 until name == upvalue or name == nil;
146 debug.setupvalue(f, i, value);
149 function mt.__tostring(f)
150 local info = debug.getinfo(f);
151 return ("function(%s:%d)"):format(info.short_src:match("[^\\/]*$"), info.linedefined);
153 debug.setmetatable(function() end, mt);
156 function init_global_state()
161 prosody.bare_sessions = bare_sessions;
162 prosody.full_sessions = full_sessions;
163 prosody.hosts = hosts;
165 prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR,
166 plugins = CFG_PLUGINDIR, data = CFG_DATADIR };
168 prosody.arg = _G.arg;
170 prosody.platform = "unknown";
171 if os.getenv("WINDIR") then
172 prosody.platform = "windows";
173 elseif package.config:sub(1,1) == "/" then
174 prosody.platform = "posix";
177 prosody.installed = nil;
178 if CFG_SOURCEDIR and (prosody.platform == "windows" or CFG_SOURCEDIR:match("^/")) then
179 prosody.installed = true;
182 -- Function to reload the config file
183 function prosody.reload_config()
184 log("info", "Reloading configuration file");
185 prosody.events.fire_event("reloading-config");
186 local ok, level, err = config.load((rawget(_G, "CFG_CONFIGDIR") or ".").."/prosody.cfg.lua");
188 if level == "parser" then
189 log("error", "There was an error parsing the configuration file: %s", tostring(err));
190 elseif level == "file" then
191 log("error", "Couldn't read the config file when trying to reload: %s", tostring(err));
194 return ok, (err and tostring(level)..": "..tostring(err)) or nil;
197 -- Function to reopen logfiles
198 function prosody.reopen_logfiles()
199 log("info", "Re-opening log files");
200 prosody.events.fire_event("reopen-log-files");
203 -- Function to initiate prosody shutdown
204 function prosody.shutdown(reason)
205 log("info", "Shutting down: %s", reason or "unknown reason");
206 prosody.shutdown_reason = reason;
207 prosody.events.fire_event("server-stopping", {reason = reason});
208 server.setquitting(true);
211 -- Load SSL settings from config, and create a ctx table
212 local certmanager = require "core.certmanager";
213 local global_ssl_ctx = certmanager.create_context("*", "server");
214 prosody.global_ssl_ctx = global_ssl_ctx;
216 local cl = require "net.connlisteners";
217 function prosody.net_activate_ports(option, listener, default, conntype)
218 conntype = conntype or (global_ssl_ctx and "tls") or "tcp";
219 local ports_option = option and option.."_ports" or "ports";
220 if not cl.get(listener) then return; end
221 local ports = config.get("*", "core", ports_option) or default;
222 if type(ports) == "number" then ports = {ports} end;
224 if type(ports) ~= "table" then
225 log("error", "core."..ports_option.." is not a table");
227 for _, port in ipairs(ports) do
228 port = tonumber(port);
229 if type(port) ~= "number" then
230 log("error", "Non-numeric "..ports_option..": "..tostring(port));
232 local ok, err = cl.start(listener, {
233 ssl = conntype == "ssl" and global_ssl_ctx,
235 interface = (option and config.get("*", "core", option.."_interface"))
236 or cl.get(listener).default_interface
237 or config.get("*", "core", "interface"),
241 local friendly_message = err;
242 if err:match(" in use") then
243 if port == 5222 or port == 5223 or port == 5269 then
244 friendly_message = "check that Prosody or another XMPP server is "
245 .."not already running and using this port";
246 elseif port == 80 or port == 81 then
247 friendly_message = "check that a HTTP server is not already using "
249 elseif port == 5280 then
250 friendly_message = "check that Prosody or a BOSH connection manager "
251 .."is not already running";
253 friendly_message = "this port is in use by another application";
255 elseif err:match("permission") then
256 friendly_message = "Prosody does not have sufficient privileges to use this port";
257 elseif err == "no ssl context" then
258 if not config.get("*", "core", "ssl") then
259 friendly_message = "there is no 'ssl' config under Host \"*\" which is "
260 .."require for legacy SSL ports";
262 friendly_message = "initializing SSL support failed, see previous log entries";
265 log("error", "Failed to open server port %d, %s", port, friendly_message);
273 function read_version()
274 -- Try to determine version
275 local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
277 prosody.version = version_file:read("*a"):gsub("%s*$", "");
278 version_file:close();
279 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
280 prosody.version = "hg:"..prosody.version;
283 prosody.version = "unknown";
287 function load_secondary_libraries()
288 --- Load and initialise core modules
289 require "util.import"
290 require "util.xmppstream"
291 require "core.rostermanager"
292 require "core.hostmanager"
293 require "core.modulemanager"
294 require "core.usermanager"
295 require "core.sessionmanager"
296 require "core.stanza_router"
297 package.loaded['core.componentmanager'] = setmetatable({},{__index=function()
298 log("warn", "componentmanager is deprecated: %s", debug.traceback():match("\n[^\n]*\n[\s\t]*([^\n]*)"));
299 return function() end
305 require "util.datetime"
306 require "util.iterators"
308 require "util.helpers"
310 pcall(require, "util.signal") -- Not on Windows
312 -- Commented to protect us from
313 -- the second kind of people
315 pcall(require, "remdebug.engine");
316 if remdebug then remdebug.engine.start() end
319 require "net.connlisteners";
321 require "util.stanza"
325 function init_data_store()
326 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
327 require "util.datamanager".set_data_path(data_path);
328 require "util.datamanager".add_callback(function(username, host, datastore, data)
329 if config.get(host, "core", "anonymous_login") then
332 return username, host, datastore, data;
334 require "core.storagemanager";
337 function prepare_to_start()
338 log("info", "Prosody is using the %s backend for connection handling", server.get_backend());
339 -- Signal to modules that we are ready to start
340 prosody.events.fire_event("server-starting");
342 -- start listening on sockets
343 if config.get("*", "core", "ports") then
344 prosody.net_activate_ports(nil, "multiplex", {5222, 5269});
345 if config.get("*", "core", "ssl_ports") then
346 prosody.net_activate_ports("ssl", "multiplex", {5223}, "ssl");
349 prosody.net_activate_ports("c2s", "xmppclient", {5222});
350 prosody.net_activate_ports("s2s", "xmppserver", {5269});
351 prosody.net_activate_ports("component", "xmppcomponent", {5347}, "tcp");
352 prosody.net_activate_ports("legacy_ssl", "xmppclient", {}, "ssl");
355 prosody.start_time = os.time();
358 function init_global_protection()
359 -- Catch global accesses
360 local locked_globals_mt = {
361 __index = function (t, k) log("warn", "%s", debug.traceback("Attempt to read a non-existent global '"..tostring(k).."'", 2)); end;
362 __newindex = function (t, k, v) error("Attempt to set a global: "..tostring(k).." = "..tostring(v), 2); end;
365 function prosody.unlock_globals()
366 setmetatable(_G, nil);
369 function prosody.lock_globals()
370 setmetatable(_G, locked_globals_mt);
374 prosody.lock_globals();
378 -- Error handler for errors that make it this far
379 local function catch_uncaught_error(err)
380 if type(err) == "string" and err:match("interrupted!$") then
384 log("error", "Top-level error, please report:\n%s", tostring(err));
385 local traceback = debug.traceback("", 2);
387 log("error", "%s", traceback);
390 prosody.events.fire_event("very-bad-error", {error = err, traceback = traceback});
393 while select(2, xpcall(server.loop, catch_uncaught_error)) ~= "quitting" do
399 log("info", "Shutdown status: Cleaning up");
400 prosody.events.fire_event("server-cleanup");
402 -- Ok, we're quitting I know, but we
403 -- need to do some tidying before we go :)
404 server.setquitting(false);
406 log("info", "Shutdown status: Closing all active sessions");
407 for hostname, host in pairs(hosts) do
408 log("debug", "Shutdown status: Closing client connections for %s", hostname)
409 if host.sessions then
410 local reason = { condition = "system-shutdown", text = "Server is shutting down" };
411 if prosody.shutdown_reason then
412 reason.text = reason.text..": "..prosody.shutdown_reason;
414 for username, user in pairs(host.sessions) do
415 for resource, session in pairs(user.sessions) do
416 log("debug", "Closing connection for %s@%s/%s", username, hostname, resource);
417 session:close(reason);
422 log("debug", "Shutdown status: Closing outgoing s2s connections from %s", hostname);
424 for remotehost, session in pairs(host.s2sout) do
425 if session.close then
426 session:close("system-shutdown");
428 log("warn", "Unable to close outgoing s2s session to %s, no session:close()?!", remotehost);
434 log("info", "Shutdown status: Closing all server connections");
437 server.setquitting(true);
441 -- These actions are in a strict order, as many depend on
442 -- previous steps to have already been performed
445 check_dependencies();
447 set_function_metatable();
451 log("info", "Hello and welcome to Prosody version %s", prosody.version);
452 load_secondary_libraries();
454 init_global_protection();
457 prosody.events.fire_event("server-started");
461 log("info", "Shutting down...");
463 prosody.events.fire_event("server-stopped");
464 log("info", "Shutdown complete");