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-such-method"] = "This module has no commands";
164 ["not-running"] = "Prosody is not running";
165 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
167 hosts = prosody.hosts;
169 local function make_host(hostname)
170 return { events = prosody.events, users = require "core.usermanager".new_null_provider(hostname) };
173 for hostname, config in pairs(config.getconfig()) do
174 hosts[hostname] = make_host(hostname);
177 require "core.modulemanager"
179 require "util.prosodyctl"
181 -----------------------
183 function show_message(msg, ...)
184 print(msg:format(...));
187 function show_warning(msg, ...)
188 print(msg:format(...));
191 function show_usage(usage, desc)
192 print("Usage: "..arg[0].." "..usage);
198 local function getchar(n)
199 local stty_ret = os.execute("stty raw -echo 2>/dev/null");
201 if stty_ret == 0 then
202 ok, char = pcall(io.read, n or 1);
203 os.execute("stty sane");
205 ok, char = pcall(io.read, "*l");
207 char = char:sub(1, n or 1);
215 local function getpass()
216 local stty_ret = os.execute("stty -echo 2>/dev/null");
217 if stty_ret ~= 0 then
218 io.write("\027[08m"); -- ANSI 'hidden' text attribute
220 local ok, pass = pcall(io.read, "*l");
221 if stty_ret == 0 then
222 os.execute("stty sane");
224 io.write("\027[00m");
232 function show_yesno(prompt)
233 io.write(prompt, " ");
234 local choice = getchar():lower();
236 if not choice:match("%a") then
237 choice = prompt:match("%[.-(%U).-%]$");
238 if not choice then return nil; end
240 return (choice == "y");
243 local function read_password()
246 io.write("Enter new password: ");
247 password = getpass();
249 show_message("No password - cancelled");
252 io.write("Retype new password: ");
253 if getpass() ~= password then
254 if not show_yesno [=[Passwords did not match, try again? [Y/n]]=] then
264 local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
265 -----------------------
267 local command = arg[1];
269 function commands.adduser(arg)
270 if not arg[1] or arg[1] == "--help" then
271 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
274 local user, host = arg[1]:match("([^@]+)@(.+)");
275 if not user and host then
276 show_message [[Failed to understand JID, please supply the JID you want to create]]
277 show_usage [[adduser user@host]]
282 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
286 if not hosts[host] then
287 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
288 show_warning("The user will not be able to log in until this is changed.");
289 hosts[host] = make_host(host);
292 if prosodyctl.user_exists{ user = user, host = host } then
293 show_message [[That user already exists]];
297 local password = read_password();
298 if not password then return 1; end
300 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
302 if ok then return 0; end
304 show_message(error_messages[msg])
308 function commands.passwd(arg)
309 if not arg[1] or arg[1] == "--help" then
310 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
313 local user, host = arg[1]:match("([^@]+)@(.+)");
314 if not user and host then
315 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
316 show_usage [[passwd user@host]]
321 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
325 if not hosts[host] then
326 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
327 show_warning("The user will not be able to log in until this is changed.");
328 hosts[host] = make_host(host);
331 if not prosodyctl.user_exists { user = user, host = host } then
332 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
336 local password = read_password();
337 if not password then return 1; end
339 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
341 if ok then return 0; end
343 show_message(error_messages[msg])
347 function commands.deluser(arg)
348 if not arg[1] or arg[1] == "--help" then
349 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
352 local user, host = arg[1]:match("([^@]+)@(.+)");
353 if not user and host then
354 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
355 show_usage [[passwd user@host]]
360 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
364 if not hosts[host] then
365 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
366 show_warning("The user will not be able to log in until this is changed.");
367 hosts[host] = make_host(host);
370 if not prosodyctl.user_exists { user = user, host = host } then
371 show_message [[That user does not exist on this server]]
375 local ok, msg = prosodyctl.passwd { user = user, host = host };
377 if ok then return 0; end
379 show_message(error_messages[msg])
383 function commands.start(arg)
384 if arg[1] == "--help" then
385 show_usage([[start]], [[Start Prosody]]);
388 local ok, ret = prosodyctl.isrunning();
390 show_message(error_messages[ret]);
395 local ok, ret = prosodyctl.getpid();
397 show_message("Couldn't get running Prosody's PID");
398 show_message(error_messages[ret]);
401 show_message("Prosody is already running with PID %s", ret or "(unknown)");
405 local ok, ret = prosodyctl.start();
407 if config.get("*", "core", "daemonize") ~= false then
410 local ok, running = prosodyctl.isrunning();
411 if ok and running then
414 show_message("Still waiting...");
415 elseif i >= prosodyctl_timeout then
416 show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
422 show_message("Started");
427 show_message("Failed to start Prosody");
428 show_message(error_messages[ret])
432 function commands.status(arg)
433 if arg[1] == "--help" then
434 show_usage([[status]], [[Reports the running status of Prosody]]);
438 local ok, ret = prosodyctl.isrunning();
440 show_message(error_messages[ret]);
445 local ok, ret = prosodyctl.getpid();
447 show_message("Couldn't get running Prosody's PID");
448 show_message(error_messages[ret]);
451 show_message("Prosody is running with PID %s", ret or "(unknown)");
454 show_message("Prosody is not running");
455 if not switched_user and current_uid ~= 0 then
457 print(" You will also see this if prosodyctl is not running under");
458 print(" the same user account as Prosody. Try running as root (e.g. ");
459 print(" with 'sudo' in front) to gain access to Prosody's real status.");
466 function commands.stop(arg)
467 if arg[1] == "--help" then
468 show_usage([[stop]], [[Stop a running Prosody server]]);
472 if not prosodyctl.isrunning() then
473 show_message("Prosody is not running");
477 local ok, ret = prosodyctl.stop();
481 local ok, running = prosodyctl.isrunning();
482 if ok and not running then
485 show_message("Still waiting...");
486 elseif i >= prosodyctl_timeout then
487 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
493 show_message("Stopped");
497 show_message(error_messages[ret]);
501 function commands.restart(arg)
502 if arg[1] == "--help" then
503 show_usage([[restart]], [[Restart a running Prosody server]]);
507 local ret = commands.stop(arg);
509 ret = commands.start(arg);
514 -- ejabberdctl compatibility
516 function commands.register(arg)
517 local user, host, password = unpack(arg);
518 if (not (user and host)) or arg[1] == "--help" then
519 if user ~= "--help" then
521 show_message [[No username specified]]
523 show_message [[Please specify which host you want to register the user on]];
526 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
530 password = read_password();
532 show_message [[Unable to register user with no password]];
537 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
539 if ok then return 0; end
541 show_message(error_messages[msg])
545 function commands.unregister(arg)
546 local user, host = unpack(arg);
547 if (not (user and host)) or arg[1] == "--help" then
548 if user ~= "--help" then
550 show_message [[No username specified]]
552 show_message [[Please specify which host you want to unregister the user from]];
555 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
559 local ok, msg = prosodyctl.deluser { user = user, host = host };
561 if ok then return 0; end
563 show_message(error_messages[msg])
567 ---------------------
569 if command and command:match("^mod_") then -- Is a command in a module
570 local module_name = command:match("^mod_(.+)");
571 local ret, err = modulemanager.load("*", module_name);
573 show_message("Failed to load module '"..module_name.."': "..err);
577 table.remove(arg, 1);
579 local module = modulemanager.get_module("*", module_name);
581 show_message("Failed to load module '"..module_name.."': Unknown error");
585 if not modulemanager.module_has_method(module, "command") then
586 show_message("Fail: mod_"..module_name.." does not support any commands");
590 local ok, ret = modulemanager.call_module_method(module, "command", arg);
592 if type(ret) == "number" then
594 elseif type(ret) == "string" then
599 show_message("Failed to execute command: "..error_messages[ret]);
604 if not commands[command] then -- Show help for all commands
605 function show_usage(usage, desc)
610 print("prosodyctl - Manage a Prosody server");
612 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
614 print("Where COMMAND may be one of:\n");
616 local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
617 local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart" };
621 for _, command_name in ipairs(commands_order) do
622 local command = commands[command_name];
626 done[command_name] = true;
630 for command_name, command in pairs(commands) do
631 if not done[command_name] and not hidden_commands:contains(command_name) then
634 done[command_name] = true;
642 os.exit(commands[command]({ select(2, unpack(arg)) }));