mod_tls: :up() out of the starttls tag in stream:features
[prosody.git] / plugins / mod_console.lua
index 8d87655df03a01d833107ca23efc7c93383ba629..e8d31cebe22024d8004a8695523b57d6113ddca9 100644 (file)
@@ -1,4 +1,4 @@
--- Prosody IM v0.4
+-- Prosody IM
 -- Copyright (C) 2008-2009 Matthew Wild
 -- Copyright (C) 2008-2009 Waqas Hussain
 -- 
@@ -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;
@@ -24,6 +24,8 @@ 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
@@ -68,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");
@@ -154,11 +159,57 @@ 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
 
 def_env.server = {};
-function def_env.server:reload()
+
+function def_env.server:insane_reload()
        prosody.unlock_globals();
        dofile "prosody"
        prosody = _G.prosody;
@@ -183,6 +234,11 @@ function def_env.server:uptime()
                minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
 end
 
+function def_env.server:shutdown(reason)
+       prosody.shutdown(reason);
+       return true, "Shutdown initiated";
+end
+
 def_env.module = {};
 
 local function get_hosts_set(hosts, module)
@@ -286,6 +342,11 @@ function def_env.config:get(host, section, key)
        return true, tostring(config_get(host, section, key));
 end
 
+function def_env.config:reload()
+       local ok, err = prosody.reload_config();
+       return ok, (ok and "Config reloaded (you may need to reload modules to take effect)") or tostring(err);
+end
+
 def_env.hosts = {};
 function def_env.hosts:list()
        for host, host_session in pairs(hosts) do
@@ -312,10 +373,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";
@@ -440,7 +515,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
@@ -448,7 +523,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