2 -- Copyright (C) 2008-2009 Matthew Wild
3 -- Copyright (C) 2008-2009 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
13 local prosody = _G.prosody;
14 local hosts = prosody.hosts;
15 local connlisteners_register = require "net.connlisteners".register;
17 local console_listener = { default_port = 5582; default_mode = "*l"; default_interface = "127.0.0.1" };
19 require "util.iterators";
20 local jid_bare = require "util.jid".bare;
21 local set, array = require "util.set", require "util.array";
25 local default_env_mt = { __index = def_env };
27 prosody.console = { commands = commands, env = def_env };
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 });
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;
42 session.env = setmetatable({}, default_env_mt);
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 });
56 function console_listener.listener(conn, data)
57 local session = sessions[conn];
60 -- Handle new connection
61 session = console:new_session(conn);
62 sessions[conn] = session;
67 (function(session, data)
70 if data:match("^>") then
71 data = data:gsub("^>", "");
73 elseif data == "\004" then
74 commands["bye"](session, data);
77 local command = data:lower();
78 command = data:match("^%w+") or data:match("%p");
79 if commands[command] then
80 commands[command](session, data);
87 local chunk, err = loadstring("return "..data);
89 chunk, err = loadstring(data);
91 err = err:gsub("^%[string .-%]:%d+: ", "");
92 err = err:gsub("^:%d+: ", "");
93 err = err:gsub("'<eof>'", "the end of the line");
94 session.print("Sorry, I couldn't understand that... "..err);
99 setfenv(chunk, (useglobalenv and redirect_output(_G, session)) or session.env or nil);
101 local ranok, taskok, message = pcall(chunk);
103 if not (ranok or message or useglobalenv) and commands[data:lower()] then
104 commands[data:lower()](session, data);
109 session.print("Fatal error while running command, it did not complete");
110 session.print("Error: "..taskok);
115 session.print("Result: "..tostring(taskok));
117 elseif (not taskok) and message then
118 session.print("Command completed with a problem");
119 session.print("Message: "..tostring(message));
123 session.print("OK: "..tostring(message));
126 session.send(string.char(0));
129 function console_listener.disconnect(conn, err)
133 connlisteners_register('console', console_listener);
135 -- Console commands --
136 -- These are simple commands, not valid standalone in Lua
138 function commands.bye(session)
139 session.print("See you! :)");
140 session.disconnect();
142 commands.quit, commands.exit = commands.bye, commands.bye;
144 commands["!"] = function (session, data)
145 if data:match("^!!") then
146 session.print("!> "..session.env._);
147 return console_listener.listener(session.conn, session.env._);
149 local old, new = data:match("^!(.-[^\\])!(.-)!$");
151 local ok, res = pcall(string.gsub, session.env._, old, new);
156 session.print("!> "..res);
157 return console_listener.listener(session.conn, res);
159 session.print("Sorry, not sure what you want");
162 function commands.help(session, data)
163 local print = session.print;
164 local section = data:match("^help (%w+)");
166 print [[Commands are divided into multiple sections. For help on a particular section, ]]
167 print [[type: help SECTION (for example, 'help c2s'). Sections are: ]]
169 print [[c2s - Commands to manage local client-to-server sessions]]
170 print [[s2s - Commands to manage sessions between this server and others]]
171 print [[module - Commands to load/reload/unload modules/plugins]]
172 print [[server - Uptime, version, shutting down, etc.]]
173 print [[console - Help regarding the console itself]]
174 elseif section == "c2s" then
175 print [[c2s:show(jid) - Show all client sessions with the specified JID (or all if no JID given)]]
176 print [[c2s:show_insecure() - Show all unencrypted client connections]]
177 print [[c2s:show_secure() - Show all encrypted client connections]]
178 print [[c2s:close(jid) - Close all sessions for the specified JID]]
179 elseif section == "s2s" then
180 print [[s2s:show(domain) - Show all s2s connections for the given domain (or all if no domain given)]]
181 print [[s2s:close(from, to) - Close a connection from one domain to another]]
182 elseif section == "module" then
183 print [[module:load(module, host) - Load the specified module on the specified host (or all hosts if none given)]]
184 print [[module:reload(module, host) - The same, but unloads and loads the module (saving state if the module supports it)]]
185 print [[module:unload(module, host) - The same, but just unloads the module from memory]]
186 print [[module:list(host) - List the modules loaded on the specified host]]
187 elseif section == "server" then
188 print [[server:version() - Show the server's version number]]
189 print [[server:uptime() - Show how long the server has been running]]
190 --print [[server:shutdown(reason) - Shut down the server, with an optional reason to be broadcast to all connections]]
191 elseif section == "console" then
192 print [[Hey! Welcome to Prosody's admin console.]]
193 print [[First thing, if you're ever wondering how to get out, simply type 'quit'.]]
194 print [[Secondly, note that we don't support the full telnet protocol yet (it's coming)]]
195 print [[so you may have trouble using the arrow keys, etc. depending on your system.]]
197 print [[For now we offer a couple of handy shortcuts:]]
198 print [[!! - Repeat the last command]]
199 print [[!old!new! - repeat the last command, but with 'old' replaced by 'new']]
201 print [[For those well-versed in Prosody's internals, or taking instruction from those who are,]]
202 print [[you can prefix a command with > to escape the console sandbox, and access everything in]]
203 print [[the running server. Great fun, but be careful not to break anything :)]]
208 -- Session environment --
209 -- Anything in def_env will be accessible within the session as a global variable
213 function def_env.server:insane_reload()
214 prosody.unlock_globals();
216 prosody = _G.prosody;
217 return true, "Server reloaded";
220 function def_env.server:version()
221 return true, tostring(prosody.version or "unknown");
224 function def_env.server:uptime()
225 local t = os.time()-prosody.start_time;
226 local seconds = t%60;
227 t = (t - seconds)/60;
228 local minutes = t%60;
229 t = (t - minutes)/60;
233 return true, string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)",
234 days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "",
235 minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
238 function def_env.server:shutdown(reason)
239 prosody.shutdown(reason);
240 return true, "Shutdown initiated";
245 local function get_hosts_set(hosts, module)
246 if type(hosts) == "table" then
248 return set.new(hosts);
249 elseif hosts._items then
252 elseif type(hosts) == "string" then
253 return set.new { hosts };
254 elseif hosts == nil then
255 local mm = require "modulemanager";
256 return set.new(array.collect(keys(prosody.hosts)))
257 / function (host) return prosody.hosts[host].type == "local" or module and mm.is_loaded(host, module); end;
261 function def_env.module:load(name, hosts, config)
262 local mm = require "modulemanager";
264 hosts = get_hosts_set(hosts);
266 -- Load the module for each host
267 local ok, err, count = true, nil, 0;
269 if (not mm.is_loaded(host, name)) then
270 ok, err = mm.load(host, name, config);
273 self.session.print(err or "Unknown error loading module");
276 self.session.print("Loaded for "..host);
281 return ok, (ok and "Module loaded onto "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
284 function def_env.module:unload(name, hosts)
285 local mm = require "modulemanager";
287 hosts = get_hosts_set(hosts, name);
289 -- Unload the module for each host
290 local ok, err, count = true, nil, 0;
292 if mm.is_loaded(host, name) then
293 ok, err = mm.unload(host, name);
296 self.session.print(err or "Unknown error unloading module");
299 self.session.print("Unloaded from "..host);
303 return ok, (ok and "Module unloaded from "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
306 function def_env.module:reload(name, hosts)
307 local mm = require "modulemanager";
309 hosts = get_hosts_set(hosts, name);
311 -- Reload the module for each host
312 local ok, err, count = true, nil, 0;
314 if mm.is_loaded(host, name) then
315 ok, err = mm.reload(host, name);
318 self.session.print(err or "Unknown error reloading module");
324 self.session.print("Reloaded on "..host);
328 return ok, (ok and "Module reloaded on "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
331 function def_env.module:list(hosts)
333 hosts = array.collect(keys(prosody.hosts));
335 if type(hosts) == "string" then
338 if type(hosts) ~= "table" then
339 return false, "Please supply a host or a list of hosts you would like to see";
342 local print = self.session.print;
343 for _, host in ipairs(hosts) do
345 local modules = array.collect(keys(prosody.hosts[host].modules or {})):sort();
346 if #modules == 0 then
347 print(" No modules loaded");
349 for _, name in ipairs(modules) do
357 function def_env.config:load(filename, format)
358 local config_load = require "core.configmanager".load;
359 local ok, err = config_load(filename, format);
361 return false, err or "Unknown error loading config";
363 return true, "Config loaded";
366 function def_env.config:get(host, section, key)
367 local config_get = require "core.configmanager".get
368 return true, tostring(config_get(host, section, key));
371 function def_env.config:reload()
372 local ok, err = prosody.reload_config();
373 return ok, (ok and "Config reloaded (you may need to reload modules to take effect)") or tostring(err);
377 function def_env.hosts:list()
378 for host, host_session in pairs(hosts) do
379 self.session.print(host);
384 function def_env.hosts:add(name)
389 local function show_c2s(callback)
390 for hostname, host in pairs(hosts) do
391 for username, user in pairs(host.sessions or {}) do
392 for resource, session in pairs(user.sessions or {}) do
393 local jid = username.."@"..hostname.."/"..resource;
394 callback(jid, session);
400 function def_env.c2s:show(match_jid)
401 local print, count = self.session.print, 0;
403 show_c2s(function (jid, session)
404 if curr_host ~= session.host then
405 curr_host = session.host;
408 if (not match_jid) or jid:match(match_jid) then
410 local status, priority = "unavailable", tostring(session.priority or "-");
411 if session.presence then
412 status = session.presence:child_with_name("show");
414 status = status:get_text() or "[invalid!]";
416 status = "available";
419 print(" "..jid.." - "..status.."("..priority..")");
422 return true, "Total: "..count.." clients";
425 function def_env.c2s:show_insecure(match_jid)
426 local print, count = self.session.print, 0;
427 show_c2s(function (jid, session)
428 if ((not match_jid) or jid:match(match_jid)) and not session.secure then
433 return true, "Total: "..count.." insecure client connections";
436 function def_env.c2s:show_secure(match_jid)
437 local print, count = self.session.print, 0;
438 show_c2s(function (jid, session)
439 if ((not match_jid) or jid:match(match_jid)) and session.secure then
444 return true, "Total: "..count.." secure client connections";
447 function def_env.c2s:close(match_jid)
448 local print, count = self.session.print, 0;
449 show_c2s(function (jid, session)
450 if jid == match_jid or jid_bare(jid) == match_jid then
455 return true, "Total: "..count.." sessions closed";
459 function def_env.s2s:show(match_jid)
460 local _print = self.session.print;
461 local print = self.session.print;
463 local count_in, count_out = 0,0;
465 for host, host_session in pairs(hosts) do
466 print = function (...) _print(host); _print(...); print = _print; end
467 for remotehost, session in pairs(host_session.s2sout) do
468 if (not match_jid) or remotehost:match(match_jid) or host:match(match_jid) then
469 count_out = count_out + 1;
470 print(" "..host.." -> "..remotehost..(session.secure and "(encrypted)" or ""));
471 if session.sendq then
472 print(" There are "..#session.sendq.." queued outgoing stanzas for this connection");
474 if session.type == "s2sout_unauthed" then
475 if session.connecting then
476 print(" Connection not yet established");
477 if not session.srv_hosts then
478 if not session.conn then
479 print(" We do not yet have a DNS answer for this host's SRV records");
481 print(" This host has no SRV records, using A record instead");
483 elseif session.srv_choice then
484 print(" We are on SRV record "..session.srv_choice.." of "..#session.srv_hosts);
485 local srv_choice = session.srv_hosts[session.srv_choice];
486 print(" Using "..(srv_choice.target or ".")..":"..(srv_choice.port or 5269));
488 elseif session.notopen then
489 print(" The <stream> has not yet been opened");
490 elseif not session.dialback_key then
491 print(" Dialback has not been initiated yet");
492 elseif session.dialback_key then
493 print(" Dialback has been requested, but no result received");
499 for session in pairs(incoming_s2s) do
500 if session.to_host == host and ((not match_jid) or host:match(match_jid)
501 or (session.from_host and session.from_host:match(match_jid))) then
502 count_in = count_in + 1;
503 print(" "..host.." <- "..(session.from_host or "(unknown)")..(session.secure and "(encrypted)" or ""));
504 if session.type == "s2sin_unauthed" then
505 print(" Connection not yet authenticated");
507 for name in pairs(session.hosts) do
508 if name ~= session.from_host then
509 print(" also hosts "..tostring(name));
518 for session in pairs(incoming_s2s) do
519 if not session.to_host and ((not match_jid) or session.from_host and session.from_host:match(match_jid)) then
520 count_in = count_in + 1;
521 print("Other incoming s2s connections");
522 print(" (unknown) <- "..(session.from_host or "(unknown)"));
526 return true, "Total: "..count_out.." outgoing, "..count_in.." incoming connections";
529 function def_env.s2s:close(from, to)
530 local print, count = self.session.print, 0;
532 if not (from and to) then
533 return false, "Syntax: s2s:close('from', 'to') - Closes all s2s sessions from 'from' to 'to'";
534 elseif from == to then
535 return false, "Both from and to are the same... you can't do that :)";
538 if hosts[from] and not hosts[to] then
539 -- Is an outgoing connection
540 local session = hosts[from].s2sout[to];
542 print("No outgoing connection from "..from.." to "..to)
544 (session.close or s2smanager.destroy_session)(session);
546 print("Closed outgoing session from "..from.." to "..to);
548 elseif hosts[to] and not hosts[from] then
549 -- Is an incoming connection
550 for session in pairs(incoming_s2s) do
551 if session.to_host == to and session.from_host == from then
552 (session.close or s2smanager.destroy_session)(session);
558 print("No incoming connections from "..from.." to "..to);
560 print("Closed "..count.." incoming session"..((count == 1 and "") or "s").." from "..from.." to "..to);
562 elseif hosts[to] and hosts[from] then
563 return false, "Both of the hostnames you specified are local, there are no s2s sessions to close";
565 return false, "Neither of the hostnames you specified are being used on this server";
568 return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
573 function printbanner(session)
574 local option = config.get("*", "core", "console_banner");
575 if option == nil or option == "full" or option == "graphic" then
578 | _ \ _ __ ___ ___ _-_ __| |_ _
579 | |_) | '__/ _ \/ __|/ _ \ / _` | | | |
580 | __/| | | (_) \__ \ |_| | (_| | |_| |
581 |_| |_| \___/|___/\___/ \__,_|\__, |
582 A study in simplicity |___/
586 if option == nil or option == "short" or option == "full" then
587 session.print("Welcome to the Prosody administration console. For a list of commands, type: help");
588 session.print("You may find more help on using this console in our online documentation at ");
589 session.print("http://prosody.im/doc/console\n");
591 if option and option ~= "short" and option ~= "full" and option ~= "graphic" then
592 if type(option) == "string" then
593 session.print(option)
594 elseif type(option) == "function" then
595 setfenv(option, redirect_output(_G, session));
596 pcall(option, session);