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();
39 lock_globals = function () end;
40 unlock_globals = function () end;
42 local prosody = prosody;
44 local dependencies = require "util.dependencies";
45 if not dependencies.check_dependencies() then
49 config = require "core.configmanager"
55 if arg[1] == "--config" and arg[2] then
56 table.insert(filenames, arg[2]);
57 table.remove(arg, 1); table.remove(arg, 1);
59 table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
62 for _, format in ipairs(config.parsers()) do
63 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
66 for _,_filename in ipairs(filenames) do
68 local file = io.open(filename);
71 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
75 local ok, level, err = config.load(filename);
78 print("**************************");
79 if level == "parser" then
80 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
81 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
82 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
84 elseif level == "file" then
85 print("Prosody was unable to find the configuration file.");
86 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
87 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
88 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
90 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
92 print("**************************");
97 local original_logging_config = config.get("*", "core", "log");
98 config.set("*", "core", "log", { { levels = { min="info" }, to = "console" } });
100 require "core.loggingmanager"
102 dependencies.log_warnings();
104 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
105 require "util.datamanager".set_data_path(data_path);
107 -- Switch away from root and into the prosody user --
108 local switched_user, current_uid;
110 local want_pposix_version = "0.3.5";
111 local ok, pposix = pcall(require, "util.pposix");
113 if ok and pposix then
114 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
115 current_uid = pposix.getuid();
116 if current_uid == 0 then
118 local desired_user = config.get("*", "core", "prosody_user") or "prosody";
119 local desired_group = config.get("*", "core", "prosody_group") or desired_user;
120 local ok, err = pposix.setgid(desired_group);
122 ok, err = pposix.initgroups(desired_user);
125 ok, err = pposix.setuid(desired_user);
128 switched_user = true;
131 if not switched_user then
133 print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
137 -- Set our umask to protect data files
138 pposix.umask(config.get("*", "core", "umask") or "027");
140 print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
141 print("For more help send the below error to us through http://prosody.im/discuss");
142 print(tostring(pposix))
145 local function test_writeable(filename)
146 local f, err = io.open(filename, "a");
154 local unwriteable_files = {};
155 if type(original_logging_config) == "string" and original_logging_config:sub(1,1) ~= "*" then
156 local ok, err = test_writeable(original_logging_config);
158 table.insert(unwriteable_files, err);
160 elseif type(original_logging_config) == "table" then
161 for _, rule in ipairs(original_logging_config) do
162 if rule.filename then
163 local ok, err = test_writeable(rule.filename);
165 table.insert(unwriteable_files, err);
171 if #unwriteable_files > 0 then
172 print("One of more of the Prosody log files are not");
173 print("writeable, please correct the errors and try");
174 print("starting prosodyctl again.");
176 for _, err in ipairs(unwriteable_files) do
184 local error_messages = setmetatable({
185 ["invalid-username"] = "The given username is invalid in a Jabber ID";
186 ["invalid-hostname"] = "The given hostname is invalid";
187 ["no-password"] = "No password was supplied";
188 ["no-such-user"] = "The given user does not exist on the server";
189 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
190 ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
191 ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
192 ["no-such-method"] = "This module has no commands";
193 ["not-running"] = "Prosody is not running";
194 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
196 hosts = prosody.hosts;
198 local function make_host(hostname)
201 events = prosody.events,
202 users = require "core.usermanager".new_null_provider(hostname)
206 for hostname, config in pairs(config.getconfig()) do
207 hosts[hostname] = make_host(hostname);
210 require "core.modulemanager"
212 require "util.prosodyctl"
214 -----------------------
216 function show_message(msg, ...)
217 print(msg:format(...));
220 function show_warning(msg, ...)
221 print(msg:format(...));
224 function show_usage(usage, desc)
225 print("Usage: "..arg[0].." "..usage);
231 local function getchar(n)
232 local stty_ret = os.execute("stty raw -echo 2>/dev/null");
234 if stty_ret == 0 then
235 ok, char = pcall(io.read, n or 1);
236 os.execute("stty sane");
238 ok, char = pcall(io.read, "*l");
240 char = char:sub(1, n or 1);
248 local function getpass()
249 local stty_ret = os.execute("stty -echo 2>/dev/null");
250 if stty_ret ~= 0 then
251 io.write("\027[08m"); -- ANSI 'hidden' text attribute
253 local ok, pass = pcall(io.read, "*l");
254 if stty_ret == 0 then
255 os.execute("stty sane");
257 io.write("\027[00m");
265 function show_yesno(prompt)
266 io.write(prompt, " ");
267 local choice = getchar():lower();
269 if not choice:match("%a") then
270 choice = prompt:match("%[.-(%U).-%]$");
271 if not choice then return nil; end
273 return (choice == "y");
276 local function read_password()
279 io.write("Enter new password: ");
280 password = getpass();
282 show_message("No password - cancelled");
285 io.write("Retype new password: ");
286 if getpass() ~= password then
287 if not show_yesno [=[Passwords did not match, try again? [Y/n]]=] then
297 local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
298 -----------------------
300 local command = arg[1];
302 function commands.adduser(arg)
303 if not arg[1] or arg[1] == "--help" then
304 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
307 local user, host = arg[1]:match("([^@]+)@(.+)");
308 if not user and host then
309 show_message [[Failed to understand JID, please supply the JID you want to create]]
310 show_usage [[adduser user@host]]
315 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
319 if not hosts[host] then
320 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
321 show_warning("The user will not be able to log in until this is changed.");
322 hosts[host] = make_host(host);
325 if prosodyctl.user_exists{ user = user, host = host } then
326 show_message [[That user already exists]];
330 local password = read_password();
331 if not password then return 1; end
333 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
335 if ok then return 0; end
341 function commands.passwd(arg)
342 if not arg[1] or arg[1] == "--help" then
343 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
346 local user, host = arg[1]:match("([^@]+)@(.+)");
347 if not user and host then
348 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
349 show_usage [[passwd user@host]]
354 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
358 if not hosts[host] then
359 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
360 show_warning("The user will not be able to log in until this is changed.");
361 hosts[host] = make_host(host);
364 if not prosodyctl.user_exists { user = user, host = host } then
365 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
369 local password = read_password();
370 if not password then return 1; end
372 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
374 if ok then return 0; end
376 show_message(error_messages[msg])
380 function commands.deluser(arg)
381 if not arg[1] or arg[1] == "--help" then
382 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
385 local user, host = arg[1]:match("([^@]+)@(.+)");
386 if not user and host then
387 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
388 show_usage [[passwd user@host]]
393 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
397 if not hosts[host] then
398 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
399 show_warning("The user will not be able to log in until this is changed.");
400 hosts[host] = make_host(host);
403 if not prosodyctl.user_exists { user = user, host = host } then
404 show_message [[That user does not exist on this server]]
408 local ok, msg = prosodyctl.passwd { user = user, host = host };
410 if ok then return 0; end
412 show_message(error_messages[msg])
416 function commands.start(arg)
417 if arg[1] == "--help" then
418 show_usage([[start]], [[Start Prosody]]);
421 local ok, ret = prosodyctl.isrunning();
423 show_message(error_messages[ret]);
428 local ok, ret = prosodyctl.getpid();
430 show_message("Couldn't get running Prosody's PID");
431 show_message(error_messages[ret]);
434 show_message("Prosody is already running with PID %s", ret or "(unknown)");
438 local ok, ret = prosodyctl.start();
440 if config.get("*", "core", "daemonize") ~= false then
443 local ok, running = prosodyctl.isrunning();
444 if ok and running then
447 show_message("Still waiting...");
448 elseif i >= prosodyctl_timeout then
449 show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
455 show_message("Started");
460 show_message("Failed to start Prosody");
461 show_message(error_messages[ret])
465 function commands.status(arg)
466 if arg[1] == "--help" then
467 show_usage([[status]], [[Reports the running status of Prosody]]);
471 local ok, ret = prosodyctl.isrunning();
473 show_message(error_messages[ret]);
478 local ok, ret = prosodyctl.getpid();
480 show_message("Couldn't get running Prosody's PID");
481 show_message(error_messages[ret]);
484 show_message("Prosody is running with PID %s", ret or "(unknown)");
487 show_message("Prosody is not running");
488 if not switched_user and current_uid ~= 0 then
490 print(" You will also see this if prosodyctl is not running under");
491 print(" the same user account as Prosody. Try running as root (e.g. ");
492 print(" with 'sudo' in front) to gain access to Prosody's real status.");
499 function commands.stop(arg)
500 if arg[1] == "--help" then
501 show_usage([[stop]], [[Stop a running Prosody server]]);
505 if not prosodyctl.isrunning() then
506 show_message("Prosody is not running");
510 local ok, ret = prosodyctl.stop();
514 local ok, running = prosodyctl.isrunning();
515 if ok and not running then
518 show_message("Still waiting...");
519 elseif i >= prosodyctl_timeout then
520 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
526 show_message("Stopped");
530 show_message(error_messages[ret]);
534 function commands.restart(arg)
535 if arg[1] == "--help" then
536 show_usage([[restart]], [[Restart a running Prosody server]]);
541 return commands.start(arg);
544 -- ejabberdctl compatibility
546 function commands.register(arg)
547 local user, host, password = unpack(arg);
548 if (not (user and host)) or arg[1] == "--help" then
549 if user ~= "--help" then
551 show_message [[No username specified]]
553 show_message [[Please specify which host you want to register the user on]];
556 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
560 password = read_password();
562 show_message [[Unable to register user with no password]];
567 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
569 if ok then return 0; end
571 show_message(error_messages[msg])
575 function commands.unregister(arg)
576 local user, host = unpack(arg);
577 if (not (user and host)) or arg[1] == "--help" then
578 if user ~= "--help" then
580 show_message [[No username specified]]
582 show_message [[Please specify which host you want to unregister the user from]];
585 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
589 local ok, msg = prosodyctl.deluser { user = user, host = host };
591 if ok then return 0; end
593 show_message(error_messages[msg])
597 ---------------------
599 if command and command:match("^mod_") then -- Is a command in a module
600 local module_name = command:match("^mod_(.+)");
601 local ret, err = modulemanager.load("*", module_name);
603 show_message("Failed to load module '"..module_name.."': "..err);
607 table.remove(arg, 1);
609 local module = modulemanager.get_module("*", module_name);
611 show_message("Failed to load module '"..module_name.."': Unknown error");
615 if not modulemanager.module_has_method(module, "command") then
616 show_message("Fail: mod_"..module_name.." does not support any commands");
620 local ok, ret = modulemanager.call_module_method(module, "command", arg);
622 if type(ret) == "number" then
624 elseif type(ret) == "string" then
629 show_message("Failed to execute command: "..error_messages[ret]);
634 if not commands[command] then -- Show help for all commands
635 function show_usage(usage, desc)
640 print("prosodyctl - Manage a Prosody server");
642 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
644 print("Where COMMAND may be one of:\n");
646 local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
647 local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart" };
651 for _, command_name in ipairs(commands_order) do
652 local command = commands[command_name];
656 done[command_name] = true;
660 for command_name, command in pairs(commands) do
661 if not done[command_name] and not hidden_commands:contains(command_name) then
664 done[command_name] = true;
672 os.exit(commands[command]({ select(2, unpack(arg)) }));