boost_beast/include/boost/beast/websocket/impl/close.hpp

//
// Copyright (c) 2016-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)
//
// Official repository: https://github.com/boostorg/beast
//

#ifndef BOOST_BEAST_WEBSOCKET_IMPL_CLOSE_HPP
#define BOOST_BEAST_WEBSOCKET_IMPL_CLOSE_HPP

#include <boost/beast/websocket/teardown.hpp>
#include <boost/beast/websocket/detail/mask.hpp>
#include <boost/beast/core/async_op_base.hpp>
#include <boost/beast/core/flat_static_buffer.hpp>
#include <boost/beast/core/stream_traits.hpp>
#include <boost/beast/core/detail/config.hpp>
#include <boost/asio/coroutine.hpp>
#include <boost/asio/post.hpp>
#include <boost/throw_exception.hpp>
#include <memory>

namespace boost {
namespace beast {
namespace websocket {

/*  Close the WebSocket Connection

    This composed operation sends the close frame if it hasn't already
    been sent, then reads and discards frames until receiving a close
    frame. Finally it invokes the teardown operation to shut down the
    underlying connection.
*/
template<class NextLayer, bool deflateSupported>
template<class Handler>
class stream<NextLayer, deflateSupported>::close_op
    : public beast::stable_async_op_base<
        Handler, beast::executor_type<stream>>
    , public net::coroutine
{
    struct state
    {
        stream<NextLayer, deflateSupported>& ws;
        detail::frame_buffer fb;
        error_code ev;
        bool cont = false;

        state(
            stream<NextLayer, deflateSupported>& ws_,
            close_reason const& cr)
            : ws(ws_)
        {
            // Serialize the close frame
            ws.template write_close<
                flat_static_buffer_base>(fb, cr);
        }
    };

    state& d_;

public:
    static constexpr int id = 4; // for soft_mutex

    template<class Handler_>
    close_op(
        Handler_&& h,
        stream<NextLayer, deflateSupported>& ws,
        close_reason const& cr)
        : stable_async_op_base<
            Handler, beast::executor_type<stream>>(
                std::forward<Handler_>(h), ws.get_executor())
        , d_(beast::allocate_stable<state>(
            *this, ws, cr))
    {
    }

    void
    operator()(
        error_code ec = {},
        std::size_t bytes_transferred = 0,
        bool cont = true)
    {
        using beast::detail::clamp;
        d_.cont = cont;
        BOOST_ASIO_CORO_REENTER(*this)
        {
            // Attempt to acquire write block
            if(! d_.ws.impl_->wr_block.try_lock(this))
            {
                // Suspend
                BOOST_ASIO_CORO_YIELD
                d_.ws.impl_->paused_close.emplace(std::move(*this));

                // Acquire the write block
                d_.ws.impl_->wr_block.lock(this);

                // Resume
                BOOST_ASIO_CORO_YIELD
                net::post(
                    d_.ws.get_executor(), std::move(*this));
                BOOST_ASSERT(d_.ws.impl_->wr_block.is_locked(this));
            }

            // Make sure the stream is open
            if(! d_.ws.impl_->check_open(ec))
                goto upcall;

            // Can't call close twice
            BOOST_ASSERT(! d_.ws.impl_->wr_close);

            // Change status to closing
            BOOST_ASSERT(d_.ws.impl_->status_ == status::open);
            d_.ws.impl_->status_ = status::closing;

            // Send close frame
            d_.ws.impl_->wr_close = true;
            BOOST_ASIO_CORO_YIELD
            net::async_write(d_.ws.impl_->stream,
                d_.fb.data(), std::move(*this));
            if(! d_.ws.impl_->check_ok(ec))
                goto upcall;

            if(d_.ws.impl_->rd_close)
            {
                // This happens when the read_op gets a close frame
                // at the same time close_op is sending the close frame.
                // The read_op will be suspended on the write block.
                goto teardown;
            }

            // Maybe suspend
            if(! d_.ws.impl_->rd_block.try_lock(this))
            {
                // Suspend
                BOOST_ASIO_CORO_YIELD
                d_.ws.impl_->paused_r_close.emplace(std::move(*this));

                // Acquire the read block
                d_.ws.impl_->rd_block.lock(this);

                // Resume
                BOOST_ASIO_CORO_YIELD
                net::post(
                    d_.ws.get_executor(), std::move(*this));
                BOOST_ASSERT(d_.ws.impl_->rd_block.is_locked(this));

                // Make sure the stream is open
                BOOST_ASSERT(d_.ws.impl_->status_ != status::open);
                BOOST_ASSERT(d_.ws.impl_->status_ != status::closed);
                if( d_.ws.impl_->status_ == status::failed)
                    goto upcall;

                BOOST_ASSERT(! d_.ws.impl_->rd_close);
            }

            // Drain
            if(d_.ws.impl_->rd_remain > 0)
                goto read_payload;
            for(;;)
            {
                // Read frame header
                while(! d_.ws.parse_fh(
                    d_.ws.impl_->rd_fh, d_.ws.impl_->rd_buf, d_.ev))
                {
                    if(d_.ev)
                        goto teardown;
                    BOOST_ASIO_CORO_YIELD
                    d_.ws.impl_->stream.async_read_some(
                        d_.ws.impl_->rd_buf.prepare(read_size(d_.ws.impl_->rd_buf,
                            d_.ws.impl_->rd_buf.max_size())),
                                std::move(*this));
                    if(! d_.ws.impl_->check_ok(ec))
                        goto upcall;
                    d_.ws.impl_->rd_buf.commit(bytes_transferred);
                }
                if(detail::is_control(d_.ws.impl_->rd_fh.op))
                {
                    // Process control frame
                    if(d_.ws.impl_->rd_fh.op == detail::opcode::close)
                    {
                        BOOST_ASSERT(! d_.ws.impl_->rd_close);
                        d_.ws.impl_->rd_close = true;
                        auto const mb = buffers_prefix(
                            clamp(d_.ws.impl_->rd_fh.len),
                            d_.ws.impl_->rd_buf.data());
                        if(d_.ws.impl_->rd_fh.len > 0 && d_.ws.impl_->rd_fh.mask)
                            detail::mask_inplace(mb, d_.ws.impl_->rd_key);
                        detail::read_close(d_.ws.impl_->cr, mb, d_.ev);
                        if(d_.ev)
                            goto teardown;
                        d_.ws.impl_->rd_buf.consume(clamp(d_.ws.impl_->rd_fh.len));
                        goto teardown;
                    }
                    d_.ws.impl_->rd_buf.consume(clamp(d_.ws.impl_->rd_fh.len));
                }
                else
                {
                read_payload:
                    while(d_.ws.impl_->rd_buf.size() < d_.ws.impl_->rd_remain)
                    {
                        d_.ws.impl_->rd_remain -= d_.ws.impl_->rd_buf.size();
                        d_.ws.impl_->rd_buf.consume(d_.ws.impl_->rd_buf.size());
                        BOOST_ASIO_CORO_YIELD
                        d_.ws.impl_->stream.async_read_some(
                            d_.ws.impl_->rd_buf.prepare(read_size(d_.ws.impl_->rd_buf,
                                d_.ws.impl_->rd_buf.max_size())),
                                    std::move(*this));
                        if(! d_.ws.impl_->check_ok(ec))
                            goto upcall;
                        d_.ws.impl_->rd_buf.commit(bytes_transferred);
                    }
                    BOOST_ASSERT(d_.ws.impl_->rd_buf.size() >= d_.ws.impl_->rd_remain);
                    d_.ws.impl_->rd_buf.consume(clamp(d_.ws.impl_->rd_remain));
                    d_.ws.impl_->rd_remain = 0;
                }
            }

        teardown:
            // Teardown
            BOOST_ASSERT(d_.ws.impl_->wr_block.is_locked(this));
            using beast::websocket::async_teardown;
            BOOST_ASIO_CORO_YIELD
            async_teardown(d_.ws.impl_->role,
                d_.ws.impl_->stream, std::move(*this));
            BOOST_ASSERT(d_.ws.impl_->wr_block.is_locked(this));
            if(ec == net::error::eof)
            {
                // Rationale:
                // http://stackoverflow.com/questions/25587403/boost-asio-ssl-async-shutdown-always-finishes-with-an-error
                ec = {};
            }
            if(! ec)
                ec = d_.ev;
            if(ec)
                d_.ws.impl_->status_ = status::failed;
            else
                d_.ws.impl_->status_ = status::closed;
            d_.ws.impl_->close();

        upcall:
            BOOST_ASSERT(d_.ws.impl_->wr_block.is_locked(this));
            d_.ws.impl_->wr_block.unlock(this);
            if(d_.ws.impl_->rd_block.try_unlock(this))
                d_.ws.impl_->paused_r_rd.maybe_invoke();
            d_.ws.impl_->paused_rd.maybe_invoke() ||
                d_.ws.impl_->paused_ping.maybe_invoke() ||
                d_.ws.impl_->paused_wr.maybe_invoke();
            if(! d_.cont)
            {
                BOOST_ASIO_CORO_YIELD
                net::post(
                    d_.ws.get_executor(),
                    beast::bind_front_handler(std::move(*this), ec));
            }
            this->invoke(ec);
        }
    }
};

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

template<class NextLayer, bool deflateSupported>
void
stream<NextLayer, deflateSupported>::
close(close_reason const& cr)
{
    static_assert(is_sync_stream<next_layer_type>::value,
        "SyncStream requirements not met");
    error_code ec;
    close(cr, ec);
    if(ec)
        BOOST_THROW_EXCEPTION(system_error{ec});
}

template<class NextLayer, bool deflateSupported>
void
stream<NextLayer, deflateSupported>::
close(close_reason const& cr, error_code& ec)
{
    static_assert(is_sync_stream<next_layer_type>::value,
        "SyncStream requirements not met");
    using beast::detail::clamp;
    ec = {};
    // Make sure the stream is open
    if(! impl_->check_open(ec))
        return;
    // If rd_close_ is set then we already sent a close
    BOOST_ASSERT(! impl_->rd_close);
    BOOST_ASSERT(! impl_->wr_close);
    impl_->wr_close = true;
    {
        detail::frame_buffer fb;
        write_close<flat_static_buffer_base>(fb, cr);
        net::write(impl_->stream, fb.data(), ec);
    }
    if(! impl_->check_ok(ec))
        return;
    impl_->status_ = status::closing;
    error_code result;
    // Drain the connection
    if(impl_->rd_remain > 0)
        goto read_payload;
    for(;;)
    {
        // Read frame header
        while(! parse_fh(
            impl_->rd_fh, impl_->rd_buf, result))
        {
            if(result)
                return do_fail(
                    close_code::none, result, ec);
            auto const bytes_transferred =
                impl_->stream.read_some(
                    impl_->rd_buf.prepare(read_size(impl_->rd_buf,
                        impl_->rd_buf.max_size())), ec);
            if(! impl_->check_ok(ec))
                return;
            impl_->rd_buf.commit(bytes_transferred);
        }
        if(detail::is_control(impl_->rd_fh.op))
        {
            // Process control frame
            if(impl_->rd_fh.op == detail::opcode::close)
            {
                BOOST_ASSERT(! impl_->rd_close);
                impl_->rd_close = true;
                auto const mb = buffers_prefix(
                    clamp(impl_->rd_fh.len),
                    impl_->rd_buf.data());
                if(impl_->rd_fh.len > 0 && impl_->rd_fh.mask)
                    detail::mask_inplace(mb, impl_->rd_key);
                detail::read_close(impl_->cr, mb, result);
                if(result)
                {
                    // Protocol violation
                    return do_fail(
                        close_code::none, result, ec);
                }
                impl_->rd_buf.consume(clamp(impl_->rd_fh.len));
                break;
            }
            impl_->rd_buf.consume(clamp(impl_->rd_fh.len));
        }
        else
        {
        read_payload:
            while(impl_->rd_buf.size() < impl_->rd_remain)
            {
                impl_->rd_remain -= impl_->rd_buf.size();
                impl_->rd_buf.consume(impl_->rd_buf.size());
                auto const bytes_transferred =
                    impl_->stream.read_some(
                        impl_->rd_buf.prepare(read_size(impl_->rd_buf,
                            impl_->rd_buf.max_size())), ec);
                if(! impl_->check_ok(ec))
                    return;
                impl_->rd_buf.commit(bytes_transferred);
            }
            BOOST_ASSERT(
                impl_->rd_buf.size() >= impl_->rd_remain);
            impl_->rd_buf.consume(clamp(impl_->rd_remain));
            impl_->rd_remain = 0;
        }
    }
    // _Close the WebSocket Connection_
    do_fail(close_code::none, error::closed, ec);
    if(ec == error::closed)
        ec = {};
}

template<class NextLayer, bool deflateSupported>
template<class CloseHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(
    CloseHandler, void(error_code))
stream<NextLayer, deflateSupported>::
async_close(close_reason const& cr, CloseHandler&& handler)
{
    static_assert(is_async_stream<next_layer_type>::value,
        "AsyncStream requirements not met");
    BOOST_BEAST_HANDLER_INIT(
        CloseHandler, void(error_code));
    close_op<BOOST_ASIO_HANDLER_TYPE(
        CloseHandler, void(error_code))>{
            std::move(init.completion_handler), *this, cr}(
                {}, 0, false);
    return init.result.get();
}

} // websocket
} // beast
} // boost

#endif