boost_beast/include/beast/websocket/impl/accept.ipp

//
// Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//

#ifndef BEAST_WEBSOCKET_IMPL_ACCEPT_IPP
#define BEAST_WEBSOCKET_IMPL_ACCEPT_IPP

#include <beast/websocket/detail/type_traits.hpp>
#include <beast/http/message.hpp>
#include <beast/http/header_parser.hpp>
#include <beast/http/read.hpp>
#include <beast/http/string_body.hpp>
#include <beast/http/write.hpp>
#include <beast/core/handler_helpers.hpp>
#include <beast/core/handler_ptr.hpp>
#include <beast/core/prepare_buffers.hpp>
#include <beast/core/detail/type_traits.hpp>
#include <boost/assert.hpp>
#include <memory>
#include <type_traits>

namespace beast {
namespace websocket {

//------------------------------------------------------------------------------

// Respond to an upgrade HTTP request
template<class NextLayer>
template<class Handler>
class stream<NextLayer>::response_op
{
    struct data
    {
        bool cont;
        stream<NextLayer>& ws;
        http::response_header res;
        int state = 0;

        template<class Fields, class Decorator>
        data(Handler&, stream<NextLayer>& ws_,
            http::header<true, Fields> const& req,
                Decorator const& decorator,
                    bool cont_)
            : cont(cont_)
            , ws(ws_)
            , res(ws_.build_response(req, decorator))
        {
        }

        template<class Fields,
            class Buffers, class Decorator>
        data(Handler&, stream<NextLayer>& ws_,
            http::header<true, Fields> const& req,
                Buffers const& buffers,
                    Decorator const& decorator,
                        bool cont_)
            : cont(cont_)
            , ws(ws_)
            , res(ws_.build_response(req, decorator))
        {
            using boost::asio::buffer_copy;
            using boost::asio::buffer_size;
            // VFALCO What about catch(std::length_error const&)?
            ws.stream_.buffer().commit(buffer_copy(
                ws.stream_.buffer().prepare(
                    buffer_size(buffers)), buffers));
        }
    };

    handler_ptr<data, Handler> d_;

public:
    response_op(response_op&&) = default;
    response_op(response_op const&) = default;

    template<class DeducedHandler, class... Args>
    response_op(DeducedHandler&& h,
            stream<NextLayer>& ws, Args&&... args)
        : d_(std::forward<DeducedHandler>(h),
            ws, std::forward<Args>(args)...)
    {
        (*this)(error_code{}, false);
    }

    void operator()(
        error_code ec, bool again = true);

    friend
    void* asio_handler_allocate(
        std::size_t size, response_op* op)
    {
        return beast_asio_helpers::
            allocate(size, op->d_.handler());
    }

    friend
    void asio_handler_deallocate(
        void* p, std::size_t size, response_op* op)
    {
        return beast_asio_helpers::
            deallocate(p, size, op->d_.handler());
    }

    friend
    bool asio_handler_is_continuation(response_op* op)
    {
        return op->d_->cont;
    }

    template<class Function>
    friend
    void asio_handler_invoke(Function&& f, response_op* op)
    {
        return beast_asio_helpers::
            invoke(f, op->d_.handler());
    }
};

template<class NextLayer>
template<class Handler>
void
stream<NextLayer>::response_op<Handler>::
operator()(error_code ec, bool again)
{
    auto& d = *d_;
    d.cont = d.cont || again;
    while(! ec && d.state != 99)
    {
        switch(d.state)
        {
        case 0:
            // send response
            d.state = 1;
            http::async_write(d.ws.next_layer(),
                d.res, std::move(*this));
            return;

        // sent response
        case 1:
            d.state = 99;
            if(d.res.status != 101)
                ec = error::handshake_failed;
            if(! ec)
            {
                pmd_read(
                    d.ws.pmd_config_, d.res.fields);
                d.ws.open(detail::role_type::server);
            }
            break;
        }
    }
    d_.invoke(ec);
}

//------------------------------------------------------------------------------

// read and respond to an upgrade request
//
template<class NextLayer>
template<class Decorator, class Handler>
class stream<NextLayer>::accept_op
{
    struct data
    {
        bool cont;
        stream<NextLayer>& ws;
        Decorator decorator;
        http::header_parser<true, http::fields> p;
        int state = 0;

        data(Handler& handler, stream<NextLayer>& ws_,
                Decorator const& decorator_)
            : cont(beast_asio_helpers::is_continuation(handler))
            , ws(ws_)
            , decorator(decorator_)
        {
        }

