prosody

   1 #!/usr/bin/env lua
   2 -- Prosody IM
   3 -- Copyright (C) 2008-2010 Matthew Wild
   4 -- Copyright (C) 2008-2010 Waqas Hussain
   5 --
   6 -- This project is MIT/X11 licensed. Please see the
   7 -- COPYING file in the source package for more information.
   8 --
   9
  10 -- prosody - main executable for Prosody XMPP server
  11
  12 -- Will be modified by configure script if run --
  13
  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");
  18
  19 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
  20
  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) ~= ":\\")))
  25 end
  26
  27 -- Tell Lua where to find our libraries
  28 if CFG_SOURCEDIR then
  29         local function filter_relative_paths(path)
  30                 if is_relative(path) then return ""; end
  31         end
  32         local function sanitise_paths(paths)
  33                 return (paths:gsub("[^;]+;?", filter_relative_paths):gsub(";;+", ";"));
  34         end
  35         package.path = sanitise_paths(CFG_SOURCEDIR.."/?.lua;"..package.path);
  36         package.cpath = sanitise_paths(CFG_SOURCEDIR.."/?.so;"..package.cpath);
  37 end
  38
  39 -- Substitute ~ with path to home directory in data path
  40 if CFG_DATADIR then
  41         if os.getenv("HOME") then
  42                 CFG_DATADIR = CFG_DATADIR:gsub("^~", os.getenv("HOME"));
  43         end
  44 end
  45
  46 -- Global 'prosody' object
  47 local prosody = { events = require "util.events".new(); };
  48 _G.prosody = prosody;
  49
  50 -- Check dependencies
  51 local dependencies = require "util.dependencies";
  52 if not dependencies.check_dependencies() then
  53         os.exit(1);
  54 end
  55
  56 -- Load the config-parsing module
  57 config = require "core.configmanager"
  58
  59 -- -- -- --
  60 -- Define the functions we call during startup, the
  61 -- actual startup happens right at the end, where these
  62 -- functions get called
  63
  64 function read_config()
  65         local filenames = {};
  66
  67         local filename;
  68         if arg[1] == "--config" and arg[2] then
  69                 table.insert(filenames, arg[2]);
  70                 if CFG_CONFIGDIR then
  71                         table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
  72                 end
  73         else
  74                 for _, format in ipairs(config.parsers()) do
  75                         table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
  76                 end
  77         end
  78         for _,_filename in ipairs(filenames) do
  79                 filename = _filename;
  80                 local file = io.open(filename);
  81                 if file then
  82                         file:close();
  83                         CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
  84                         break;
  85                 end
  86         end
  87         local ok, level, err = config.load(filename);
  88         if not ok then
  89                 print("\n");
  90                 print("**************************");
  91                 if level == "parser" then
  92                         print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua"..":");
  93                         print("");
  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...");
  98                         else
  99                                 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
 100                         end
 101                         print("");
 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.");
 107                 end
 108                 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
 109                 print("Good luck!");
 110                 print("**************************");
 111                 print("");
 112                 os.exit(1);
 113         end
 114 end
 115
 116 function load_libraries()
 117         -- Load socket framework
 118         server = require "net.server"
 119 end
 120
 121 function init_logging()
 122         -- Initialize logging
 123         require "core.loggingmanager"
 124 end
 125
 126 function log_dependency_warnings()
 127         dependencies.log_warnings();
 128 end
 129
 130 function sanity_check()
 131         for host, host_config in pairs(config.getconfig()) do
 132                 if host ~= "*"
 133                 and host_config.core.enabled ~= false
 134                 and not host_config.core.component_module then
 135                         return;
 136                 end
 137         end
 138         log("error", "No enabled VirtualHost entries found in the config file.");
 139         log("error", "At least one active host is required for Prosody to function. Exiting...");
 140         os.exit(1);
 141 end
 142
 143 function sandbox_require()
 144         -- Replace require() with one that doesn't pollute _G, required
 145         -- for neat sandboxing of modules
 146         local _realG = _G;
 147         local _real_require = require;
 148         if not getfenv then
 149                 -- FIXME: This is a hack to replace getfenv() in Lua 5.2
 150                 function getfenv(f) return debug.getupvalue(debug.getinfo(f or 1).func, 1); end
 151         end
 152         function require(...)
 153                 local curr_env = getfenv(2);
 154                 local curr_env_mt = getmetatable(curr_env);
 155                 local _realG_mt = getmetatable(_realG);
 156                 if curr_env_mt and curr_env_mt.__index and not curr_env_mt.__newindex and _realG_mt then
 157                         local old_newindex, old_index;
 158                         old_newindex, _realG_mt.__newindex = _realG_mt.__newindex, curr_env;
 159                         old_index, _realG_mt.__index = _realG_mt.__index, function (_G, k)
 160                                 return rawget(curr_env, k);
 161                         end;
 162                         local ret = _real_require(...);
 163                         _realG_mt.__newindex = old_newindex;
 164                         _realG_mt.__index = old_index;
 165                         return ret;
 166                 end
 167                 return _real_require(...);
 168         end
 169 end
 170
 171 function set_function_metatable()
 172         local mt = {};
 173         function mt.__index(f, upvalue)
 174                 local i, name, value = 0;
 175                 repeat
 176                         i = i + 1;
 177                         name, value = debug.getupvalue(f, i);
 178                 until name == upvalue or name == nil;
 179                 return value;
 180         end
 181         function mt.__newindex(f, upvalue, value)
 182                 local i, name = 0;
 183                 repeat
 184                         i = i + 1;
 185                         name = debug.getupvalue(f, i);
 186                 until name == upvalue or name == nil;
 187                 if name then
 188                         debug.setupvalue(f, i, value);
 189                 end
 190         end
 191         function mt.__tostring(f)
 192                 local info = debug.getinfo(f);
 193                 return ("function(%s:%d)"):format(info.short_src:match("[^\\/]*$"), info.linedefined);
 194         end
 195         debug.setmetatable(function() end, mt);
 196 end
 197
 198 function init_global_state()
 199         bare_sessions = {};
 200         full_sessions = {};
 201         hosts = {};
 202
 203         prosody.bare_sessions = bare_sessions;
 204         prosody.full_sessions = full_sessions;
 205         prosody.hosts = hosts;
 206
 207         local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
 208         local custom_plugin_paths = config.get("*", "core", "plugin_paths");
 209         if custom_plugin_paths then
 210                 local path_sep = package.config:sub(3,3);
 211                 -- path1;path2;path3;defaultpath...
 212                 CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
 213         end
 214         prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR or ".",
 215                           plugins = CFG_PLUGINDIR or "plugins", data = data_path };
 216
 217         prosody.arg = _G.arg;
 218
 219         prosody.platform = "unknown";
 220         if os.getenv("WINDIR") then
 221                 prosody.platform = "windows";
 222         elseif package.config:sub(1,1) == "/" then
 223                 prosody.platform = "posix";
 224         end
 225
 226         prosody.installed = nil;
 227         if CFG_SOURCEDIR and (prosody.platform == "windows" or CFG_SOURCEDIR:match("^/")) then
 228                 prosody.installed = true;
 229         end
 230
 231         if prosody.installed then
 232                 -- Change working directory to data path.
 233                 require "lfs".chdir(data_path);
 234         end
 235
 236         -- Function to reload the config file
 237         function prosody.reload_config()
 238                 log("info", "Reloading configuration file");
 239                 prosody.events.fire_event("reloading-config");
 240                 local ok, level, err = config.load((rawget(_G, "CFG_CONFIGDIR") or ".").."/prosody.cfg.lua");
 241                 if not ok then
 242                         if level == "parser" then
 243                                 log("error", "There was an error parsing the configuration file: %s", tostring(err));
 244                         elseif level == "file" then
 245                                 log("error", "Couldn't read the config file when trying to reload: %s", tostring(err));
 246                         end
 247                 end
 248                 return ok, (err and tostring(level)..": "..tostring(err)) or nil;
 249         end
 250
 251         -- Function to reopen logfiles
 252         function prosody.reopen_logfiles()
 253                 log("info", "Re-opening log files");
 254                 prosody.events.fire_event("reopen-log-files");
 255         end
 256
 257         -- Function to initiate prosody shutdown
 258         function prosody.shutdown(reason)
 259                 log("info", "Shutting down: %s", reason or "unknown reason");
 260                 prosody.shutdown_reason = reason;
 261                 prosody.events.fire_event("server-stopping", {reason = reason});
 262                 server.setquitting(true);
 263         end
 264
 265         -- Load SSL settings from config, and create a ctx table
 266         local certmanager = require "core.certmanager";
 267         local global_ssl_ctx = certmanager.create_context("*", "server");
 268         prosody.global_ssl_ctx = global_ssl_ctx;
 269
 270 end
 271
 272 function read_version()
 273         -- Try to determine version
 274         local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
 275         if version_file then
 276                 prosody.version = version_file:read("*a"):gsub("%s*$", "");
 277                 version_file:close();
 278                 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
 279                         prosody.version = "hg:"..prosody.version;
 280                 end
 281         else
 282                 prosody.version = "unknown";
 283         end
 284 end
 285
 286 function load_secondary_libraries()
 287         --- Load and initialise core modules
 288         require "util.import"
 289         require "util.xmppstream"
 290         require "core.rostermanager"
 291         require "core.stanza_router"
 292         require "core.hostmanager"
 293         require "core.portmanager"
 294         require "core.modulemanager"
 295         require "core.usermanager"
 296         require "core.sessionmanager"
 297         package.loaded['core.componentmanager'] = setmetatable({},{__index=function()
 298                 log("warn", "componentmanager is deprecated: %s", debug.traceback():match("\n[^\n]*\n[ \t]*([^\n]*)"));
 299                 return function() end
 300         end});
 301
 302         require "net.http"
 303
 304         require "util.array"
 305         require "util.datetime"
 306         require "util.iterators"
 307         require "util.timer"
 308         require "util.helpers"
 309
 310         pcall(require, "util.signal") -- Not on Windows
 311
 312         -- Commented to protect us from
 313         -- the second kind of people
 314         --[[
 315         pcall(require, "remdebug.engine");
 316         if remdebug then remdebug.engine.start() end
 317         ]]
 318
 319         require "util.stanza"
 320         require "util.jid"
 321 end
 322
 323 function init_data_store()
 324         require "core.storagemanager";
 325 end
 326
 327 function prepare_to_start()
 328         log("info", "Prosody is using the %s backend for connection handling", server.get_backend());
 329         -- Signal to modules that we are ready to start
 330         prosody.events.fire_event("server-starting");
 331         prosody.start_time = os.time();
 332 end
 333
 334 function init_global_protection()
 335         -- Catch global accesses
 336         local locked_globals_mt = {
 337                 __index = function (t, k) log("warn", "%s", debug.traceback("Attempt to read a non-existent global '"..tostring(k).."'", 2)); end;
 338                 __newindex = function (t, k, v) error("Attempt to set a global: "..tostring(k).." = "..tostring(v), 2); end;
 339         };
 340
 341         function prosody.unlock_globals()
 342                 setmetatable(_G, nil);
 343         end
 344
 345         function prosody.lock_globals()
 346                 setmetatable(_G, locked_globals_mt);
 347         end
 348
 349         -- And lock now...
 350         prosody.lock_globals();
 351 end
 352
 353 function loop()
 354         -- Error handler for errors that make it this far
 355         local function catch_uncaught_error(err)
 356                 if type(err) == "string" and err:match("interrupted!$") then
 357                         return "quitting";
 358                 end
 359
 360                 log("error", "Top-level error, please report:\n%s", tostring(err));
 361                 local traceback = debug.traceback("", 2);
 362                 if traceback then
 363                         log("error", "%s", traceback);
 364                 end
 365
 366                 prosody.events.fire_event("very-bad-error", {error = err, traceback = traceback});
 367         end
 368
 369         while select(2, xpcall(server.loop, catch_uncaught_error)) ~= "quitting" do
 370                 socket.sleep(0.2);
 371         end
 372 end
 373
 374 function cleanup()
 375         log("info", "Shutdown status: Cleaning up");
 376         prosody.events.fire_event("server-cleanup");
 377
 378         -- Ok, we're quitting I know, but we
 379         -- need to do some tidying before we go :)
 380         server.setquitting(false);
 381
 382         log("info", "Shutdown status: Closing all active sessions");
 383         for hostname, host in pairs(hosts) do
 384                 log("debug", "Shutdown status: Closing client connections for %s", hostname)
 385                 if host.sessions then
 386                         local reason = { condition = "system-shutdown", text = "Server is shutting down" };
 387                         if prosody.shutdown_reason then
 388                                 reason.text = reason.text..": "..prosody.shutdown_reason;
 389                         end
 390                         for username, user in pairs(host.sessions) do
 391                                 for resource, session in pairs(user.sessions) do
 392                                         log("debug", "Closing connection for %s@%s/%s", username, hostname, resource);
 393                                         session:close(reason);
 394                                 end
 395                         end
 396                 end
 397
 398                 log("debug", "Shutdown status: Closing outgoing s2s connections from %s", hostname);
 399                 if host.s2sout then
 400                         for remotehost, session in pairs(host.s2sout) do
 401                                 if session.close then
 402                                         session:close("system-shutdown");
 403                                 else
 404                                         log("warn", "Unable to close outgoing s2s session to %s, no session:close()?!", remotehost);
 405                                 end
 406                         end
 407                 end
 408         end
 409
 410         log("info", "Shutdown status: Closing all server connections");
 411         server.closeall();
 412
 413         server.setquitting(true);
 414 end
 415
 416 -- Are you ready? :)
 417 -- These actions are in a strict order, as many depend on
 418 -- previous steps to have already been performed
 419 read_config();
 420 init_logging();
 421 sanity_check();
 422 sandbox_require();
 423 set_function_metatable();
 424 load_libraries();
 425 init_global_state();
 426 read_version();
 427 log("info", "Hello and welcome to Prosody version %s", prosody.version);
 428 log_dependency_warnings();
 429 load_secondary_libraries();
 430 init_data_store();
 431 init_global_protection();
 432 prepare_to_start();
 433
 434 prosody.events.fire_event("server-started");
 435
 436 loop();
 437
 438 log("info", "Shutting down...");
 439 cleanup();
 440 prosody.events.fire_event("server-stopped");
 441 log("info", "Shutdown complete");
 442