/** * Digital Voice Modem - Host Software * GPLv2 Open Source. Use is subject to license terms. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * @package DVM / Host Software * */ // // Based on code from the CRUD project. (https://github.com/venediktov/CRUD) // Licensed under the BPL-1.0 License (https://opensource.org/license/bsl1-0-html) // /* * Copyright (c) 2003-2013 Christopher M. Kohlhoff * Copyright (C) 2023 by Bryan Biedenkapp N2PLL * * Permission is hereby granted, free of charge, to any person or organization * obtaining a copy of the software and accompanying documentation covered by * this license (the “Software”) to use, reproduce, display, distribute, execute, * and transmit the Software, and to prepare derivative works of the Software, and * to permit third-parties to whom the Software is furnished to do so, all subject * to the following: * * The copyright notices in the Software and this entire statement, including the * above license grant, this restriction and the following disclaimer, must be included * in all copies of the Software, in whole or in part, and all derivative works of the * Software, unless such copies or derivative works are solely in the form of * machine-executable object code generated by a source language processor. * * 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE * DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include "Defines.h" #include "network/rest/http/HTTPPayload.h" #include "Log.h" using namespace network::rest::http; #include namespace status_strings { const std::string ok = "HTTP/1.0 200 OK\r\n"; const std::string created = "HTTP/1.0 201 Created\r\n"; const std::string accepted = "HTTP/1.0 202 Accepted\r\n"; const std::string no_content = "HTTP/1.0 204 No Content\r\n"; const std::string multiple_choices = "HTTP/1.0 300 Multiple Choices\r\n"; const std::string moved_permanently = "HTTP/1.0 301 Moved Permanently\r\n"; const std::string moved_temporarily = "HTTP/1.0 302 Moved Temporarily\r\n"; const std::string not_modified = "HTTP/1.0 304 Not Modified\r\n"; const std::string bad_request = "HTTP/1.0 400 Bad Request\r\n"; const std::string unauthorized = "HTTP/1.0 401 Unauthorized\r\n"; const std::string forbidden = "HTTP/1.0 403 Forbidden\r\n"; const std::string not_found = "HTTP/1.0 404 Not Found\r\n"; const std::string internal_server_error = "HTTP/1.0 500 Internal Server Error\r\n"; const std::string not_implemented = "HTTP/1.0 501 Not Implemented\r\n"; const std::string bad_gateway = "HTTP/1.0 502 Bad Gateway\r\n"; const std::string service_unavailable = "HTTP/1.0 503 Service Unavailable\r\n"; asio::const_buffer toBuffer(HTTPPayload::StatusType status) { switch (status) { case HTTPPayload::OK: return asio::buffer(ok); case HTTPPayload::CREATED: return asio::buffer(created); case HTTPPayload::ACCEPTED: return asio::buffer(accepted); case HTTPPayload::NO_CONTENT: return asio::buffer(no_content); case HTTPPayload::MULTIPLE_CHOICES: return asio::buffer(multiple_choices); case HTTPPayload::MOVED_PERMANENTLY: return asio::buffer(moved_permanently); case HTTPPayload::MOVED_TEMPORARILY: return asio::buffer(moved_temporarily); case HTTPPayload::NOT_MODIFIED: return asio::buffer(not_modified); case HTTPPayload::BAD_REQUEST: return asio::buffer(bad_request); case HTTPPayload::UNAUTHORIZED: return asio::buffer(unauthorized); case HTTPPayload::FORBIDDEN: return asio::buffer(forbidden); case HTTPPayload::NOT_FOUND: return asio::buffer(not_found); case HTTPPayload::INTERNAL_SERVER_ERROR: return asio::buffer(internal_server_error); case HTTPPayload::NOT_IMPLEMENTED: return asio::buffer(not_implemented); case HTTPPayload::BAD_GATEWAY: return asio::buffer(bad_gateway); case HTTPPayload::SERVICE_UNAVAILABLE: return asio::buffer(service_unavailable); default: return asio::buffer(internal_server_error); } } } // namespace status_strings namespace misc_strings { const char name_value_separator[] = { ':', ' ' }; const char crlf[] = { '\r', '\n' }; } // namespace misc_strings namespace stock_replies { const char ok[] = ""; const char json_ok[] = "{status:200,message:\"ok\"}"; const char created[] = "" "Created" "