        template<class Buffers>
        data(Handler& handler, stream<NextLayer>& ws_,
                Buffers const& buffers,
                    Decorator const& decorator_)
            : cont(beast_asio_helpers::is_continuation(handler))
            , ws(ws_)
            , decorator(decorator_)
        {
            using boost::asio::buffer_copy;
            using boost::asio::buffer_size;
            // VFALCO What about catch(std::length_error const&)?
            ws.stream_.buffer().commit(buffer_copy(
                ws.stream_.buffer().prepare(
                    buffer_size(buffers)), buffers));
        }
    };

    handler_ptr<data, Handler> d_;

public:
    accept_op(accept_op&&) = default;
    accept_op(accept_op const&) = default;

    template<class DeducedHandler, class... Args>
    accept_op(DeducedHandler&& h,
            stream<NextLayer>& ws, Args&&... args)
        : d_(std::forward<DeducedHandler>(h),
            ws, std::forward<Args>(args)...)
    {
        (*this)(error_code{}, 0, false);
    }

    void operator()(error_code ec,
        std::size_t bytes_used, bool again = true);

    friend
    void* asio_handler_allocate(
        std::size_t size, accept_op* op)
    {
        return beast_asio_helpers::
            allocate(size, op->d_.handler());
    }

    friend
    void asio_handler_deallocate(
        void* p, std::size_t size, accept_op* op)
    {
        return beast_asio_helpers::
            deallocate(p, size, op->d_.handler());
    }

    friend
    bool asio_handler_is_continuation(accept_op* op)
    {
        return op->d_->cont;
    }

    template<class Function>
    friend
    void asio_handler_invoke(Function&& f, accept_op* op)
    {
        return beast_asio_helpers::
            invoke(f, op->d_.handler());
    }
};

template<class NextLayer>
template<class Decorator, class Handler>
void
stream<NextLayer>::accept_op<Decorator, Handler>::
operator()(error_code ec,
    std::size_t bytes_used, bool again)
{
    auto& d = *d_;
    d.cont = d.cont || again;
    if(ec)
        goto upcall;
    switch(d.state)
    {
    case 0:
        // read message
        d.state = 1;
        http::async_read_some(d.ws.next_layer(),
            d.ws.stream_.buffer(), d.p,
                std::move(*this));
        return;

    case 1:
    {
        BOOST_ASSERT(d.p.got_header());
        d.ws.stream_.buffer().consume(bytes_used);
        // Arguments from our state must be
        // moved to the stack before releasing
        // the handler.
        auto& ws = d.ws;
        auto const req = d.p.release();
        auto const decorator = d.decorator;
    #if 1
        response_op<Handler>{
            d_.release_handler(),
                ws, req, decorator, true};
    #else
        // VFALCO This *should* work but breaks
        //        coroutine invariants in the unit test.
        //        Also it calls reset() when it shouldn't.
        ws.async_accept_ex(
            req, decorator, d_.release_handler());
    #endif
        return;
    }
    }
upcall:
    d_.invoke(ec);
}

//------------------------------------------------------------------------------

template<class NextLayer>
void
stream<NextLayer>::
accept()
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    error_code ec;
    accept(ec);
    if(ec)
        throw system_error{ec};
}

template<class NextLayer>
template<class ResponseDecorator>
void
stream<NextLayer>::
accept_ex(ResponseDecorator const& decorator)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    error_code ec;
    accept_ex(decorator, ec);
    if(ec)
        throw system_error{ec};
}

template<class NextLayer>
void
stream<NextLayer>::
accept(error_code& ec)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    reset();
    do_accept(&default_decorate_res, ec);
}

template<class NextLayer>
template<class ResponseDecorator>
void
stream<NextLayer>::
accept_ex(ResponseDecorator const& decorator, error_code& ec)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    reset();
    do_accept(decorator, ec);
}

template<class NextLayer>
template<class ConstBufferSequence>
void
stream<NextLayer>::
accept(ConstBufferSequence const& buffers)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    error_code ec;
    accept(buffers, ec);
    if(ec)
        throw system_error{ec};
}

template<class NextLayer>
template<
    class ConstBufferSequence, class ResponseDecorator>
void
stream<NextLayer>::
accept_ex(ConstBufferSequence const& buffers,
    ResponseDecorator const &decorator)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    error_code ec;
    accept_ex(buffers, decorator, ec);
    if(ec)
        throw system_error{ec};
}

template<class NextLayer>
template<class ConstBufferSequence>
void
stream<NextLayer>::
accept(ConstBufferSequence const& buffers, error_code& ec)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    reset();
    using boost::asio::buffer_copy;
    using boost::asio::buffer_size;
    stream_.buffer().commit(buffer_copy(
        stream_.buffer().prepare(
            buffer_size(buffers)), buffers));
    do_accept(&default_decorate_res, ec);
}

