Merge 0.8->trunk
[prosody.git] / 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 sandbox_require()
131         -- Replace require() with one that doesn't pollute _G, required
132         -- for neat sandboxing of modules
133         local _realG = _G;
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
140                         local old_newindex
141                         old_newindex, _realG_mt.__newindex = _realG_mt.__newindex, curr_env;
142                         local ret = _real_require(...);
143                         _realG_mt.__newindex = old_newindex;
144                         return ret;
145                 end
146                 return _real_require(...);
147         end
148 end
149
150 function set_function_metatable()
151         local mt = {};
152         function mt.__index(f, upvalue)
153                 local i, name, value = 0;
154                 repeat
155                         i = i + 1;
156                         name, value = debug.getupvalue(f, i);
157                 until name == upvalue or name == nil;
158                 return value;
159         end
160         function mt.__newindex(f, upvalue, value)
161                 local i, name = 0;
162                 repeat
163                         i = i + 1;
164                         name = debug.getupvalue(f, i);
165                 until name == upvalue or name == nil;
166                 if name then
167                         debug.setupvalue(f, i, value);
168                 end
169         end
170         function mt.__tostring(f)
171                 local info = debug.getinfo(f);
172                 return ("function(%s:%d)"):format(info.short_src:match("[^\\/]*$"), info.linedefined);
173         end
174         debug.setmetatable(function() end, mt);
175 end
176
177 function init_global_state()
178         bare_sessions = {};
179         full_sessions = {};
180         hosts = {};
181
182         prosody.bare_sessions = bare_sessions;
183         prosody.full_sessions = full_sessions;
184         prosody.hosts = hosts;
185         
186         local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
187         prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR, 
188                           plugins = CFG_PLUGINDIR, data = data_path };
189
190         prosody.arg = _G.arg;
191
192         prosody.platform = "unknown";
193         if os.getenv("WINDIR") then
194                 prosody.platform = "windows";
195         elseif package.config:sub(1,1) == "/" then
196                 prosody.platform = "posix";
197         end
198         
199         prosody.installed = nil;
200         if CFG_SOURCEDIR and (prosody.platform == "windows" or CFG_SOURCEDIR:match("^/")) then
201                 prosody.installed = true;
202         end
203         
204         -- Function to reload the config file
205         function prosody.reload_config()
206                 log("info", "Reloading configuration file");
207                 prosody.events.fire_event("reloading-config");
208                 local ok, level, err = config.load((rawget(_G, "CFG_CONFIGDIR") or ".").."/prosody.cfg.lua");
209                 if not ok then
210                         if level == "parser" then
211                                 log("error", "There was an error parsing the configuration file: %s", tostring(err));
212                         elseif level == "file" then
213                                 log("error", "Couldn't read the config file when trying to reload: %s", tostring(err));
214                         end
215                 end
216                 return ok, (err and tostring(level)..": "..tostring(err)) or nil;
217         end
218
219         -- Function to reopen logfiles
220         function prosody.reopen_logfiles()
221                 log("info", "Re-opening log files");
222                 prosody.events.fire_event("reopen-log-files");
223         end
224
225         -- Function to initiate prosody shutdown
226         function prosody.shutdown(reason)
227                 log("info", "Shutting down: %s", reason or "unknown reason");
228                 prosody.shutdown_reason = reason;
229                 prosody.events.fire_event("server-stopping", {reason = reason});
230                 server.setquitting(true);
231         end
232
233         -- Load SSL settings from config, and create a ctx table
234         local certmanager = require "core.certmanager";
235         local global_ssl_ctx = certmanager.create_context("*", "server");
236         prosody.global_ssl_ctx = global_ssl_ctx;
237
238         local cl = require "net.connlisteners";
239         function prosody.net_activate_ports(option, listener, default, conntype)
240                 conntype = conntype or (global_ssl_ctx and "tls") or "tcp";
241                 local ports_option = option and option.."_ports" or "ports";
242                 if not cl.get(listener) then return; end
243                 local ports = config.get("*", "core", ports_option) or default;
244                 if type(ports) == "number" then ports = {ports} end;
245                 
246                 if type(ports) ~= "table" then
247                         log("error", "core."..ports_option.." is not a table");
248                 else
249                         for _, port in ipairs(ports) do
250                                 port = tonumber(port);
251                                 if type(port) ~= "number" then
252                                         log("error", "Non-numeric "..ports_option..": "..tostring(port));
253                                 else
254                                         local ok, err = cl.start(listener, {
255                                                 ssl = conntype == "ssl" and global_ssl_ctx,
256                                                 port = port,
257                                                 interface = (option and config.get("*", "core", option.."_interface"))
258                                                         or cl.get(listener).default_interface
259                                                         or config.get("*", "core", "interface"),
260                                                 type = conntype
261                                         });
262                                         if not ok then
263                                                 local friendly_message = err;
264                                                 if err:match(" in use") then
265                                                         if port == 5222 or port == 5223 or port == 5269 then
266                                                                 friendly_message = "check that Prosody or another XMPP server is "
267                                                                         .."not already running and using this port";
268                                                         elseif port == 80 or port == 81 then
269                                                                 friendly_message = "check that a HTTP server is not already using "
270                                                                         .."this port";
271                                                         elseif port == 5280 then
272                                                                 friendly_message = "check that Prosody or a BOSH connection manager "
273                                                                         .."is not already running";
274                                                         else
275                                                                 friendly_message = "this port is in use by another application";
276                                                         end
277                                                 elseif err:match("permission") then
278                                                         friendly_message = "Prosody does not have sufficient privileges to use this port";
279                                                 elseif err == "no ssl context" then
280                                                         if not config.get("*", "core", "ssl") then
281                                                                 friendly_message = "there is no 'ssl' config under Host \"*\" which is "
282                                                                         .."require for legacy SSL ports";
283                                                         else
284                                                                 friendly_message = "initializing SSL support failed, see previous log entries";
285                                                         end
286                                                 end
287                                                 log("error", "Failed to open server port %d, %s", port, friendly_message);
288                                         end
289                                 end
290                         end
291                 end
292         end
293 end
294
295 function read_version()
296         -- Try to determine version
297         local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
298         if version_file then
299                 prosody.version = version_file:read("*a"):gsub("%s*$", "");
300                 version_file:close();
301                 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
302                         prosody.version = "hg:"..prosody.version;
303                 end
304         else
305                 prosody.version = "unknown";
306         end
307 end
308
309 function load_secondary_libraries()
310         --- Load and initialise core modules
311         require "util.import"
312         require "util.xmppstream"
313         require "core.rostermanager"
314         require "core.hostmanager"
315         require "core.modulemanager"
316         require "core.usermanager"
317         require "core.sessionmanager"
318         require "core.stanza_router"
319         package.loaded['core.componentmanager'] = setmetatable({},{__index=function()
320                 log("warn", "componentmanager is deprecated: %s", debug.traceback():match("\n[^\n]*\n[\s\t]*([^\n]*)"));
321                 return function() end
322         end});
323
324         require "net.http"
325         
326         require "util.array"
327         require "util.datetime"
328         require "util.iterators"
329         require "util.timer"
330         require "util.helpers"
331         
332         pcall(require, "util.signal") -- Not on Windows
333         
334         -- Commented to protect us from 
335         -- the second kind of people
336         --[[ 
337         pcall(require, "remdebug.engine");
338         if remdebug then remdebug.engine.start() end
339         ]]
340
341         require "net.connlisteners";
342         
343         require "util.stanza"
344         require "util.jid"
345 end
346
347 function init_data_store()
348         require "core.storagemanager";
349 end
350
351 function prepare_to_start()
352         log("info", "Prosody is using the %s backend for connection handling", server.get_backend());
353         -- Signal to modules that we are ready to start
354         prosody.events.fire_event("server-starting");
355
356         -- start listening on sockets
357         if config.get("*", "core", "ports") then
358                 prosody.net_activate_ports(nil, "multiplex", {5222, 5269});
359                 if config.get("*", "core", "ssl_ports") then
360                         prosody.net_activate_ports("ssl", "multiplex", {5223}, "ssl");
361                 end
362         else
363                 prosody.net_activate_ports("c2s", "xmppclient", {5222});
364                 prosody.net_activate_ports("s2s", "xmppserver", {5269});
365                 prosody.net_activate_ports("component", "xmppcomponent", {5347}, "tcp");
366                 prosody.net_activate_ports("legacy_ssl", "xmppclient", {}, "ssl");
367         end
368
369         prosody.start_time = os.time();
370 end     
371
372 function init_global_protection()
373         -- Catch global accesses
374         local locked_globals_mt = {
375                 __index = function (t, k) log("warn", "%s", debug.traceback("Attempt to read a non-existent global '"..tostring(k).."'", 2)); end;
376                 __newindex = function (t, k, v) error("Attempt to set a global: "..tostring(k).." = "..tostring(v), 2); end;
377         };
378                 
379         function prosody.unlock_globals()
380                 setmetatable(_G, nil);
381         end
382         
383         function prosody.lock_globals()
384                 setmetatable(_G, locked_globals_mt);
385         end
386
387         -- And lock now...
388         prosody.lock_globals();
389 end
390
391 function loop()
392         -- Error handler for errors that make it this far
393         local function catch_uncaught_error(err)
394                 if type(err) == "string" and err:match("interrupted!$") then
395                         return "quitting";
396                 end
397                 
398                 log("error", "Top-level error, please report:\n%s", tostring(err));
399                 local traceback = debug.traceback("", 2);
400                 if traceback then
401                         log("error", "%s", traceback);
402                 end
403                 
404                 prosody.events.fire_event("very-bad-error", {error = err, traceback = traceback});
405         end
406         
407         while select(2, xpcall(server.loop, catch_uncaught_error)) ~= "quitting" do
408                 socket.sleep(0.2);
409         end
410 end
411
412 function cleanup()
413         log("info", "Shutdown status: Cleaning up");
414         prosody.events.fire_event("server-cleanup");
415         
416         -- Ok, we're quitting I know, but we
417         -- need to do some tidying before we go :)
418         server.setquitting(false);
419         
420         log("info", "Shutdown status: Closing all active sessions");
421         for hostname, host in pairs(hosts) do
422                 log("debug", "Shutdown status: Closing client connections for %s", hostname)
423                 if host.sessions then
424                         local reason = { condition = "system-shutdown", text = "Server is shutting down" };
425                         if prosody.shutdown_reason then
426                                 reason.text = reason.text..": "..prosody.shutdown_reason;
427                         end
428                         for username, user in pairs(host.sessions) do
429                                 for resource, session in pairs(user.sessions) do
430                                         log("debug", "Closing connection for %s@%s/%s", username, hostname, resource);
431                                         session:close(reason);
432                                 end
433                         end
434                 end
435         
436                 log("debug", "Shutdown status: Closing outgoing s2s connections from %s", hostname);
437                 if host.s2sout then
438                         for remotehost, session in pairs(host.s2sout) do
439                                 if session.close then
440                                         session:close("system-shutdown");
441                                 else
442                                         log("warn", "Unable to close outgoing s2s session to %s, no session:close()?!", remotehost);
443                                 end
444                         end
445                 end
446         end
447
448         log("info", "Shutdown status: Closing all server connections");
449         server.closeall();
450         
451         server.setquitting(true);
452 end
453
454 -- Are you ready? :)
455 -- These actions are in a strict order, as many depend on
456 -- previous steps to have already been performed
457 read_config();
458 init_logging();
459 sandbox_require();
460 set_function_metatable();
461 load_libraries();
462 init_global_state();
463 read_version();
464 log("info", "Hello and welcome to Prosody version %s", prosody.version);
465 log_dependency_warnings();
466 load_secondary_libraries();
467 init_data_store();
468 init_global_protection();
469 prepare_to_start();
470
471 prosody.events.fire_event("server-started");
472
473 loop();
474
475 log("info", "Shutting down...");
476 cleanup();
477 prosody.events.fire_event("server-stopped");
478 log("info", "Shutdown complete");
479