Diff coverage report for

//

//

// Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)

// Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)

// Copyright (c) 2024 Mohammad Nejati

// Copyright (c) 2024 Mohammad Nejati

//

//

// Distributed under the Boost Software License, Version 1.0. (See accompanying

// 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)

// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

//

//

// Official repository: https://github.com/cppalliance/http

// Official repository: https://github.com/cppalliance/http

//

//

#ifndef BOOST_HTTP_PARSER_HPP

#ifndef BOOST_HTTP_PARSER_HPP

#define BOOST_HTTP_PARSER_HPP

#define BOOST_HTTP_PARSER_HPP

#include <boost/http/config.hpp>

#include <boost/http/config.hpp>

#include <boost/http/detail/header.hpp>

#include <boost/http/detail/header.hpp>

#include <boost/http/detail/type_traits.hpp>

#include <boost/http/detail/type_traits.hpp>

#include <boost/http/error.hpp>

#include <boost/http/error.hpp>

#include <boost/capy/buffers/buffer_copy.hpp>

#include <boost/capy/buffers/buffer_copy.hpp>

#include <boost/capy/buffers/buffer_pair.hpp>

#include <boost/capy/buffers/buffer_pair.hpp>

#include <boost/capy/buffers/slice.hpp>

#include <boost/capy/buffers/slice.hpp>

#include <boost/capy/concept/read_stream.hpp>

#include <boost/capy/concept/read_stream.hpp>

#include <boost/capy/concept/write_sink.hpp>

#include <boost/capy/concept/write_sink.hpp>

#include <boost/capy/cond.hpp>

#include <boost/capy/cond.hpp>

#include <boost/capy/error.hpp>

#include <boost/capy/error.hpp>

#include <boost/capy/io_task.hpp>

#include <boost/capy/io_task.hpp>

#include <boost/core/span.hpp>

#include <boost/core/span.hpp>

#include <cstddef>

#include <cstddef>

#include <cstdint>

#include <cstdint>

#include <memory>

#include <memory>

