prosodyctl

   1 #!/usr/bin/env lua
   2 -- Prosody IM
   3 -- Copyright (C) 2008-2009 Matthew Wild
   4 -- Copyright (C) 2008-2009 Waqas Hussain
   5 --
   6 -- This project is MIT/X11 licensed. Please see the
   7 -- COPYING file in the source package for more information.
   8 --
   9
  10 -- prosodyctl - command-line controller for Prosody XMPP server
  11
  12 -- Will be modified by configure script if run --
  13
  14 CFG_SOURCEDIR=nil;
  15 CFG_CONFIGDIR=os.getenv("PROSODY_CFGDIR");
  16 CFG_PLUGINDIR=nil;
  17 CFG_DATADIR=os.getenv("PROSODY_DATADIR");
  18
  19 -- -- -- -- -- -- -- ---- -- -- -- -- -- -- -- --
  20
  21 if CFG_SOURCEDIR then
  22         package.path = CFG_SOURCEDIR.."/?.lua;"..package.path
  23         package.cpath = CFG_SOURCEDIR.."/?.so;"..package.cpath
  24 end
  25
  26 if CFG_DATADIR then
  27         if os.getenv("HOME") then
  28                 CFG_DATADIR = CFG_DATADIR:gsub("^~", os.getenv("HOME"));
  29         end
  30 end
  31
  32 -- Global 'prosody' object
  33 prosody = {
  34         hosts = {},
  35         events = require "util.events".new(),
  36         platform = "posix"
  37 };
  38 local prosody = prosody;
  39
  40 config = require "core.configmanager"
  41
  42 do
  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");
  46         if not ok then
  47                 print("\n");
  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)));
  53                         print("");
  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.");
  59                 end
  60                 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
  61                 print("Good luck!");
  62                 print("**************************");
  63                 print("");
  64                 os.exit(1);
  65         end
  66 end
  67
  68 config.set("*", "core", "log", { { levels = { min="info" }, to = "console" } });
  69
  70 require "core.loggingmanager"
  71
  72 if not require "util.dependencies".check_dependencies() then
  73         os.exit(1);
  74 end
  75
  76 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
  77 require "util.datamanager".set_data_path(data_path);
  78
  79 -- Switch away from root and into the prosody user --
  80 local switched_user, current_uid;
  81
  82 local want_pposix_version = "0.3.3";
  83 local ok, pposix = pcall(require, "util.pposix");
  84
  85 if ok and pposix then
  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
  89                 -- We haz root!
  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);
  93                 if ok then
  94                         ok, err = pposix.setuid(desired_user);
  95                         if ok then
  96                                 -- Yay!
  97                                 switched_user = true;
  98                         end
  99                 end
 100                 if not switched_user then
 101                         -- Boo!
 102                         print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
 103                 end
 104         end
 105
 106         -- Set our umask to protect data files
 107         pposix.umask(config.get("*", "core", "umask") or "027");
 108 else
 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))
 112 end
 113
 114 local error_messages = setmetatable({
 115                 ["invalid-username"] = "The given username is invalid in a Jabber ID";
 116                 ["invalid-hostname"] = "The given hostname is invalid";
 117                 ["no-password"] = "No password was supplied";
 118                 ["no-such-user"] = "The given user does not exist on the server";
 119                 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
 120                 ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
 121                 ["no-such-method"] = "This module has no commands";
 122                 ["not-running"] = "Prosody is not running";
 123                 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
 124
 125 hosts = prosody.hosts;
 126
 127 local function make_host(hostname)
 128         return { events = prosody.events, users = require "core.usermanager".new_null_provider(hostname) };
 129 end
 130
 131 for hostname, config in pairs(config.getconfig()) do
 132         hosts[hostname] = make_host(hostname);
 133 end
 134
 135 require "core.modulemanager"
 136
 137 require "util.prosodyctl"
 138 require "socket"
 139 -----------------------
 140
 141 function show_message(msg, ...)
 142         print(msg:format(...));
 143 end
 144
 145 function show_warning(msg, ...)
 146         print(msg:format(...));
 147 end
 148
 149 function show_usage(usage, desc)
 150         print("Usage: "..arg[0].." "..usage);
 151         if desc then
 152                 print(" "..desc);
 153         end
 154 end
 155
 156 local function getchar(n)
 157         local stty_ret = os.execute("stty raw -echo 2>/dev/null");
 158         local ok, char;
 159         if stty_ret == 0 then
 160                 ok, char = pcall(io.read, n or 1);
 161                 os.execute("stty sane");
 162         else
 163                 ok, char = pcall(io.read, "*l");
 164                 if ok then
 165                         char = char:sub(1, n or 1);
 166                 end
 167         end
 168         if ok then
 169                 return char;
 170         end
 171 end
 172
 173 local function getpass()
 174         local stty_ret = os.execute("stty -echo 2>/dev/null");
 175         if stty_ret ~= 0 then
 176                 io.write("\027[08m"); -- ANSI 'hidden' text attribute
 177         end
 178         local ok, pass = pcall(io.read, "*l");
 179         if stty_ret == 0 then
 180                 os.execute("stty sane");
 181         else
 182                 io.write("\027[00m");
 183         end
 184         io.write("\n");
 185         if ok then
 186                 return pass;
 187         end
 188 end
 189
 190 function show_yesno(prompt)
 191         io.write(prompt, " ");
 192         local choice = getchar():lower();
 193         io.write("\n");
 194         if not choice:match("%a") then
 195                 choice = prompt:match("%[.-(%U).-%]$");
 196                 if not choice then return nil; end
 197         end
 198         return (choice == "y");
 199 end
 200
 201 local function read_password()
 202         local password;
 203         while true do
 204                 io.write("Enter new password: ");
 205                 password = getpass();
 206                 if not password then
 207                         show_message("No password - cancelled");
 208                         return;
 209                 end
 210                 io.write("Retype new password: ");
 211                 if getpass() ~= password then
 212                         if not show_yesno [=[Passwords did not match, try again? [Y/n]]=] then
 213                                 return;
 214                         end
 215                 else
 216                         break;
 217                 end
 218         end
 219         return password;
 220 end
 221
 222 local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
 223 -----------------------
 224 local commands = {};
 225 local command = arg[1];
 226
 227 function commands.adduser(arg)
 228         if not arg[1] or arg[1] == "--help" then
 229                 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
 230                 return 1;
 231         end
 232         local user, host = arg[1]:match("([^@]+)@(.+)");
 233         if not user and host then
 234                 show_message [[Failed to understand JID, please supply the JID you want to create]]
 235                 show_usage [[adduser user@host]]
 236                 return 1;
 237         end
 238
 239         if not host then
 240                 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
 241                 return 1;
 242         end
 243
 244         if not hosts[host] then
 245                 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
 246                 show_warning("The user will not be able to log in until this is changed.");
 247                 hosts[host] = make_host(host);
 248         end
 249
 250         if prosodyctl.user_exists{ user = user, host = host } then
 251                 show_message [[That user already exists]];
 252                 return 1;
 253         end
 254
 255         local password = read_password();
 256         if not password then return 1; end
 257
 258         local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
 259
 260         if ok then return 0; end
 261
 262         show_message(error_messages[msg])
 263         return 1;
 264 end
 265
 266 function commands.passwd(arg)
 267         if not arg[1] or arg[1] == "--help" then
 268                 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
 269                 return 1;
 270         end
 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 set the password for]]
 274                 show_usage [[passwd user@host]]
 275                 return 1;
 276         end
 277
 278         if not host then
 279                 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
 280                 return 1;
 281         end
 282
 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);
 287         end
 288
 289         if not prosodyctl.user_exists { user = user, host = host } then
 290                 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
 291                 return 1;
 292         end
 293
 294         local password = read_password();
 295         if not password then return 1; end
 296
 297         local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
 298
 299         if ok then return 0; end
 300
 301         show_message(error_messages[msg])
 302         return 1;
 303 end
 304
 305 function commands.deluser(arg)
 306         if not arg[1] or arg[1] == "--help" then
 307                 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
 308                 return 1;
 309         end
 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]]
 314                 return 1;
 315         end
 316
 317         if not host then
 318                 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
 319                 return 1;
 320         end
 321
 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);
 326         end
 327
 328         if not prosodyctl.user_exists { user = user, host = host } then
 329                 show_message [[That user does not exist on this server]]
 330                 return 1;
 331         end
 332
 333         local ok, msg = prosodyctl.passwd { user = user, host = host };
 334
 335         if ok then return 0; end
 336
 337         show_message(error_messages[msg])
 338         return 1;
 339 end
 340
 341 function commands.start(arg)
 342         if arg[1] == "--help" then
 343                 show_usage([[start]], [[Start Prosody]]);
 344                 return 1;
 345         end
 346         local ok, ret = prosodyctl.isrunning();
 347         if not ok then
 348                 show_message(error_messages[ret]);
 349                 return 1;
 350         end
 351
 352         if ret then
 353                 local ok, ret = prosodyctl.getpid();
 354                 if not ok then
 355                         show_message("Couldn't get running Prosody's PID");
 356                         show_message(error_messages[ret]);
 357                         return 1;
 358                 end
 359                 show_message("Prosody is already running with PID %s", ret or "(unknown)");
 360                 return 1;
 361         end
 362
 363         local ok, ret = prosodyctl.start();
 364         if ok then
 365                 if config.get("*", "core", "daemonize") ~= false then
 366                         local i=1;
 367                         while true do
 368                                 local ok, running = prosodyctl.isrunning();
 369                                 if ok and running then
 370                                         break;
 371                                 elseif i == 5 then
 372                                         show_message("Still waiting...");
 373                                 elseif i >= prosodyctl_timeout then
 374                                         show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
 375                                         return 2;
 376                                 end
 377                                 socket.sleep(0.5);
 378                                 i = i + 1;
 379                         end
 380                         show_message("Started");
 381                 end
 382                 return 0;
 383         end
 384
 385         show_message("Failed to start Prosody");
 386         show_message(error_messages[ret])
 387         return 1;
 388 end
 389
 390 function commands.status(arg)
 391         if arg[1] == "--help" then
 392                 show_usage([[status]], [[Reports the running status of Prosody]]);
 393                 return 1;
 394         end
 395
 396         local ok, ret = prosodyctl.isrunning();
 397         if not ok then
 398                 show_message(error_messages[ret]);
 399                 return 1;
 400         end
 401
 402         if ret then
 403                 local ok, ret = prosodyctl.getpid();
 404                 if not ok then
 405                         show_message("Couldn't get running Prosody's PID");
 406                         show_message(error_messages[ret]);
 407                         return 1;
 408                 end
 409                 show_message("Prosody is running with PID %s", ret or "(unknown)");
 410                 return 0;
 411         else
 412                 show_message("Prosody is not running");
 413                 if not switched_user and current_uid ~= 0 then
 414                         print("\nNote:")
 415                         print(" You will also see this if prosodyctl is not running under");
 416                         print(" the same user account as Prosody. Try running as root (e.g. ");
 417                         print(" with 'sudo' in front) to gain access to Prosody's real status.");
 418                 end
 419                 return 2
 420         end
 421         return 1;
 422 end
 423
 424 function commands.stop(arg)
 425         if arg[1] == "--help" then
 426                 show_usage([[stop]], [[Stop a running Prosody server]]);
 427                 return 1;
 428         end
 429
 430         if not prosodyctl.isrunning() then
 431                 show_message("Prosody is not running");
 432                 return 1;
 433         end
 434
 435         local ok, ret = prosodyctl.stop();
 436         if ok then
 437                 local i=1;
 438                 while true do
 439                         local ok, running = prosodyctl.isrunning();
 440                         if ok and not running then
 441                                 break;
 442                         elseif i == 5 then
 443                                 show_message("Still waiting...");
 444                         elseif i >= prosodyctl_timeout then
 445                                 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
 446                                 return 2;
 447                         end
 448                         socket.sleep(0.5);
 449                         i = i + 1;
 450                 end
 451                 show_message("Stopped");
 452                 return 0;
 453         end
 454
 455         show_message(error_messages[ret]);
 456         return 1;
 457 end
 458
 459 function commands.restart(arg)
 460         if arg[1] == "--help" then
 461                 show_usage([[restart]], [[Restart a running Prosody server]]);
 462                 return 1;
 463         end
 464
 465         local ret = commands.stop(arg);
 466         if ret == 0 then
 467                 ret = commands.start(arg);
 468         end
 469         return ret;
 470 end
 471
 472 -- ejabberdctl compatibility
 473
 474 function commands.register(arg)
 475         local user, host, password = unpack(arg);
 476         if (not (user and host)) or arg[1] == "--help" then
 477                 if user ~= "--help" then
 478                         if not user then
 479                                 show_message [[No username specified]]
 480                         elseif not host then
 481                                 show_message [[Please specify which host you want to register the user on]];
 482                         end
 483                 end
 484                 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
 485                 return 1;
 486         end
 487         if not password then
 488                 password = read_password();
 489                 if not password then
 490                         show_message [[Unable to register user with no password]];
 491                         return 1;
 492                 end
 493         end
 494
 495         local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
 496
 497         if ok then return 0; end
 498
 499         show_message(error_messages[msg])
 500         return 1;
 501 end
 502
 503 function commands.unregister(arg)
 504         local user, host = unpack(arg);
 505         if (not (user and host)) or arg[1] == "--help" then
 506                 if user ~= "--help" then
 507                         if not user then
 508                                 show_message [[No username specified]]
 509                         elseif not host then
 510                                 show_message [[Please specify which host you want to unregister the user from]];
 511                         end
 512                 end
 513                 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
 514                 return 1;
 515         end
 516
 517         local ok, msg = prosodyctl.deluser { user = user, host = host };
 518
 519         if ok then return 0; end
 520
 521         show_message(error_messages[msg])
 522         return 1;
 523 end
 524
 525 ---------------------
 526
 527 if command and command:match("^mod_") then -- Is a command in a module
 528         local module_name = command:match("^mod_(.+)");
 529         local ret, err = modulemanager.load("*", module_name);
 530         if not ret then
 531                 show_message("Failed to load module '"..module_name.."': "..err);
 532                 os.exit(1);
 533         end
 534
 535         table.remove(arg, 1);
 536
 537         local module = modulemanager.get_module("*", module_name);
 538         if not module then
 539                 show_message("Failed to load module '"..module_name.."': Unknown error");
 540                 os.exit(1);
 541         end
 542
 543         if not modulemanager.module_has_method(module, "command") then
 544                 show_message("Fail: mod_"..module_name.." does not support any commands");
 545                 os.exit(1);
 546         end
 547
 548         local ok, ret = modulemanager.call_module_method(module, "command", arg);
 549         if ok then
 550                 if type(ret) == "number" then
 551                         os.exit(ret);
 552                 elseif type(ret) == "string" then
 553                         show_message(ret);
 554                 end
 555                 os.exit(0); -- :)
 556         else
 557                 show_message("Failed to execute command: "..error_messages[ret]);
 558                 os.exit(1); -- :(
 559         end
 560 end
 561
 562 if not commands[command] then -- Show help for all commands
 563         function show_usage(usage, desc)
 564                 print(" "..usage);
 565                 print("    "..desc);
 566         end
 567
 568         print("prosodyctl - Manage a Prosody server");
 569         print("");
 570         print("Usage: "..arg[0].." COMMAND [OPTIONS]");
 571         print("");
 572         print("Where COMMAND may be one of:\n");
 573
 574         local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
 575         local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart" };
 576
 577         local done = {};
 578
 579         for _, command_name in ipairs(commands_order) do
 580                 local command = commands[command_name];
 581                 if command then
 582                         command{ "--help" };
 583                         print""
 584                         done[command_name] = true;
 585                 end
 586         end
 587
 588         for command_name, command in pairs(commands) do
 589                 if not done[command_name] and not hidden_commands:contains(command_name) then
 590                         command{ "--help" };
 591                         print""
 592                         done[command_name] = true;
 593                 end
 594         end
 595
 596
 597         os.exit(0);
 598 end
 599
 600 os.exit(commands[command]({ select(2, unpack(arg)) }));