icinga2/lib/remote/infohandler.cpp

/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */

#include "remote/infohandler.hpp"
#include "remote/httputility.hpp"
#include "base/application.hpp"

using namespace icinga;

REGISTER_URLHANDLER("/", InfoHandler);

bool InfoHandler::HandleRequest(
	AsioTlsStream& stream,
	const ApiUser::Ptr& user,
	boost::beast::http::request<boost::beast::http::string_body>& request,
	const Url::Ptr& url,
	boost::beast::http::response<boost::beast::http::string_body>& response,
	const Dictionary::Ptr& params,
	boost::asio::yield_context& yc,
	HttpServerConnection& server
)
{
	namespace http = boost::beast::http;

	if (url->GetPath().size() > 2)
		return false;

	if (request.method() != http::verb::get)
		return false;

	if (url->GetPath().empty()) {
		response.result(http::status::found);
		response.set(http::field::location, "/v1");
		return true;
	}

	if (url->GetPath()[0] != "v1" || url->GetPath().size() != 1)
		return false;

	response.result(http::status::ok);

	std::vector<String> permInfo;
	Array::Ptr permissions = user->GetPermissions();

	if (permissions) {
		ObjectLock olock(permissions);
		for (const Value& permission : permissions) {
			String name;
			bool hasFilter = false;
			if (permission.IsObjectType<Dictionary>()) {
				Dictionary::Ptr dpermission = permission;
				name = dpermission->Get("permission");
				hasFilter = dpermission->Contains("filter");
			} else
				name = permission;

			if (hasFilter)
				name += " (filtered)";

			permInfo.emplace_back(std::move(name));
		}
	}

	if (request[http::field::accept] == "application/json") {
		Dictionary::Ptr result1 = new Dictionary({
			{ "user", user->GetName() },
			{ "permissions", Array::FromVector(permInfo) },
			{ "version", Application::GetAppVersion() },
			{ "info", "More information about API requests is available in the documentation at https://icinga.com/docs/icinga2/latest/" }
		});

		Dictionary::Ptr result = new Dictionary({
			{ "results", new Array({ result1 }) }
		});

		HttpUtility::SendJsonBody(response, params, result);
	} else {
		response.set(http::field::content_type, "text/html");

		String body = "<html><head><title>Icinga 2</title></head><h1>Hello from Icinga 2 (Version: " + Application::GetAppVersion() + ")!</h1>";
		body += "<p>You are authenticated as <b>" + user->GetName() + "</b>. ";

		if (!permInfo.empty()) {
			body += "Your user has the following permissions:</p> <ul>";

			for (const String& perm : permInfo) {
				body += "<li>" + perm + "</li>";
			}

			body += "</ul>";
		} else
			body += "Your user does not have any permissions.</p>";

		body += R"(<p>More information about API requests is available in the <a href="https://icinga.com/docs/icinga2/latest/" target="_blank">documentation</a>.</p></html>)";
		response.body() = body;
		response.content_length(response.body().size());
	}

	return true;
}
Replace Copyright header with a short version, part I CLion -> replace in path 2019-02-25 14:48:22 +01:00			`/* Icinga 2 \| (c) 2012 Icinga GmbH \| GPLv2+ */`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00
			`#include "remote/infohandler.hpp"`
			`#include "remote/httputility.hpp"`
Add version info in /v1 fixes #12327 2016-08-09 08:44:53 +02:00			`#include "base/application.hpp"`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00
			`using namespace icinga;`

Add redirect for / refs #9105 2015-10-22 13:29:06 +02:00			`REGISTER_URLHANDLER("/", InfoHandler);`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`bool InfoHandler::HandleRequest(`
Adjust /v1/events, too 2019-02-15 11:51:12 +01:00			`AsioTlsStream& stream,`
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`const ApiUser::Ptr& user,`
			`boost::beast::http::request<boost::beast::http::string_body>& request,`
			`const Url::Ptr& url,`
			`boost::beast::http::response<boost::beast::http::string_body>& response,`
Adjust /v1/events, too 2019-02-15 11:51:12 +01:00			`const Dictionary::Ptr& params,`
			`boost::asio::yield_context& yc,`
