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]);
74 for _, format in ipairs(config.parsers()) do
75 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
78 for _,_filename in ipairs(filenames) do
80 local file = io.open(filename);
83 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
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 load_libraries()
117 -- Load socket framework
118 server = require "net.server"
121 function init_logging()
122 -- Initialize logging
123 require "core.loggingmanager"
126 function log_dependency_warnings()
127 dependencies.log_warnings();
130 function sandbox_require()
131 -- Replace require() with one that doesn't pollute _G, required
132 -- for neat sandboxing of modules
134 local _real_require = require;
135 function require(...)
136 local curr_env = getfenv(2);
137 local curr_env_mt = getmetatable(getfenv(2));
138 local _realG_mt = getmetatable(_realG);
139 if curr_env_mt and curr_env_mt.__index and not curr_env_mt.__newindex and _realG_mt then
141 old_newindex, _realG_mt.__newindex = _realG_mt.__newindex, curr_env;
142 local ret = _real_require(...);
143 _realG_mt.__newindex = old_newindex;
146 return _real_require(...);
150 function set_function_metatable()
152 function mt.__index(f, upvalue)
153 local i, name, value = 0;
156 name, value = debug.getupvalue(f, i);
157 until name == upvalue or name == nil;
160 function mt.__newindex(f, upvalue, value)
164 name = debug.getupvalue(f, i);
165 until name == upvalue or name == nil;
167 debug.setupvalue(f, i, value);
170 function mt.__tostring(f)
171 local info = debug.getinfo(f);
172 return ("function(%s:%d)"):format(info.short_src:match("[^\\/]*$"), info.linedefined);
174 debug.setmetatable(function() end, mt);
177 function init_global_state()
182 prosody.bare_sessions = bare_sessions;
183 prosody.full_sessions = full_sessions;
184 prosody.hosts = hosts;
186 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
187 local custom_plugin_paths = config.get("*", "core", "plugin_paths");
188 if custom_plugin_paths then
189 local path_sep = package.config:sub(3,3);
190 -- path1;path2;path3;defaultpath...
191 CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
193 prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR,
194 plugins = CFG_PLUGINDIR or "plugins", data = data_path };
196 prosody.arg = _G.arg;
198 prosody.platform = "unknown";
199 if os.getenv("WINDIR") then
200 prosody.platform = "windows";
201 elseif package.config:sub(1,1) == "/" then
202 prosody.platform = "posix";
205 prosody.installed = nil;
206 if CFG_SOURCEDIR and (prosody.platform == "windows" or CFG_SOURCEDIR:match("^/")) then
207 prosody.installed = true;
210 -- Function to reload the config file
211 function prosody.reload_config()
212 log("info", "Reloading configuration file");
213 prosody.events.fire_event("reloading-config");
214 local ok, level, err = config.load((rawget(_G, "CFG_CONFIGDIR") or ".").."/prosody.cfg.lua");
216 if level == "parser" then
217 log("error", "There was an error parsing the configuration file: %s", tostring(err));
218 elseif level == "file" then
219 log("error", "Couldn't read the config file when trying to reload: %s", tostring(err));
222 return ok, (err and tostring(level)..": "..tostring(err)) or nil;
225 -- Function to reopen logfiles
226 function prosody.reopen_logfiles()
227 log("info", "Re-opening log files");
228 prosody.events.fire_event("reopen-log-files");
231 -- Function to initiate prosody shutdown
232 function prosody.shutdown(reason)
233 log("info", "Shutting down: %s", reason or "unknown reason");
234 prosody.shutdown_reason = reason;
235 prosody.events.fire_event("server-stopping", {reason = reason});
236 server.setquitting(true);
239 -- Load SSL settings from config, and create a ctx table
240 local certmanager = require "core.certmanager";
241 local global_ssl_ctx = certmanager.create_context("*", "server");
242 prosody.global_ssl_ctx = global_ssl_ctx;
244 local cl = require "net.connlisteners";
245 function prosody.net_activate_ports(option, listener, default, conntype)
246 conntype = conntype or (global_ssl_ctx and "tls") or "tcp";
247 local ports_option = option and option.."_ports" or "ports";
248 if not cl.get(listener) then return; end
249 local ports = config.get("*", "core", ports_option) or default;
250 if type(ports) == "number" then ports = {ports} end;
252 if type(ports) ~= "table" then
253 log("error", "core."..ports_option.." is not a table");
255 for _, port in ipairs(ports) do
256 port = tonumber(port);
257 if type(port) ~= "number" then
258 log("error", "Non-numeric "..ports_option..": "..tostring(port));
260 local ok, err = cl.start(listener, {
261 ssl = conntype == "ssl" and global_ssl_ctx,
263 interface = (option and config.get("*", "core", option.."_interface"))
264 or cl.get(listener).default_interface
265 or config.get("*", "core", "interface"),
269 local friendly_message = err;
270 if err:match(" in use") then
271 if port == 5222 or port == 5223 or port == 5269 then
272 friendly_message = "check that Prosody or another XMPP server is "
273 .."not already running and using this port";
274 elseif port == 80 or port == 81 then
275 friendly_message = "check that a HTTP server is not already using "
277 elseif port == 5280 then
278 friendly_message = "check that Prosody or a BOSH connection manager "
279 .."is not already running";
281 friendly_message = "this port is in use by another application";
283 elseif err:match("permission") then
284 friendly_message = "Prosody does not have sufficient privileges to use this port";
285 elseif err == "no ssl context" then
286 if not config.get("*", "core", "ssl") then
287 friendly_message = "there is no 'ssl' config under Host \"*\" which is "
288 .."require for legacy SSL ports";
290 friendly_message = "initializing SSL support failed, see previous log entries";
293 log("error", "Failed to open server port %d, %s", port, friendly_message);
301 function read_version()
302 -- Try to determine version
303 local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
305 prosody.version = version_file:read("*a"):gsub("%s*$", "");
306 version_file:close();
307 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
308 prosody.version = "hg:"..prosody.version;
311 prosody.version = "unknown";
315 function load_secondary_libraries()
316 --- Load and initialise core modules
317 require "util.import"
318 require "util.xmppstream"
319 require "core.rostermanager"
320 require "core.hostmanager"
321 require "core.modulemanager"
322 require "core.usermanager"
323 require "core.sessionmanager"
324 require "core.stanza_router"
325 package.loaded['core.componentmanager'] = setmetatable({},{__index=function()
326 log("warn", "componentmanager is deprecated: %s", debug.traceback():match("\n[^\n]*\n[\s\t]*([^\n]*)"));
327 return function() end
333 require "util.datetime"
334 require "util.iterators"
336 require "util.helpers"
338 pcall(require, "util.signal") -- Not on Windows
340 -- Commented to protect us from
341 -- the second kind of people
343 pcall(require, "remdebug.engine");
344 if remdebug then remdebug.engine.start() end
347 require "net.connlisteners";
348 require "net.httpserver";
350 require "util.stanza"
354 function init_data_store()
355 require "core.storagemanager";
358 function prepare_to_start()
359 log("info", "Prosody is using the %s backend for connection handling", server.get_backend());
360 -- Signal to modules that we are ready to start
361 prosody.events.fire_event("server-starting");
363 -- start listening on sockets
364 if config.get("*", "core", "ports") then
365 prosody.net_activate_ports(nil, "multiplex", {5222, 5269});
366 if config.get("*", "core", "ssl_ports") then
367 prosody.net_activate_ports("ssl", "multiplex", {5223}, "ssl");
370 prosody.net_activate_ports("c2s", "xmppclient", {5222});
371 prosody.net_activate_ports("s2s", "xmppserver", {5269});
372 prosody.net_activate_ports("component", "xmppcomponent", {5347}, "tcp");
373 prosody.net_activate_ports("legacy_ssl", "xmppclient", {}, "ssl");
376 prosody.start_time = os.time();
379 function init_global_protection()
380 -- Catch global accesses
381 local locked_globals_mt = {
382 __index = function (t, k) log("warn", "%s", debug.traceback("Attempt to read a non-existent global '"..tostring(k).."'", 2)); end;
383 __newindex = function (t, k, v) error("Attempt to set a global: "..tostring(k).." = "..tostring(v), 2); end;
386 function prosody.unlock_globals()
387 setmetatable(_G, nil);
390 function prosody.lock_globals()
391 setmetatable(_G, locked_globals_mt);
395 prosody.lock_globals();
399 -- Error handler for errors that make it this far
400 local function catch_uncaught_error(err)
401 if type(err) == "string" and err:match("interrupted!$") then
405 log("error", "Top-level error, please report:\n%s", tostring(err));
406 local traceback = debug.traceback("", 2);
408 log("error", "%s", traceback);
411 prosody.events.fire_event("very-bad-error", {error = err, traceback = traceback});
414 while select(2, xpcall(server.loop, catch_uncaught_error)) ~= "quitting" do
420 log("info", "Shutdown status: Cleaning up");
421 prosody.events.fire_event("server-cleanup");
423 -- Ok, we're quitting I know, but we
424 -- need to do some tidying before we go :)
425 server.setquitting(false);
427 log("info", "Shutdown status: Closing all active sessions");
428 for hostname, host in pairs(hosts) do
429 log("debug", "Shutdown status: Closing client connections for %s", hostname)
430 if host.sessions then
431 local reason = { condition = "system-shutdown", text = "Server is shutting down" };
432 if prosody.shutdown_reason then
433 reason.text = reason.text..": "..prosody.shutdown_reason;
435 for username, user in pairs(host.sessions) do
436 for resource, session in pairs(user.sessions) do
437 log("debug", "Closing connection for %s@%s/%s", username, hostname, resource);
438 session:close(reason);
443 log("debug", "Shutdown status: Closing outgoing s2s connections from %s", hostname);
445 for remotehost, session in pairs(host.s2sout) do
446 if session.close then
447 session:close("system-shutdown");
449 log("warn", "Unable to close outgoing s2s session to %s, no session:close()?!", remotehost);
455 log("info", "Shutdown status: Closing all server connections");
458 server.setquitting(true);
462 -- These actions are in a strict order, as many depend on
463 -- previous steps to have already been performed
467 set_function_metatable();
471 log("info", "Hello and welcome to Prosody version %s", prosody.version);
472 log_dependency_warnings();
473 load_secondary_libraries();
475 init_global_protection();
478 prosody.events.fire_event("server-started");
482 log("info", "Shutting down...");
484 prosody.events.fire_event("server-stopped");
485 log("info", "Shutdown complete");