/*============================================================================ CMake - Cross Platform Makefile Generator Copyright 2015 Stephen Kelly Copyright 2016 Tobias Hunger Distributed under the OSI-approved BSD License (the "License"); see accompanying file Copyright.txt for details. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the License for more information. ============================================================================*/ #include "cmServer.h" #include "cmServerProtocol.h" #include "cmSystemTools.h" #include "cmVersionMacros.h" #include "cmake.h" #if defined(CMAKE_BUILD_WITH_CMAKE) #include "cm_jsoncpp_reader.h" #include "cm_jsoncpp_value.h" #endif static const std::string kTYPE_KEY = "type"; static const std::string kCOOKIE_KEY = "cookie"; static const std::string kREPLY_TO_KEY = "inReplyTo"; static const std::string kERROR_MESSAGE_KEY = "errorMessage"; static const std::string kERROR_TYPE = "error"; static const std::string kREPLY_TYPE = "reply"; static const std::string kPROGRESS_TYPE = "progress"; static const std::string kMESSAGE_TYPE = "message"; static const std::string kSTART_MAGIC = "[== CMake Server ==["; static const std::string kEND_MAGIC = "]== CMake Server ==]"; typedef struct { uv_write_t req; uv_buf_t buf; } write_req_t; void alloc_buffer(uv_handle_t* handle, size_t suggested_size, uv_buf_t* buf) { (void)handle; *buf = uv_buf_init(static_cast(malloc(suggested_size)), static_cast(suggested_size)); } void free_write_req(uv_write_t* req) { write_req_t* wr = reinterpret_cast(req); free(wr->buf.base); free(wr); } void on_stdout_write(uv_write_t* req, int status) { (void)status; auto server = reinterpret_cast(req->data); free_write_req(req); server->PopOne(); } void write_data(uv_stream_t* dest, std::string content, uv_write_cb cb) { write_req_t* req = static_cast(malloc(sizeof(write_req_t))); req->req.data = dest->data; req->buf = uv_buf_init(static_cast(malloc(content.size())), static_cast(content.size())); memcpy(req->buf.base, content.c_str(), content.size()); uv_write(reinterpret_cast(req), static_cast(dest), &req->buf, 1, cb); } void read_stdin(uv_stream_t* stream, ssize_t nread, const uv_buf_t* buf) { if (nread > 0) { auto server = reinterpret_cast(stream->data); std::string result = std::string(buf->base, buf->base + nread); server->handleData(result); } if (buf->base) free(buf->base); } cmServer::cmServer(bool supportExperimental) : SupportExperimental(supportExperimental) { // Register supported protocols: this->RegisterProtocol(new cmServerProtocol1_0); } cmServer::~cmServer() { if (!this->Protocol) { // Server was never fully started! return; } uv_close(reinterpret_cast(this->InputStream), NULL); uv_close(reinterpret_cast(this->OutputStream), NULL); uv_loop_close(this->Loop); for (cmServerProtocol* p : this->SupportedProtocols) { delete p; } } void cmServer::PopOne() { this->Writing = false; if (this->Queue.empty()) { return; } Json::Reader reader; Json::Value value; const std::string input = this->Queue.front(); this->Queue.erase(this->Queue.begin()); if (!reader.parse(input, value)) { this->WriteParseError("Failed to parse JSON input."); return; } const cmServerRequest request(this, value[kTYPE_KEY].asString(), value[kCOOKIE_KEY].asString(), value); if (request.Type == "") { cmServerResponse response(request); response.SetError("No type given in request."); this->WriteResponse(response); return; } cmSystemTools::SetMessageCallback(reportMessage, const_cast(&request)); if (this->Protocol) { this->Protocol->CMakeInstance()->SetProgressCallback( reportProgress, const_cast(&request)); this->WriteResponse(this->Protocol->Process(request)); } else { this->WriteResponse(this->SetProtocolVersion(request)); } } void cmServer::handleData(const std::string& data) { this->DataBuffer += data; for (;;) { auto needle = this->DataBuffer.find('\n'); if (needle == std::string::npos) { return; } std::string line = this->DataBuffer.substr(0, needle); const auto ls = line.size(); if (ls > 1 && line.at(ls - 1) == '\r') line.erase(ls - 1, 1); this->DataBuffer.erase(this->DataBuffer.begin(), this->DataBuffer.begin() + needle + 1); if (line == kSTART_MAGIC) { this->JsonData.clear(); continue; } if (line == kEND_MAGIC) { this->Queue.push_back(this->JsonData); this->JsonData.clear(); if (!this->Writing) { this->PopOne(); } } else { this->JsonData += line; this->JsonData += "\n"; } } } void cmServer::RegisterProtocol(cmServerProtocol* protocol) { if (protocol->IsExperimental() && !this->SupportExperimental) { return; } auto version = protocol->ProtocolVersion(); assert(version.first >= 0); assert(version.second >= 0); auto it = std::find_if(this->SupportedProtocols.begin(), this->SupportedProtocols.end(), [version](cmServerProtocol* p) { return p->ProtocolVersion() == version; }); if (it == this->SupportedProtocols.end()) this->SupportedProtocols.push_back(protocol); } void cmServer::PrintHello() const { Json::Value hello = Json::objectValue; hello[kTYPE_KEY] = "hello"; Json::Value& protocolVersions = hello["supportedProtocolVersions"] = Json::arrayValue; for (auto const& proto : this->SupportedProtocols) { auto version = proto->ProtocolVersion(); Json::Value tmp = Json::objectValue; tmp["major"] = version.first; tmp["minor"] = version.second; if (proto->IsExperimental()) { tmp["experimental"] = true; } protocolVersions.append(tmp); } this->WriteJsonObject(hello); } void cmServer::reportProgress(const char* msg, float progress, void* data) { const cmServerRequest* request = static_cast(data); assert(request); if (progress < 0.0 || progress > 1.0) { request->ReportMessage(msg, ""); } else { request->ReportProgress(0, static_cast(progress * 1000), 1000, msg); } } void cmServer::reportMessage(const char* msg, const char* title, bool& /* cancel */, void* data) { const cmServerRequest* request = static_cast(data); assert(request); assert(msg); std::string titleString; if (title) { titleString = title; } request->ReportMessage(std::string(msg), titleString); } cmServerResponse cmServer::SetProtocolVersion(const cmServerRequest& request) { if (request.Type != "handshake") return request.ReportError("Waiting for type \"handshake\"."); Json::Value requestedProtocolVersion = request.Data["protocolVersion"]; if (requestedProtocolVersion.isNull()) return request.ReportError( "\"protocolVersion\" is required for \"handshake\"."); if (!requestedProtocolVersion.isObject()) return request.ReportError("\"protocolVersion\" must be a JSON object."); Json::Value majorValue = requestedProtocolVersion["major"]; if (!majorValue.isInt()) return request.ReportError("\"major\" must be set and an integer."); Json::Value minorValue = requestedProtocolVersion["minor"]; if (!minorValue.isNull() && !minorValue.isInt()) return request.ReportError("\"minor\" must be unset or an integer."); const int major = majorValue.asInt(); const int minor = minorValue.isNull() ? -1 : minorValue.asInt(); if (major < 0) return request.ReportError("\"major\" must be >= 0."); if (!minorValue.isNull() && minor < 0) return request.ReportError("\"minor\" must be >= 0 when set."); this->Protocol = this->FindMatchingProtocol(this->SupportedProtocols, major, minor); if (!this->Protocol) { return request.ReportError("Protocol version not supported."); } std::string errorMessage; if (!this->Protocol->Activate(request, &errorMessage)) { this->Protocol = CM_NULLPTR; return request.ReportError("Failed to activate protocol version: " + errorMessage); } return request.Reply(Json::objectValue); } bool cmServer::Serve() { if (this->SupportedProtocols.empty()) { return false; } assert(!this->Protocol); this->Loop = uv_default_loop(); if (uv_guess_handle(1) == UV_TTY) { uv_tty_init(this->Loop, &this->Input.tty, 0, 1); uv_tty_set_mode(&this->Input.tty, UV_TTY_MODE_NORMAL); this->Input.tty.data = this; InputStream = reinterpret_cast(&this->Input.tty); uv_tty_init(this->Loop, &this->Output.tty, 1, 0); uv_tty_set_mode(&this->Output.tty, UV_TTY_MODE_NORMAL); this->Output.tty.data = this; OutputStream = reinterpret_cast(&this->Output.tty); } else { uv_pipe_init(this->Loop, &this->Input.pipe, 0); uv_pipe_open(&this->Input.pipe, 0); this->Input.pipe.data = this; InputStream = reinterpret_cast(&this->Input.pipe); uv_pipe_init(this->Loop, &this->Output.pipe, 0); uv_pipe_open(&this->Output.pipe, 1); this->Output.pipe.data = this; OutputStream = reinterpret_cast(&this->Output.pipe); } this->PrintHello(); uv_read_start(this->InputStream, alloc_buffer, read_stdin); uv_run(this->Loop, UV_RUN_DEFAULT); return true; } void cmServer::WriteJsonObject(const Json::Value& jsonValue) const { Json::FastWriter writer; std::string result = std::string("\n") + kSTART_MAGIC + std::string("\n") + writer.write(jsonValue) + kEND_MAGIC + std::string("\n"); this->Writing = true; write_data(this->OutputStream, result, on_stdout_write); } cmServerProtocol* cmServer::FindMatchingProtocol( const std::vector& protocols, int major, int minor) { cmServerProtocol* bestMatch = nullptr; for (auto protocol : protocols) { auto version = protocol->ProtocolVersion(); if (major != version.first) continue; if (minor == version.second) return protocol; if (!bestMatch || bestMatch->ProtocolVersion().second < version.second) bestMatch = protocol; } return minor < 0 ? bestMatch : nullptr; } void cmServer::WriteProgress(const cmServerRequest& request, int min, int current, int max, const std::string& message) const { assert(min <= current && current <= max); assert(message.length() != 0); Json::Value obj = Json::objectValue; obj[kTYPE_KEY] = kPROGRESS_TYPE; obj[kREPLY_TO_KEY] = request.Type; obj[kCOOKIE_KEY] = request.Cookie; obj["progressMessage"] = message; obj["progressMinimum"] = min; obj["progressMaximum"] = max; obj["progressCurrent"] = current; this->WriteJsonObject(obj); } void cmServer::WriteMessage(const cmServerRequest& request, const std::string& message, const std::string& title) const { if (message.empty()) return; Json::Value obj = Json::objectValue; obj[kTYPE_KEY] = kMESSAGE_TYPE; obj[kREPLY_TO_KEY] = request.Type; obj[kCOOKIE_KEY] = request.Cookie; obj["message"] = message; if (!title.empty()) { obj["title"] = title; } WriteJsonObject(obj); } void cmServer::WriteParseError(const std::string& message) const { Json::Value obj = Json::objectValue; obj[kTYPE_KEY] = kERROR_TYPE; obj[kERROR_MESSAGE_KEY] = message; obj[kREPLY_TO_KEY] = ""; obj[kCOOKIE_KEY] = ""; this->WriteJsonObject(obj); } void cmServer::WriteResponse(const cmServerResponse& response) const { assert(response.IsComplete()); Json::Value obj = response.Data(); obj[kCOOKIE_KEY] = response.Cookie; obj[kTYPE_KEY] = response.IsError() ? kERROR_TYPE : kREPLY_TYPE; obj[kREPLY_TO_KEY] = response.Type; if (response.IsError()) { obj[kERROR_MESSAGE_KEY] = response.ErrorMessage(); } this->WriteJsonObject(obj); }