HttpServerConnection: encapsulate streaming start indicator 2019-04-02 17:37:29 +02:00			`HttpServerConnection& server`
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`)`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00			`{`
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`namespace http = boost::beast::http;`

			`if (url->GetPath().size() > 2)`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00			`return false;`

Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`if (request.method() != http::verb::get)`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00			`return false;`

Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`if (url->GetPath().empty()) {`
			`response.result(http::status::found);`
			`response.set(http::field::location, "/v1");`
Add redirect for / refs #9105 2015-10-22 13:29:06 +02:00			`return true;`
			`}`

Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`if (url->GetPath()[0] != "v1" \|\| url->GetPath().size() != 1)`
Add redirect for / refs #9105 2015-10-22 13:29:06 +02:00			`return false;`

Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`response.result(http::status::ok);`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00			`std::vector<String> permInfo;`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00			`Array::Ptr permissions = user->GetPermissions();`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00			`if (permissions) {`
			`ObjectLock olock(permissions);`
Replace BOOST_FOREACH with range-based for loops fixes #12538 2016-08-25 06:19:44 +02:00			`for (const Value& permission : permissions) {`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00			`String name;`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00			`bool hasFilter = false;`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00			`if (permission.IsObjectType<Dictionary>()) {`
			`Dictionary::Ptr dpermission = permission;`
			`name = dpermission->Get("permission");`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00			`hasFilter = dpermission->Contains("filter");`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00			`} else`
			`name = permission;`

API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00			`if (hasFilter)`
			`name += " (filtered)";`

Use std::vector::emplace_back instead of std::vector::push_back 2017-11-30 08:19:58 +01:00			`permInfo.emplace_back(std::move(name));`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00			`}`
			`}`

Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`if (request[http::field::accept] == "application/json") {`
Use initializer lists for arrays and dictionaries 2018-01-11 11:17:38 +01:00			`Dictionary::Ptr result1 = new Dictionary({`
			`{ "user", user->GetName() },`
			`{ "permissions", Array::FromVector(permInfo) },`
			`{ "version", Application::GetAppVersion() },`
Update doc URL for the API info handler at /v1 2019-08-27 16:47:07 +02:00			`{ "info", "More information about API requests is available in the documentation at https://icinga.com/docs/icinga2/latest/" }`
Use initializer lists for arrays and dictionaries 2018-01-11 11:17:38 +01:00			`});`

			`Dictionary::Ptr result = new Dictionary({`
			`{ "results", new Array({ result1 }) }`
			`});`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00
API: Add 'pretty' parameter for beautified JSON response bodies fixes #5877 2017-12-20 15:31:05 +01:00			`HttpUtility::SendJsonBody(response, params, result);`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00			`} else {`
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`response.set(http::field::content_type, "text/html");`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00
Add version info in /v1 fixes #12327 2016-08-09 08:44:53 +02:00			`String body = "<html><head><title>Icinga 2</title></head><h1>Hello from Icinga 2 (Version: " + Application::GetAppVersion() + ")!</h1>";`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00			`body += "<p>You are authenticated as <b>" + user->GetName() + "</b>. ";`

			`if (!permInfo.empty()) {`
			`body += "Your user has the following permissions:</p> <ul>";`

Replace BOOST_FOREACH with range-based for loops fixes #12538 2016-08-25 06:19:44 +02:00			`for (const String& perm : permInfo) {`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00			`body += "<li>" + perm + "</li>";`
			`}`

			`body += "</ul>";`
			`} else`
			`body += "Your user does not have any permissions.</p>";`

Update doc URL for the API info handler at /v1 2019-08-27 16:47:07 +02:00			`body += R"(<p>More information about API requests is available in the <a href="https://icinga.com/docs/icinga2/latest/" target="_blank">documentation</a>.</p></html>)";`
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 10:33:01 +01:00			`response.body() = body;`
Use content_length method for setting the Content-Length header Boost.Beast changed the signature of the previously used generic `set` method so that it no longer accepts integer types, however there is alreay a more specific method for setting the Content-Length header, so use this one instead. 2020-12-22 14:32:56 +01:00			`response.content_length(response.body().size());`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 10:28:44 +02:00			`}`
Implement URL handler for /v1 refs #9105 2015-10-22 12:02:15 +02:00
			`return true;`
			`}`