Crow/include/crow/http_response.h

258 lines
7.6 KiB
C
Raw Normal View History

2014-04-01 12:25:16 +00:00
#pragma once
#include <string>
#include <unordered_map>
#include <ios>
#include <fstream>
#include <sstream>
#include <sys/stat.h>
#include "crow/http_request.h"
#include "crow/ci_map.h"
#include "crow/socket_adaptors.h"
#include "crow/logging.h"
#include "crow/mime_types.h"
#include "crow/returnable.h"
2020-11-13 05:42:02 +00:00
2014-04-26 17:19:59 +00:00
namespace crow
2014-04-01 12:25:16 +00:00
{
template<typename Adaptor, typename Handler, typename... Middlewares>
class Connection;
/// HTTP response
2014-04-01 12:25:16 +00:00
struct response
{
template<typename Adaptor, typename Handler, typename... Middlewares>
friend class crow::Connection;
int code{200}; ///< The Status code for the response.
std::string body; ///< The actual payload containing the response data.
ci_map headers; ///< HTTP headers.
#ifdef CROW_ENABLE_COMPRESSION
bool compressed = true; ///< If compression is enabled and this is false, the individual response will not be compressed.
#endif
bool is_head_response = false; ///< Whether this is a response to a HEAD request.
bool manual_length_header = false; ///< Whether Crow should automatically add a "Content-Length" header.
/// Set the value of an existing header in the response.
void set_header(std::string key, std::string value)
{
headers.erase(key);
headers.emplace(std::move(key), std::move(value));
}
/// Add a new header to the response.
void add_header(std::string key, std::string value)
{
headers.emplace(std::move(key), std::move(value));
}
const std::string& get_header_value(const std::string& key)
{
return crow::get_header_value(headers, key);
}
// clang-format off
2014-04-01 12:25:16 +00:00
response() {}
explicit response(int code) : code(code) {}
response(std::string body) : body(std::move(body)) {}
response(int code, std::string body) : code(code), body(std::move(body)) {}
// clang-format on
response(returnable&& value)
{
body = value.dump();
set_header("Content-Type", value.content_type);
}
response(returnable& value)
{
body = value.dump();
set_header("Content-Type", value.content_type);
}
response(int code, returnable& value):
code(code)
{
body = value.dump();
set_header("Content-Type", value.content_type);
}
2014-04-17 14:06:41 +00:00
response(response&& r)
{
*this = std::move(r);
}
response(std::string contentType, std::string body):
body(std::move(body))
2021-08-29 06:49:18 +00:00
{
set_header("Content-Type", mime_types.at(contentType));
2021-08-29 06:49:18 +00:00
}
response(int code, std::string contentType, std::string body):
code(code), body(std::move(body))
{
set_header("Content-Type", mime_types.at(contentType));
}
response& operator=(const response& r) = delete;
response& operator=(response&& r) noexcept
2014-04-17 14:06:41 +00:00
{
body = std::move(r.body);
code = r.code;
headers = std::move(r.headers);
2015-02-20 03:00:15 +00:00
completed_ = r.completed_;
file_info = std::move(r.file_info);
2014-04-17 14:06:41 +00:00
return *this;
}
/// Check if the response has completed (whether response.end() has been called)
2014-09-06 19:30:53 +00:00
bool is_completed() const noexcept
{
return completed_;
}
void clear()
{
body.clear();
code = 200;
headers.clear();
completed_ = false;
2021-02-12 12:21:59 +00:00
file_info = static_file_info{};
}
/// Return a "Temporary Redirect" response.
///
/// Location can either be a route or a full URL.
2016-10-03 13:32:16 +00:00
void redirect(const std::string& location)
{
code = 307;
set_header("Location", location);
}
/// Return a "Permanent Redirect" response.
///
/// Location can either be a route or a full URL.
void redirect_perm(const std::string& location)
{
code = 308;
set_header("Location", location);
}
/// Return a "Found (Moved Temporarily)" response.
///
/// Location can either be a route or a full URL.
void moved(const std::string& location)
{
code = 302;
set_header("Location", location);
}
/// Return a "Moved Permanently" response.
///
/// Location can either be a route or a full URL.
void moved_perm(const std::string& location)
2016-10-03 13:32:16 +00:00
{
code = 301;
set_header("Location", location);
}
void write(const std::string& body_part)
{
body += body_part;
}
/// Set the response completion flag and call the handler (to send the response).
void end()
{
if (!completed_)
{
completed_ = true;
if (is_head_response)
{
set_header("Content-Length", std::to_string(body.size()));
body = "";
manual_length_header = true;
}
if (complete_request_handler_)
{
complete_request_handler_();
}
}
}
/// Same as end() except it adds a body part right before ending.
void end(const std::string& body_part)
{
body += body_part;
end();
}
/// Check if the connection is still alive (usually by checking the socket status).
2014-08-06 16:18:33 +00:00
bool is_alive()
{
return is_alive_helper_ && is_alive_helper_();
}
/// Check whether the response has a static file defined.
bool is_static_type()
{
return file_info.path.size();
}
/// This constains metadata (coming from the `stat` command) related to any static files associated with this response.
///
/// Either a static file or a string body can be returned as 1 response.
struct static_file_info
{
std::string path = "";
struct stat statbuf;
int statResult;
};
///Return a static file as the response body
void set_static_file_info(std::string path)
{
utility::sanitize_filename(path);
file_info.path = path;
file_info.statResult = stat(file_info.path.c_str(), &file_info.statbuf);
#ifdef CROW_ENABLE_COMPRESSION
2021-01-21 03:46:54 +00:00
compressed = false;
#endif
if (file_info.statResult == 0)
{
std::size_t last_dot = path.find_last_of(".");
std::string extension = path.substr(last_dot + 1);
std::string mimeType = "";
code = 200;
this->add_header("Content-length", std::to_string(file_info.statbuf.st_size));
if (extension != "")
{
mimeType = mime_types.at(extension);
if (mimeType != "")
this->add_header("Content-Type", mimeType);
else
this->add_header("content-Type", "text/plain");
}
}
else
{
code = 404;
file_info.path.clear();
this->end();
}
}
private:
bool completed_{};
std::function<void()> complete_request_handler_;
std::function<bool()> is_alive_helper_;
static_file_info file_info;
2014-04-01 12:25:16 +00:00
};
} // namespace crow