prosodyctl, util.prosodyctl: Show error when mod_posix is not enabled and an attempt...
[prosody.git] / prosodyctl
index 0709bcb96ad8494347eb56ce90078e385dc1d754..88cf552ccb251034c5f822906b4597c52a7f256b 100755 (executable)
@@ -1,5 +1,5 @@
 #!/usr/bin/env lua
--- Prosody IM v0.4
+-- Prosody IM
 -- Copyright (C) 2008-2009 Matthew Wild
 -- Copyright (C) 2008-2009 Waqas Hussain
 -- 
@@ -29,9 +29,13 @@ if CFG_DATADIR then
        end
 end
 
--- Required to be able to find packages installed with luarocks
-pcall(require, "luarocks.require")
-
+-- Global 'prosody' object
+prosody = {
+       hosts = {},
+       events = require "util.events".new(),
+       platform = "posix"
+};
+local prosody = prosody;
 
 config = require "core.configmanager"
 
@@ -60,46 +64,121 @@ do
                os.exit(1);
        end
 end
+local original_logging_config = config.get("*", "core", "log");
+config.set("*", "core", "log", { { levels = { min="info" }, to = "console" } });
+
+require "core.loggingmanager"
+
+if not require "util.dependencies".check_dependencies() then
+       os.exit(1);
+end
 
 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
 require "util.datamanager".set_data_path(data_path);
 
 -- Switch away from root and into the prosody user --
 local switched_user, current_uid;
+
+local want_pposix_version = "0.3.5";
 local ok, pposix = pcall(require, "util.pposix");
+
 if ok and pposix then
+       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
        current_uid = pposix.getuid();
        if current_uid == 0 then
                -- We haz root!
                local desired_user = config.get("*", "core", "prosody_user") or "prosody";
-               local ok, err = pposix.setuid(desired_user);
+               local desired_group = config.get("*", "core", "prosody_group") or desired_user;
+               local ok, err = pposix.setgid(desired_group);
                if ok then
-                       -- Yay!
-                       switched_user = true;
-               else
+                       ok, err = pposix.initgroups(desired_user);
+               end
+               if ok then
+                       ok, err = pposix.setuid(desired_user);
+                       if ok then
+                               -- Yay!
+                               switched_user = true;
+                       end
+               end
+               if not switched_user then
                        -- Boo!
-                       print("Warning: Couldn't switch to Prosody user '"..tostring(desired_user).."': "..tostring(err));
+                       print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
                end
        end
+       
+       -- Set our umask to protect data files
+       pposix.umask(config.get("*", "core", "umask") or "027");
 else
        print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
        print("For more help send the below error to us through http://prosody.im/discuss");
        print(tostring(pposix))
 end
 
