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
  53 -- Load the config-parsing module
  54 config = require "core.configmanager"
  55
  56 -- -- -- --
  57 -- Define the functions we call during startup, the
  58 -- actual startup happens right at the end, where these
  59 -- functions get called
  60
  61 function read_config()
  62         local filenames = {};
  63
  64         local filename;
  65         if arg[1] == "--config" and arg[2] then
  66                 table.insert(filenames, arg[2]);
  67                 if CFG_CONFIGDIR then
  68                         table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
  69                 end
  70         elseif os.getenv("PROSODY_CONFIG") then -- Passed by prosodyctl
  71                         table.insert(filenames, os.getenv("PROSODY_CONFIG"));
  72         else
  73                 for _, format in ipairs(config.parsers()) do
  74                         table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
  75                 end
  76         end
  77         for _,_filename in ipairs(filenames) do
  78                 filename = _filename;
  79                 local file = io.open(filename);
  80                 if file then
  81                         file:close();
  82                         CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
  83                         break;
  84                 end
  85         end
  86         prosody.config_file = filename
  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 check_dependencies()
 117         if not dependencies.check_dependencies() then
 118                 os.exit(1);
 119         end
 120 end
 121
 122 function load_libraries()
 123         -- Load socket framework
 124         server = require "net.server"
 125 end
 126
 127 function init_logging()
 128         -- Initialize logging
 129         require "core.loggingmanager"
 130 end
 131
 132 function log_dependency_warnings()
 133         dependencies.log_warnings();
 134 end
 135
 136 function sanity_check()
 137         for host, host_config in pairs(config.getconfig()) do
 138                 if host ~= "*"
 139                 and host_config.enabled ~= false
 140                 and not host_config.component_module then
 141                         return;
 142                 end
 143         end
 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...");
 146         os.exit(1);
 147 end
 148
 149 function sandbox_require()
 150         -- Replace require() with one that doesn't pollute _G, required
 151         -- for neat sandboxing of modules
 152         local _realG = _G;
 153         local _real_require = require;
 154         local getfenv = getfenv or function (f)
 155                 -- FIXME: This is a hack to replace getfenv() in Lua 5.2
 156                 local name, env = debug.getupvalue(debug.getinfo(f or 1).func, 1);
 157                 if name == "_ENV" then
 158                         return env;
 159                 end
 160         end
 161         function require(...)
 162                 local curr_env = getfenv(2);
 163                 local curr_env_mt = getmetatable(curr_env);
 164                 local _realG_mt = getmetatable(_realG);
 165                 if curr_env_mt and curr_env_mt.__index and not curr_env_mt.__newindex and _realG_mt then
 166                         local old_newindex, old_index;
 167                         old_newindex, _realG_mt.__newindex = _realG_mt.__newindex, curr_env;
 168                         old_index, _realG_mt.__index = _realG_mt.__index, function (_G, k)
 169                                 return rawget(curr_env, k);
 170                         end;
 171                         local ret = _real_require(...);
 172                         _realG_mt.__newindex = old_newindex;
 173                         _realG_mt.__index = old_index;
 174                         return ret;
 175                 end
 176                 return _real_require(...);
 177         end
 178 end
 179
 180 function set_function_metatable()
 181         local mt = {};
 182         function mt.__index(f, upvalue)
 183                 local i, name, value = 0;
 184                 repeat
 185                         i = i + 1;
 186                         name, value = debug.getupvalue(f, i);
 187                 until name == upvalue or name == nil;
 188                 return value;
 189         end
 190         function mt.__newindex(f, upvalue, value)
 191                 local i, name = 0;
 192                 repeat
 193                         i = i + 1;
 194                         name = debug.getupvalue(f, i);
 195                 until name == upvalue or name == nil;
 196                 if name then
 197                         debug.setupvalue(f, i, value);
 198                 end
 199         end
 200         function mt.__tostring(f)
 201                 local info = debug.getinfo(f);
 202                 return ("function(%s:%d)"):format(info.short_src:match("[^\\/]*$"), info.linedefined);
 203         end
 204         debug.setmetatable(function() end, mt);
 205 end
 206
 207 function init_global_state()
 208         -- COMPAT: These globals are deprecated
 209         bare_sessions = {};
 210         full_sessions = {};
 211         hosts = {};
 212
 213         prosody.bare_sessions = bare_sessions;
 214         prosody.full_sessions = full_sessions;
 215         prosody.hosts = hosts;
 216
 217         local data_path = config.get("*", "data_path") or CFG_DATADIR or "data";
 218         local custom_plugin_paths = config.get("*", "plugin_paths");
 219         if custom_plugin_paths then
 220                 local path_sep = package.config:sub(3,3);
 221                 -- path1;path2;path3;defaultpath...
 222                 CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
 223         end
 224         prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR or ".",
 225                           plugins = CFG_PLUGINDIR or "plugins", data = data_path };
 226
 227         prosody.arg = _G.arg;
 228
 229         prosody.platform = "unknown";
 230         if os.getenv("WINDIR") then
 231                 prosody.platform = "windows";
 232         elseif package.config:sub(1,1) == "/" then
 233                 prosody.platform = "posix";
 234         end
 235
 236         prosody.installed = nil;
 237         if CFG_SOURCEDIR and (prosody.platform == "windows" or CFG_SOURCEDIR:match("^/")) then
 238                 prosody.installed = true;
 239         end
 240
 241         if prosody.installed then
 242                 -- Change working directory to data path.
 243                 require "lfs".chdir(data_path);
 244         end
 245
 246         -- Function to reload the config file
 247         function prosody.reload_config()
 248                 log("info", "Reloading configuration file");
 249                 prosody.events.fire_event("reloading-config");
 250                 local ok, level, err = config.load(prosody.config_file);
 251                 if not ok then
 252                         if level == "parser" then
 253                                 log("error", "There was an error parsing the configuration file: %s", tostring(err));
 254                         elseif level == "file" then
 255                                 log("error", "Couldn't read the config file when trying to reload: %s", tostring(err));
 256                         end
 257                 end
 258                 return ok, (err and tostring(level)..": "..tostring(err)) or nil;
 259         end
 260
 261         -- Function to reopen logfiles
 262         function prosody.reopen_logfiles()
 263                 log("info", "Re-opening log files");
 264                 prosody.events.fire_event("reopen-log-files");
 265         end
 266
 267         -- Function to initiate prosody shutdown
 268         function prosody.shutdown(reason)
 269                 log("info", "Shutting down: %s", reason or "unknown reason");
 270                 prosody.shutdown_reason = reason;
 271                 prosody.events.fire_event("server-stopping", {reason = reason});
 272                 server.setquitting(true);
 273         end
 274 end
 275
 276 function read_version()
 277         -- Try to determine version
 278         local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
 279         if version_file then
 280                 prosody.version = version_file:read("*a"):gsub("%s*$", "");
 281                 version_file:close();
 282                 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
 283                         prosody.version = "hg:"..prosody.version;
 284                 end
 285         else
 286                 prosody.version = "unknown";
 287         end
 288 end
 289
 290 function load_secondary_libraries()
 291         --- Load and initialise core modules
 292         require "util.import"
 293         require "util.xmppstream"
 294         require "core.stanza_router"
 295         require "core.statsmanager"
 296         require "core.hostmanager"
 297         require "core.portmanager"
 298         require "core.modulemanager"
 299         require "core.usermanager"
 300         require "core.rostermanager"
 301         require "core.sessionmanager"
 302         package.loaded['core.componentmanager'] = setmetatable({},{__index=function()
 303                 log("warn", "componentmanager is deprecated: %s", debug.traceback():match("\n[^\n]*\n[ \t]*([^\n]*)"));
 304                 return function() end
 305         end});
 306
 307         require "net.http"
 308
 309         require "util.array"
 310         require "util.datetime"
 311         require "util.iterators"
 312         require "util.timer"
 313         require "util.helpers"
 314
 315         pcall(require, "util.signal") -- Not on Windows
 316
 317         -- Commented to protect us from
 318         -- the second kind of people
 319         --[[
 320         pcall(require, "remdebug.engine");
 321         if remdebug then remdebug.engine.start() end
 322         ]]
 323
 324         require "util.stanza"
 325         require "util.jid"
 326 end
 327
 328 function init_data_store()
 329         require "core.storagemanager";
 330 end
 331
 332 function prepare_to_start()
 333         log("info", "Prosody is using the %s backend for connection handling", server.get_backend());
 334         -- Signal to modules that we are ready to start
 335         prosody.events.fire_event("server-starting");
 336         prosody.start_time = os.time();
 337 end
 338
 339 function init_global_protection()
 340         -- Catch global accesses
 341         local locked_globals_mt = {
 342                 __index = function (t, k) log("warn", "%s", debug.traceback("Attempt to read a non-existent global '"..tostring(k).."'", 2)); end;
 343                 __newindex = function (t, k, v) error("Attempt to set a global: "..tostring(k).." = "..tostring(v), 2); end;
 344         };
 345
 346         function prosody.unlock_globals()
 347                 setmetatable(_G, nil);
 348         end
 349
 350         function prosody.lock_globals()
 351                 setmetatable(_G, locked_globals_mt);
 352         end
 353
 354         -- And lock now...
 355         prosody.lock_globals();
 356 end
 357
 358 function loop()
 359         -- Error handler for errors that make it this far
 360         local function catch_uncaught_error(err)
 361                 if type(err) == "string" and err:match("interrupted!$") then
 362                         return "quitting";
 363                 end
 364
 365                 log("error", "Top-level error, please report:\n%s", tostring(err));
 366                 local traceback = debug.traceback("", 2);
 367                 if traceback then
 368                         log("error", "%s", traceback);
 369                 end
 370
 371                 prosody.events.fire_event("very-bad-error", {error = err, traceback = traceback});
 372         end
 373
 374         while select(2, xpcall(server.loop, catch_uncaught_error)) ~= "quitting" do
 375                 socket.sleep(0.2);
 376         end
 377 end
 378
 379 function cleanup()
 380         log("info", "Shutdown status: Cleaning up");
 381         prosody.events.fire_event("server-cleanup");
 382 end
 383
 384 -- Are you ready? :)
 385 -- These actions are in a strict order, as many depend on
 386 -- previous steps to have already been performed
 387 read_config();
 388 init_logging();
 389 sanity_check();
 390 sandbox_require();
 391 set_function_metatable();
 392 check_dependencies();
 393 load_libraries();
 394 init_global_state();
 395 read_version();
 396 log("info", "Hello and welcome to Prosody version %s", prosody.version);
 397 log_dependency_warnings();
 398 load_secondary_libraries();
 399 init_data_store();
 400 init_global_protection();
 401 prepare_to_start();
 402
 403 prosody.events.fire_event("server-started");
 404
 405 loop();
 406
 407 log("info", "Shutting down...");
 408 cleanup();
 409 prosody.events.fire_event("server-stopped");
 410 log("info", "Shutdown complete");
 411