/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
#include "cli/consolecommand.hpp"
#include "config/configcompiler.hpp"
#include "remote/consolehandler.hpp"
#include "remote/url.hpp"
#include "base/configwriter.hpp"
#include "base/serializer.hpp"
#include "base/json.hpp"
#include "base/console.hpp"
#include "base/application.hpp"
#include "base/objectlock.hpp"
#include "base/unixsocket.hpp"
#include "base/utility.hpp"
#include "base/networkstream.hpp"
#include "base/defer.hpp"
#include "base/io-engine.hpp"
#include "base/stream.hpp"
#include "base/tcpsocket.hpp" /* include global icinga::Connect */
#include
#include "base/exception.hpp"
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#ifdef HAVE_EDITLINE
#include "cli/editline.hpp"
#endif /* HAVE_EDITLINE */
using namespace icinga;
namespace po = boost::program_options;
static ScriptFrame *l_ScriptFrame;
static Url::Ptr l_Url;
static Shared::Ptr l_TlsStream;
static String l_Session;
REGISTER_CLICOMMAND("console", ConsoleCommand);
INITIALIZE_ONCE(&ConsoleCommand::StaticInitialize);
extern "C" void dbg_spawn_console()
{
ScriptFrame frame(true);
ConsoleCommand::RunScriptConsole(frame);
}
extern "C" void dbg_inspect_value(const Value& value)
{
ConfigWriter::EmitValue(std::cout, 1, Serialize(value, 0));
std::cout << std::endl;
}
extern "C" void dbg_inspect_object(Object *obj)
{
Object::Ptr objr = obj;
dbg_inspect_value(objr);
}
extern "C" void dbg_eval(const char *text)
{
std::unique_ptr expr;
try {
ScriptFrame frame(true);
expr = ConfigCompiler::CompileText("", text);
Value result = Serialize(expr->Evaluate(frame), 0);
dbg_inspect_value(result);
} catch (const std::exception& ex) {
std::cout << "Error: " << DiagnosticInformation(ex) << "\n";
}
}
extern "C" void dbg_eval_with_value(const Value& value, const char *text)
{
std::unique_ptr expr;
try {
ScriptFrame frame(true);
frame.Locals = new Dictionary({
{ "arg", value }
});
expr = ConfigCompiler::CompileText("", text);
Value result = Serialize(expr->Evaluate(frame), 0);
dbg_inspect_value(result);
} catch (const std::exception& ex) {
std::cout << "Error: " << DiagnosticInformation(ex) << "\n";
}
}
extern "C" void dbg_eval_with_object(Object *object, const char *text)
{
std::unique_ptr expr;
try {
ScriptFrame frame(true);
frame.Locals = new Dictionary({
{ "arg", object }
});
expr = ConfigCompiler::CompileText("", text);
Value result = Serialize(expr->Evaluate(frame), 0);
dbg_inspect_value(result);
} catch (const std::exception& ex) {
std::cout << "Error: " << DiagnosticInformation(ex) << "\n";
}
}
void ConsoleCommand::BreakpointHandler(ScriptFrame& frame, ScriptError *ex, const DebugInfo& di)
{
static std::mutex mutex;
std::unique_lock lock(mutex);
if (!Application::GetScriptDebuggerEnabled())
return;
if (ex && ex->IsHandledByDebugger())
return;
std::cout << "Breakpoint encountered.\n";
if (ex) {
std::cout << "Exception: " << DiagnosticInformation(*ex) << "\n";
ex->SetHandledByDebugger(true);
} else
ShowCodeLocation(std::cout, di);
std::cout << "You can inspect expressions (such as variables) by entering them at the prompt.\n"
<< "To leave the debugger and continue the program use \"$continue\".\n"
<< "For further commands see \"$help\".\n";
#ifdef HAVE_EDITLINE
rl_completion_entry_function = ConsoleCommand::ConsoleCompleteHelper;
rl_completion_append_character = '\0';
#endif /* HAVE_EDITLINE */
ConsoleCommand::RunScriptConsole(frame);
}
void ConsoleCommand::StaticInitialize()
{
Expression::OnBreakpoint.connect(&ConsoleCommand::BreakpointHandler);
}
String ConsoleCommand::GetDescription() const
{
return "Interprets Icinga script expressions.";
}
String ConsoleCommand::GetShortDescription() const
{
return "Icinga console";
}
ImpersonationLevel ConsoleCommand::GetImpersonationLevel() const
{
return ImpersonateNone;
}
void ConsoleCommand::InitParameters(boost::program_options::options_description& visibleDesc,
boost::program_options::options_description& hiddenDesc) const
{
visibleDesc.add_options()
("connect,c", po::value(), "connect to an Icinga 2 instance")
("eval,e", po::value(), "evaluate expression and terminate")
("file,r", po::value(), "evaluate a file and terminate")
("syntax-only", "only validate syntax (requires --eval or --file)")
("sandbox", "enable sandbox mode")
;
}
#ifdef HAVE_EDITLINE
char *ConsoleCommand::ConsoleCompleteHelper(const char *word, int state)
{
static std::vector matches;
if (state == 0) {
if (!l_Url)
matches = ConsoleHandler::GetAutocompletionSuggestions(word, *l_ScriptFrame);
else {
Array::Ptr suggestions;
/* Remote debug console. */
try {
suggestions = AutoCompleteScript(l_Session, word, l_ScriptFrame->Sandboxed);
} catch (...) {
return nullptr; //Errors are just ignored here.
}
matches.clear();
ObjectLock olock(suggestions);
std::copy(suggestions->Begin(), suggestions->End(), std::back_inserter(matches));
}
}
if (state >= static_cast(matches.size()))
return nullptr;
return strdup(matches[state].CStr());
}
#endif /* HAVE_EDITLINE */
/**
* The entry point for the "console" CLI command.
*
* @returns An exit status.
*/
int ConsoleCommand::Run(const po::variables_map& vm, const std::vector& ap) const
{
#ifdef HAVE_EDITLINE
rl_completion_entry_function = ConsoleCommand::ConsoleCompleteHelper;
rl_completion_append_character = '\0';
#endif /* HAVE_EDITLINE */
String addr, session;
ScriptFrame scriptFrame(true);
session = Utility::NewUniqueID();
if (vm.count("sandbox"))
scriptFrame.Sandboxed = true;
scriptFrame.Self = scriptFrame.Locals;
if (!vm.count("eval") && !vm.count("file"))
std::cout << "Icinga 2 (version: " << Application::GetAppVersion() << ")\n"
<< "Type $help to view available commands.\n";
String addrEnv = Utility::GetFromEnvironment("ICINGA2_API_URL");
if (!addrEnv.IsEmpty())
addr = addrEnv;
/* Initialize remote connect parameters. */
if (vm.count("connect")) {
addr = vm["connect"].as();
try {
l_Url = new Url(addr);
} catch (const std::exception& ex) {
Log(LogCritical, "ConsoleCommand", ex.what());
return EXIT_FAILURE;
}
String usernameEnv = Utility::GetFromEnvironment("ICINGA2_API_USERNAME");
String passwordEnv = Utility::GetFromEnvironment("ICINGA2_API_PASSWORD");
if (!usernameEnv.IsEmpty())
l_Url->SetUsername(usernameEnv);
if (!passwordEnv.IsEmpty())
l_Url->SetPassword(passwordEnv);
if (l_Url->GetPort().IsEmpty())
l_Url->SetPort("5665");
/* User passed --connect and wants to run the expression via REST API.
* Evaluate this now before any user input happens.
*/
try {
l_TlsStream = ConsoleCommand::Connect();
} catch (const std::exception& ex) {
return EXIT_FAILURE;
}
}
String command;
bool syntaxOnly = false;
if (vm.count("syntax-only")) {
if (vm.count("eval") || vm.count("file"))
syntaxOnly = true;
else {
std::cerr << "The option --syntax-only can only be used in combination with --eval or --file." << std::endl;
return EXIT_FAILURE;
}
}
String commandFileName;
if (vm.count("eval"))
command = vm["eval"].as();
else if (vm.count("file")) {
commandFileName = vm["file"].as();
try {
std::ifstream fp(commandFileName.CStr());
fp.exceptions(std::ifstream::failbit | std::ifstream::badbit);
command = String(std::istreambuf_iterator(fp), std::istreambuf_iterator());
} catch (const std::exception&) {
std::cerr << "Could not read file '" << commandFileName << "'." << std::endl;
return EXIT_FAILURE;
}
}
return RunScriptConsole(scriptFrame, addr, session, command, commandFileName, syntaxOnly);
}
int ConsoleCommand::RunScriptConsole(ScriptFrame& scriptFrame, const String& connectAddr, const String& session,
const String& commandOnce, const String& commandOnceFileName, bool syntaxOnly)
{
std::map lines;
int next_line = 1;
#ifdef HAVE_EDITLINE
String homeEnv = Utility::GetFromEnvironment("HOME");
String historyPath;
std::fstream historyfp;
if (!homeEnv.IsEmpty()) {
historyPath = String(homeEnv) + "/.icinga2_history";
historyfp.open(historyPath.CStr(), std::fstream::in);
String line;
while (std::getline(historyfp, line.GetData()))
add_history(line.CStr());
historyfp.close();
}
#endif /* HAVE_EDITLINE */
l_ScriptFrame = &scriptFrame;
l_Session = session;
while (std::cin.good()) {
String fileName;
if (commandOnceFileName.IsEmpty())
fileName = "<" + Convert::ToString(next_line) + ">";
else
fileName = commandOnceFileName;
next_line++;
bool continuation = false;
std::string command;
incomplete:
std::string line;
if (commandOnce.IsEmpty()) {
#ifdef HAVE_EDITLINE
std::ostringstream promptbuf;
std::ostream& os = promptbuf;
#else /* HAVE_EDITLINE */
std::ostream& os = std::cout;
#endif /* HAVE_EDITLINE */
os << fileName;
if (!continuation)
os << " => ";
else
os << " .. ";
#ifdef HAVE_EDITLINE
String prompt = promptbuf.str();
char *cline;
cline = readline(prompt.CStr());
if (!cline)
break;
if (commandOnce.IsEmpty() && cline[0] != '\0') {
add_history(cline);
if (!historyPath.IsEmpty()) {
historyfp.open(historyPath.CStr(), std::fstream::out | std::fstream::app);
historyfp << cline << "\n";
historyfp.close();
}
}
line = cline;
free(cline);
#else /* HAVE_EDITLINE */
std::getline(std::cin, line);
#endif /* HAVE_EDITLINE */
} else
line = commandOnce;
if (!line.empty() && line[0] == '$') {
if (line == "$continue" || line == "$quit" || line == "$exit")
break;
else if (line == "$help")
std::cout << "Welcome to the Icinga 2 debug console.\n"
"Usable commands:\n"
" $continue Continue running Icinga 2 (script debugger).\n"
" $quit, $exit Stop debugging and quit the console.\n"
" $help Print this help.\n\n"
"For more information on how to use this console, please consult the documentation at https://icinga.com/docs\n";
else
std::cout << "Unknown debugger command: " << line << "\n";
continue;
}
if (!command.empty())
command += "\n";
command += line;
std::unique_ptr expr;
try {
lines[fileName] = command;
Value result;
/* Local debug console. */
if (connectAddr.IsEmpty()) {
expr = ConfigCompiler::CompileText(fileName, command);
/* This relies on the fact that - for syntax errors - CompileText()
* returns an AST where the top-level expression is a 'throw'. */
if (!syntaxOnly || dynamic_cast(expr.get())) {
if (syntaxOnly)
std::cerr << " => " << command << std::endl;
result = Serialize(expr->Evaluate(scriptFrame), 0);
} else
result = true;
} else {
/* Remote debug console. */
try {
result = ExecuteScript(l_Session, command, scriptFrame.Sandboxed);
} catch (const ScriptError&) {
/* Re-throw the exception for the outside try-catch block. */
boost::rethrow_exception(boost::current_exception());
} catch (const std::exception& ex) {
Log(LogCritical, "ConsoleCommand")
<< "HTTP query failed: " << ex.what();
#ifdef HAVE_EDITLINE
/* Ensures that the terminal state is reset */
rl_deprep_terminal();
#endif /* HAVE_EDITLINE */
return EXIT_FAILURE;
}
}
if (commandOnce.IsEmpty()) {
std::cout << ConsoleColorTag(Console_ForegroundCyan);
ConfigWriter::EmitValue(std::cout, 1, result);
std::cout << ConsoleColorTag(Console_Normal) << "\n";
} else {
std::cout << JsonEncode(result) << "\n";
break;
}
} catch (const ScriptError& ex) {
if (ex.IsIncompleteExpression() && commandOnce.IsEmpty()) {
continuation = true;
goto incomplete;
}
DebugInfo di = ex.GetDebugInfo();
if (commandOnceFileName.IsEmpty() && lines.find(di.Path) != lines.end()) {
String text = lines[di.Path];
std::vector ulines = text.Split("\n");
for (decltype(ulines.size()) i = 1; i <= ulines.size(); i++) {
int start, len;
if (i == (decltype(i))di.FirstLine)
start = di.FirstColumn;
else
start = 0;
if (i == (decltype(i))di.LastLine)
len = di.LastColumn - di.FirstColumn + 1;
else
len = ulines[i - 1].GetLength();
int offset;
if (di.Path != fileName) {
std::cout << di.Path << ": " << ulines[i - 1] << "\n";
offset = 2;
} else
offset = 4;
if (i >= (decltype(i))di.FirstLine && i <= (decltype(i))di.LastLine) {
std::cout << String(di.Path.GetLength() + offset, ' ');
std::cout << String(start, ' ') << String(len, '^') << "\n";
}
}
} else {
ShowCodeLocation(std::cout, di);
}
std::cout << ex.what() << "\n";
if (!commandOnce.IsEmpty())
return EXIT_FAILURE;
} catch (const std::exception& ex) {
std::cout << "Error: " << DiagnosticInformation(ex) << "\n";
if (!commandOnce.IsEmpty())
return EXIT_FAILURE;
}
}
return EXIT_SUCCESS;
}
/**
* Connects to host:port and performs a TLS shandshake
*
* @returns AsioTlsStream pointer for future HTTP connections.
*/
Shared::Ptr ConsoleCommand::Connect()
{
Shared::Ptr sslContext;
try {
sslContext = MakeAsioSslContext(Empty, Empty, Empty); //TODO: Add support for cert, key, ca parameters
} catch(const std::exception& ex) {
Log(LogCritical, "DebugConsole")
<< "Cannot make SSL context: " << ex.what();
throw;
}
String host = l_Url->GetHost();
String port = l_Url->GetPort();
Shared::Ptr stream = Shared::Make(IoEngine::Get().GetIoContext(), *sslContext, host);
try {
icinga::Connect(stream->lowest_layer(), host, port);
} catch (const std::exception& ex) {
Log(LogWarning, "DebugConsole")
<< "Cannot connect to REST API on host '" << host << "' port '" << port << "': " << ex.what();
throw;
}
auto& tlsStream (stream->next_layer());
try {
tlsStream.handshake(tlsStream.client);
} catch (const std::exception& ex) {
Log(LogWarning, "DebugConsole")
<< "TLS handshake with host '" << host << "' failed: " << ex.what();
throw;
}
return stream;
}
/**
* Sends the request via REST API and returns the parsed response.
*
* @param tlsStream Caller must prepare TLS stream/handshake.
* @param url Fully prepared Url object.
* @return A dictionary decoded from JSON.
*/
Dictionary::Ptr ConsoleCommand::SendRequest()
{
namespace beast = boost::beast;
namespace http = beast::http;
l_TlsStream = ConsoleCommand::Connect();
Defer s ([&]() {
l_TlsStream->next_layer().shutdown();
});
http::request request(http::verb::post, std::string(l_Url->Format(false)), 10);
request.set(http::field::user_agent, "Icinga/DebugConsole/" + Application::GetAppVersion());
request.set(http::field::host, l_Url->GetHost() + ":" + l_Url->GetPort());
request.set(http::field::accept, "application/json");
request.set(http::field::authorization, "Basic " + Base64::Encode(l_Url->GetUsername() + ":" + l_Url->GetPassword()));
try {
http::write(*l_TlsStream, request);
l_TlsStream->flush();
} catch (const std::exception &ex) {
Log(LogWarning, "DebugConsole")
<< "Cannot write HTTP request to REST API at URL '" << l_Url->Format(true) << "': " << ex.what();
throw;
}
http::parser parser;
beast::flat_buffer buf;
try {
http::read(*l_TlsStream, buf, parser);
} catch (const std::exception &ex) {
Log(LogWarning, "DebugConsole")
<< "Failed to parse HTTP response from REST API at URL '" << l_Url->Format(true) << "': " << ex.what();
throw;
}
auto &response(parser.get());
/* Handle HTTP errors first. */
if (response.result() != http::status::ok) {
String message = "HTTP request failed; Code: " + Convert::ToString(response.result())
+ "; Body: " + response.body();
BOOST_THROW_EXCEPTION(ScriptError(message));
}
Dictionary::Ptr jsonResponse;
auto &body(response.body());
//Log(LogWarning, "Console")
// << "Got response: " << response.body();
try {
jsonResponse = JsonDecode(body);
} catch (...) {
String message = "Cannot parse JSON response body: " + response.body();
BOOST_THROW_EXCEPTION(ScriptError(message));
}
return jsonResponse;
}
/**
* Executes the DSL script via HTTP and returns HTTP and user errors.
*
* @param session Local session handler.
* @param command The DSL string.
* @param sandboxed Whether to run this sandboxed.
* @return Result value, also contains user errors.
*/
Value ConsoleCommand::ExecuteScript(const String& session, const String& command, bool sandboxed)
{
/* Extend the url parameters for the request. */
l_Url->SetPath({"v1", "console", "execute-script"});
l_Url->SetQuery({
{"session", session},
{"command", command},
{"sandboxed", sandboxed ? "1" : "0"}
});
Dictionary::Ptr jsonResponse = SendRequest();
/* Extract the result, and handle user input errors too. */
Array::Ptr results = jsonResponse->Get("results");
Value result;
if (results && results->GetLength() > 0) {
Dictionary::Ptr resultInfo = results->Get(0);
if (resultInfo->Get("code") >= 200 && resultInfo->Get("code") <= 299) {
result = resultInfo->Get("result");
} else {
String errorMessage = resultInfo->Get("status");
DebugInfo di;
Dictionary::Ptr debugInfo = resultInfo->Get("debug_info");
if (debugInfo) {
di.Path = debugInfo->Get("path");
di.FirstLine = debugInfo->Get("first_line");
di.FirstColumn = debugInfo->Get("first_column");
di.LastLine = debugInfo->Get("last_line");
di.LastColumn = debugInfo->Get("last_column");
}
bool incompleteExpression = resultInfo->Get("incomplete_expression");
BOOST_THROW_EXCEPTION(ScriptError(errorMessage, di, incompleteExpression));
}
}
return result;
}
/**
* Executes the auto completion script via HTTP and returns HTTP and user errors.
*
* @param session Local session handler.
* @param command The auto completion string.
* @param sandboxed Whether to run this sandboxed.
* @return Result value, also contains user errors.
*/
Array::Ptr ConsoleCommand::AutoCompleteScript(const String& session, const String& command, bool sandboxed)
{
/* Extend the url parameters for the request. */
l_Url->SetPath({ "v1", "console", "auto-complete-script" });
l_Url->SetQuery({
{"session", session},
{"command", command},
{"sandboxed", sandboxed ? "1" : "0"}
});
Dictionary::Ptr jsonResponse = SendRequest();
/* Extract the result, and handle user input errors too. */
Array::Ptr results = jsonResponse->Get("results");
Array::Ptr suggestions;
if (results && results->GetLength() > 0) {
Dictionary::Ptr resultInfo = results->Get(0);
if (resultInfo->Get("code") >= 200 && resultInfo->Get("code") <= 299) {
suggestions = resultInfo->Get("suggestions");
} else {
String errorMessage = resultInfo->Get("status");
BOOST_THROW_EXCEPTION(ScriptError(errorMessage));
}
}
return suggestions;
}