3 -- Copyright (C) 2008-2010 Matthew Wild
4 -- Copyright (C) 2008-2010 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 --
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");
19 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
21 -- Tell Lua where to find our libraries
23 package.path = CFG_SOURCEDIR.."/?.lua;"..package.path;
24 package.cpath = CFG_SOURCEDIR.."/?.so;"..package.cpath;
27 -- Substitute ~ with path to home directory in data path
29 if os.getenv("HOME") then
30 CFG_DATADIR = CFG_DATADIR:gsub("^~", os.getenv("HOME"));
34 -- Global 'prosody' object
37 events = require "util.events".new(),
40 local prosody = prosody;
42 config = require "core.configmanager"
48 if arg[1] == "--config" and arg[2] then
49 table.insert(filenames, arg[2]);
50 table.remove(arg, 1); table.remove(arg, 1);
52 table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
55 for _, format in ipairs(config.parsers()) do
56 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
59 for _,_filename in ipairs(filenames) do
61 local file = io.open(filename);
64 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
68 local ok, level, err = config.load(filename);
71 print("**************************");
72 if level == "parser" then
73 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
74 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
75 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
77 elseif level == "file" then
78 print("Prosody was unable to find the configuration file.");
79 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
80 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
81 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
83 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
85 print("**************************");
90 local original_logging_config = config.get("*", "core", "log");
91 config.set("*", "core", "log", { { levels = { min="info" }, to = "console" } });
93 require "core.loggingmanager"
95 if not require "util.dependencies".check_dependencies() then
99 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
100 require "util.datamanager".set_data_path(data_path);
102 -- Switch away from root and into the prosody user --
103 local switched_user, current_uid;
105 local want_pposix_version = "0.3.5";
106 local ok, pposix = pcall(require, "util.pposix");
108 if ok and pposix then
109 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
110 current_uid = pposix.getuid();
111 if current_uid == 0 then
113 local desired_user = config.get("*", "core", "prosody_user") or "prosody";
114 local desired_group = config.get("*", "core", "prosody_group") or desired_user;
115 local ok, err = pposix.setgid(desired_group);
117 ok, err = pposix.initgroups(desired_user);
120 ok, err = pposix.setuid(desired_user);
123 switched_user = true;
126 if not switched_user then
128 print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
132 -- Set our umask to protect data files
133 pposix.umask(config.get("*", "core", "umask") or "027");
135 print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
136 print("For more help send the below error to us through http://prosody.im/discuss");
137 print(tostring(pposix))
140 local function test_writeable(filename)
141 local f, err = io.open(filename, "a");
149 local unwriteable_files = {};
150 if type(original_logging_config) == "string" and original_logging_config:sub(1,1) ~= "*" then
151 local ok, err = test_writeable(original_logging_config);
153 table.insert(unwriteable_files, err);
155 elseif type(original_logging_config) == "table" then
156 for _, rule in ipairs(original_logging_config) do
157 if rule.filename then
158 local ok, err = test_writeable(rule.filename);
160 table.insert(unwriteable_files, err);
166 if #unwriteable_files > 0 then
167 print("One of more of the Prosody log files are not");
168 print("writeable, please correct the errors and try");
169 print("starting prosodyctl again.");
171 for _, err in ipairs(unwriteable_files) do
179 local error_messages = setmetatable({
180 ["invalid-username"] = "The given username is invalid in a Jabber ID";
181 ["invalid-hostname"] = "The given hostname is invalid";
182 ["no-password"] = "No password was supplied";
183 ["no-such-user"] = "The given user does not exist on the server";
184 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
185 ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
186 ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
187 ["no-such-method"] = "This module has no commands";
188 ["not-running"] = "Prosody is not running";
189 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
191 hosts = prosody.hosts;
193 local function make_host(hostname)
196 events = prosody.events,
197 users = require "core.usermanager".new_null_provider(hostname)
201 for hostname, config in pairs(config.getconfig()) do
202 hosts[hostname] = make_host(hostname);
205 require "core.modulemanager"
207 require "util.prosodyctl"
209 -----------------------
211 function show_message(msg, ...)
212 print(msg:format(...));
215 function show_warning(msg, ...)
216 print(msg:format(...));
219 function show_usage(usage, desc)
220 print("Usage: "..arg[0].." "..usage);
226 local function getchar(n)
227 local stty_ret = os.execute("stty raw -echo 2>/dev/null");
229 if stty_ret == 0 then
230 ok, char = pcall(io.read, n or 1);
231 os.execute("stty sane");
233 ok, char = pcall(io.read, "*l");
235 char = char:sub(1, n or 1);
243 local function getpass()
244 local stty_ret = os.execute("stty -echo 2>/dev/null");
245 if stty_ret ~= 0 then
246 io.write("\027[08m"); -- ANSI 'hidden' text attribute
248 local ok, pass = pcall(io.read, "*l");
249 if stty_ret == 0 then
250 os.execute("stty sane");
252 io.write("\027[00m");
260 function show_yesno(prompt)
261 io.write(prompt, " ");
262 local choice = getchar():lower();
264 if not choice:match("%a") then
265 choice = prompt:match("%[.-(%U).-%]$");
266 if not choice then return nil; end
268 return (choice == "y");
271 local function read_password()
274 io.write("Enter new password: ");
275 password = getpass();
277 show_message("No password - cancelled");
280 io.write("Retype new password: ");
281 if getpass() ~= password then
282 if not show_yesno [=[Passwords did not match, try again? [Y/n]]=] then
292 local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
293 -----------------------
295 local command = arg[1];
297 function commands.adduser(arg)
298 if not arg[1] or arg[1] == "--help" then
299 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
302 local user, host = arg[1]:match("([^@]+)@(.+)");
303 if not user and host then
304 show_message [[Failed to understand JID, please supply the JID you want to create]]
305 show_usage [[adduser user@host]]
310 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
314 if not hosts[host] then
315 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
316 show_warning("The user will not be able to log in until this is changed.");
317 hosts[host] = make_host(host);
320 if prosodyctl.user_exists{ user = user, host = host } then
321 show_message [[That user already exists]];
325 local password = read_password();
326 if not password then return 1; end
328 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
330 if ok then return 0; end
332 show_message(error_messages[msg])
336 function commands.passwd(arg)
337 if not arg[1] or arg[1] == "--help" then
338 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
341 local user, host = arg[1]:match("([^@]+)@(.+)");
342 if not user and host then
343 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
344 show_usage [[passwd user@host]]
349 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
353 if not hosts[host] then
354 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
355 show_warning("The user will not be able to log in until this is changed.");
356 hosts[host] = make_host(host);
359 if not prosodyctl.user_exists { user = user, host = host } then
360 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
364 local password = read_password();
365 if not password then return 1; end
367 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
369 if ok then return 0; end
371 show_message(error_messages[msg])
375 function commands.deluser(arg)
376 if not arg[1] or arg[1] == "--help" then
377 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
380 local user, host = arg[1]:match("([^@]+)@(.+)");
381 if not user and host then
382 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
383 show_usage [[passwd user@host]]
388 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
392 if not hosts[host] then
393 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
394 show_warning("The user will not be able to log in until this is changed.");
395 hosts[host] = make_host(host);
398 if not prosodyctl.user_exists { user = user, host = host } then
399 show_message [[That user does not exist on this server]]
403 local ok, msg = prosodyctl.passwd { user = user, host = host };
405 if ok then return 0; end
407 show_message(error_messages[msg])
411 function commands.start(arg)
412 if arg[1] == "--help" then
413 show_usage([[start]], [[Start Prosody]]);
416 local ok, ret = prosodyctl.isrunning();
418 show_message(error_messages[ret]);
423 local ok, ret = prosodyctl.getpid();
425 show_message("Couldn't get running Prosody's PID");
426 show_message(error_messages[ret]);
429 show_message("Prosody is already running with PID %s", ret or "(unknown)");
433 local ok, ret = prosodyctl.start();
435 if config.get("*", "core", "daemonize") ~= false then
438 local ok, running = prosodyctl.isrunning();
439 if ok and running then
442 show_message("Still waiting...");
443 elseif i >= prosodyctl_timeout then
444 show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
450 show_message("Started");
455 show_message("Failed to start Prosody");
456 show_message(error_messages[ret])
460 function commands.status(arg)
461 if arg[1] == "--help" then
462 show_usage([[status]], [[Reports the running status of Prosody]]);
466 local ok, ret = prosodyctl.isrunning();
468 show_message(error_messages[ret]);
473 local ok, ret = prosodyctl.getpid();
475 show_message("Couldn't get running Prosody's PID");
476 show_message(error_messages[ret]);
479 show_message("Prosody is running with PID %s", ret or "(unknown)");
482 show_message("Prosody is not running");
483 if not switched_user and current_uid ~= 0 then
485 print(" You will also see this if prosodyctl is not running under");
486 print(" the same user account as Prosody. Try running as root (e.g. ");
487 print(" with 'sudo' in front) to gain access to Prosody's real status.");
494 function commands.stop(arg)
495 if arg[1] == "--help" then
496 show_usage([[stop]], [[Stop a running Prosody server]]);
500 if not prosodyctl.isrunning() then
501 show_message("Prosody is not running");
505 local ok, ret = prosodyctl.stop();
509 local ok, running = prosodyctl.isrunning();
510 if ok and not running then
513 show_message("Still waiting...");
514 elseif i >= prosodyctl_timeout then
515 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
521 show_message("Stopped");
525 show_message(error_messages[ret]);
529 function commands.restart(arg)
530 if arg[1] == "--help" then
531 show_usage([[restart]], [[Restart a running Prosody server]]);
536 return commands.start(arg);
539 -- ejabberdctl compatibility
541 function commands.register(arg)
542 local user, host, password = unpack(arg);
543 if (not (user and host)) or arg[1] == "--help" then
544 if user ~= "--help" then
546 show_message [[No username specified]]
548 show_message [[Please specify which host you want to register the user on]];
551 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
555 password = read_password();
557 show_message [[Unable to register user with no password]];
562 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
564 if ok then return 0; end
566 show_message(error_messages[msg])
570 function commands.unregister(arg)
571 local user, host = unpack(arg);
572 if (not (user and host)) or arg[1] == "--help" then
573 if user ~= "--help" then
575 show_message [[No username specified]]
577 show_message [[Please specify which host you want to unregister the user from]];
580 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
584 local ok, msg = prosodyctl.deluser { user = user, host = host };
586 if ok then return 0; end
588 show_message(error_messages[msg])
592 ---------------------
594 if command and command:match("^mod_") then -- Is a command in a module
595 local module_name = command:match("^mod_(.+)");
596 local ret, err = modulemanager.load("*", module_name);
598 show_message("Failed to load module '"..module_name.."': "..err);
602 table.remove(arg, 1);
604 local module = modulemanager.get_module("*", module_name);
606 show_message("Failed to load module '"..module_name.."': Unknown error");
610 if not modulemanager.module_has_method(module, "command") then
611 show_message("Fail: mod_"..module_name.." does not support any commands");
615 local ok, ret = modulemanager.call_module_method(module, "command", arg);
617 if type(ret) == "number" then
619 elseif type(ret) == "string" then
624 show_message("Failed to execute command: "..error_messages[ret]);
629 if not commands[command] then -- Show help for all commands
630 function show_usage(usage, desc)
635 print("prosodyctl - Manage a Prosody server");
637 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
639 print("Where COMMAND may be one of:\n");
641 local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
642 local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart" };
646 for _, command_name in ipairs(commands_order) do
647 local command = commands[command_name];
651 done[command_name] = true;
655 for command_name, command in pairs(commands) do
656 if not done[command_name] and not hidden_commands:contains(command_name) then
659 done[command_name] = true;
667 os.exit(commands[command]({ select(2, unpack(arg)) }));