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