template<class NextLayer>
template<
    class ConstBufferSequence, class ResponseDecorator>
void
stream<NextLayer>::
accept_ex(ConstBufferSequence const& buffers,
    ResponseDecorator const& decorator, error_code& ec)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    reset();
    using boost::asio::buffer_copy;
    using boost::asio::buffer_size;
    stream_.buffer().commit(buffer_copy(
        stream_.buffer().prepare(
            buffer_size(buffers)), buffers));
    do_accept(decorator, ec);
}

template<class NextLayer>
template<class Fields>
void
stream<NextLayer>::
accept(http::header<true, Fields> const& req)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    error_code ec;
    accept(req, ec);
    if(ec)
        throw system_error{ec};
}

template<class NextLayer>
template<class Fields, class ResponseDecorator>
void
stream<NextLayer>::
accept_ex(http::header<true, Fields> const& req,
    ResponseDecorator const& decorator)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    error_code ec;
    accept_ex(req, decorator, ec);
    if(ec)
        throw system_error{ec};
}

template<class NextLayer>
template<class Fields>
void
stream<NextLayer>::
accept(http::header<true, Fields> const& req,
    error_code& ec)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    reset();
    do_accept(req, &default_decorate_res, ec);
}

template<class NextLayer>
template<class Fields, class ResponseDecorator>
void
stream<NextLayer>::
accept_ex(http::header<true, Fields> const& req,
    ResponseDecorator const& decorator, error_code& ec)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    reset();
    do_accept(req, decorator, ec);
}

template<class NextLayer>
template<class Fields, class ConstBufferSequence>
void
stream<NextLayer>::
accept(http::header<true, Fields> const& req,
    ConstBufferSequence const& buffers)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    error_code ec;
    accept(req, buffers, ec);
    if(ec)
        throw system_error{ec};
}

template<class NextLayer>
template<class Fields,
    class ConstBufferSequence, class ResponseDecorator>
void
stream<NextLayer>::
accept_ex(http::header<true, Fields> const& req,
    ConstBufferSequence const& buffers,
        ResponseDecorator const& decorator)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    error_code ec;
    accept_ex(req, buffers, decorator, ec);
    if(ec)
        throw system_error{ec};
}

template<class NextLayer>
template<class Fields, class ConstBufferSequence>
void
stream<NextLayer>::
accept(http::header<true, Fields> const& req,
    ConstBufferSequence const& buffers, error_code& ec)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    reset();
    using boost::asio::buffer_copy;
    using boost::asio::buffer_size;
    stream_.buffer().commit(buffer_copy(
        stream_.buffer().prepare(
            buffer_size(buffers)), buffers));
    do_accept(req, &default_decorate_res, ec);
}

template<class NextLayer>
template<class Fields,
    class ConstBufferSequence, class ResponseDecorator>
