mod_console: s2s:close: Use session:close() if that exists, otherwise just destroy...
[prosody.git] / plugins / mod_console.lua
index 77d76a82409f8589df33ce5b997abfa3627c07a6..716c252506d61a4fce209737c4a1cf663ba240ef 100644 (file)
@@ -1,4 +1,4 @@
--- Prosody IM v0.4
+-- Prosody IM
 -- Copyright (C) 2008-2009 Matthew Wild
 -- Copyright (C) 2008-2009 Waqas Hussain
 -- 
@@ -8,19 +8,28 @@
 
 module.host = "*";
 
+local _G = _G;
+
 local prosody = _G.prosody;
 local hosts = prosody.hosts;
 local connlisteners_register = require "net.connlisteners".register;
 
-local console_listener = { default_port = 5582; default_mode = "*l"; };
+local console_listener = { default_port = 5582; default_mode = "*l"; default_interface = "127.0.0.1" };
 
 require "util.iterators";
+local jid_bare = require "util.jid".bare;
 local set, array = require "util.set", require "util.array";
 
 local commands = {};
 local def_env = {};
 local default_env_mt = { __index = def_env };
 
+prosody.console = { commands = commands, env = def_env };
+
+local function redirect_output(_G, session)
+       return setmetatable({ print = session.print }, { __index = function (t, k) return rawget(_G, k); end, __newindex = function (t, k, v) rawset(_G, k, v); end });
+end
+
 console = {};
 
 function console:new_session(conn)
