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 -- Required to be able to find packages installed with luarocks
33 pcall(require, "luarocks.require")
36 config = require "core.configmanager"
39 -- TODO: Check for other formats when we add support for them
40 -- Use lfs? Make a new conf/ dir?
41 local ok, level, err = config.load((CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
44 print("**************************");
45 if level == "parser" then
46 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
47 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
48 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
50 elseif level == "file" then
51 print("Prosody was unable to find the configuration file.");
52 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
53 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
54 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
56 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
58 print("**************************");
64 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
65 require "util.datamanager".set_data_path(data_path);
67 -- Switch away from root and into the prosody user --
68 local switched_user, current_uid;
69 local ok, pposix = pcall(require, "util.pposix");
71 current_uid = pposix.getuid();
72 if current_uid == 0 then
74 local desired_user = config.get("*", "core", "prosody_user") or "prosody";
75 local ok, err = pposix.setuid(desired_user);
81 print("Warning: Couldn't switch to Prosody user '"..tostring(desired_user).."': "..tostring(err));
85 print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
86 print("For more help send the below error to us through http://prosody.im/discuss");
87 print(tostring(pposix))
90 local error_messages = setmetatable({
91 ["invalid-username"] = "The given username is invalid in a Jabber ID";
92 ["invalid-hostname"] = "The given hostname is invalid";
93 ["no-password"] = "No password was supplied";
94 ["no-such-user"] = "The given user does not exist on the server";
95 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
96 ["no-pidfile"] = "There is no pidfile option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
97 ["no-such-method"] = "This module has no commands";
98 ["not-running"] = "Prosody is not running";
99 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
103 require "core.hostmanager"
104 require "core.eventmanager".fire_event("server-starting");
105 require "core.modulemanager"
107 require "util.prosodyctl"
109 -----------------------
111 function show_message(msg, ...)
112 print(msg:format(...));
115 function show_warning(msg, ...)
116 print(msg:format(...));
119 function show_usage(usage, desc)
120 print("Usage: "..arg[0].." "..usage);
126 local function getchar(n)
127 os.execute("stty raw -echo");
128 local char = io.read(n or 1);
129 os.execute("stty sane");
133 local function getpass()
134 os.execute("stty -echo");
135 local pass = io.read("*l");
136 os.execute("stty sane");
141 function show_yesno(prompt)
142 io.write(prompt, " ");
143 local choice = getchar():lower();
145 if not choice:match("%a") then
146 choice = prompt:match("%[.-(%U).-%]$");
147 if not choice then return nil; end
149 return (choice == "y");
152 local function read_password()
155 io.write("Enter new password: ");
156 password = getpass();
157 io.write("Retype new password: ");
158 if getpass() ~= password then
159 if not show_yesno [=[Passwords did not match, try again? [Y/n]]=] then
169 local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
170 -----------------------
172 local command = arg[1];
174 function commands.adduser(arg)
175 if not arg[1] or arg[1] == "--help" then
176 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
179 local user, host = arg[1]:match("([^@]+)@(.+)");
180 if not user and host then
181 show_message [[Failed to understand JID, please supply the JID you want to create]]
182 show_usage [[adduser user@host]]
187 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
191 if prosodyctl.user_exists{ user = user, host = host } then
192 show_message [[That user already exists]];
196 if not hosts[host] then
197 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
198 show_warning("The user will not be able to log in until this is changed.");
201 local password = read_password();
202 if not password then return 1; end
204 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
206 if ok then return 0; end
208 show_message(error_messages[msg])
212 function commands.passwd(arg)
213 if not arg[1] or arg[1] == "--help" then
214 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
217 local user, host = arg[1]:match("([^@]+)@(.+)");
218 if not user and host then
219 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
220 show_usage [[passwd user@host]]
225 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
229 if not prosodyctl.user_exists { user = user, host = host } then
230 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
234 local password = read_password();
235 if not password then return 1; end
237 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
239 if ok then return 0; end
241 show_message(error_messages[msg])
245 function commands.deluser(arg)
246 if not arg[1] or arg[1] == "--help" then
247 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
250 local user, host = arg[1]:match("([^@]+)@(.+)");
251 if not user and host then
252 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
253 show_usage [[passwd user@host]]
258 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
262 if not prosodyctl.user_exists { user = user, host = host } then
263 show_message [[That user does not exist on this server]]
267 local ok, msg = prosodyctl.passwd { user = user, host = host };
269 if ok then return 0; end
271 show_message(error_messages[msg])
275 function commands.start(arg)
276 if arg[1] == "--help" then
277 show_usage([[start]], [[Start Prosody]]);
280 local ok, ret = prosodyctl.isrunning();
282 show_message(error_messages[ret]);
287 local ok, ret = prosodyctl.getpid();
289 show_message("Couldn't get running Prosody's PID");
290 show_message(error_messages[ret]);
293 show_message("Prosody is already running with PID %s", ret or "(unknown)");
297 local ok, ret = prosodyctl.start();
301 local ok, running = prosodyctl.isrunning();
302 if ok and running then
305 show_message("Still waiting...");
306 elseif i >= prosodyctl_timeout then
307 show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
313 show_message("Started");
317 show_message("Failed to start Prosody");
318 show_message(error_messages[ret])
322 function commands.status(arg)
323 if arg[1] == "--help" then
324 show_usage([[status]], [[Reports the running status of Prosody]]);
328 local ok, ret = prosodyctl.isrunning();
330 show_message(error_messages[ret]);
335 local ok, ret = prosodyctl.getpid();
337 show_message("Couldn't get running Prosody's PID");
338 show_message(error_messages[ret]);
341 show_message("Prosody is running with PID %s", ret or "(unknown)");
344 show_message("Prosody is not running");
345 if not switched_user and current_uid ~= 0 then
347 print(" You will also see this if prosodyctl is not running under");
348 print(" the same user account as Prosody. Try running as root (e.g. ");
349 print(" with 'sudo' in front) to gain access to Prosody's real status.");
356 function commands.stop(arg)
357 if arg[1] == "--help" then
358 show_usage([[stop]], [[Stop a running Prosody server]]);
362 if not prosodyctl.isrunning() then
363 show_message("Prosody is not running");
367 local ok, ret = prosodyctl.stop();
371 local ok, running = prosodyctl.isrunning();
372 if ok and not running then
375 show_message("Still waiting...");
376 elseif i >= prosodyctl_timeout then
377 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
383 show_message("Stopped");
387 show_message(error_messages[ret]);
391 -- ejabberdctl compatibility
393 function commands.register(arg)
394 local user, host, password = unpack(arg);
395 if (not (user and host)) or arg[1] == "--help" then
396 if user ~= "--help" then
398 show_message [[No username specified]]
400 show_message [[Please specify which host you want to register the user on]];
403 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
407 password = read_password();
409 show_message [[Unable to register user with no password]];
414 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
416 if ok then return 0; end
418 show_message(error_messages[msg])
422 function commands.unregister(arg)
423 local user, host = unpack(arg);
424 if (not (user and host)) or arg[1] == "--help" then
425 if user ~= "--help" then
427 show_message [[No username specified]]
429 show_message [[Please specify which host you want to unregister the user from]];
432 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
436 local ok, msg = prosodyctl.deluser { user = user, host = host };
438 if ok then return 0; end
440 show_message(error_messages[msg])
445 ---------------------
447 if command:match("^mod_") then -- Is a command in a module
448 local module_name = command:match("^mod_(.+)");
449 local ret, err = modulemanager.load("*", module_name);
451 show_message("Failed to load module '"..module_name.."': "..err);
455 table.remove(arg, 1);
457 local module = modulemanager.get_module("*", module_name);
459 show_message("Failed to load module '"..module_name.."': Unknown error");
463 if not modulemanager.module_has_method(module, "command") then
464 show_message("Fail: mod_"..module_name.." does not support any commands");
468 local ok, ret = modulemanager.call_module_method(module, "command", arg);
470 if type(ret) == "number" then
472 elseif type(ret) == "string" then
477 show_message("Failed to execute command: "..error_messages[ret]);
482 if not commands[command] then -- Show help for all commands
483 function show_usage(usage, desc)
488 print("prosodyctl - Manage a Prosody server");
490 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
492 print("Where COMMAND may be one of:\n");
494 local hidden_commands = require "util.set".new{ "register", "unregister" };
495 local commands_order = { "adduser", "passwd", "deluser" };
499 for _, command_name in ipairs(commands_order) do
500 local command = commands[command_name];
504 done[command_name] = true;
508 for command_name, command in pairs(commands) do
509 if not done[command_name] and not hidden_commands:contains(command_name) then
512 done[command_name] = true;
520 os.exit(commands[command]({ select(2, unpack(arg)) }));