3 -- Copyright (C) 2008-2009 Matthew Wild
4 -- Copyright (C) 2008-2009 Waqas Hussain
6 -- This project is MIT/X11 licensed. Please see the
7 -- COPYING file in the source package for more information.
10 -- prosodyctl - command-line controller for Prosody XMPP server
12 -- Will be modified by configure script if run --
15 CFG_CONFIGDIR=os.getenv("PROSODY_CFGDIR");
17 CFG_DATADIR=os.getenv("PROSODY_DATADIR");
19 -- -- -- -- -- -- -- ---- -- -- -- -- -- -- -- --
22 package.path = CFG_SOURCEDIR.."/?.lua;"..package.path
23 package.cpath = CFG_SOURCEDIR.."/?.so;"..package.cpath
27 if os.getenv("HOME") then
28 CFG_DATADIR = CFG_DATADIR:gsub("^~", os.getenv("HOME"));
32 -- Global 'prosody' object
35 events = require "util.events".new(),
38 local prosody = prosody;
40 config = require "core.configmanager"
43 -- TODO: Check for other formats when we add support for them
44 -- Use lfs? Make a new conf/ dir?
45 local ok, level, err = config.load((CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
48 print("**************************");
49 if level == "parser" then
50 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
51 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
52 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
54 elseif level == "file" then
55 print("Prosody was unable to find the configuration file.");
56 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
57 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
58 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
60 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
62 print("**************************");
67 local original_logging_config = config.get("*", "core", "log");
68 config.set("*", "core", "log", { { levels = { min="info" }, to = "console" } });
70 require "core.loggingmanager"
72 if not require "util.dependencies".check_dependencies() then
76 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
77 require "util.datamanager".set_data_path(data_path);
79 -- Switch away from root and into the prosody user --
80 local switched_user, current_uid;
82 local want_pposix_version = "0.3.5";
83 local ok, pposix = pcall(require, "util.pposix");
86 if pposix._VERSION ~= want_pposix_version then print(string.format("Unknown version (%s) of binary pposix module, expected %s", tostring(pposix._VERSION), want_pposix_version)); return; end
87 current_uid = pposix.getuid();
88 if current_uid == 0 then
90 local desired_user = config.get("*", "core", "prosody_user") or "prosody";
91 local desired_group = config.get("*", "core", "prosody_group") or desired_user;
92 local ok, err = pposix.setgid(desired_group);
94 ok, err = pposix.initgroups(desired_user);
97 ok, err = pposix.setuid(desired_user);
100 switched_user = true;
103 if not switched_user then
105 print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
109 -- Set our umask to protect data files
110 pposix.umask(config.get("*", "core", "umask") or "027");
112 print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
113 print("For more help send the below error to us through http://prosody.im/discuss");
114 print(tostring(pposix))
117 local function test_writeable(filename)
118 local f, err = io.open(filename, "a");
126 local unwriteable_files = {};
127 if type(original_logging_config) == "string" and original_logging_config:sub(1,1) ~= "*" then
128 local ok, err = test_writeable(original_logging_config);
130 table.insert(unwriteable_files, err);
132 elseif type(original_logging_config) == "table" then
133 for _, rule in ipairs(original_logging_config) do
134 if rule.filename then
135 local ok, err = test_writeable(rule.filename);
137 table.insert(unwriteable_files, err);
143 if #unwriteable_files > 0 then
144 print("One of more of the Prosody log files are not");
145 print("writeable, please correct the errors and try");
146 print("starting prosodyctl again.");
148 for _, err in ipairs(unwriteable_files) do
156 local error_messages = setmetatable({
157 ["invalid-username"] = "The given username is invalid in a Jabber ID";
158 ["invalid-hostname"] = "The given hostname is invalid";
159 ["no-password"] = "No password was supplied";
160 ["no-such-user"] = "The given user does not exist on the server";
161 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
162 ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
163 ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
164 ["no-such-method"] = "This module has no commands";
165 ["not-running"] = "Prosody is not running";
166 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
168 hosts = prosody.hosts;
170 local function make_host(hostname)
173 events = prosody.events,
174 users = require "core.usermanager".new_null_provider(hostname)
178 for hostname, config in pairs(config.getconfig()) do
179 hosts[hostname] = make_host(hostname);
182 require "core.modulemanager"
184 require "util.prosodyctl"
186 -----------------------
188 function show_message(msg, ...)
189 print(msg:format(...));
192 function show_warning(msg, ...)
193 print(msg:format(...));
196 function show_usage(usage, desc)
197 print("Usage: "..arg[0].." "..usage);
203 local function getchar(n)
204 local stty_ret = os.execute("stty raw -echo 2>/dev/null");
206 if stty_ret == 0 then
207 ok, char = pcall(io.read, n or 1);
208 os.execute("stty sane");
210 ok, char = pcall(io.read, "*l");
212 char = char:sub(1, n or 1);
220 local function getpass()
221 local stty_ret = os.execute("stty -echo 2>/dev/null");
222 if stty_ret ~= 0 then
223 io.write("\027[08m"); -- ANSI 'hidden' text attribute
225 local ok, pass = pcall(io.read, "*l");
226 if stty_ret == 0 then
227 os.execute("stty sane");
229 io.write("\027[00m");
237 function show_yesno(prompt)
238 io.write(prompt, " ");
239 local choice = getchar():lower();
241 if not choice:match("%a") then
242 choice = prompt:match("%[.-(%U).-%]$");
243 if not choice then return nil; end
245 return (choice == "y");
248 local function read_password()
251 io.write("Enter new password: ");
252 password = getpass();
254 show_message("No password - cancelled");
257 io.write("Retype new password: ");
258 if getpass() ~= password then
259 if not show_yesno [=[Passwords did not match, try again? [Y/n]]=] then
269 local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
270 -----------------------
272 local command = arg[1];
274 function commands.adduser(arg)
275 if not arg[1] or arg[1] == "--help" then
276 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
279 local user, host = arg[1]:match("([^@]+)@(.+)");
280 if not user and host then
281 show_message [[Failed to understand JID, please supply the JID you want to create]]
282 show_usage [[adduser user@host]]
287 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
291 if not hosts[host] then
292 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
293 show_warning("The user will not be able to log in until this is changed.");
294 hosts[host] = make_host(host);
297 if prosodyctl.user_exists{ user = user, host = host } then
298 show_message [[That user already exists]];
302 local password = read_password();
303 if not password then return 1; end
305 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
307 if ok then return 0; end
309 show_message(error_messages[msg])
313 function commands.passwd(arg)
314 if not arg[1] or arg[1] == "--help" then
315 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
318 local user, host = arg[1]:match("([^@]+)@(.+)");
319 if not user and host then
320 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
321 show_usage [[passwd user@host]]
326 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
330 if not hosts[host] then
331 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
332 show_warning("The user will not be able to log in until this is changed.");
333 hosts[host] = make_host(host);
336 if not prosodyctl.user_exists { user = user, host = host } then
337 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
341 local password = read_password();
342 if not password then return 1; end
344 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
346 if ok then return 0; end
348 show_message(error_messages[msg])
352 function commands.deluser(arg)
353 if not arg[1] or arg[1] == "--help" then
354 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
357 local user, host = arg[1]:match("([^@]+)@(.+)");
358 if not user and host then
359 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
360 show_usage [[passwd user@host]]
365 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
369 if not hosts[host] then
370 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
371 show_warning("The user will not be able to log in until this is changed.");
372 hosts[host] = make_host(host);
375 if not prosodyctl.user_exists { user = user, host = host } then
376 show_message [[That user does not exist on this server]]
380 local ok, msg = prosodyctl.passwd { user = user, host = host };
382 if ok then return 0; end
384 show_message(error_messages[msg])
388 function commands.start(arg)
389 if arg[1] == "--help" then
390 show_usage([[start]], [[Start Prosody]]);
393 local ok, ret = prosodyctl.isrunning();
395 show_message(error_messages[ret]);
400 local ok, ret = prosodyctl.getpid();
402 show_message("Couldn't get running Prosody's PID");
403 show_message(error_messages[ret]);
406 show_message("Prosody is already running with PID %s", ret or "(unknown)");
410 local ok, ret = prosodyctl.start();
412 if config.get("*", "core", "daemonize") ~= false then
415 local ok, running = prosodyctl.isrunning();
416 if ok and running then
419 show_message("Still waiting...");
420 elseif i >= prosodyctl_timeout then
421 show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
427 show_message("Started");
432 show_message("Failed to start Prosody");
433 show_message(error_messages[ret])
437 function commands.status(arg)
438 if arg[1] == "--help" then
439 show_usage([[status]], [[Reports the running status of Prosody]]);
443 local ok, ret = prosodyctl.isrunning();
445 show_message(error_messages[ret]);
450 local ok, ret = prosodyctl.getpid();
452 show_message("Couldn't get running Prosody's PID");
453 show_message(error_messages[ret]);
456 show_message("Prosody is running with PID %s", ret or "(unknown)");
459 show_message("Prosody is not running");
460 if not switched_user and current_uid ~= 0 then
462 print(" You will also see this if prosodyctl is not running under");
463 print(" the same user account as Prosody. Try running as root (e.g. ");
464 print(" with 'sudo' in front) to gain access to Prosody's real status.");
471 function commands.stop(arg)
472 if arg[1] == "--help" then
473 show_usage([[stop]], [[Stop a running Prosody server]]);
477 if not prosodyctl.isrunning() then
478 show_message("Prosody is not running");
482 local ok, ret = prosodyctl.stop();
486 local ok, running = prosodyctl.isrunning();
487 if ok and not running then
490 show_message("Still waiting...");
491 elseif i >= prosodyctl_timeout then
492 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
498 show_message("Stopped");
502 show_message(error_messages[ret]);
506 function commands.restart(arg)
507 if arg[1] == "--help" then
508 show_usage([[restart]], [[Restart a running Prosody server]]);
512 local ret = commands.stop(arg);
514 ret = commands.start(arg);
519 -- ejabberdctl compatibility
521 function commands.register(arg)
522 local user, host, password = unpack(arg);
523 if (not (user and host)) or arg[1] == "--help" then
524 if user ~= "--help" then
526 show_message [[No username specified]]
528 show_message [[Please specify which host you want to register the user on]];
531 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
535 password = read_password();
537 show_message [[Unable to register user with no password]];
542 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
544 if ok then return 0; end
546 show_message(error_messages[msg])
550 function commands.unregister(arg)
551 local user, host = unpack(arg);
552 if (not (user and host)) or arg[1] == "--help" then
553 if user ~= "--help" then
555 show_message [[No username specified]]
557 show_message [[Please specify which host you want to unregister the user from]];
560 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
564 local ok, msg = prosodyctl.deluser { user = user, host = host };
566 if ok then return 0; end
568 show_message(error_messages[msg])
572 ---------------------
574 if command and command:match("^mod_") then -- Is a command in a module
575 local module_name = command:match("^mod_(.+)");
576 local ret, err = modulemanager.load("*", module_name);
578 show_message("Failed to load module '"..module_name.."': "..err);
582 table.remove(arg, 1);
584 local module = modulemanager.get_module("*", module_name);
586 show_message("Failed to load module '"..module_name.."': Unknown error");
590 if not modulemanager.module_has_method(module, "command") then
591 show_message("Fail: mod_"..module_name.." does not support any commands");
595 local ok, ret = modulemanager.call_module_method(module, "command", arg);
597 if type(ret) == "number" then
599 elseif type(ret) == "string" then
604 show_message("Failed to execute command: "..error_messages[ret]);
609 if not commands[command] then -- Show help for all commands
610 function show_usage(usage, desc)
615 print("prosodyctl - Manage a Prosody server");
617 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
619 print("Where COMMAND may be one of:\n");
621 local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
622 local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart" };
626 for _, command_name in ipairs(commands_order) do
627 local command = commands[command_name];
631 done[command_name] = true;
635 for command_name, command in pairs(commands) do
636 if not done[command_name] and not hidden_commands:contains(command_name) then
639 done[command_name] = true;
647 os.exit(commands[command]({ select(2, unpack(arg)) }));