201 Created

" ""; const char json_created[] = "{status:201,message:\"created\"}"; const char accepted[] = "" "Accepted" "

202 Accepted

" ""; const char json_accepted[] = "{status:202,message:\"accepted\"}"; const char no_content[] = "" "No Content" "

204 Content

" ""; const char json_no_content[] = "{status:204,message:\"no content\"}"; const char multiple_choices[] = "" "Multiple Choices" "

300 Multiple Choices

" ""; const char json_multiple_choices[] = "{status:300,message:\"multiple choices\"}"; const char moved_permanently[] = "" "Moved Permanently" "

301 Moved Permanently

" ""; const char json_moved_permanently[] = "{status:301,message:\"moved permanently\"}"; const char moved_temporarily[] = "" "Moved Temporarily" "

302 Moved Temporarily

" ""; const char json_moved_temporarily[] = "{status:302,message:\"moved temporarily\"}"; const char not_modified[] = "" "Not Modified" "

304 Not Modified

" ""; const char json_not_modified[] = "{status:304,message:\"not modified\"}"; const char bad_request[] = "" "Bad Request" "

400 Bad Request

" ""; const char json_bad_request[] = "{status:400,message:\"bad request\"}"; const char unauthorized[] = "" "Unauthorized" "

401 Unauthorized

" ""; const char json_unauthorized[] = "{status:401,message:\"unauthorized\"}"; const char forbidden[] = "" "Forbidden" "

403 Forbidden

" ""; const char json_forbidden[] = "{status:403,message:\"forbidden\"}"; const char not_found[] = "" "Not Found" "

404 Not Found

" ""; const char json_not_found[] = "{status:404,message:\"not found\"}"; const char internal_server_error[] = "" "Internal Server Error" "

500 Internal Server Error

" ""; const char json_internal_server_error[] = "{status:500,message:\"internal server error\"}"; const char not_implemented[] = "" "Not Implemented" "

501 Not Implemented

" ""; const char json_not_implemented[] = "{status:501,message:\"not implemented\"}"; const char bad_gateway[] = "" "Bad Gateway" "

502 Bad Gateway

" ""; const char json_bad_gateway[] = "{status:502,message:\"bad gateway\"}"; const char service_unavailable[] = "" "Service Unavailable" "

503 Service Unavailable

" ""; const char json_service_unavailable[] = "{status:503,message:\"service unavailable\"}"; std::string to_string(HTTPPayload::StatusType status, std::string contentType) { std::transform(contentType.begin(), contentType.end(), contentType.begin(), ::tolower); if (contentType == "application/json") { switch (status) { case HTTPPayload::OK: return json_ok; case HTTPPayload::CREATED: return json_created; case HTTPPayload::ACCEPTED: return json_accepted; case HTTPPayload::NO_CONTENT: return json_no_content; case HTTPPayload::MULTIPLE_CHOICES: return json_multiple_choices; case HTTPPayload::MOVED_PERMANENTLY: return json_moved_permanently; case HTTPPayload::MOVED_TEMPORARILY: return json_moved_temporarily; case HTTPPayload::NOT_MODIFIED: return json_not_modified; case HTTPPayload::BAD_REQUEST: return json_bad_request; case HTTPPayload::UNAUTHORIZED: return json_unauthorized; case HTTPPayload::FORBIDDEN: return json_forbidden; case HTTPPayload::NOT_FOUND: return json_not_found; case HTTPPayload::INTERNAL_SERVER_ERROR: return json_internal_server_error; case HTTPPayload::NOT_IMPLEMENTED: return json_not_implemented; case HTTPPayload::BAD_GATEWAY: return json_bad_gateway; case HTTPPayload::SERVICE_UNAVAILABLE: return json_service_unavailable; default: return json_internal_server_error; } } else { switch (status) { case HTTPPayload::OK: return ok; case HTTPPayload::CREATED: return created; case HTTPPayload::ACCEPTED: return accepted; case HTTPPayload::NO_CONTENT: return no_content; case HTTPPayload::MULTIPLE_CHOICES: return multiple_choices; case HTTPPayload::MOVED_PERMANENTLY: return moved_permanently; case HTTPPayload::MOVED_TEMPORARILY: return moved_temporarily; case HTTPPayload::NOT_MODIFIED: return not_modified; case HTTPPayload::BAD_REQUEST: return bad_request; case HTTPPayload::UNAUTHORIZED: return unauthorized; case HTTPPayload::FORBIDDEN: return forbidden; case HTTPPayload::NOT_FOUND: return not_found; case HTTPPayload::INTERNAL_SERVER_ERROR: return internal_server_error; case HTTPPayload::NOT_IMPLEMENTED: return not_implemented; case HTTPPayload::BAD_GATEWAY: return bad_gateway; case HTTPPayload::SERVICE_UNAVAILABLE: return service_unavailable; default: return internal_server_error; } } } } // namespace stock_replies // --------------------------------------------------------------------------- // Public Class Members // --------------------------------------------------------------------------- /// /// Convert the reply into a vector of buffers. The buffers do not own the /// underlying memory blocks, therefore the reply object must remain valid and /// not be changed until the write operation has completed. /// std::vector HTTPPayload::toBuffers() { std::vector buffers; if (isClientPayload) { std::stringstream ss; ss << ::strtoupper(method) << " " << uri << " " << HTTP_DEFAULT_VERSION; std::string request = ss.str(); buffers.push_back(asio::buffer(request)); } else { buffers.push_back(status_strings::toBuffer(status)); } for (std::size_t i = 0; i < headers.size(); ++i) { HTTPHeaders::Header& h = headers.m_headers[i]; //::LogDebug(LOG_REST, "HTTPPayload::toBuffers() header = %s, value = %s", h.name.c_str(), h.value.c_str()); buffers.push_back(asio::buffer(h.name)); buffers.push_back(asio::buffer(misc_strings::name_value_separator)); buffers.push_back(asio::buffer(h.value)); buffers.push_back(asio::buffer(misc_strings::crlf)); } buffers.push_back(asio::buffer(misc_strings::crlf)); buffers.push_back(asio::buffer(content)); return buffers; } /// /// /// /// /// void HTTPPayload::payload(json::object obj, HTTPPayload::StatusType s) { json::value v = json::value(obj); std::string json = v.serialize(); payload(json, s, "application/json"); } /// /// /// /// /// /// void HTTPPayload::payload(std::string c, HTTPPayload::StatusType s, std::string contentType) { content = c; status = s; ensureDefaultHeaders(contentType); } // --------------------------------------------------------------------------- // Static Members // --------------------------------------------------------------------------- /// /// Get a status payload. /// /// /// /// HTTPPayload HTTPPayload::requestPayload(std::string method, std::string uri, std::string contentType) { HTTPPayload rep; rep.isClientPayload = true; rep.method = ::strtoupper(method); rep.uri = uri; rep.ensureDefaultHeaders(contentType); return rep; } /// /// Get a status payload. /// /// /// HTTPPayload HTTPPayload::statusPayload(HTTPPayload::StatusType status, const std::string contentType) { HTTPPayload rep; rep.isClientPayload = false; rep.status = status; if (status != HTTPPayload::NO_CONTENT) { rep.content = stock_replies::to_string(status, contentType); rep.ensureDefaultHeaders(contentType); } return rep; } // --------------------------------------------------------------------------- // Private Members // --------------------------------------------------------------------------- /// /// /// /// void HTTPPayload::ensureDefaultHeaders(std::string contentType) { if (!isClientPayload) { headers.add("Content-Type", contentType); headers.add("Content-Length", std::to_string(content.size())); headers.add("Server", std::string((__EXE_NAME__ "/" __VER__))); } else { headers.add("User-Agent", std::string((__EXE_NAME__ "/" __VER__))); headers.add("Accept", "*/*"); if (::strtoupper(method) != HTTP_GET) { headers.add("Content-Type", contentType); headers.add("Content-Length", std::to_string(content.size())); } } //for (auto header : headers.headers()) // ::LogDebug(LOG_REST, "HTTPPayload::ensureDefaultHeaders() header = %s, value = %s", header.name.c_str(), header.value.c_str()); }