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