net.server_event: Return "quitting" on loop exit to be compatible with net.server_sel...
[prosody.git] / plugins / mod_console.lua
index 28e12a626a90c5abf01a22620678c1815b4544a5..5e6b684661bedc38ac1352e46af61734faf22af8 100644 (file)
@@ -14,7 +14,7 @@ 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;
@@ -33,11 +33,11 @@ end
 console = {};
 
 function console:new_session(conn)
-       local w = function(s) conn.write(s:gsub("\n", "\r\n")); end;
+       local w = function(s) conn:write(s:gsub("\n", "\r\n")); end;
        local session = { conn = conn;
                        send = function (t) w(tostring(t)); end;
                        print = function (t) w("| "..tostring(t).."\n"); end;
-                       disconnect = function () conn.close(); end;
+                       disconnect = function () conn:close(); end;
                        };
        session.env = setmetatable({}, default_env_mt);
        
@@ -53,7 +53,7 @@ end
 
 local sessions = {};
 
-function console_listener.listener(conn, data)
+function console_listener.onincoming(conn, data)
        local session = sessions[conn];
        
        if not session then
@@ -70,6 +70,9 @@ function console_listener.listener(conn, data)
                        if data:match("^>") then
                                data = data:gsub("^>", "");
                                useglobalenv = true;
+                       elseif data == "\004" then
+                               commands["bye"](session, data);
+                               return;
                        else
                                local command = data:lower();
                                command = data:match("^%w+") or data:match("%p");
@@ -123,8 +126,12 @@ function console_listener.listener(conn, data)
        session.send(string.char(0));
 end
 
-function console_listener.disconnect(conn, err)
-       
+function console_listener.ondisconnect(conn, err)
+       local session = sessions[conn];
+       if session then
+               session.disconnect();
+               sessions[conn] = nil;
+       end
 end
 
 connlisteners_register('console', console_listener);
@@ -156,6 +163,55 @@ 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 [[config - Reloading the configuration, 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]]
+               print [[module:list(host) - List the modules loaded on the specified host]]
+       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 == "config" then
+               print [[config:reload() - Reload the server configuration. Modules may need to be reloaded for changes to take effect.]]
+       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
 
@@ -279,6 +335,35 @@ function def_env.module:reload(name, hosts)
        return ok, (ok and "Module reloaded on "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 end
 
+function def_env.module:list(hosts)
+       if hosts == nil then
+               hosts = array.collect(keys(prosody.hosts));
+       end
+       if type(hosts) == "string" then
+               hosts = { hosts };
+       end
+       if type(hosts) ~= "table" then
+               return false, "Please supply a host or a list of hosts you would like to see";
+       end
+       
+       local print = self.session.print;
+       for _, host in ipairs(hosts) do
+               print(host..":");
+               local modules = array.collect(keys(prosody.hosts[host] and prosody.hosts[host].modules or {})):sort();
+               if #modules == 0 then
+                       if prosody.hosts[host] then
+                               print("    No modules loaded");
+                       else
+                               print("    Host not found");
+                       end
+               else
+                       for _, name in ipairs(modules) do
+                               print("    "..name);
+                       end
+               end
+       end
+end
+
 def_env.config = {};
 function def_env.config:load(filename, format)
        local config_load = require "core.configmanager".load;
@@ -325,10 +410,24 @@ end
 
 function def_env.c2s:show(match_jid)
        local print, count = self.session.print, 0;
-       show_c2s(function (jid)
+       local curr_host;
+       show_c2s(function (jid, session)
+               if curr_host ~= session.host then
+                       curr_host = session.host;
+                       print(curr_host);
+               end
                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";
@@ -379,7 +478,7 @@ function def_env.s2s:show(match_jid)
                for remotehost, session in pairs(host_session.s2sout) do
                        if (not match_jid) or remotehost:match(match_jid) or host:match(match_jid) then
                                count_out = count_out + 1;
-                               print("    "..host.." -> "..remotehost);
+                               print("    "..host.." -> "..remotehost..(session.secure and " (encrypted)" or "")..(session.compressed and " (compressed)" or ""));
                                if session.sendq then
                                        print("        There are "..#session.sendq.." queued outgoing stanzas for this connection");
                                end
@@ -407,12 +506,16 @@ function def_env.s2s:show(match_jid)
                                end
                        end
                end     
-               
+               local subhost_filter = function (h) 
+                               return (match_jid and h:match(match_jid));
+                       end
                for session in pairs(incoming_s2s) do
                        if session.to_host == host and ((not match_jid) or host:match(match_jid) 
-                               or (session.from_host and session.from_host:match(match_jid))) then
+                               or (session.from_host and session.from_host:match(match_jid))
+                               -- Pft! is what I say to list comprehensions
+                               or (session.hosts and #array.collect(keys(session.hosts)):filter(subhost_filter)>0)) then
                                count_in = count_in + 1;
-                               print("    "..host.." <- "..(session.from_host or "(unknown)"));
+                               print("    "..host.." <- "..(session.from_host or "(unknown)")..(session.secure and " (encrypted)" or "")..(session.compressed and " (compressed)" or ""));
                                if session.type == "s2sin_unauthed" then
                                                print("        Connection not yet authenticated");
                                end
@@ -453,7 +556,7 @@ function def_env.s2s:close(from, to)
                if not session then 
                        print("No outgoing connection from "..from.." to "..to)
                else
-                       s2smanager.destroy_session(session);
+                       (session.close or s2smanager.destroy_session)(session);
                        count = count + 1;
                        print("Closed outgoing session from "..from.." to "..to);
                end
@@ -461,7 +564,7 @@ function def_env.s2s:close(from, to)
                -- Is an incoming connection
                for session in pairs(incoming_s2s) do
                        if session.to_host == to and session.from_host == from then
-                               s2smanager.destroy_session(session);
+                               (session.close or s2smanager.destroy_session)(session);
                                count = count + 1;
                        end
                end
@@ -480,6 +583,44 @@ function def_env.s2s:close(from, to)
        return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
 end
 
+def_env.host = {}; def_env.hosts = def_env.host;
+function def_env.host:activate(hostname, config)
+       local hostmanager_activate = require "core.hostmanager".activate;
+       if hosts[hostname] then
+               return false, "The host "..tostring(hostname).." is already activated";
+       end
+       
+       local defined_hosts = config or configmanager.getconfig();
+       if not config and not defined_hosts[hostname] then
+               return false, "Couldn't find "..tostring(hostname).." defined in the config, perhaps you need to config:reload()?";
+       end
+       hostmanager_activate(hostname, config or defined_hosts[hostname]);
+       return true, "Host "..tostring(hostname).." activated";
+end
+
+function def_env.host:deactivate(hostname, reason)
+       local hostmanager_deactivate = require "core.hostmanager".deactivate;
+       local host = hosts[hostname];
+       if not host then
+               return false, "The host "..tostring(hostname).." is not activated";
+       end
+       if reason then
+               reason = { condition = "host-gone", text = reason };
+       end
+       hostmanager_deactivate(hostname, reason);
+       return true, "Host "..tostring(hostname).." deactivated";
+end
+
+function def_env.host:list()
+       local print = self.session.print;
+       local i = 0;
+       for host in values(array.collect(keys(prosody.hosts)):sort()) do
+               i = i + 1;
+               print(host);
+       end
+       return true, i.." hosts";
+end
+
 -------------
 
 function printbanner(session)
@@ -509,3 +650,5 @@ if option and option ~= "short" and option ~= "full" and option ~= "graphic" the
        end
 end
 end
+
+prosody.net_activate_ports("console", "console", {5582}, "tcp");