@@ -58,7 +67,10 @@ function console_listener.listener(conn, data)
                (function(session, data)
                        local useglobalenv;
                        
-                       if data:match("[!.]$") then
+                       if data:match("^>") then
+                               data = data:gsub("^>", "");
+                               useglobalenv = true;
+                       else
                                local command = data:lower();
                                command = data:match("^%w+") or data:match("%p");
                                if commands[command] then
@@ -67,11 +79,6 @@ function console_listener.listener(conn, data)
                                end
                        end
 
-                       if data:match("^>") then
-                               data = data:gsub("^>", "");
-                               useglobalenv = true;
-                       end
-                       
                        session.env._ = data;
                        
                        local chunk, err = loadstring("return "..data);
@@ -86,10 +93,15 @@ function console_listener.listener(conn, data)
                                end
                        end
                        
-                       setfenv(chunk, (useglobalenv and _G) or session.env or nil);
+                       setfenv(chunk, (useglobalenv and redirect_output(_G, session)) or session.env or nil);
                        
                        local ranok, taskok, message = pcall(chunk);
                        
+                       if not (ranok or message or useglobalenv) and commands[data:lower()] then
+                               commands[data:lower()](session, data);
+                               return;
+                       end
+                       
                        if not ranok then
                                session.print("Fatal error while running command, it did not complete");
                                session.print("Error: "..taskok);
@@ -124,6 +136,7 @@ function commands.bye(session)
        session.print("See you! :)");
        session.disconnect();
 end
+commands.quit, commands.exit = commands.bye, commands.bye;
 
 commands["!"] = function (session, data)
        if data:match("^!!") then
@@ -143,6 +156,51 @@ commands["!"] = function (session, data)
        session.print("Sorry, not sure what you want");
 end
 
+function commands.help(session, data)
+       local print = session.print;
+       local section = data:match("^help (%w+)");
+       if not section then
+               print [[Commands are divided into multiple sections. For help on a particular section, ]]
+               print [[type: help SECTION (for example, 'help c2s'). Sections are: ]]
+               print [[]]
+               print [[c2s - Commands to manage local client-to-server sessions]]
+               print [[s2s - Commands to manage sessions between this server and others]]
+               print [[module - Commands to load/reload/unload modules/plugins]]
+               print [[server - Uptime, version, shutting down, etc.]]
+               print [[console - Help regarding the console itself]]
+       elseif section == "c2s" then
+               print [[c2s:show(jid) - Show all client sessions with the specified JID (or all if no JID given)]]
+               print [[c2s:show_insecure() - Show all unencrypted client connections]]
+               print [[c2s:show_secure() - Show all encrypted client connections]]
+               print [[c2s:close(jid) - Close all sessions for the specified JID]]
+       elseif section == "s2s" then
+               print [[s2s:show(domain) - Show all s2s connections for the given domain (or all if no domain given)]]
+               print [[s2s:close(from, to) - Close a connection from one domain to another]]
+       elseif section == "module" then
+               print [[module:load(module, host) - Load the specified module on the specified host (or all hosts if none given)]]
+               print [[module:reload(module, host) - The same, but unloads and loads the module (saving state if the module supports it)]]
+               print [[module:unload(module, host) - The same, but just unloads the module from memory]]
+       elseif section == "server" then
+               print [[server:version() - Show the server's version number]]
+               print [[server:uptime() - Show how long the server has been running]]
+               --print [[server:shutdown(reason) - Shut down the server, with an optional reason to be broadcast to all connections]]
+       elseif section == "console" then
+               print [[Hey! Welcome to Prosody's admin console.]]
+               print [[First thing, if you're ever wondering how to get out, simply type 'quit'.]]
+               print [[Secondly, note that we don't support the full telnet protocol yet (it's coming)]]
+               print [[so you may have trouble using the arrow keys, etc. depending on your system.]]
+               print [[]]
+               print [[For now we offer a couple of handy shortcuts:]]
+               print [[!! - Repeat the last command]]
+               print [[!old!new! - repeat the last command, but with 'old' replaced by 'new']]
+               print [[]]
+               print [[For those well-versed in Prosody's internals, or taking instruction from those who are,]]
+               print [[you can prefix a command with > to escape the console sandbox, and access everything in]]
+               print [[the running server. Great fun, but be careful not to break anything :)]]
+       end
+       print [[]]
+end
+
 -- Session environment --
 -- Anything in def_env will be accessible within the session as a global variable
 
@@ -154,9 +212,27 @@ function def_env.server:reload()
        return true, "Server reloaded";
 end
 
+function def_env.server:version()
+       return true, tostring(prosody.version or "unknown");
+end
+
+function def_env.server:uptime()
+       local t = os.time()-prosody.start_time;
+       local seconds = t%60;
+       t = (t - seconds)/60;
+       local minutes = t%60;
+       t = (t - minutes)/60;
+       local hours = t%24;
+       t = (t - hours)/24;
+       local days = t;
+       return true, string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)", 
+               days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "", 
+               minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
+end
+
 def_env.module = {};
 
-local function get_hosts_set(hosts)
+local function get_hosts_set(hosts, module)
        if type(hosts) == "table" then
                if hosts[1] then
                        return set.new(hosts);
@@ -166,8 +242,9 @@ local function get_hosts_set(hosts)
        elseif type(hosts) == "string" then
                return set.new { hosts };
        elseif hosts == nil then
+               local mm = require "modulemanager";
                return set.new(array.collect(keys(prosody.hosts)))
-                       / function (host) return prosody.hosts[host].type == "local"; end;
+                       / function (host) return prosody.hosts[host].type == "local" or module and mm.is_loaded(host, module); end;
        end
 end
 
@@ -197,7 +274,7 @@ end
 function def_env.module:unload(name, hosts)
        local mm = require "modulemanager";
 
-       hosts = get_hosts_set(hosts);
+       hosts = get_hosts_set(hosts, name);
        
        -- Unload the module for each host
        local ok, err, count = true, nil, 0;
@@ -219,7 +296,7 @@ end
 function def_env.module:reload(name, hosts)
        local mm = require "modulemanager";
 
-       hosts = get_hosts_set(hosts);
+       hosts = get_hosts_set(hosts, name);
        
        -- Reload the module for each host
        local ok, err, count = true, nil, 0;
@@ -282,10 +359,19 @@ end
 
 function def_env.c2s:show(match_jid)
        local print, count = self.session.print, 0;
-       show_c2s(function (jid)
+       show_c2s(function (jid, session)
                if (not match_jid) or jid:match(match_jid) then
                        count = count + 1;
-                       print(jid);
+                       local status, priority = "unavailable", tostring(session.priority or "-");
+                       if session.presence then
+                               status = session.presence:child_with_name("show");
+                               if status then
+                                       status = status:get_text() or "[invalid!]";
+                               else
+                                       status = "available";
+                               end
+                       end
+                       print(jid.." - "..status.."("..priority..")");
                end             
        end);
        return true, "Total: "..count.." clients";
@@ -313,6 +399,16 @@ function def_env.c2s:show_secure(match_jid)
        return true, "Total: "..count.." secure client connections";
 end
 
+function def_env.c2s:close(match_jid)
+       local print, count = self.session.print, 0;
+       show_c2s(function (jid, session)
+               if jid == match_jid or jid_bare(jid) == match_jid then
+                       count = count + 1;
+                       session:close();
+               end
+       end);
+       return true, "Total: "..count.." sessions closed";
+end
 
 def_env.s2s = {};
 function def_env.s2s:show(match_jid)
@@ -385,9 +481,53 @@ function def_env.s2s:show(match_jid)
        return true, "Total: "..count_out.." outgoing, "..count_in.." incoming connections";
 end
 
+function def_env.s2s:close(from, to)
+       local print, count = self.session.print, 0;
+       
+       if not (from and to) then
+               return false, "Syntax: s2s:close('from', 'to') - Closes all s2s sessions from 'from' to 'to'";
+       elseif from == to then
+               return false, "Both from and to are the same... you can't do that :)";
+       end
+       
+       if hosts[from] and not hosts[to] then
+               -- Is an outgoing connection
+               local session = hosts[from].s2sout[to];
+               if not session then 
+                       print("No outgoing connection from "..from.." to "..to)
+               else
+                       (session.close or s2smanager.destroy_session)(session);
+                       count = count + 1;
+                       print("Closed outgoing session from "..from.." to "..to);
+               end
+       elseif hosts[to] and not hosts[from] then
+               -- Is an incoming connection
+               for session in pairs(incoming_s2s) do
+                       if session.to_host == to and session.from_host == from then
+                               (session.close or s2smanager.destroy_session)(session);
+                               count = count + 1;
+                       end
+               end
+               
+               if count == 0 then
+                       print("No incoming connections from "..from.." to "..to);
+               else
+                       print("Closed "..count.." incoming session"..((count == 1 and "") or "s").." from "..from.." to "..to);
+               end
+       elseif hosts[to] and hosts[from] then
+               return false, "Both of the hostnames you specified are local, there are no s2s sessions to close";
+       else
+               return false, "Neither of the hostnames you specified are being used on this server";
+       end
+       
+       return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
+end
+
 -------------
 
 function printbanner(session)
+       local option = config.get("*", "core", "console_banner");
+if option == nil or option == "full" or option == "graphic" then
 session.print [[
                    ____                \   /     _       
                     |  _ \ _ __ ___  ___  _-_   __| |_   _ 
@@ -397,7 +537,18 @@ session.print [[
                     A study in simplicity            |___/ 
 
 ]]
+end
+if option == nil or option == "short" or option == "full" then
 session.print("Welcome to the Prosody administration console. For a list of commands, type: help");
 session.print("You may find more help on using this console in our online documentation at ");
 session.print("http://prosody.im/doc/console\n");
 end
+if option and option ~= "short" and option ~= "full" and option ~= "graphic" then
+       if type(option) == "string" then
+               session.print(option)
+       elseif type(option) == "function" then
+               setfenv(option, redirect_output(_G, session));
+               pcall(option, session);
+       end
+end
+end