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