namespace boost {

namespace boost {

namespace http {

namespace http {

// Forward declaration

// Forward declaration

class request_parser;

class request_parser;

class response_parser;

class response_parser;

class static_request;

class static_request;

class static_response;

class static_response;

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

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

/** A parser for HTTP/1 messages.

/** A parser for HTTP/1 messages.

    This parser uses a single block of memory allocated

    This parser uses a single block of memory allocated

    during construction and guarantees it will never

    during construction and guarantees it will never

    exceed the specified size. This space is reused for

    exceed the specified size. This space is reused for

    parsing multiple HTTP messages ( one at a time ).

    parsing multiple HTTP messages ( one at a time ).

    The allocated space is used for:

    The allocated space is used for:

    @li Buffering raw input from a socket

    @li Buffering raw input from a socket

    @li Storing HTTP headers with O(1) access to

    @li Storing HTTP headers with O(1) access to

        method, target, and status code

        method, target, and status code

    @li Storing all or part of an HTTP message body

    @li Storing all or part of an HTTP message body

    @li Storing state for inflate algorithms

    @li Storing state for inflate algorithms

    The parser is strict. Any malformed input according

    The parser is strict. Any malformed input according

    to the HTTP ABNFs is treated as an unrecoverable

    to the HTTP ABNFs is treated as an unrecoverable

    error.

    error.

    @see

    @see

        @ref response_parser,

        @ref response_parser,

        @ref request_parser.

        @ref request_parser.

*/

*/

class parser

class parser

{

{

public:

public:

    template<capy::ReadStream Stream>

    template<capy::ReadStream Stream>

    class source;

    class source;

    /// Buffer type returned from @ref prepare.

    /// Buffer type returned from @ref prepare.

    using mutable_buffers_type =

    using mutable_buffers_type =

        boost::span<capy::mutable_buffer const>;

        boost::span<capy::mutable_buffer const>;

    /// Buffer type returned from @ref pull_body.

    /// Buffer type returned from @ref pull_body.

    using const_buffers_type =

    using const_buffers_type =

        boost::span<capy::const_buffer const>;

        boost::span<capy::const_buffer const>;

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

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

    //

    //

    // Observers

    // Observers

    //

    //

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

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

    /// Check if a complete header has been parsed.

    /// Check if a complete header has been parsed.

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    bool

    bool

    got_header() const noexcept;

    got_header() const noexcept;

    /// Check if a complete message has been parsed.

    /// Check if a complete message has been parsed.

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    bool

    bool

    is_complete() const noexcept;

    is_complete() const noexcept;

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

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

    //

    //

    // Modifiers

    // Modifiers

    //

    //

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

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

    /// Prepare for a new stream.

    /// Prepare for a new stream.

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    void

    void

    reset() noexcept;

    reset() noexcept;

    /** Prepare for a new message.

    /** Prepare for a new message.

        @par Preconditions

        @par Preconditions

        Either this is the first message in the stream,

        Either this is the first message in the stream,

        or the previous message has been fully parsed.

        or the previous message has been fully parsed.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    void

    void

    start();

    start();

    /** Return a buffer for reading input.

    /** Return a buffer for reading input.

        After writing to the buffer, call @ref commit

        After writing to the buffer, call @ref commit

        with the number of bytes written.

        with the number of bytes written.

        @par Preconditions

        @par Preconditions

        @ref parse returned @ref condition::need_more_input.

        @ref parse returned @ref condition::need_more_input.

        @par Postconditions

        @par Postconditions

        A call to @ref commit or @ref commit_eof is

        A call to @ref commit or @ref commit_eof is

        required before calling @ref prepare again.

        required before calling @ref prepare again.

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        @return A non-empty mutable buffer.

        @return A non-empty mutable buffer.

        @see @ref commit, @ref commit_eof.

        @see @ref commit, @ref commit_eof.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    mutable_buffers_type

    mutable_buffers_type

    prepare();

    prepare();

    /** Commit bytes to the input buffer.

    /** Commit bytes to the input buffer.

        @par Preconditions

        @par Preconditions

        @li `n <= capy::buffer_size( this->prepare() )`

        @li `n <= capy::buffer_size( this->prepare() )`

        @li No prior call to @ref commit or @ref commit_eof

        @li No prior call to @ref commit or @ref commit_eof

            since the last @ref prepare

            since the last @ref prepare

        @par Postconditions

        @par Postconditions

        Buffers from @ref prepare are invalidated.

        Buffers from @ref prepare are invalidated.

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        @param n The number of bytes written.

        @param n The number of bytes written.

        @see @ref parse, @ref prepare.

        @see @ref parse, @ref prepare.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    void

    void

    commit(

    commit(

        std::size_t n);

        std::size_t n);

    /** Indicate end of input.

    /** Indicate end of input.

        Call this when the underlying stream has closed

        Call this when the underlying stream has closed

        and no more data will arrive.

        and no more data will arrive.

        @par Postconditions

        @par Postconditions

        Buffers from @ref prepare are invalidated.

        Buffers from @ref prepare are invalidated.

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        @see @ref parse, @ref prepare.

        @see @ref parse, @ref prepare.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    void

    void

    commit_eof();

    commit_eof();

    /** Parse pending input data.

    /** Parse pending input data.

        Returns immediately after the header is fully

        Returns immediately after the header is fully

        parsed to allow @ref set_body_limit to be called

        parsed to allow @ref set_body_limit to be called

        before body parsing begins. If an error occurs

        before body parsing begins. If an error occurs

        during body parsing, the parsed header remains

        during body parsing, the parsed header remains

        valid and accessible.

        valid and accessible.

        When `ec == condition::need_more_input`, read

        When `ec == condition::need_more_input`, read

        more data and call @ref commit before calling

        more data and call @ref commit before calling

        this function again.

        this function again.

        When `ec == error::end_of_stream`, the stream

        When `ec == error::end_of_stream`, the stream

        closed cleanly. Call @ref reset to reuse the

        closed cleanly. Call @ref reset to reuse the

        parser for a new stream.

        parser for a new stream.

        @param ec Set to the error, if any occurred.

        @param ec Set to the error, if any occurred.

        @see @ref start, @ref prepare, @ref commit.

        @see @ref start, @ref prepare, @ref commit.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    void

    void

    parse(

    parse(

        system::error_code& ec);

        system::error_code& ec);

    /** Set maximum body size for the current message.

    /** Set maximum body size for the current message.

        Overrides @ref parser_config::body_limit for this

        Overrides @ref parser_config::body_limit for this

        message only. The limit resets to the default

        message only. The limit resets to the default

        for subsequent messages.

        for subsequent messages.

        @par Preconditions

        @par Preconditions

        `this->got_header() == true` and body parsing

        `this->got_header() == true` and body parsing

        has not started.

        has not started.

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        @param n The body size limit in bytes.

        @param n The body size limit in bytes.

        @see @ref parser_config::body_limit.

        @see @ref parser_config::body_limit.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    void

    void

    set_body_limit(std::uint64_t n);

    set_body_limit(std::uint64_t n);

    /** Return available body data.

    /** Return available body data.

        Use this to incrementally process body data.

        Use this to incrementally process body data.

        Call @ref consume_body after processing to

        Call @ref consume_body after processing to

        release the buffer space.

        release the buffer space.

        @par Example

        @par Example

        @code

        @code

        request_parser pr( ctx );

        request_parser pr( ctx );

        pr.start();

        pr.start();

        co_await pr.read_header( stream );

        co_await pr.read_header( stream );

        while( ! pr.is_complete() )

        while( ! pr.is_complete() )

        {

        {

            co_await read_some( stream, pr );

            co_await read_some( stream, pr );

            auto cbs = pr.pull_body();

            auto cbs = pr.pull_body();

            // process cbs ...

            // process cbs ...

            pr.consume_body( capy::buffer_size( cbs ) );

            pr.consume_body( capy::buffer_size( cbs ) );

        }

        }

        @endcode

        @endcode

        @par Preconditions

        @par Preconditions

        `this->got_header() == true`

        `this->got_header() == true`

        @par Postconditions

        @par Postconditions

        The returned buffer is invalidated by any

        The returned buffer is invalidated by any

        modifying member function.

        modifying member function.

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        @return Buffers containing available body data.

        @return Buffers containing available body data.

        @see @ref consume_body.

        @see @ref consume_body.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    const_buffers_type

    const_buffers_type

    pull_body();

    pull_body();

    /** Consume bytes from available body data.

    /** Consume bytes from available body data.

        @par Preconditions

        @par Preconditions

        `n <= capy::buffer_size( this->pull_body() )`

        `n <= capy::buffer_size( this->pull_body() )`

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        @param n The number of bytes to consume.

        @param n The number of bytes to consume.

        @see @ref pull_body.

        @see @ref pull_body.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    void

    void

    consume_body(std::size_t n);

    consume_body(std::size_t n);

    /** Return the complete body.

    /** Return the complete body.

        Use this when the entire message fits within

        Use this when the entire message fits within

        the parser's internal buffer.

        the parser's internal buffer.

        @par Example

        @par Example

        @code

        @code

        request_parser pr( ctx );

        request_parser pr( ctx );

        pr.start();

        pr.start();

        co_await pr.read_header( stream );

        co_await pr.read_header( stream );

        // ... read entire body ...

        // ... read entire body ...

        core::string_view body = pr.body();

        core::string_view body = pr.body();

        @endcode

        @endcode

        @par Preconditions

        @par Preconditions

        @li `this->is_complete() == true`

        @li `this->is_complete() == true`

        @li No previous call to @ref consume_body

        @li No previous call to @ref consume_body

        @par Exception Safety

        @par Exception Safety

        Strong guarantee.

        Strong guarantee.

        @return A string view of the complete body.

        @return A string view of the complete body.

        @see @ref is_complete.

        @see @ref is_complete.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    core::string_view

    core::string_view

    body() const;

    body() const;

    /** Return unconsumed data past the last message.

    /** Return unconsumed data past the last message.

        Use this after an upgrade or CONNECT request

        Use this after an upgrade or CONNECT request

        to retrieve protocol-dependent data that

        to retrieve protocol-dependent data that

        follows the HTTP message.

        follows the HTTP message.

        @return A string view of leftover data.

        @return A string view of leftover data.

        @see @ref metadata::upgrade, @ref metadata::connection.

        @see @ref metadata::upgrade, @ref metadata::connection.

    */

    */

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    core::string_view

    core::string_view

    release_buffered_data() noexcept;

    release_buffered_data() noexcept;

    /** Asynchronously read the HTTP headers.

    /** Asynchronously read the HTTP headers.

        Reads from the stream until the headers are

        Reads from the stream until the headers are

        complete or an error occurs.

        complete or an error occurs.

        @par Preconditions

        @par Preconditions

        @li @ref reset has been called

        @li @ref reset has been called

        @li @ref start has been called

        @li @ref start has been called

        @param stream The stream to read from.

        @param stream The stream to read from.

        @return An awaitable yielding `(error_code)`.

        @return An awaitable yielding `(error_code)`.

        @see @ref read.

        @see @ref read.

    */

    */

    template<capy::ReadStream Stream>

    template<capy::ReadStream Stream>

    capy::io_task<>

    capy::io_task<>

    read_header(Stream& stream);

    read_header(Stream& stream);

    /** Asynchronously read body data into buffers.

    /** Asynchronously read body data into buffers.

        Reads from the stream and copies body data into

        Reads from the stream and copies body data into

        the provided buffers with complete-fill semantics.

        the provided buffers with complete-fill semantics.

        Returns `capy::error::eof` when the body is complete.

        Returns `capy::error::eof` when the body is complete.

        @par Preconditions

        @par Preconditions

        @li @ref reset has been called

        @li @ref reset has been called

        @li @ref start has been called

        @li @ref start has been called

        @param stream The stream to read from.

        @param stream The stream to read from.

        @param buffers The buffers to read into.

        @param buffers The buffers to read into.

        @return An awaitable yielding `(error_code,std::size_t)`.

        @return An awaitable yielding `(error_code,std::size_t)`.

        @see @ref read_header.

        @see @ref read_header.

    */

    */

    template<capy::ReadStream Stream, capy::MutableBufferSequence MB>

    template<capy::ReadStream Stream, capy::MutableBufferSequence MB>

    capy::io_task<std::size_t>

    capy::io_task<std::size_t>

    read(Stream& stream, MB buffers);

    read(Stream& stream, MB buffers);

    /** Return a source for reading body data.

    /** Return a source for reading body data.

        The returned source satisfies @ref capy::BufferSource.

        The returned source satisfies @ref capy::BufferSource.

        On first pull, headers are automatically parsed if

        On first pull, headers are automatically parsed if

        not yet received.

        not yet received.

        @par Example

        @par Example

        @code

        @code

        request_parser pr( ctx );

        request_parser pr( ctx );

        pr.start();

        pr.start();

        auto body = pr.source_for( socket );

        auto body = pr.source_for( socket );

        capy::const_buffer arr[16];

        capy::const_buffer arr[16];

        auto [ec, bufs] = co_await body.pull( arr );

        auto [ec, bufs] = co_await body.pull( arr );

        body.consume( buffer_size( bufs ) );

        body.consume( buffer_size( bufs ) );

        @endcode

        @endcode

        @param stream The stream to read from.

        @param stream The stream to read from.

        @return A source satisfying @ref capy::BufferSource.

        @return A source satisfying @ref capy::BufferSource.

        @see @ref read_header, @ref capy::BufferSource.

        @see @ref read_header, @ref capy::BufferSource.

    */

    */

    template<capy::ReadStream Stream>

    template<capy::ReadStream Stream>

    source<Stream>

    source<Stream>

    source_for(Stream& stream) noexcept;

    source_for(Stream& stream) noexcept;

    /** Read body from stream and push to a WriteSink.

    /** Read body from stream and push to a WriteSink.

        Reads body data from the stream and pushes each chunk to

        Reads body data from the stream and pushes each chunk to

        the sink. The sink must consume all bytes from each write.

        the sink. The sink must consume all bytes from each write.

        @param stream The stream to read body data from.

        @param stream The stream to read body data from.

        @param sink The sink to receive body data.

        @param sink The sink to receive body data.

        @return An awaitable yielding `(error_code)`.

        @return An awaitable yielding `(error_code)`.

        @see WriteSink.

        @see WriteSink.

    */

    */

    template<capy::WriteSink Sink>

    template<capy::WriteSink Sink>

    capy::io_task<>

    capy::io_task<>

    read(capy::ReadStream auto& stream, Sink&& sink);

    read(capy::ReadStream auto& stream, Sink&& sink);

private:

private:

    friend class request_parser;

    friend class request_parser;

    friend class response_parser;

    friend class response_parser;

    class impl;

    class impl;

    BOOST_HTTP_DECL ~parser();

    BOOST_HTTP_DECL ~parser();

    BOOST_HTTP_DECL parser() noexcept;

    BOOST_HTTP_DECL parser() noexcept;

    BOOST_HTTP_DECL parser(parser&& other) noexcept;

    BOOST_HTTP_DECL parser(parser&& other) noexcept;

    BOOST_HTTP_DECL parser(

    BOOST_HTTP_DECL parser(

        std::shared_ptr<parser_config_impl const> cfg,

        std::shared_ptr<parser_config_impl const> cfg,

        detail::kind k);

        detail::kind k);

    BOOST_HTTP_DECL void assign(parser&& other) noexcept;

    BOOST_HTTP_DECL void assign(parser&& other) noexcept;

    BOOST_HTTP_DECL

    BOOST_HTTP_DECL

    void

    void

    start_impl(bool);

    start_impl(bool);

    static_request const&

    static_request const&

    safe_get_request() const;

    safe_get_request() const;

    static_response const&

    static_response const&

    safe_get_response() const;

    safe_get_response() const;

    impl* impl_;

    impl* impl_;

};

};

/** A source for reading the message body.

/** A source for reading the message body.

    This type satisfies @ref capy::BufferSource. It can be

    This type satisfies @ref capy::BufferSource. It can be

    constructed immediately after parser construction; on

    constructed immediately after parser construction; on

    first pull, headers are automatically parsed if not

    first pull, headers are automatically parsed if not

    yet received.

    yet received.

    @tparam Stream A type satisfying @ref capy::ReadStream.

    @tparam Stream A type satisfying @ref capy::ReadStream.

    @see @ref parser::source_for.

    @see @ref parser::source_for.

*/

*/

template<capy::ReadStream Stream>

template<capy::ReadStream Stream>

class parser::source

class parser::source

{

{

    Stream* stream_;

    Stream* stream_;

    parser* pr_;

    parser* pr_;

public:

public:

    /// Default constructor.

    /// Default constructor.

    source() noexcept

    source() noexcept

        : stream_(nullptr)

        : stream_(nullptr)

        , pr_(nullptr)

        , pr_(nullptr)

    {

    {

    }

    }

    /// Construct a source for reading body data.

    /// Construct a source for reading body data.

    {

    {

    /** Pull buffer data from the body.

    /** Pull buffer data from the body.

        On first invocation, reads headers if not yet parsed.

        On first invocation, reads headers if not yet parsed.

        Returns buffer descriptors pointing to internal parser

        Returns buffer descriptors pointing to internal parser

        memory. When the body is complete, returns an empty span.

        memory. When the body is complete, returns an empty span.

        @param dest Span of const_buffer to fill.

        @param dest Span of const_buffer to fill.

        @return An awaitable yielding `(error_code,std::span<const_buffer>)`.

        @return An awaitable yielding `(error_code,std::span<const_buffer>)`.

    */

    */

    capy::io_task<std::span<capy::const_buffer>>

    capy::io_task<std::span<capy::const_buffer>>

    pull(std::span<capy::const_buffer> dest);

    pull(std::span<capy::const_buffer> dest);

    /** Consume bytes from pulled body data.

    /** Consume bytes from pulled body data.

        Advances the read position by the specified number of

        Advances the read position by the specified number of

        bytes. The next pull returns data starting after the

        bytes. The next pull returns data starting after the

        consumed bytes.

        consumed bytes.

        @param n The number of bytes to consume.

        @param n The number of bytes to consume.

    */

    */

    void

    void

    consume(std::size_t n) noexcept;

    consume(std::size_t n) noexcept;

};

};

template<capy::ReadStream Stream>

template<capy::ReadStream Stream>

capy::io_task<>

capy::io_task<>

read_header(Stream& stream)

read_header(Stream& stream)

{

{

    system::error_code ec;

    system::error_code ec;

    for(;;)

    for(;;)

    {

    {

        parse(ec);

        parse(ec);

        if(got_header())

        if(got_header())

            co_return {};

            co_return {};

        if(ec != condition::need_more_input)

        if(ec != condition::need_more_input)

            co_return {ec};

            co_return {ec};

        auto mbs = prepare();

        auto mbs = prepare();

        auto [read_ec, n] = co_await stream.read_some(mbs);

        auto [read_ec, n] = co_await stream.read_some(mbs);

        if(read_ec == capy::cond::eof)

        if(read_ec == capy::cond::eof)

            commit_eof();

            commit_eof();

        else if(!read_ec)

        else if(!read_ec)

            commit(n);

            commit(n);

        else

        else

            co_return {read_ec};

            co_return {read_ec};

    }

    }

template<capy::ReadStream Stream, capy::MutableBufferSequence MB>

template<capy::ReadStream Stream, capy::MutableBufferSequence MB>

capy::io_task<std::size_t>

capy::io_task<std::size_t>

parser::

parser::

read(Stream& stream, MB buffers)

read(Stream& stream, MB buffers)

{

{

    if(capy::buffer_empty(buffers))

    if(capy::buffer_empty(buffers))

        co_return {{}, 0};

        co_return {{}, 0};

    std::size_t total = 0;

    std::size_t total = 0;

    auto dest = capy::sans_prefix(buffers, 0);

    auto dest = capy::sans_prefix(buffers, 0);

    for(;;)

    for(;;)

    {

    {

        system::error_code ec;

        system::error_code ec;