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(
	const WaitGroup::Ptr&,
	const HttpApiRequest& request,
	HttpApiResponse& response,
	boost::asio::yield_context&
)
{
	namespace http = boost::beast::http;

	auto url = request.Url();
	auto user = request.User();
	auto params = request.Params();

	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");

		auto& body = response.body();
		body << "<html><head><title>Icinga 2</title></head><h1>Hello from Icinga 2 (Version: "
			<< Application::GetAppVersion() << ")!</h1>"
			<< "<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>)";
	}

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

Add redirect for / refs #9105 2015-10-22 07:29:06 -04:00			`REGISTER_URLHANDLER("/", InfoHandler);`
Implement URL handler for /v1 refs #9105 2015-10-22 06:02:15 -04:00
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 04:33:01 -05:00			`bool InfoHandler::HandleRequest(`
Use WaitGroup to wait for or abort HTTP requests The wait group gets passed to HttpServerConnection, then down to the HttpHandlers. For those handlers that modify the program state, the wait group is locked so ApiListener will wait on Stop() for the request to complete. If the request iterates over config objects, a further check on the state of the wait group is added to abort early and not delay program shutdown. In that case, 503 responses will be sent to the client. Additionally, in HttpServerConnection, no further requests than the one already started will be allowed once the wait group is joining. 2025-06-11 04:28:16 -04:00			`const WaitGroup::Ptr&,`
Update names of HttpRequest and HttpResponse 2026-01-22 06:41:21 -05:00			`const HttpApiRequest& request,`
			`HttpApiResponse& response,`
Silence compiler warnings about unused parameters Every of these parameters exists for a reason. The best we can do is to convince the compiler. 2026-01-23 07:31:01 -05:00			`boost::asio::yield_context&`
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 04:33:01 -05:00			`)`
Implement URL handler for /v1 refs #9105 2015-10-22 06:02:15 -04:00			`{`
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 04:33:01 -05:00			`namespace http = boost::beast::http;`

Use new HTTP message classes in HttpServerConnection and Handlers 2025-07-23 03:37:05 -04:00			`auto url = request.Url();`
			`auto user = request.User();`
			`auto params = request.Params();`

Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 04:33:01 -05:00			`if (url->GetPath().size() > 2)`
Implement URL handler for /v1 refs #9105 2015-10-22 06:02:15 -04:00			`return false;`

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

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

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

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

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

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

Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 04:33:01 -05:00			`if (request[http::field::accept] == "application/json") {`
Use initializer lists for arrays and dictionaries 2018-01-11 05:17:38 -05: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 10:47:07 -04: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 05:17:38 -05: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 04:28:44 -04:00
API: Add 'pretty' parameter for beautified JSON response bodies fixes #5877 2017-12-20 09:31:05 -05:00			`HttpUtility::SendJsonBody(response, params, result);`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 04:28:44 -04:00			`} else {`
Adjust all HTTP handlers (ex. /v1/events) 2019-02-15 04:33:01 -05:00			`response.set(http::field::content_type, "text/html");`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 04:28:44 -04:00
Use new HTTP message classes in HttpServerConnection and Handlers 2025-07-23 03:37:05 -04:00			`auto& body = response.body();`
			`body << "<html><head><title>Icinga 2</title></head><h1>Hello from Icinga 2 (Version: "`
			`<< Application::GetAppVersion() << ")!</h1>"`
			`<< "<p>You are authenticated as <b>" << user->GetName() << "</b>. ";`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 04:28:44 -04:00
			`if (!permInfo.empty()) {`
Use new HTTP message classes in HttpServerConnection and Handlers 2025-07-23 03:37:05 -04:00			`body << "Your user has the following permissions:</p> <ul>";`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 04:28:44 -04:00
Replace BOOST_FOREACH with range-based for loops fixes #12538 2016-08-25 00:19:44 -04:00			`for (const String& perm : permInfo) {`
Use new HTTP message classes in HttpServerConnection and Handlers 2025-07-23 03:37:05 -04:00			`body << "<li>" << perm << "</li>";`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 04:28:44 -04:00			`}`

Use new HTTP message classes in HttpServerConnection and Handlers 2025-07-23 03:37:05 -04:00			`body << "</ul>";`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 04:28:44 -04:00			`} else`
Use new HTTP message classes in HttpServerConnection and Handlers 2025-07-23 03:37:05 -04:00			`body << "Your user does not have any permissions.</p>";`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 04:28:44 -04:00
Use new HTTP message classes in HttpServerConnection and Handlers 2025-07-23 03:37:05 -04: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>)";`
API: Fix that /v1 returns html if json is requested fixes #10570 2016-05-11 04:28:44 -04:00			`}`
Implement URL handler for /v1 refs #9105 2015-10-22 06:02:15 -04:00
			`return true;`
			`}`