+local function test_writeable(filename)
+       local f, err = io.open(filename, "a");
+       if not f then
+               return false, err;
+       end
+       f:close();
+       return true;
+end
+
+local unwriteable_files = {};
+if type(original_logging_config) == "string" and original_logging_config:sub(1,1) ~= "*" then
+       local ok, err = test_writeable(original_logging_config);
+       if not ok then
+               table.insert(unwriteable_files, err);
+       end
+elseif type(original_logging_config) == "table" then
+       for _, rule in ipairs(original_logging_config) do
+               if rule.filename then
+                       local ok, err = test_writeable(rule.filename);
+                       if not ok then
+                               table.insert(unwriteable_files, err);
+                       end
+               end
+       end
+end
+
+if #unwriteable_files > 0 then
+       print("One of more of the Prosody log files are not");
+       print("writeable, please correct the errors and try");
+       print("starting prosodyctl again.");
+       print("");
+       for _, err in ipairs(unwriteable_files) do
+               print(err);
+       end
+       print("");
+       os.exit(1);
+end
+
+
 local error_messages = setmetatable({ 
                ["invalid-username"] = "The given username is invalid in a Jabber ID";
                ["invalid-hostname"] = "The given hostname is invalid";
                ["no-password"] = "No password was supplied";
                ["no-such-user"] = "The given user does not exist on the server";
+               ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
+               ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
+               ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
+               ["no-such-method"] = "This module has no commands";
+               ["not-running"] = "Prosody is not running";
                }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
 
-hosts = {};
+hosts = prosody.hosts;
 
-require "core.hostmanager"
-require "core.eventmanager".fire_event("server-starting");
+local function make_host(hostname)
+       return { events = prosody.events, users = require "core.usermanager".new_null_provider(hostname) };
+end
+
+for hostname, config in pairs(config.getconfig()) do
+       hosts[hostname] = make_host(hostname);
+end
+       
+require "core.modulemanager"
 
 require "util.prosodyctl"
+require "socket"
 -----------------------
 
 function show_message(msg, ...)
@@ -118,18 +197,37 @@ function show_usage(usage, desc)
 end
 
 local function getchar(n)
-       os.execute("stty raw -echo");
-       local char = io.read(n or 1);
-       os.execute("stty sane");
-       return char;
+       local stty_ret = os.execute("stty raw -echo 2>/dev/null");
+       local ok, char;
+       if stty_ret == 0 then
+               ok, char = pcall(io.read, n or 1);
+               os.execute("stty sane");
+       else
+               ok, char = pcall(io.read, "*l");
+               if ok then
+                       char = char:sub(1, n or 1);
+               end
+       end
+       if ok then
+               return char;
+       end
 end
        
 local function getpass()
-       os.execute("stty -echo");
-       local pass = io.read("*l");
-       os.execute("stty sane");
+       local stty_ret = os.execute("stty -echo 2>/dev/null");
+       if stty_ret ~= 0 then
+               io.write("\027[08m"); -- ANSI 'hidden' text attribute
+       end
+       local ok, pass = pcall(io.read, "*l");
+       if stty_ret == 0 then
+               os.execute("stty sane");
+       else
+               io.write("\027[00m");
+       end
        io.write("\n");
-       return pass;
+       if ok then
+               return pass;
+       end
 end
 
 function show_yesno(prompt)
@@ -148,6 +246,10 @@ local function read_password()
        while true do
                io.write("Enter new password: ");
                password = getpass();
+               if not password then
+                       show_message("No password - cancelled");
+                       return;
+               end
                io.write("Retype new password: ");
                if getpass() ~= password then
                        if not show_yesno [=[Passwords did not match, try again? [Y/n]]=] then
@@ -159,6 +261,8 @@ local function read_password()
        end
        return password;
 end
+
+local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
 -----------------------
 local commands = {};
 local command = arg[1];
@@ -180,14 +284,15 @@ function commands.adduser(arg)
                return 1;
        end
        
-       if prosodyctl.user_exists{ user = user, host = host } then
-               show_message [[That user already exists]];
-               return 1;
-       end
-       
        if not hosts[host] then
                show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
                show_warning("The user will not be able to log in until this is changed.");
+               hosts[host] = make_host(host);
+       end
+       
+       if prosodyctl.user_exists{ user = user, host = host } then
+               show_message [[That user already exists]];
+               return 1;
        end
        
        local password = read_password();
@@ -218,6 +323,12 @@ function commands.passwd(arg)
                return 1;
        end
        
+       if not hosts[host] then
+               show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
+               show_warning("The user will not be able to log in until this is changed.");
+               hosts[host] = make_host(host);
+       end
+       
        if not prosodyctl.user_exists { user = user, host = host } then
                show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
                return 1;
@@ -251,6 +362,12 @@ function commands.deluser(arg)
                return 1;
        end
        
+       if not hosts[host] then
+               show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
+               show_warning("The user will not be able to log in until this is changed.");
+               hosts[host] = make_host(host);
+       end
+
        if not prosodyctl.user_exists { user = user, host = host } then
                show_message [[That user does not exist on this server]]
                return 1;
@@ -287,7 +404,26 @@ function commands.start(arg)
        end
        
        local ok, ret = prosodyctl.start();
-       if ok then return 0; end
+       if ok then
+               if config.get("*", "core", "daemonize") ~= false then
+                       local i=1;
+                       while true do
+                               local ok, running = prosodyctl.isrunning();
+                               if ok and running then
+                                       break;
+                               elseif i == 5 then
+                                       show_message("Still waiting...");
+                               elseif i >= prosodyctl_timeout then
+                                       show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
+                                       return 2;
+                               end
+                               socket.sleep(0.5);
+                               i = i + 1;
+                       end
+                       show_message("Started");
+               end
+               return 0;
+       end
 
        show_message("Failed to start Prosody");
        show_message(error_messages[ret])       
@@ -318,9 +454,10 @@ function commands.status(arg)
        else
                show_message("Prosody is not running");
                if not switched_user and current_uid ~= 0 then
-                       print("\nNote: You will also see this if prosodyctl is not running under the same");
-                       print("      user account as Prosody. Try running as root (e.g. with 'sudo' in front) to");
-                       print("      gain access to Prosody's real status.");
+                       print("\nNote:")
+                       print(" You will also see this if prosodyctl is not running under");
+                       print(" the same user account as Prosody. Try running as root (e.g. ");
+                       print(" with 'sudo' in front) to gain access to Prosody's real status.");
                end
                return 2
        end
@@ -339,12 +476,42 @@ function commands.stop(arg)
        end
        
        local ok, ret = prosodyctl.stop();
-       if ok then return 0; end
+       if ok then
+               local i=1;
+               while true do
+                       local ok, running = prosodyctl.isrunning();
+                       if ok and not running then
+                               break;
+                       elseif i == 5 then
+                               show_message("Still waiting...");
+                       elseif i >= prosodyctl_timeout then
+                               show_message("Prosody is still running. Please give it some time or check your log files for errors.");
+                               return 2;
+                       end
+                       socket.sleep(0.5);
+                       i = i + 1;
+               end
+               show_message("Stopped");
+               return 0;
+       end
 
        show_message(error_messages[ret]);
        return 1;
 end
 
+function commands.restart(arg)
+       if arg[1] == "--help" then
+               show_usage([[restart]], [[Restart a running Prosody server]]);
+               return 1;
+       end
+       
+       local ret = commands.stop(arg);
+       if ret == 0 then
+               ret = commands.start(arg);
+       end
+       return ret;
+end
+
 -- ejabberdctl compatibility
 
 function commands.register(arg)
@@ -398,9 +565,43 @@ function commands.unregister(arg)
        return 1;
 end
 
-
 ---------------------
 
+if command and command:match("^mod_") then -- Is a command in a module
+       local module_name = command:match("^mod_(.+)");
+       local ret, err = modulemanager.load("*", module_name);
+       if not ret then
+               show_message("Failed to load module '"..module_name.."': "..err);
+               os.exit(1);
+       end
+       
+       table.remove(arg, 1);
+       
+       local module = modulemanager.get_module("*", module_name);
+       if not module then
+               show_message("Failed to load module '"..module_name.."': Unknown error");
+               os.exit(1);
+       end
+       
+       if not modulemanager.module_has_method(module, "command") then
+               show_message("Fail: mod_"..module_name.." does not support any commands");
+               os.exit(1);
+       end
+       
+       local ok, ret = modulemanager.call_module_method(module, "command", arg);
+       if ok then
+               if type(ret) == "number" then
+                       os.exit(ret);
+               elseif type(ret) == "string" then
+                       show_message(ret);
+               end
+               os.exit(0); -- :)
+       else
+               show_message("Failed to execute command: "..error_messages[ret]);
+               os.exit(1); -- :(
+       end
+end
+
 if not commands[command] then -- Show help for all commands
        function show_usage(usage, desc)
                print(" "..usage);
@@ -413,8 +614,8 @@ if not commands[command] then -- Show help for all commands
        print("");
        print("Where COMMAND may be one of:\n");
 
-       local hidden_commands = require "util.set".new{ "register", "unregister" };
-       local commands_order = { "adduser", "passwd", "deluser" };
+       local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
+       local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart" };
 
        local done = {};