-- Prosody IM

-- Copyright (C) 2008-2010 Matthew Wild

-- Copyright (C) 2008-2010 Waqas Hussain

--

-- This project is MIT/X11 licensed. Please see the

-- COPYING file in the source package for more information.

--

-- luacheck: ignore 212/self

module:set_global();

module:depends("admin_socket");

local hostmanager = require "prosody.core.hostmanager";

local modulemanager = require "prosody.core.modulemanager";

local s2smanager = require "prosody.core.s2smanager";

local portmanager = require "prosody.core.portmanager";

local helpers = require "prosody.util.helpers";

local server = require "prosody.net.server";

local st = require "prosody.util.stanza";

local _G = _G;

local prosody = _G.prosody;

local unpack = table.unpack;

local iterators = require "prosody.util.iterators";

local keys, values = iterators.keys, iterators.values;

local jid_bare, jid_split, jid_join, jid_resource, jid_compare = import("prosody.util.jid", "bare", "prepped_split", "join", "resource", "compare");

local set, array = require "prosody.util.set", require "prosody.util.array";

local cert_verify_identity = require "prosody.util.x509".verify_identity;

local envload = require "prosody.util.envload".envload;

local envloadfile = require "prosody.util.envload".envloadfile;

local has_pposix, pposix = pcall(require, "prosody.util.pposix");

local async = require "prosody.util.async";

local serialization = require "prosody.util.serialization";

local serialize_config = serialization.new ({ fatal = false, unquoted = true});

local time = require "prosody.util.time";

local promise = require "prosody.util.promise";

local logger = require "prosody.util.logger";

local t_insert = table.insert;

local t_concat = table.concat;

local format_number = require "prosody.util.human.units".format;

local format_table = require "prosody.util.human.io".table;

local function capitalize(s)

	if not s then return end

	return (s:gsub("^%a", string.upper):gsub("_", " "));

end

local function pre(prefix, str, alt)

	if type(str) ~= "string" or str == "" then return alt or ""; end

	return prefix .. str;

end

local function suf(str, suffix, alt)

	if type(str) ~= "string" or str == "" then return alt or ""; end

	return str .. suffix;

end

local commands = module:shared("commands")

local def_env = module:shared("env");

local default_env_mt = { __index = def_env };

local function redirect_output(target, session)

	local env = setmetatable({ print = session.print }, { __index = function (_, k) return rawget(target, k); end });

	env.dofile = function(name)

		local f, err = envloadfile(name, env);

		if not f then return f, err; end

		return f();

	end;

	return env;

end

console = {};

local runner_callbacks = {};

function runner_callbacks:error(err)

	module:log("error", "Traceback[shell]: %s", err);

	self.data.print("Fatal error while running command, it did not complete");

	self.data.print("Error: "..tostring(err));

end

local function send_repl_output(session, line, attr)

	return session.send(st.stanza("repl-output", attr):text(tostring(line)));

end

function console:new_session(admin_session)

	local session = {

		send = function (t)

			return send_repl_output(admin_session, t);

		end;

		print = function (...)

			local t = {};

			for i=1,select("#", ...) do

				t[i] = tostring(select(i, ...));

			end

			return send_repl_output(admin_session, table.concat(t, "\t"));

		end;

		write = function (t)

			return send_repl_output(admin_session, t, { eol = "0" });

		end;

		serialize = tostring;

		disconnect = function () admin_session:close(); end;

		is_connected = function ()

			return not not admin_session.conn;

		end

	};

	session.env = setmetatable({}, default_env_mt);

	session.thread = async.runner(function (line)

		console:process_line(session, line);

	end, runner_callbacks, session);

	-- Load up environment with helper objects

	for name, t in pairs(def_env) do

		if type(t) == "table" then

			session.env[name] = setmetatable({ session = session }, { __index = t });

		end

	end

	session.env.output:configure();

	return session;

end

