plugins/mod_console.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2009 Matthew Wild
   3 -- Copyright (C) 2008-2009 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   9 module.host = "*";
  10
  11 local _G = _G;
  12
  13 local prosody = _G.prosody;
  14 local hosts = prosody.hosts;
  15 local connlisteners_register = require "net.connlisteners".register;
  16
  17 local console_listener = { default_port = 5582; default_mode = "*l"; default_interface = "127.0.0.1" };
  18
  19 require "util.iterators";
  20 local jid_bare = require "util.jid".bare;
  21 local set, array = require "util.set", require "util.array";
  22
  23 local commands = {};
  24 local def_env = {};
  25 local default_env_mt = { __index = def_env };
  26
  27 prosody.console = { commands = commands, env = def_env };
  28
  29 local function redirect_output(_G, session)
  30         return setmetatable({ print = session.print }, { __index = function (t, k) return rawget(_G, k); end, __newindex = function (t, k, v) rawset(_G, k, v); end });
  31 end
  32
  33 console = {};
  34
  35 function console:new_session(conn)
  36         local w = function(s) conn.write(s:gsub("\n", "\r\n")); end;
  37         local session = { conn = conn;
  38                         send = function (t) w(tostring(t)); end;
  39                         print = function (t) w("| "..tostring(t).."\n"); end;
  40                         disconnect = function () conn.close(); end;
  41                         };
  42         session.env = setmetatable({}, default_env_mt);
  43
  44         -- Load up environment with helper objects
  45         for name, t in pairs(def_env) do
  46                 if type(t) == "table" then
  47                         session.env[name] = setmetatable({ session = session }, { __index = t });
  48                 end
  49         end
  50
  51         return session;
  52 end
  53
  54 local sessions = {};
  55
  56 function console_listener.listener(conn, data)
  57         local session = sessions[conn];
  58
  59         if not session then
  60                 -- Handle new connection
  61                 session = console:new_session(conn);
  62                 sessions[conn] = session;
  63                 printbanner(session);
  64         end
  65         if data then
  66                 -- Handle data
  67                 (function(session, data)
  68                         local useglobalenv;
  69
  70                         if data:match("^>") then
  71                                 data = data:gsub("^>", "");
  72                                 useglobalenv = true;
  73                         else
  74                                 local command = data:lower();
  75                                 command = data:match("^%w+") or data:match("%p");
  76                                 if commands[command] then
  77                                         commands[command](session, data);
  78                                         return;
  79                                 end
  80                         end
  81
  82                         session.env._ = data;
  83
  84                         local chunk, err = loadstring("return "..data);
  85                         if not chunk then
  86                                 chunk, err = loadstring(data);
  87                                 if not chunk then
  88                                         err = err:gsub("^%[string .-%]:%d+: ", "");
  89                                         err = err:gsub("^:%d+: ", "");
  90                                         err = err:gsub("'<eof>'", "the end of the line");
  91                                         session.print("Sorry, I couldn't understand that... "..err);
  92                                         return;
  93                                 end
  94                         end
  95
  96                         setfenv(chunk, (useglobalenv and redirect_output(_G, session)) or session.env or nil);
  97
  98                         local ranok, taskok, message = pcall(chunk);
  99
 100                         if not (ranok or message or useglobalenv) and commands[data:lower()] then
 101                                 commands[data:lower()](session, data);
 102                                 return;
 103                         end
 104
 105                         if not ranok then
 106                                 session.print("Fatal error while running command, it did not complete");
 107                                 session.print("Error: "..taskok);
 108                                 return;
 109                         end
 110
 111                         if not message then
 112                                 session.print("Result: "..tostring(taskok));
 113                                 return;
 114                         elseif (not taskok) and message then
 115                                 session.print("Command completed with a problem");
 116                                 session.print("Message: "..tostring(message));
 117                                 return;
 118                         end
 119
 120                         session.print("OK: "..tostring(message));
 121                 end)(session, data);
 122         end
 123         session.send(string.char(0));
 124 end
 125
 126 function console_listener.disconnect(conn, err)
 127
 128 end
 129
 130 connlisteners_register('console', console_listener);
 131
 132 -- Console commands --
 133 -- These are simple commands, not valid standalone in Lua
 134
 135 function commands.bye(session)
 136         session.print("See you! :)");
 137         session.disconnect();
 138 end
 139 commands.quit, commands.exit = commands.bye, commands.bye;
 140
 141 commands["!"] = function (session, data)
 142         if data:match("^!!") then
 143                 session.print("!> "..session.env._);
 144                 return console_listener.listener(session.conn, session.env._);
 145         end
 146         local old, new = data:match("^!(.-[^\\])!(.-)!$");
 147         if old and new then
 148                 local ok, res = pcall(string.gsub, session.env._, old, new);
 149                 if not ok then
 150                         session.print(res)
 151                         return;
 152                 end
 153                 session.print("!> "..res);
 154                 return console_listener.listener(session.conn, res);
 155         end
 156         session.print("Sorry, not sure what you want");
 157 end
 158
 159 function commands.help(session, data)
 160         local print = session.print;
 161         local section = data:match("^help (%w+)");
 162         if not section then
 163                 print [[Commands are divided into multiple sections. For help on a particular section, ]]
 164                 print [[type: help SECTION (for example, 'help c2s'). Sections are: ]]
 165                 print [[]]
 166                 print [[c2s - Commands to manage local client-to-server sessions]]
 167                 print [[s2s - Commands to manage sessions between this server and others]]
 168                 print [[module - Commands to load/reload/unload modules/plugins]]
 169                 print [[server - Uptime, version, shutting down, etc.]]
 170                 print [[console - Help regarding the console itself]]
 171         elseif section == "c2s" then
 172                 print [[c2s:show(jid) - Show all client sessions with the specified JID (or all if no JID given)]]
 173                 print [[c2s:show_insecure() - Show all unencrypted client connections]]
 174                 print [[c2s:show_secure() - Show all encrypted client connections]]
 175                 print [[c2s:close(jid) - Close all sessions for the specified JID]]
 176         elseif section == "s2s" then
 177                 print [[s2s:show(domain) - Show all s2s connections for the given domain (or all if no domain given)]]
 178                 print [[s2s:close(from, to) - Close a connection from one domain to another]]
 179         elseif section == "module" then
 180                 print [[module:load(module, host) - Load the specified module on the specified host (or all hosts if none given)]]
 181                 print [[module:reload(module, host) - The same, but unloads and loads the module (saving state if the module supports it)]]
 182                 print [[module:unload(module, host) - The same, but just unloads the module from memory]]
 183         elseif section == "server" then
 184                 print [[server:version() - Show the server's version number]]
 185                 print [[server:uptime() - Show how long the server has been running]]
 186                 --print [[server:shutdown(reason) - Shut down the server, with an optional reason to be broadcast to all connections]]
 187         elseif section == "console" then
 188                 print [[Hey! Welcome to Prosody's admin console.]]
 189                 print [[First thing, if you're ever wondering how to get out, simply type 'quit'.]]
 190                 print [[Secondly, note that we don't support the full telnet protocol yet (it's coming)]]
 191                 print [[so you may have trouble using the arrow keys, etc. depending on your system.]]
 192                 print [[]]
 193                 print [[For now we offer a couple of handy shortcuts:]]
 194                 print [[!! - Repeat the last command]]
 195                 print [[!old!new! - repeat the last command, but with 'old' replaced by 'new']]
 196                 print [[]]
 197                 print [[For those well-versed in Prosody's internals, or taking instruction from those who are,]]
 198                 print [[you can prefix a command with > to escape the console sandbox, and access everything in]]
 199                 print [[the running server. Great fun, but be careful not to break anything :)]]
 200         end
 201         print [[]]
 202 end
 203
 204 -- Session environment --
 205 -- Anything in def_env will be accessible within the session as a global variable
 206
 207 def_env.server = {};
 208
 209 function def_env.server:insane_reload()
 210         prosody.unlock_globals();
 211         dofile "prosody"
 212         prosody = _G.prosody;
 213         return true, "Server reloaded";
 214 end
 215
 216 function def_env.server:version()
 217         return true, tostring(prosody.version or "unknown");
 218 end
 219
 220 function def_env.server:uptime()
 221         local t = os.time()-prosody.start_time;
 222         local seconds = t%60;
 223         t = (t - seconds)/60;
 224         local minutes = t%60;
 225         t = (t - minutes)/60;
 226         local hours = t%24;
 227         t = (t - hours)/24;
 228         local days = t;
 229         return true, string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)",
 230                 days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "",
 231                 minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
 232 end
 233
 234 function def_env.server:shutdown(reason)
 235         prosody.shutdown(reason);
 236         return true, "Shutdown initiated";
 237 end
 238
 239 def_env.module = {};
 240
 241 local function get_hosts_set(hosts, module)
 242         if type(hosts) == "table" then
 243                 if hosts[1] then
 244                         return set.new(hosts);
 245                 elseif hosts._items then
 246                         return hosts;
 247                 end
 248         elseif type(hosts) == "string" then
 249                 return set.new { hosts };
 250         elseif hosts == nil then
 251                 local mm = require "modulemanager";
 252                 return set.new(array.collect(keys(prosody.hosts)))
 253                         / function (host) return prosody.hosts[host].type == "local" or module and mm.is_loaded(host, module); end;
 254         end
 255 end
 256
 257 function def_env.module:load(name, hosts, config)
 258         local mm = require "modulemanager";
 259
 260         hosts = get_hosts_set(hosts);
 261
 262         -- Load the module for each host
 263         local ok, err, count = true, nil, 0;
 264         for host in hosts do
 265                 if (not mm.is_loaded(host, name)) then
 266                         ok, err = mm.load(host, name, config);
 267                         if not ok then
 268                                 ok = false;
 269                                 self.session.print(err or "Unknown error loading module");
 270                         else
 271                                 count = count + 1;
 272                                 self.session.print("Loaded for "..host);
 273                         end
 274                 end
 275         end
 276
 277         return ok, (ok and "Module loaded onto "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 278 end
 279
 280 function def_env.module:unload(name, hosts)
 281         local mm = require "modulemanager";
 282
 283         hosts = get_hosts_set(hosts, name);
 284
 285         -- Unload the module for each host
 286         local ok, err, count = true, nil, 0;
 287         for host in hosts do
 288                 if mm.is_loaded(host, name) then
 289                         ok, err = mm.unload(host, name);
 290                         if not ok then
 291                                 ok = false;
 292                                 self.session.print(err or "Unknown error unloading module");
 293                         else
 294                                 count = count + 1;
 295                                 self.session.print("Unloaded from "..host);
 296                         end
 297                 end
 298         end
 299         return ok, (ok and "Module unloaded from "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 300 end
 301
 302 function def_env.module:reload(name, hosts)
 303         local mm = require "modulemanager";
 304
 305         hosts = get_hosts_set(hosts, name);
 306
 307         -- Reload the module for each host
 308         local ok, err, count = true, nil, 0;
 309         for host in hosts do
 310                 if mm.is_loaded(host, name) then
 311                         ok, err = mm.reload(host, name);
 312                         if not ok then
 313                                 ok = false;
 314                                 self.session.print(err or "Unknown error reloading module");
 315                         else
 316                                 count = count + 1;
 317                                 if ok == nil then
 318                                         ok = true;
 319                                 end
 320                                 self.session.print("Reloaded on "..host);
 321                         end
 322                 end
 323         end
 324         return ok, (ok and "Module reloaded on "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 325 end
 326
 327 def_env.config = {};
 328 function def_env.config:load(filename, format)
 329         local config_load = require "core.configmanager".load;
 330         local ok, err = config_load(filename, format);
 331         if not ok then
 332                 return false, err or "Unknown error loading config";
 333         end
 334         return true, "Config loaded";
 335 end
 336
 337 function def_env.config:get(host, section, key)
 338         local config_get = require "core.configmanager".get
 339         return true, tostring(config_get(host, section, key));
 340 end
 341
 342 function def_env.config:reload()
 343         local ok, err = prosody.reload_config();
 344         return ok, (ok and "Config reloaded (you may need to reload modules to take effect)") or tostring(err);
 345 end
 346
 347 def_env.hosts = {};
 348 function def_env.hosts:list()
 349         for host, host_session in pairs(hosts) do
 350                 self.session.print(host);
 351         end
 352         return true, "Done";
 353 end
 354
 355 function def_env.hosts:add(name)
 356 end
 357
 358 def_env.c2s = {};
 359
 360 local function show_c2s(callback)
 361         for hostname, host in pairs(hosts) do
 362                 for username, user in pairs(host.sessions or {}) do
 363                         for resource, session in pairs(user.sessions or {}) do
 364                                 local jid = username.."@"..hostname.."/"..resource;
 365                                 callback(jid, session);
 366                         end
 367                 end
 368         end
 369 end
 370
 371 function def_env.c2s:show(match_jid)
 372         local print, count = self.session.print, 0;
 373         show_c2s(function (jid, session)
 374                 if (not match_jid) or jid:match(match_jid) then
 375                         count = count + 1;
 376                         local status, priority = "unavailable", tostring(session.priority or "-");
 377                         if session.presence then
 378                                 status = session.presence:child_with_name("show");
 379                                 if status then
 380                                         status = status:get_text() or "[invalid!]";
 381                                 else
 382                                         status = "available";
 383                                 end
 384                         end
 385                         print(jid.." - "..status.."("..priority..")");
 386                 end
 387         end);
 388         return true, "Total: "..count.." clients";
 389 end
 390
 391 function def_env.c2s:show_insecure(match_jid)
 392         local print, count = self.session.print, 0;
 393         show_c2s(function (jid, session)
 394                 if ((not match_jid) or jid:match(match_jid)) and not session.secure then
 395                         count = count + 1;
 396                         print(jid);
 397                 end
 398         end);
 399         return true, "Total: "..count.." insecure client connections";
 400 end
 401
 402 function def_env.c2s:show_secure(match_jid)
 403         local print, count = self.session.print, 0;
 404         show_c2s(function (jid, session)
 405                 if ((not match_jid) or jid:match(match_jid)) and session.secure then
 406                         count = count + 1;
 407                         print(jid);
 408                 end
 409         end);
 410         return true, "Total: "..count.." secure client connections";
 411 end
 412
 413 function def_env.c2s:close(match_jid)
 414         local print, count = self.session.print, 0;
 415         show_c2s(function (jid, session)
 416                 if jid == match_jid or jid_bare(jid) == match_jid then
 417                         count = count + 1;
 418                         session:close();
 419                 end
 420         end);
 421         return true, "Total: "..count.." sessions closed";
 422 end
 423
 424 def_env.s2s = {};
 425 function def_env.s2s:show(match_jid)
 426         local _print = self.session.print;
 427         local print = self.session.print;
 428
 429         local count_in, count_out = 0,0;
 430
 431         for host, host_session in pairs(hosts) do
 432                 print = function (...) _print(host); _print(...); print = _print; end
 433                 for remotehost, session in pairs(host_session.s2sout) do
 434                         if (not match_jid) or remotehost:match(match_jid) or host:match(match_jid) then
 435                                 count_out = count_out + 1;
 436                                 print("    "..host.." -> "..remotehost);
 437                                 if session.sendq then
 438                                         print("        There are "..#session.sendq.." queued outgoing stanzas for this connection");
 439                                 end
 440                                 if session.type == "s2sout_unauthed" then
 441                                         if session.connecting then
 442                                                 print("        Connection not yet established");
 443                                                 if not session.srv_hosts then
 444                                                         if not session.conn then
 445                                                                 print("        We do not yet have a DNS answer for this host's SRV records");
 446                                                         else
 447                                                                 print("        This host has no SRV records, using A record instead");
 448                                                         end
 449                                                 elseif session.srv_choice then
 450                                                         print("        We are on SRV record "..session.srv_choice.." of "..#session.srv_hosts);
 451                                                         local srv_choice = session.srv_hosts[session.srv_choice];
 452                                                         print("        Using "..(srv_choice.target or ".")..":"..(srv_choice.port or 5269));
 453                                                 end
 454                                         elseif session.notopen then
 455                                                 print("        The <stream> has not yet been opened");
 456                                         elseif not session.dialback_key then
 457                                                 print("        Dialback has not been initiated yet");
 458                                         elseif session.dialback_key then
 459                                                 print("        Dialback has been requested, but no result received");
 460                                         end
 461                                 end
 462                         end
 463                 end
 464
 465                 for session in pairs(incoming_s2s) do
 466                         if session.to_host == host and ((not match_jid) or host:match(match_jid)
 467                                 or (session.from_host and session.from_host:match(match_jid))) then
 468                                 count_in = count_in + 1;
 469                                 print("    "..host.." <- "..(session.from_host or "(unknown)"));
 470                                 if session.type == "s2sin_unauthed" then
 471                                                 print("        Connection not yet authenticated");
 472                                 end
 473                                 for name in pairs(session.hosts) do
 474                                         if name ~= session.from_host then
 475                                                 print("        also hosts "..tostring(name));
 476                                         end
 477                                 end
 478                         end
 479                 end
 480
 481                 print = _print;
 482         end
 483
 484         for session in pairs(incoming_s2s) do
 485                 if not session.to_host and ((not match_jid) or session.from_host and session.from_host:match(match_jid)) then
 486                         count_in = count_in + 1;
 487                         print("Other incoming s2s connections");
 488                         print("    (unknown) <- "..(session.from_host or "(unknown)"));
 489                 end
 490         end
 491
 492         return true, "Total: "..count_out.." outgoing, "..count_in.." incoming connections";
 493 end
 494
 495 function def_env.s2s:close(from, to)
 496         local print, count = self.session.print, 0;
 497
 498         if not (from and to) then
 499                 return false, "Syntax: s2s:close('from', 'to') - Closes all s2s sessions from 'from' to 'to'";
 500         elseif from == to then
 501                 return false, "Both from and to are the same... you can't do that :)";
 502         end
 503
 504         if hosts[from] and not hosts[to] then
 505                 -- Is an outgoing connection
 506                 local session = hosts[from].s2sout[to];
 507                 if not session then
 508                         print("No outgoing connection from "..from.." to "..to)
 509                 else
 510                         s2smanager.destroy_session(session);
 511                         count = count + 1;
 512                         print("Closed outgoing session from "..from.." to "..to);
 513                 end
 514         elseif hosts[to] and not hosts[from] then
 515                 -- Is an incoming connection
 516                 for session in pairs(incoming_s2s) do
 517                         if session.to_host == to and session.from_host == from then
 518                                 s2smanager.destroy_session(session);
 519                                 count = count + 1;
 520                         end
 521                 end
 522
 523                 if count == 0 then
 524                         print("No incoming connections from "..from.." to "..to);
 525                 else
 526                         print("Closed "..count.." incoming session"..((count == 1 and "") or "s").." from "..from.." to "..to);
 527                 end
 528         elseif hosts[to] and hosts[from] then
 529                 return false, "Both of the hostnames you specified are local, there are no s2s sessions to close";
 530         else
 531                 return false, "Neither of the hostnames you specified are being used on this server";
 532         end
 533
 534         return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
 535 end
 536
 537 -------------
 538
 539 function printbanner(session)
 540         local option = config.get("*", "core", "console_banner");
 541 if option == nil or option == "full" or option == "graphic" then
 542 session.print [[
 543                    ____                \   /     _
 544                     |  _ \ _ __ ___  ___  _-_   __| |_   _
 545                     | |_) | '__/ _ \/ __|/ _ \ / _` | | | |
 546                     |  __/| | | (_) \__ \ |_| | (_| | |_| |
 547                     |_|   |_|  \___/|___/\___/ \__,_|\__, |
 548                     A study in simplicity            |___/
 549
 550 ]]
 551 end
 552 if option == nil or option == "short" or option == "full" then
 553 session.print("Welcome to the Prosody administration console. For a list of commands, type: help");
 554 session.print("You may find more help on using this console in our online documentation at ");
 555 session.print("http://prosody.im/doc/console\n");
 556 end
 557 if option and option ~= "short" and option ~= "full" and option ~= "graphic" then
 558         if type(option) == "string" then
 559                 session.print(option)
 560         elseif type(option) == "function" then
 561                 setfenv(option, redirect_output(_G, session));
 562                 pcall(option, session);
 563         end
 564 end
 565 end