forked from boostorg/beast
Vinnie Falco
8b62c23ab6
New classes are introduced to represent HTTP messages and their associated bodies. The parser interface is reworked to use CRTP, error codes, and trait checks. New classes: * basic_headers Models field/value pairs in a HTTP message. * message Models a HTTP message, body behavior defined by template argument. Parsed message carries metadata generated during parsing. * parser Produces parsed messages. * empty_body, string_body, basic_streambuf_body Classes used to represent content bodies in various ways. New functions: * read, async_read, write, async_write Read and write HTTP messages on a socket. New concepts: * Body: Represents the HTTP Content-Body. * Field: A HTTP header field. * FieldSequence: A forward sequence of fields. * Reader: Parses a Body from a stream of bytes. * Writer: Serializes a Body to buffers. basic_parser changes: * add write methods which throw exceptions instead * error_code passed via parameter instead of return value * fold private member calls into existing callbacks * basic_parser uses CRTP instead of virtual members * add documentation on Derived requirements for CRTP impl/http-parser changes: * joyent renamed to nodejs to reflect upstream changes
321 lines
8.8 KiB
C++
321 lines
8.8 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of Beast: https://github.com/vinniefalco/Beast
|
|
Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef BEAST_HTTP_MESSAGE_IPP_INCLUDED
|
|
#define BEAST_HTTP_MESSAGE_IPP_INCLUDED
|
|
|
|
#include <beast/http/chunk_encode.h>
|
|
#include <beast/http/type_check.h>
|
|
#include <beast/http/detail/writes.h>
|
|
#include <beast/http/detail/write_preparation.h>
|
|
#include <beast/http/rfc2616.h>
|
|
#include <boost/asio/buffer.hpp>
|
|
#include <condition_variable>
|
|
#include <mutex>
|
|
|
|
namespace beast {
|
|
namespace http {
|
|
|
|
template<bool isRequest, class Body, class Headers>
|
|
message<isRequest, Body, Headers>::
|
|
message()
|
|
{
|
|
static_assert(is_Body<Body>::value,
|
|
"Body requirements not met");
|
|
}
|
|
|
|
template<bool isRequest, class Body, class Headers>
|
|
message<isRequest, Body, Headers>::
|
|
message(request_params params)
|
|
{
|
|
static_assert(is_Body<Body>::value,
|
|
"Body requirements not met");
|
|
static_assert(isRequest, "message is not a request");
|
|
this->method = params.method;
|
|
this->url = std::move(params.url);
|
|
version = params.version;
|
|
}
|
|
|
|
template<bool isRequest, class Body, class Headers>
|
|
message<isRequest, Body, Headers>::
|
|
message(response_params params)
|
|
{
|
|
static_assert(is_Body<Body>::value,
|
|
"Body requirements not met");
|
|
static_assert(! isRequest, "message is not a response");
|
|
this->status = params.status;
|
|
this->reason = std::move(params.reason);
|
|
version = params.version;
|
|
}
|
|
|
|
template<bool isRequest, class Body, class Headers>
|
|
template<class Streambuf>
|
|
void
|
|
message<isRequest, Body, Headers>::
|
|
write_firstline(Streambuf& streambuf,
|
|
std::true_type) const
|
|
{
|
|
detail::write(streambuf, to_string(this->method));
|
|
detail::write(streambuf, " ");
|
|
detail::write(streambuf, this->url);
|
|
switch(version)
|
|
{
|
|
case 10:
|
|
detail::write(streambuf, " HTTP/1.0\r\n");
|
|
break;
|
|
case 11:
|
|
detail::write(streambuf, " HTTP/1.1\r\n");
|
|
break;
|
|
default:
|
|
detail::write(streambuf, " HTTP/");
|
|
detail::write(streambuf, version / 10);
|
|
detail::write(streambuf, ".");
|
|
detail::write(streambuf, version % 10);
|
|
detail::write(streambuf, "\r\n");
|
|
break;
|
|
}
|
|
}
|
|
|
|
template<bool isRequest, class Body, class Headers>
|
|
template<class Streambuf>
|
|
void
|
|
message<isRequest, Body, Headers>::
|
|
write_firstline(Streambuf& streambuf,
|
|
std::false_type) const
|
|
{
|
|
switch(version)
|
|
{
|
|
case 10:
|
|
detail::write(streambuf, "HTTP/1.0 ");
|
|
break;
|
|
case 11:
|
|
detail::write(streambuf, "HTTP/1.1 ");
|
|
break;
|
|
default:
|
|
detail::write(streambuf, " HTTP/");
|
|
detail::write(streambuf, version / 10);
|
|
detail::write(streambuf, ".");
|
|
detail::write(streambuf, version % 10);
|
|
detail::write(streambuf, " ");
|
|
break;
|
|
}
|
|
detail::write(streambuf, this->status);
|
|
detail::write(streambuf, " ");
|
|
detail::write(streambuf, this->reason);
|
|
detail::write(streambuf, "\r\n");
|
|
}
|
|
|
|
namespace detail {
|
|
|
|
template<class ConstBufferSequence>
|
|
std::string
|
|
buffers_to_string(ConstBufferSequence const& buffers)
|
|
{
|
|
using boost::asio::buffer_cast;
|
|
using boost::asio::buffer_size;
|
|
std::string s;
|
|
s.reserve(buffer_size(buffers));
|
|
for(auto const& b : buffers)
|
|
s.append(buffer_cast<char const*>(b),
|
|
buffer_size(b));
|
|
return s;
|
|
}
|
|
|
|
} // detail
|
|
|
|
// Diagnostic output only
|
|
template<bool isRequest, class Body, class Headers>
|
|
std::ostream&
|
|
operator<<(std::ostream& os,
|
|
message<isRequest, Body, Headers> const& msg)
|
|
{
|
|
static_assert(is_WritableBody<Body>::value,
|
|
"WritableBody requirements not met");
|
|
error_code ec;
|
|
detail::write_preparation<isRequest, Body, Headers> wp(msg);
|
|
wp.init(ec);
|
|
if(ec)
|
|
return os;
|
|
std::mutex m;
|
|
std::condition_variable cv;
|
|
bool ready = false;
|
|
resume_context resume{
|
|
[&]
|
|
{
|
|
std::lock_guard<std::mutex> lock(m);
|
|
ready = true;
|
|
cv.notify_one();
|
|
}};
|
|
auto copy = resume;
|
|
os << detail::buffers_to_string(wp.sb.data());
|
|
wp.sb.consume(wp.sb.size());
|
|
auto writef =
|
|
[&os, &wp](auto const& buffers)
|
|
{
|
|
if(wp.chunked)
|
|
os << detail::buffers_to_string(
|
|
chunk_encode(buffers));
|
|
else
|
|
os << detail::buffers_to_string(
|
|
buffers);
|
|
};
|
|
for(;;)
|
|
{
|
|
{
|
|
auto result = wp.w(std::move(copy), ec, writef);
|
|
if(ec)
|
|
return os;
|
|
if(result)
|
|
break;
|
|
if(boost::indeterminate(result))
|
|
{
|
|
copy = resume;
|
|
std::unique_lock<std::mutex> lock(m);
|
|
cv.wait(lock, [&]{ return ready; });
|
|
ready = false;
|
|
}
|
|
}
|
|
wp.sb.consume(wp.sb.size());
|
|
for(;;)
|
|
{
|
|
auto result = wp.w(std::move(copy), ec, writef);
|
|
if(ec)
|
|
return os;
|
|
if(result)
|
|
break;
|
|
if(boost::indeterminate(result))
|
|
{
|
|
copy = resume;
|
|
std::unique_lock<std::mutex> lock(m);
|
|
cv.wait(lock, [&]{ return ready; });
|
|
ready = false;
|
|
}
|
|
}
|
|
}
|
|
if(wp.chunked)
|
|
{
|
|
// VFALCO Unfortunately the current interface to the
|
|
// Writer concept prevents us from using coalescing the
|
|
// final body chunk with the final chunk delimiter.
|
|
//
|
|
// write final chunk
|
|
os << detail::buffers_to_string(chunk_encode_final());
|
|
if(ec)
|
|
return os;
|
|
}
|
|
os << std::endl;
|
|
return os;
|
|
}
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
template<bool isRequest, class Body, class Headers>
|
|
void
|
|
set_connection(bool keep_alive,
|
|
message<isRequest, Body, Headers>& req)
|
|
{
|
|
if(req.version >= 11)
|
|
{
|
|
if(! keep_alive)
|
|
req.headers.replace("Connection", "close");
|
|
else
|
|
req.headers.erase("Connection");
|
|
}
|
|
else
|
|
{
|
|
if(keep_alive)
|
|
req.headers.replace("Connection", "keep-alive");
|
|
else
|
|
req.headers.erase("Connection");
|
|
}
|
|
}
|
|
|
|
template<class Body, class Headers,
|
|
class OtherBody, class OtherAllocator>
|
|
void
|
|
set_connection(bool keep_alive,
|
|
message<false, Body, Headers>& resp,
|
|
message<true, OtherBody, OtherAllocator> const& req)
|
|
{
|
|
if(req.version >= 11)
|
|
{
|
|
if(rfc2616::token_in_list(req["Connection"], "close"))
|
|
keep_alive = false;
|
|
}
|
|
else
|
|
{
|
|
if(! rfc2616::token_in_list(req["Connection"], "keep-alive"))
|
|
keep_alive = false;
|
|
}
|
|
set_connection(keep_alive, resp);
|
|
}
|
|
|
|
template<class Streambuf, class FieldSequence>
|
|
void
|
|
write_fields(Streambuf& streambuf, FieldSequence const& fields)
|
|
{
|
|
static_assert(is_Streambuf<Streambuf>::value,
|
|
"Streambuf requirements not met");
|
|
//static_assert(is_FieldSequence<FieldSequence>::value,
|
|
// "FieldSequence requirements not met");
|
|
for(auto const& field : fields)
|
|
{
|
|
detail::write(streambuf, field.name());
|
|
detail::write(streambuf, ": ");
|
|
detail::write(streambuf, field.value());
|
|
detail::write(streambuf, "\r\n");
|
|
}
|
|
}
|
|
|
|
template<bool isRequest, class Body, class Headers>
|
|
bool
|
|
is_keep_alive(message<isRequest, Body, Headers> const& msg)
|
|
{
|
|
if(msg.version >= 11)
|
|
{
|
|
if(rfc2616::token_in_list(
|
|
msg.headers["Connection"], "close"))
|
|
return false;
|
|
return true;
|
|
}
|
|
if(rfc2616::token_in_list(
|
|
msg.headers["Connection"], "keep-alive"))
|
|
return true;
|
|
return false;
|
|
}
|
|
|
|
template<bool isRequest, class Body, class Headers>
|
|
bool
|
|
is_upgrade(message<isRequest, Body, Headers> const& msg)
|
|
{
|
|
if(msg.version < 11)
|
|
return false;
|
|
if(rfc2616::token_in_list(
|
|
msg.headers["Connection"], "upgrade"))
|
|
return true;
|
|
return false;
|
|
}
|
|
|
|
} // http
|
|
} // beast
|
|
|
|
#include <beast/http/impl/message.ipp>
|
|
|
|
#endif
|