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 function def_env.server:reload()
 209         prosody.unlock_globals();
 210         dofile "prosody"
 211         prosody = _G.prosody;
 212         return true, "Server reloaded";
 213 end
 214
 215 function def_env.server:version()
 216         return true, tostring(prosody.version or "unknown");
 217 end
 218
 219 function def_env.server:uptime()
 220         local t = os.time()-prosody.start_time;
 221         local seconds = t%60;
 222         t = (t - seconds)/60;
 223         local minutes = t%60;
 224         t = (t - minutes)/60;
 225         local hours = t%24;
 226         t = (t - hours)/24;
 227         local days = t;
 228         return true, string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)",
 229                 days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "",
 230                 minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
 231 end
 232
 233 def_env.module = {};
 234
 235 local function get_hosts_set(hosts, module)
 236         if type(hosts) == "table" then
 237                 if hosts[1] then
 238                         return set.new(hosts);
 239                 elseif hosts._items then
 240                         return hosts;
 241                 end
 242         elseif type(hosts) == "string" then
 243                 return set.new { hosts };
 244         elseif hosts == nil then
 245                 local mm = require "modulemanager";
 246                 return set.new(array.collect(keys(prosody.hosts)))
 247                         / function (host) return prosody.hosts[host].type == "local" or module and mm.is_loaded(host, module); end;
 248         end
 249 end
 250
 251 function def_env.module:load(name, hosts, config)
 252         local mm = require "modulemanager";
 253
 254         hosts = get_hosts_set(hosts);
 255
 256         -- Load the module for each host
 257         local ok, err, count = true, nil, 0;
 258         for host in hosts do
 259                 if (not mm.is_loaded(host, name)) then
 260                         ok, err = mm.load(host, name, config);
 261                         if not ok then
 262                                 ok = false;
 263                                 self.session.print(err or "Unknown error loading module");
 264                         else
 265                                 count = count + 1;
 266                                 self.session.print("Loaded for "..host);
 267                         end
 268                 end
 269         end
 270
 271         return ok, (ok and "Module loaded onto "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 272 end
 273
 274 function def_env.module:unload(name, hosts)
 275         local mm = require "modulemanager";
 276
 277         hosts = get_hosts_set(hosts, name);
 278
 279         -- Unload the module for each host
 280         local ok, err, count = true, nil, 0;
 281         for host in hosts do
 282                 if mm.is_loaded(host, name) then
 283                         ok, err = mm.unload(host, name);
 284                         if not ok then
 285                                 ok = false;
 286                                 self.session.print(err or "Unknown error unloading module");
 287                         else
 288                                 count = count + 1;
 289                                 self.session.print("Unloaded from "..host);
 290                         end
 291                 end
 292         end
 293         return ok, (ok and "Module unloaded from "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 294 end
 295
 296 function def_env.module:reload(name, hosts)
 297         local mm = require "modulemanager";
 298
 299         hosts = get_hosts_set(hosts, name);
 300
 301         -- Reload the module for each host
 302         local ok, err, count = true, nil, 0;
 303         for host in hosts do
 304                 if mm.is_loaded(host, name) then
 305                         ok, err = mm.reload(host, name);
 306                         if not ok then
 307                                 ok = false;
 308                                 self.session.print(err or "Unknown error reloading module");
 309                         else
 310                                 count = count + 1;
 311                                 if ok == nil then
 312                                         ok = true;
 313                                 end
 314                                 self.session.print("Reloaded on "..host);
 315                         end
 316                 end
 317         end
 318         return ok, (ok and "Module reloaded on "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 319 end
 320
 321 def_env.config = {};
 322 function def_env.config:load(filename, format)
 323         local config_load = require "core.configmanager".load;
 324         local ok, err = config_load(filename, format);
 325         if not ok then
 326                 return false, err or "Unknown error loading config";
 327         end
 328         return true, "Config loaded";
 329 end
 330
 331 function def_env.config:get(host, section, key)
 332         local config_get = require "core.configmanager".get
 333         return true, tostring(config_get(host, section, key));
 334 end
 335
 336 def_env.hosts = {};
 337 function def_env.hosts:list()
 338         for host, host_session in pairs(hosts) do
 339                 self.session.print(host);
 340         end
 341         return true, "Done";
 342 end
 343
 344 function def_env.hosts:add(name)
 345 end
 346
 347 def_env.c2s = {};
 348
 349 local function show_c2s(callback)
 350         for hostname, host in pairs(hosts) do
 351                 for username, user in pairs(host.sessions or {}) do
 352                         for resource, session in pairs(user.sessions or {}) do
 353                                 local jid = username.."@"..hostname.."/"..resource;
 354                                 callback(jid, session);
 355                         end
 356                 end
 357         end
 358 end
 359
 360 function def_env.c2s:show(match_jid)
 361         local print, count = self.session.print, 0;
 362         show_c2s(function (jid, session)
 363                 if (not match_jid) or jid:match(match_jid) then
 364                         count = count + 1;
 365                         local status, priority = "unavailable", tostring(session.priority or "-");
 366                         if session.presence then
 367                                 status = session.presence:child_with_name("show");
 368                                 if status then
 369                                         status = status:get_text() or "[invalid!]";
 370                                 else
 371                                         status = "available";
 372                                 end
 373                         end
 374                         print(jid.." - "..status.."("..priority..")");
 375                 end
 376         end);
 377         return true, "Total: "..count.." clients";
 378 end
 379
 380 function def_env.c2s:show_insecure(match_jid)
 381         local print, count = self.session.print, 0;
 382         show_c2s(function (jid, session)
 383                 if ((not match_jid) or jid:match(match_jid)) and not session.secure then
 384                         count = count + 1;
 385                         print(jid);
 386                 end
 387         end);
 388         return true, "Total: "..count.." insecure client connections";
 389 end
 390
 391 function def_env.c2s:show_secure(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 session.secure then
 395                         count = count + 1;
 396                         print(jid);
 397                 end
 398         end);
 399         return true, "Total: "..count.." secure client connections";
 400 end
 401
 402 function def_env.c2s:close(match_jid)
 403         local print, count = self.session.print, 0;
 404         show_c2s(function (jid, session)
 405                 if jid == match_jid or jid_bare(jid) == match_jid then
 406                         count = count + 1;
 407                         session:close();
 408                 end
 409         end);
 410         return true, "Total: "..count.." sessions closed";
 411 end
 412
 413 def_env.s2s = {};
 414 function def_env.s2s:show(match_jid)
 415         local _print = self.session.print;
 416         local print = self.session.print;
 417
 418         local count_in, count_out = 0,0;
 419
 420         for host, host_session in pairs(hosts) do
 421                 print = function (...) _print(host); _print(...); print = _print; end
 422                 for remotehost, session in pairs(host_session.s2sout) do
 423                         if (not match_jid) or remotehost:match(match_jid) or host:match(match_jid) then
 424                                 count_out = count_out + 1;
 425                                 print("    "..host.." -> "..remotehost);
 426                                 if session.sendq then
 427                                         print("        There are "..#session.sendq.." queued outgoing stanzas for this connection");
 428                                 end
 429                                 if session.type == "s2sout_unauthed" then
 430                                         if session.connecting then
 431                                                 print("        Connection not yet established");
 432                                                 if not session.srv_hosts then
 433                                                         if not session.conn then
 434                                                                 print("        We do not yet have a DNS answer for this host's SRV records");
 435                                                         else
 436                                                                 print("        This host has no SRV records, using A record instead");
 437                                                         end
 438                                                 elseif session.srv_choice then
 439                                                         print("        We are on SRV record "..session.srv_choice.." of "..#session.srv_hosts);
 440                                                         local srv_choice = session.srv_hosts[session.srv_choice];
 441                                                         print("        Using "..(srv_choice.target or ".")..":"..(srv_choice.port or 5269));
 442                                                 end
 443                                         elseif session.notopen then
 444                                                 print("        The <stream> has not yet been opened");
 445                                         elseif not session.dialback_key then
 446                                                 print("        Dialback has not been initiated yet");
 447                                         elseif session.dialback_key then
 448                                                 print("        Dialback has been requested, but no result received");
 449                                         end
 450                                 end
 451                         end
 452                 end
 453
 454                 for session in pairs(incoming_s2s) do
 455                         if session.to_host == host and ((not match_jid) or host:match(match_jid)
 456                                 or (session.from_host and session.from_host:match(match_jid))) then
 457                                 count_in = count_in + 1;
 458                                 print("    "..host.." <- "..(session.from_host or "(unknown)"));
 459                                 if session.type == "s2sin_unauthed" then
 460                                                 print("        Connection not yet authenticated");
 461                                 end
 462                                 for name in pairs(session.hosts) do
 463                                         if name ~= session.from_host then
 464                                                 print("        also hosts "..tostring(name));
 465                                         end
 466                                 end
 467                         end
 468                 end
 469
 470                 print = _print;
 471         end
 472
 473         for session in pairs(incoming_s2s) do
 474                 if not session.to_host and ((not match_jid) or session.from_host and session.from_host:match(match_jid)) then
 475                         count_in = count_in + 1;
 476                         print("Other incoming s2s connections");
 477                         print("    (unknown) <- "..(session.from_host or "(unknown)"));
 478                 end
 479         end
 480
 481         return true, "Total: "..count_out.." outgoing, "..count_in.." incoming connections";
 482 end
 483
 484 function def_env.s2s:close(from, to)
 485         local print, count = self.session.print, 0;
 486
 487         if not (from and to) then
 488                 return false, "Syntax: s2s:close('from', 'to') - Closes all s2s sessions from 'from' to 'to'";
 489         elseif from == to then
 490                 return false, "Both from and to are the same... you can't do that :)";
 491         end
 492
 493         if hosts[from] and not hosts[to] then
 494                 -- Is an outgoing connection
 495                 local session = hosts[from].s2sout[to];
 496                 if not session then
 497                         print("No outgoing connection from "..from.." to "..to)
 498                 else
 499                         (session.close or s2smanager.destroy_session)(session);
 500                         count = count + 1;
 501                         print("Closed outgoing session from "..from.." to "..to);
 502                 end
 503         elseif hosts[to] and not hosts[from] then
 504                 -- Is an incoming connection
 505                 for session in pairs(incoming_s2s) do
 506                         if session.to_host == to and session.from_host == from then
 507                                 (session.close or s2smanager.destroy_session)(session);
 508                                 count = count + 1;
 509                         end
 510                 end
 511
 512                 if count == 0 then
 513                         print("No incoming connections from "..from.." to "..to);
 514                 else
 515                         print("Closed "..count.." incoming session"..((count == 1 and "") or "s").." from "..from.." to "..to);
 516                 end
 517         elseif hosts[to] and hosts[from] then
 518                 return false, "Both of the hostnames you specified are local, there are no s2s sessions to close";
 519         else
 520                 return false, "Neither of the hostnames you specified are being used on this server";
 521         end
 522
 523         return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
 524 end
 525
 526 -------------
 527
 528 function printbanner(session)
 529         local option = config.get("*", "core", "console_banner");
 530 if option == nil or option == "full" or option == "graphic" then
 531 session.print [[
 532                    ____                \   /     _
 533                     |  _ \ _ __ ___  ___  _-_   __| |_   _
 534                     | |_) | '__/ _ \/ __|/ _ \ / _` | | | |
 535                     |  __/| | | (_) \__ \ |_| | (_| | |_| |
 536                     |_|   |_|  \___/|___/\___/ \__,_|\__, |
 537                     A study in simplicity            |___/
 538
 539 ]]
 540 end
 541 if option == nil or option == "short" or option == "full" then
 542 session.print("Welcome to the Prosody administration console. For a list of commands, type: help");
 543 session.print("You may find more help on using this console in our online documentation at ");
 544 session.print("http://prosody.im/doc/console\n");
 545 end
 546 if option and option ~= "short" and option ~= "full" and option ~= "graphic" then
 547         if type(option) == "string" then
 548                 session.print(option)
 549         elseif type(option) == "function" then
 550                 setfenv(option, redirect_output(_G, session));
 551                 pcall(option, session);
 552         end
 553 end
 554 end