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.3";
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.setuid(desired_user);
100 if not switched_user then
102 print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
106 -- Set our umask to protect data files
107 pposix.umask(config.get("*", "core", "umask") or "027");
109 print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
110 print("For more help send the below error to us through http://prosody.im/discuss");
111 print(tostring(pposix))
114 local function test_writeable(filename)
115 local f, err = io.open(filename, "a");
123 local unwriteable_files = {};
124 if type(original_logging_config) == "string" and original_logging_config:sub(1,1) ~= "*" then
125 local ok, err = test_writeable(original_logging_config);
127 table.insert(unwriteable_files, err);
129 elseif type(original_logging_config) == "table" then
130 for _, rule in ipairs(original_logging_config) do
131 if rule.filename then
132 local ok, err = test_writeable(rule.filename);
134 table.insert(unwriteable_files, err);
140 if #unwriteable_files > 0 then
141 print("One of more of the Prosody log files are not");
142 print("writeable, please correct the errors and try");
143 print("starting prosodyctl again.");
145 for _, err in ipairs(unwriteable_files) do
153 local error_messages = setmetatable({
154 ["invalid-username"] = "The given username is invalid in a Jabber ID";
155 ["invalid-hostname"] = "The given hostname is invalid";
156 ["no-password"] = "No password was supplied";
157 ["no-such-user"] = "The given user does not exist on the server";
158 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
159 ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
160 ["no-such-method"] = "This module has no commands";
161 ["not-running"] = "Prosody is not running";
162 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
164 hosts = prosody.hosts;
166 local function make_host(hostname)
167 return { events = prosody.events, users = require "core.usermanager".new_null_provider(hostname) };
170 for hostname, config in pairs(config.getconfig()) do
171 hosts[hostname] = make_host(hostname);
174 require "core.modulemanager"
176 require "util.prosodyctl"
178 -----------------------
180 function show_message(msg, ...)
181 print(msg:format(...));
184 function show_warning(msg, ...)
185 print(msg:format(...));
188 function show_usage(usage, desc)
189 print("Usage: "..arg[0].." "..usage);
195 local function getchar(n)
196 local stty_ret = os.execute("stty raw -echo 2>/dev/null");
198 if stty_ret == 0 then
199 ok, char = pcall(io.read, n or 1);
200 os.execute("stty sane");
202 ok, char = pcall(io.read, "*l");
204 char = char:sub(1, n or 1);
212 local function getpass()
213 local stty_ret = os.execute("stty -echo 2>/dev/null");
214 if stty_ret ~= 0 then
215 io.write("\027[08m"); -- ANSI 'hidden' text attribute
217 local ok, pass = pcall(io.read, "*l");
218 if stty_ret == 0 then
219 os.execute("stty sane");
221 io.write("\027[00m");
229 function show_yesno(prompt)
230 io.write(prompt, " ");
231 local choice = getchar():lower();
233 if not choice:match("%a") then
234 choice = prompt:match("%[.-(%U).-%]$");
235 if not choice then return nil; end
237 return (choice == "y");
240 local function read_password()
243 io.write("Enter new password: ");
244 password = getpass();
246 show_message("No password - cancelled");
249 io.write("Retype new password: ");
250 if getpass() ~= password then
251 if not show_yesno [=[Passwords did not match, try again? [Y/n]]=] then
261 local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
262 -----------------------
264 local command = arg[1];
266 function commands.adduser(arg)
267 if not arg[1] or arg[1] == "--help" then
268 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
271 local user, host = arg[1]:match("([^@]+)@(.+)");
272 if not user and host then
273 show_message [[Failed to understand JID, please supply the JID you want to create]]
274 show_usage [[adduser user@host]]
279 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
283 if not hosts[host] then
284 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
285 show_warning("The user will not be able to log in until this is changed.");
286 hosts[host] = make_host(host);
289 if prosodyctl.user_exists{ user = user, host = host } then
290 show_message [[That user already exists]];
294 local password = read_password();
295 if not password then return 1; end
297 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
299 if ok then return 0; end
301 show_message(error_messages[msg])
305 function commands.passwd(arg)
306 if not arg[1] or arg[1] == "--help" then
307 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
310 local user, host = arg[1]:match("([^@]+)@(.+)");
311 if not user and host then
312 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
313 show_usage [[passwd user@host]]
318 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
322 if not hosts[host] then
323 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
324 show_warning("The user will not be able to log in until this is changed.");
325 hosts[host] = make_host(host);
328 if not prosodyctl.user_exists { user = user, host = host } then
329 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
333 local password = read_password();
334 if not password then return 1; end
336 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
338 if ok then return 0; end
340 show_message(error_messages[msg])
344 function commands.deluser(arg)
345 if not arg[1] or arg[1] == "--help" then
346 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
349 local user, host = arg[1]:match("([^@]+)@(.+)");
350 if not user and host then
351 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
352 show_usage [[passwd user@host]]
357 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
361 if not hosts[host] then
362 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
363 show_warning("The user will not be able to log in until this is changed.");
364 hosts[host] = make_host(host);
367 if not prosodyctl.user_exists { user = user, host = host } then
368 show_message [[That user does not exist on this server]]
372 local ok, msg = prosodyctl.passwd { user = user, host = host };
374 if ok then return 0; end
376 show_message(error_messages[msg])
380 function commands.start(arg)
381 if arg[1] == "--help" then
382 show_usage([[start]], [[Start Prosody]]);
385 local ok, ret = prosodyctl.isrunning();
387 show_message(error_messages[ret]);
392 local ok, ret = prosodyctl.getpid();
394 show_message("Couldn't get running Prosody's PID");
395 show_message(error_messages[ret]);
398 show_message("Prosody is already running with PID %s", ret or "(unknown)");
402 local ok, ret = prosodyctl.start();
404 if config.get("*", "core", "daemonize") ~= false then
407 local ok, running = prosodyctl.isrunning();
408 if ok and running then
411 show_message("Still waiting...");
412 elseif i >= prosodyctl_timeout then
413 show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
419 show_message("Started");
424 show_message("Failed to start Prosody");
425 show_message(error_messages[ret])
429 function commands.status(arg)
430 if arg[1] == "--help" then
431 show_usage([[status]], [[Reports the running status of Prosody]]);
435 local ok, ret = prosodyctl.isrunning();
437 show_message(error_messages[ret]);
442 local ok, ret = prosodyctl.getpid();
444 show_message("Couldn't get running Prosody's PID");
445 show_message(error_messages[ret]);
448 show_message("Prosody is running with PID %s", ret or "(unknown)");
451 show_message("Prosody is not running");
452 if not switched_user and current_uid ~= 0 then
454 print(" You will also see this if prosodyctl is not running under");
455 print(" the same user account as Prosody. Try running as root (e.g. ");
456 print(" with 'sudo' in front) to gain access to Prosody's real status.");
463 function commands.stop(arg)
464 if arg[1] == "--help" then
465 show_usage([[stop]], [[Stop a running Prosody server]]);
469 if not prosodyctl.isrunning() then
470 show_message("Prosody is not running");
474 local ok, ret = prosodyctl.stop();
478 local ok, running = prosodyctl.isrunning();
479 if ok and not running then
482 show_message("Still waiting...");
483 elseif i >= prosodyctl_timeout then
484 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
490 show_message("Stopped");
494 show_message(error_messages[ret]);
498 function commands.restart(arg)
499 if arg[1] == "--help" then
500 show_usage([[restart]], [[Restart a running Prosody server]]);
504 local ret = commands.stop(arg);
506 ret = commands.start(arg);
511 -- ejabberdctl compatibility
513 function commands.register(arg)
514 local user, host, password = unpack(arg);
515 if (not (user and host)) or arg[1] == "--help" then
516 if user ~= "--help" then
518 show_message [[No username specified]]
520 show_message [[Please specify which host you want to register the user on]];
523 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
527 password = read_password();
529 show_message [[Unable to register user with no password]];
534 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
536 if ok then return 0; end
538 show_message(error_messages[msg])
542 function commands.unregister(arg)
543 local user, host = unpack(arg);
544 if (not (user and host)) or arg[1] == "--help" then
545 if user ~= "--help" then
547 show_message [[No username specified]]
549 show_message [[Please specify which host you want to unregister the user from]];
552 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
556 local ok, msg = prosodyctl.deluser { user = user, host = host };
558 if ok then return 0; end
560 show_message(error_messages[msg])
564 ---------------------
566 if command and command:match("^mod_") then -- Is a command in a module
567 local module_name = command:match("^mod_(.+)");
568 local ret, err = modulemanager.load("*", module_name);
570 show_message("Failed to load module '"..module_name.."': "..err);
574 table.remove(arg, 1);
576 local module = modulemanager.get_module("*", module_name);
578 show_message("Failed to load module '"..module_name.."': Unknown error");
582 if not modulemanager.module_has_method(module, "command") then
583 show_message("Fail: mod_"..module_name.." does not support any commands");
587 local ok, ret = modulemanager.call_module_method(module, "command", arg);
589 if type(ret) == "number" then
591 elseif type(ret) == "string" then
596 show_message("Failed to execute command: "..error_messages[ret]);
601 if not commands[command] then -- Show help for all commands
602 function show_usage(usage, desc)
607 print("prosodyctl - Manage a Prosody server");
609 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
611 print("Where COMMAND may be one of:\n");
613 local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
614 local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart" };
618 for _, command_name in ipairs(commands_order) do
619 local command = commands[command_name];
623 done[command_name] = true;
627 for command_name, command in pairs(commands) do
628 if not done[command_name] and not hidden_commands:contains(command_name) then
631 done[command_name] = true;
639 os.exit(commands[command]({ select(2, unpack(arg)) }));