void
stream<NextLayer>::
accept_ex(http::header<true, Fields> const& req,
    ConstBufferSequence const& buffers,
        ResponseDecorator const& decorator,
            error_code& ec)
{
    static_assert(is_SyncStream<next_layer_type>::value,
        "SyncStream requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    reset();
    using boost::asio::buffer_copy;
    using boost::asio::buffer_size;
    stream_.buffer().commit(buffer_copy(
        stream_.buffer().prepare(
            buffer_size(buffers)), buffers));
    do_accept(req, decorator, ec);
}

//------------------------------------------------------------------------------

template<class NextLayer>
template<class AcceptHandler>
typename async_completion<AcceptHandler,
    void(error_code)>::result_type
stream<NextLayer>::
async_accept(AcceptHandler&& handler)
{
    static_assert(is_AsyncStream<next_layer_type>::value,
        "AsyncStream requirements requirements not met");
    beast::async_completion<AcceptHandler,
        void(error_code)> completion{handler};
    reset();
    accept_op<decltype(&default_decorate_res),
        decltype(completion.handler)>{completion.handler,
            *this, &default_decorate_res};
    return completion.result.get();
}

template<class NextLayer>
template<class ResponseDecorator, class AcceptHandler>
typename async_completion<AcceptHandler,
    void(error_code)>::result_type
stream<NextLayer>::
async_accept_ex(ResponseDecorator const& decorator,
    AcceptHandler&& handler)
{
    static_assert(is_AsyncStream<next_layer_type>::value,
        "AsyncStream requirements requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    beast::async_completion<AcceptHandler,
        void(error_code)> completion{handler};
    reset();
    accept_op<ResponseDecorator, decltype(completion.handler)>{
        completion.handler, *this, decorator};
    return completion.result.get();
}

template<class NextLayer>
template<class ConstBufferSequence, class AcceptHandler>
typename async_completion<AcceptHandler,
    void(error_code)>::result_type
stream<NextLayer>::
async_accept(ConstBufferSequence const& buffers,
    AcceptHandler&& handler)
{
    static_assert(is_AsyncStream<next_layer_type>::value,
        "AsyncStream requirements requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    beast::async_completion<AcceptHandler,
        void(error_code)> completion{handler};
    reset();
    accept_op<decltype(&default_decorate_res),
        decltype(completion.handler)>{completion.handler,
        *this, buffers, &default_decorate_res};
    return completion.result.get();
}

template<class NextLayer>
template<class ConstBufferSequence,
    class ResponseDecorator, class AcceptHandler>
typename async_completion<AcceptHandler,
    void(error_code)>::result_type
stream<NextLayer>::
async_accept_ex(ConstBufferSequence const& buffers,
    ResponseDecorator const& decorator,
        AcceptHandler&& handler)
{
    static_assert(is_AsyncStream<next_layer_type>::value,
        "AsyncStream requirements requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    beast::async_completion<AcceptHandler,
        void(error_code)> completion{handler};
    reset();
    accept_op<ResponseDecorator, decltype(completion.handler)>{
        completion.handler, *this, buffers, decorator};
    return completion.result.get();
}

template<class NextLayer>
template<class Fields, class AcceptHandler>
typename async_completion<AcceptHandler,
    void(error_code)>::result_type
stream<NextLayer>::
async_accept(http::header<true, Fields> const& req,
    AcceptHandler&& handler)
{
    static_assert(is_AsyncStream<next_layer_type>::value,
        "AsyncStream requirements requirements not met");
    beast::async_completion<AcceptHandler,
        void(error_code)> completion{handler};
    reset();
    response_op<decltype(completion.handler)>{
        completion.handler, *this, req,
            &default_decorate_res, beast_asio_helpers::
                is_continuation(completion.handler)};
    return completion.result.get();
}

template<class NextLayer>
template<class Fields,
    class ResponseDecorator, class AcceptHandler>
typename async_completion<AcceptHandler,
    void(error_code)>::result_type
stream<NextLayer>::
async_accept_ex(http::header<true, Fields> const& req,
    ResponseDecorator const& decorator, AcceptHandler&& handler)
{
    static_assert(is_AsyncStream<next_layer_type>::value,
        "AsyncStream requirements requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    beast::async_completion<AcceptHandler,
        void(error_code)> completion{handler};
    reset();
    response_op<decltype(completion.handler)>{
        completion.handler, *this, req, decorator,
            beast_asio_helpers::is_continuation(
                completion.handler)};
    return completion.result.get();
}

template<class NextLayer>
template<class Fields,
    class ConstBufferSequence, class AcceptHandler>
typename async_completion<AcceptHandler,
    void(error_code)>::result_type
stream<NextLayer>::
async_accept(http::header<true, Fields> const& req,
    ConstBufferSequence const& buffers,
        AcceptHandler&& handler)
{
    static_assert(is_AsyncStream<next_layer_type>::value,
        "AsyncStream requirements requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    beast::async_completion<AcceptHandler,
        void(error_code)> completion{handler};
    reset();
    response_op<decltype(completion.handler)>{
        completion.handler, *this, req, buffers,
            &default_decorate_res, beast_asio_helpers::
                    is_continuation(completion.handler)};
    return completion.result.get();
}

template<class NextLayer>
template<class Fields, class ConstBufferSequence,
    class ResponseDecorator, class AcceptHandler>
typename async_completion<AcceptHandler,
    void(error_code)>::result_type
stream<NextLayer>::
async_accept_ex(http::header<true, Fields> const& req,
    ConstBufferSequence const& buffers,
        ResponseDecorator const& decorator,
            AcceptHandler&& handler)
{
    static_assert(is_AsyncStream<next_layer_type>::value,
        "AsyncStream requirements requirements not met");
    static_assert(is_ConstBufferSequence<
        ConstBufferSequence>::value,
            "ConstBufferSequence requirements not met");
    static_assert(detail::is_ResponseDecorator<
        ResponseDecorator>::value,
            "ResponseDecorator requirements not met");
    beast::async_completion<AcceptHandler,
        void(error_code)> completion{handler};
    reset();
    response_op<decltype(completion.handler)>{
        completion.handler, *this, req, buffers, decorator,
            beast_asio_helpers::is_continuation(
                completion.handler)};
    return completion.result.get();
}

} // websocket
} // beast

#endif