local function handle_line(event)

	local session = event.origin.shell_session;

	if not session then

		session = console:new_session(event.origin);

		event.origin.shell_session = session;

	end

	local default_width = 132; -- The common default of 80 is a bit too narrow for e.g. s2s:show(), 132 was another common width for hardware terminals

	local margin = 2; -- To account for '| ' when lines are printed

	session.width = (tonumber(event.stanza.attr.width) or default_width)-margin;

	local line = event.stanza:get_text();

	local useglobalenv;

	local result = st.stanza("repl-result");

	if line:match("^>") then

		line = line:gsub("^>", "");

		useglobalenv = true;

	else

		local command = line:match("^%w+") or line:match("%p");

		if commands[command] then

			commands[command](session, line);

			event.origin.send(result);

			return;

		end

	end

	session.env._ = line;

	if not useglobalenv and commands[line:lower()] then

		commands[line:lower()](session, line);

		event.origin.send(result);

		return;

	end

	if useglobalenv and not session.globalenv then

		session.globalenv = redirect_output(_G, session);

	end

	local chunkname = "=console";

	local env = (useglobalenv and session.globalenv) or session.env or nil

	-- luacheck: ignore 311/err

	local chunk, err = envload("return "..line, chunkname, env);

	if not chunk then

		chunk, err = envload(line, chunkname, env);

		if not chunk then

			err = err:gsub("^%[string .-%]:%d+: ", "");

			err = err:gsub("^:%d+: ", "");

			err = err:gsub("'<eof>'", "the end of the line");

			result.attr.type = "error";

			result:text("Sorry, I couldn't understand that... "..err);

			event.origin.send(result);

			return;

		end

	end

	local taskok, message = chunk();

	if promise.is_promise(taskok) then

		taskok, message = async.wait_for(taskok);

	end

	if not message then

		if type(taskok) ~= "string" and useglobalenv then

			taskok = session.serialize(taskok);

		end

		result:text("Result: "..tostring(taskok));

	elseif (not taskok) and message then

		result.attr.type = "error";

		result:text("Error: "..tostring(message));

	else

		result:text("OK: "..tostring(message));

	end

	event.origin.send(result);

end

module:hook("admin/repl-input", function (event)

	local ok, err = pcall(handle_line, event);

	if not ok then

		event.origin.send(st.stanza("repl-result", { type = "error" }):text(err));

	end

	return true;

end);

-- Console commands --

-- These are simple commands, not valid standalone in Lua

