JezK
Edit File: ApiServer.h
/* * Phusion Passenger - https://www.phusionpassenger.com/ * Copyright (c) 2013-2015 Phusion Holding B.V. * * "Passenger", "Phusion Passenger" and "Union Station" are registered * trademarks of Phusion Holding B.V. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ #ifndef _PASSENGER_UST_ROUTER_API_SERVER_H_ #define _PASSENGER_UST_ROUTER_API_SERVER_H_ #include <string> #include <jsoncpp/json.h> #include <modp_b64.h> #include <ServerKit/HttpServer.h> #include <DataStructures/LString.h> #include <Exceptions.h> #include <StaticString.h> #include <Utils/StrIntUtils.h> #include <Utils/BufferedIO.h> #include <Utils/MessageIO.h> #include <UstRouter/Controller.h> #include <Shared/ApiServerUtils.h> #include <Shared/ApplicationPoolApiKey.h> namespace Passenger { namespace UstRouter { using namespace std; class Request: public ServerKit::BaseHttpRequest { public: string body; Json::Value jsonBody; DEFINE_SERVER_KIT_BASE_HTTP_REQUEST_FOOTER(Request); }; class ApiServer: public ServerKit::HttpServer<ApiServer, ServerKit::HttpClient<Request> > { private: typedef ServerKit::HttpServer<ApiServer, ServerKit::HttpClient<Request> > ParentClass; typedef ServerKit::HttpClient<Request> Client; typedef ServerKit::HeaderTable HeaderTable; void route(Client *client, Request *req, const StaticString &path) { if (path == P_STATIC_STRING("/ping.json")) { apiServerProcessPing(this, client, req); } else if (path == P_STATIC_STRING("/info.json") // The "/version.json" path is deprecated || path == P_STATIC_STRING("/version.json")) { apiServerProcessInfo(this, client, req); } else if (path == P_STATIC_STRING("/shutdown.json")) { apiServerProcessShutdown(this, client, req); } else if (path == P_STATIC_STRING("/backtraces.txt")) { apiServerProcessBacktraces(this, client, req); } else if (path == P_STATIC_STRING("/config.json")) { processConfig(client, req); } else if (path == P_STATIC_STRING("/reinherit_logs.json")) { apiServerProcessReinheritLogs(this, client, req, instanceDir, fdPassingPassword); } else if (path == P_STATIC_STRING("/reopen_logs.json")) { apiServerProcessReopenLogs(this, client, req); } else if (path == P_STATIC_STRING("/server.json")) { processServerStatus(client, req); } else { apiServerRespondWith404(this, client, req); } } void processConfig(Client *client, Request *req) { if (req->method == HTTP_GET) { if (!authorizeStateInspectionOperation(this, client, req)) { apiServerRespondWith401(this, client, req); } HeaderTable headers; Json::Value doc; string logFile = getLogFile(); string fileDescriptorLogFile = getFileDescriptorLogFile(); headers.insert(req->pool, "Content-Type", "application/json"); doc["log_level"] = getLogLevel(); if (!logFile.empty()) { doc["log_file"] = logFile; } if (!fileDescriptorLogFile.empty()) { doc["file_descriptor_log_file"] = fileDescriptorLogFile; } writeSimpleResponse(client, 200, &headers, doc.toStyledString()); if (!req->ended()) { endRequest(&client, &req); } } else if (req->method == HTTP_PUT) { if (!authorizeAdminOperation(this, client, req)) { apiServerRespondWith401(this, client, req); } else if (!req->hasBody()) { endAsBadRequest(&client, &req, "Body required"); } // Continue in processConfigBody() } else { apiServerRespondWith405(this, client, req); } } void processConfigBody(Client *client, Request *req) { HeaderTable headers; Json::Value &json = req->jsonBody; headers.insert(req->pool, "Content-Type", "application/json"); if (json.isMember("log_level")) { setLogLevel(json["log_level"].asInt()); } if (json.isMember("log_file")) { string logFile = json["log_file"].asString(); try { logFile = absolutizePath(logFile); } catch (const SystemException &e) { unsigned int bufsize = 1024; char *message = (char *) psg_pnalloc(req->pool, bufsize); snprintf(message, bufsize, "{ \"status\": \"error\", " "\"message\": \"Cannot absolutize log file filename: %s\" }", e.what()); writeSimpleResponse(client, 500, &headers, message); if (!req->ended()) { endRequest(&client, &req); } return; } int e; if (!setLogFile(logFile, &e)) { unsigned int bufsize = 1024; char *message = (char *) psg_pnalloc(req->pool, bufsize); snprintf(message, bufsize, "{ \"status\": \"error\", " "\"message\": \"Cannot open log file: %s (errno=%d)\" }", strerror(e), e); writeSimpleResponse(client, 500, &headers, message); if (!req->ended()) { endRequest(&client, &req); } return; } P_NOTICE("Log file opened."); } writeSimpleResponse(client, 200, &headers, "{ \"status\": \"ok\" }\n"); if (!req->ended()) { endRequest(&client, &req); } } void gatherControllerState(Client *client, Request *req, Controller *controller) { Json::Value state = controller->inspectStateAsJson(); getContext()->libev->runLater(boost::bind(&ApiServer::controllerStateGathered, this, client, req, state)); } void controllerStateGathered(Client *client, Request *req, Json::Value state) { if (req->ended()) { unrefRequest(req, __FILE__, __LINE__); return; } HeaderTable headers; headers.insert(req->pool, "Content-Type", "application/json"); writeSimpleResponse(client, 200, &headers, psg_pstrdup(req->pool, state.toStyledString())); if (!req->ended()) { Request *req2 = req; endRequest(&client, &req2); } unrefRequest(req, __FILE__, __LINE__); } void processServerStatus(Client *client, Request *req) { if (req->method != HTTP_GET) { apiServerRespondWith405(this, client, req); } else if (authorizeStateInspectionOperation(this, client, req)) { refRequest(req, __FILE__, __LINE__); controller->getContext()->libev->runLater(boost::bind( &ApiServer::gatherControllerState, this, client, req, controller)); } else { apiServerRespondWith401(this, client, req); } } protected: virtual void onRequestBegin(Client *client, Request *req) { const StaticString path(req->path.start->data, req->path.size); P_INFO("API request: " << http_method_str(req->method) << " " << StaticString(req->path.start->data, req->path.size)); try { route(client, req, path); } catch (const oxt::tracable_exception &e) { SKC_ERROR(client, "Exception: " << e.what() << "\n" << e.backtrace()); if (!req->ended()) { req->wantKeepAlive = false; endRequest(&client, &req); } } } virtual ServerKit::Channel::Result onRequestBody(Client *client, Request *req, const MemoryKit::mbuf &buffer, int errcode) { if (buffer.size() > 0) { // Data req->body.append(buffer.start, buffer.size()); } else if (errcode == 0) { // EOF Json::Reader reader; if (reader.parse(req->body, req->jsonBody)) { try { processConfigBody(client, req); } catch (const oxt::tracable_exception &e) { SKC_ERROR(client, "Exception: " << e.what() << "\n" << e.backtrace()); if (!req->ended()) { req->wantKeepAlive = false; endRequest(&client, &req); } } } else { apiServerRespondWith422(this, client, req, reader.getFormattedErrorMessages()); } } else { // Error disconnect(&client); } return ServerKit::Channel::Result(buffer.size(), false); } virtual void deinitializeRequest(Client *client, Request *req) { req->body.clear(); if (!req->jsonBody.isNull()) { req->jsonBody = Json::Value(); } ParentClass::deinitializeRequest(client, req); } public: Controller *controller; ApiAccountDatabase *apiAccountDatabase; string instanceDir; string fdPassingPassword; EventFd *exitEvent; ApiServer(ServerKit::Context *context) : ParentClass(context), controller(NULL), apiAccountDatabase(NULL), exitEvent(NULL) { } virtual StaticString getServerName() const { return P_STATIC_STRING("UstRouterApiServer"); } virtual unsigned int getClientName(const Client *client, char *buf, size_t size) const { return ParentClass::getClientName(client, buf, size); } bool authorizeByUid(uid_t uid) const { return uid == 0 || uid == geteuid(); } bool authorizeByApiKey(const ApplicationPool2::ApiKey &apiKey) const { return apiKey.isSuper(); } }; } // namespace UstRouter } // namespace Passenger #endif /* _PASSENGER_UST_ROUTER_API_SERVER_H_ */