local available_columns; --forward declaration so it is reachable from the help

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 [[]]

		local row = format_table({ { title = "Section", width = 7 }, { title = "Description", width = "100%" } }, session.width)

		print(row())

		print(row { "c2s"; "Commands to manage local client-to-server sessions" })

		print(row { "s2s"; "Commands to manage sessions between this server and others" })

		print(row { "http"; "Commands to inspect HTTP services" }) -- XXX plural but there is only one so far

		print(row { "module"; "Commands to load/reload/unload modules/plugins" })

		print(row { "host"; "Commands to activate, deactivate and list virtual hosts" })

		print(row { "user"; "Commands to create and delete users, and change their passwords" })

		print(row { "roles"; "Show information about user roles" })

		print(row { "muc"; "Commands to create, list and manage chat rooms" })

		print(row { "stats"; "Commands to show internal statistics" })

		print(row { "server"; "Uptime, version, shutting down, etc." })

		print(row { "port"; "Commands to manage ports the server is listening on" })

		print(row { "dns"; "Commands to manage and inspect the internal DNS resolver" })

		print(row { "xmpp"; "Commands for sending XMPP stanzas" })

		print(row { "debug"; "Commands for debugging the server" })

		print(row { "watch"; "Commands for watching live logs from the server" })

		print(row { "config"; "Reloading the configuration, etc." })

		print(row { "columns"; "Information about customizing session listings" })

		print(row { "console"; "Help regarding the console itself" })

	elseif section == "c2s" then

		print [[c2s:show(jid, columns) - Show all client sessions with the specified JID (or all if no JID given)]]

		print [[c2s:show_tls(jid) - Show TLS cipher info for encrypted sessions]]

		print [[c2s:count() - Count sessions without listing them]]

		print [[c2s:close(jid) - Close all sessions for the specified JID]]

		print [[c2s:closeall() - Close all active c2s connections ]]

	elseif section == "s2s" then

		print [[s2s:show(domain, columns) - Show all s2s connections for the given domain (or all if no domain given)]]

		print [[s2s:show_tls(domain) - Show TLS cipher info for encrypted sessions]]

		print [[s2s:close(from, to) - Close a connection from one domain to another]]

		print [[s2s:closeall(host) - Close all the incoming/outgoing s2s sessions to specified host]]

	elseif section == "http" then

		print [[http:list(hosts) - Show HTTP endpoints]]

	elseif section == "module" then

		print [[module:info(module, host) - Show information about a loaded module]]

		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 == "host" then

		print [[host:activate(hostname) - Activates the specified host]]

		print [[host:deactivate(hostname) - Disconnects all clients on this host and deactivates]]

		print [[host:list() - List the currently-activated hosts]]

	elseif section == "user" then

		print [[user:create(jid, password, role) - Create the specified user account]]

		print [[user:password(jid, password) - Set the password for the specified user account]]

		print [[user:roles(jid, host) - Show current roles for an user]]

		print [[user:setrole(jid, host, role) - Set primary role of a user (see 'help roles')]]

		print [[user:addrole(jid, host, role) - Add a secondary role to a user]]

		print [[user:delrole(jid, host, role) - Remove a secondary role from a user]]

		print [[user:disable(jid) - Disable the specified user account, preventing login]]

		print [[user:enable(jid) - Enable the specified user account, restoring login access]]

		print [[user:delete(jid) - Permanently remove the specified user account]]

		print [[user:list(hostname, pattern) - List users on the specified host, optionally filtering with a pattern]]

	elseif section == "roles" then

		print [[Roles may grant access or restrict users from certain operations]]

		print [[Built-in roles are:]]

		print [[  prosody:user     - Normal user (default)]]

		print [[  prosody:admin    - Host administrator]]

		print [[  prosody:operator - Server administrator]]

		print [[]]

		print [[Roles can be assigned using the user management commands (see 'help user').]]

	elseif section == "muc" then

		-- TODO `muc:room():foo()` commands

		print [[muc:create(roomjid, { config }) - Create the specified MUC room with the given config]]

		print [[muc:list(host) - List rooms on the specified MUC component]]

		print [[muc:room(roomjid) - Reference the specified MUC room to access MUC API methods]]

		print [[muc:occupants(roomjid, filter) - List room occupants, optionally filtered on substring or role]]

		print [[muc:affiliations(roomjid, filter) - List affiliated members of the room, optionally filtered on substring or affiliation]]

	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:memory() - Show details about the server's memory usage]]

		print [[server:shutdown(reason) - Shut down the server, with an optional reason to be broadcast to all connections]]

	elseif section == "port" then

		print [[port:list() - Lists all network ports prosody currently listens on]]

		print [[port:close(port, interface) - Close a port]]

	elseif section == "dns" then

		print [[dns:lookup(name, type, class) - Do a DNS lookup]]

		print [[dns:addnameserver(nameserver) - Add a nameserver to the list]]

		print [[dns:setnameserver(nameserver) - Replace the list of name servers with the supplied one]]

		print [[dns:purge() - Clear the DNS cache]]

		print [[dns:cache() - Show cached records]]

	elseif section == "xmpp" then

		print [[xmpp:ping(localhost, remotehost) -- Sends a ping to a remote XMPP server and reports the response]]

	elseif section == "config" then

		print [[config:reload() - Reload the server configuration. Modules may need to be reloaded for changes to take effect.]]

		print [[config:get([host,] option) - Show the value of a config option.]]

	elseif section == "stats" then -- luacheck: ignore 542

		print [[stats:show(pattern) - Show internal statistics, optionally filtering by name with a pattern]]

		print [[stats:show():cfgraph() - Show a cumulative frequency graph]]

		print [[stats:show():histogram() - Show a histogram of selected metric]]

	elseif section == "debug" then

		print [[debug:logevents(host) - Enable logging of fired events on host]]

		print [[debug:events(host, event) - Show registered event handlers]]

		print [[debug:timers() - Show information about scheduled timers]]

	elseif section == "watch" then

		print [[watch:log() - Follow debug logs]]

		print [[watch:stanzas(target, filter) - Watch live stanzas matching the specified target and filter]]

	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 :)]]

	elseif section == "columns" then

		print [[The columns shown by c2s:show() and s2s:show() can be customizied via the]]

		print [['columns' argument as described here.]]

		print [[]]

		print [[Columns can be specified either as "id jid ipv" or as {"id", "jid", "ipv"}.]]

		print [[Available columns are:]]

		local meta_columns = {

			{ title = "ID"; width = 5 };

			{ title = "Column Title"; width = 12 };

			{ title = "Description"; width = 12 };

		};

		-- auto-adjust widths

		for column, spec in pairs(available_columns) do

			meta_columns[1].width = math.max(meta_columns[1].width or 0, #column);

			meta_columns[2].width = math.max(meta_columns[2].width or 0, #(spec.title or ""));

			meta_columns[3].width = math.max(meta_columns[3].width or 0, #(spec.description or ""));

		end

		local row = format_table(meta_columns, session.width)

		print(row());

		for column, spec in iterators.sorted_pairs(available_columns) do

			print(row({ column, spec.title, spec.description }));

		end

		print [[]]

		print [[Most fields on the internal session structures can also be used as columns]]

		-- Also, you can pass a table column specification directly, with mapper callback and all

	end

end

-- Session environment --

-- Anything in def_env will be accessible within the session as a global variable

--luacheck: ignore 212/self

local serialize_defaults = module:get_option("console_prettyprint_settings",

	{ fatal = false; unquoted = true; maxdepth = 2; table_iterator = "pairs" })

def_env.output = {};

function def_env.output:configure(opts)

	if type(opts) ~= "table" then

		opts = { preset = opts };

	end

	if not opts.fallback then

		-- XXX Error message passed to fallback is lost, does it matter?

		opts.fallback = tostring;

	end