CrowCpp / Crow / 571

Committed 24 Jan 2025 03:29PM UTC coverage: 87.806% (-0.1%) from 87.916%

Build # 571

Build Type

Pull #974

gh-actions

Committed by

web-flow

Commit Message

Merge 18329b3ec into c0da4dbaf

Pull Request Pull Request #974: replaced += by append and changed the order of strings to remove nece…

Run Details

5 of 5 new or added lines in 1 file covered. (100.0%)

5 existing lines in 2 files now uncovered.

3982 of 4535 relevant lines covered (87.81%)

256.48 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.68

/include/crow/parser.h

#pragma once

#include <string>
#include <unordered_map>
#include <algorithm>

#include "crow/http_request.h"
#include "crow/http_parser_merged.h"

namespace crow
{
    /// A wrapper for `nodejs/http-parser`.

    ///
    /// Used to generate a \ref crow.request from the TCP socket buffer.
    template<typename Handler>
    struct HTTPParser : public http_parser
    {
        static int on_message_begin(http_parser*)
        {
            return 0;
        }
        static int on_method(http_parser* self_)
        {
            HTTPParser* self = static_cast<HTTPParser*>(self_);
            self->req.method = static_cast<HTTPMethod>(self->method);

            return 0;
        }
        static int on_url(http_parser* self_, const char* at, size_t length)
        {
            HTTPParser* self = static_cast<HTTPParser*>(self_);
            self->req.raw_url.insert(self->req.raw_url.end(), at, at + length);
            self->req.url_params = query_string(self->req.raw_url);
            self->req.url = self->req.raw_url.substr(0, self->qs_point != 0 ? self->qs_point : std::string::npos);

            self->process_url();

            return 0;
        }
        static int on_header_field(http_parser* self_, const char* at, size_t length)
        {
            HTTPParser* self = static_cast<HTTPParser*>(self_);
            switch (self->header_building_state)
            {
                case 0:
                    if (!self->header_value.empty())
                    {
                        self->req.headers.emplace(std::move(self->header_field), std::move(self->header_value));
                    }
                    self->header_field.assign(at, at + length);
                    self->header_building_state = 1;
                    break;
                case 1:
                    self->header_field.insert(self->header_field.end(), at, at + length);
                    break;
            }
            return 0;
        }
        static int on_header_value(http_parser* self_, const char* at, size_t length)
        {
            HTTPParser* self = static_cast<HTTPParser*>(self_);
            switch (self->header_building_state)
            {
                case 0:
                    self->header_value.insert(self->header_value.end(), at, at + length);
                    break;
                case 1:
                    self->header_building_state = 0;
                    self->header_value.assign(at, at + length);
                    break;
            }
            return 0;
        }
        static int on_headers_complete(http_parser* self_)
        {
            HTTPParser* self = static_cast<HTTPParser*>(self_);
            if (!self->header_field.empty())
            {
                self->req.headers.emplace(std::move(self->header_field), std::move(self->header_value));
            }

            self->set_connection_parameters();

            self->process_header();
            return 0;
        }
        static int on_body(http_parser* self_, const char* at, size_t length)
        {
            HTTPParser* self = static_cast<HTTPParser*>(self_);
            self->req.body.insert(self->req.body.end(), at, at + length);
            return 0;
        }
        static int on_message_complete(http_parser* self_)
        {
            HTTPParser* self = static_cast<HTTPParser*>(self_);

            self->message_complete = true;
            self->process_message();
            return 0;
        }
        HTTPParser(Handler* handler):
          http_parser(),
          handler_(handler)
        {
            http_parser_init(this);
        }

        // return false on error
        /// Parse a buffer into the different sections of an HTTP request.
        bool feed(const char* buffer, int length)
        {
            if (message_complete)
                return true;

            const static http_parser_settings settings_{
              on_message_begin,
              on_method,
              on_url,
              on_header_field,
              on_header_value,
              on_headers_complete,
              on_body,
              on_message_complete,
            };

            int nparsed = http_parser_execute(this, &settings_, buffer, length);
            if (http_errno != CHPE_OK)
            {
                return false;
            }
            return nparsed == length;
        }

        bool done()
        {
            return feed(nullptr, 0);
        }

        void clear()
        {
            req = crow::request();
            header_field.clear();
            header_value.clear();
            header_building_state = 0;
            qs_point = 0;
            message_complete = false;
            state = CROW_NEW_MESSAGE();
        }

        inline void process_url()
        {
            handler_->handle_url();
        }

        inline void process_header()
        {
            handler_->handle_header();
        }

        inline void process_message()
        {
            handler_->handle();
        }

        inline void set_connection_parameters()
        {
            req.http_ver_major = http_major;
            req.http_ver_minor = http_minor;

            //NOTE(EDev): it seems that the problem is with crow's policy on closing the connection for HTTP_VERSION < 1.0, the behaviour for that in crow is "don't close the connection, but don't send a keep-alive either"

            // HTTP1.1 = always send keep_alive, HTTP1.0 = only send if header exists, HTTP?.? = never send
            req.keep_alive = (http_major == 1 && http_minor == 0) ?
                               ((flags & F_CONNECTION_KEEP_ALIVE) ? true : false) :
                               ((http_major == 1 && http_minor == 1) ? true : false);

            // HTTP1.1 = only close if close header exists, HTTP1.0 = always close unless keep_alive header exists, HTTP?.?= never close
            req.close_connection = (http_major == 1 && http_minor == 0) ?
                                     ((flags & F_CONNECTION_KEEP_ALIVE) ? false : true) :
                                     ((http_major == 1 && http_minor == 1) ? ((flags & F_CONNECTION_CLOSE) ? true : false) : false);
            req.upgrade = static_cast<bool>(upgrade);
        }

        /// The final request that this parser outputs.
        ///
        /// Data parsed is put directly into this object as soon as the related callback returns. (e.g. the request will have the cooorect method as soon as on_method() returns)
        request req;

    private:
        int header_building_state = 0;
        bool message_complete = false;
        std::string header_field;
        std::string header_value;

        Handler* handler_; ///< This is currently an HTTP connection object (\ref crow.Connection).
    };
} // namespace crow

#undef CROW_NEW_MESSAGE
#undef CROW_start_state

1	#pragma once
2
3	#include <string>
4	#include <unordered_map>
5	#include <algorithm>
6
7	#include "crow/http_request.h"
8	#include "crow/http_parser_merged.h"
9
10	namespace crow
11	{
12	/// A wrapper for `nodejs/http-parser`.
13
14	///
15	/// Used to generate a \ref crow.request from the TCP socket buffer.
16	template<typename Handler>
17	struct HTTPParser : public http_parser
18	{
19	static int on_message_begin(http_parser*)	126✔
20	{
21	return 0;	126✔
22	}
23	static int on_method(http_parser* self_)	398✔
24	{
25	HTTPParser* self = static_cast<HTTPParser*>(self_);	398✔
26	self->req.method = static_cast<HTTPMethod>(self->method);	398✔
27
28	return 0;	398✔
29	}
30	static int on_url(http_parser* self_, const char* at, size_t length)	122✔
31	{
32	HTTPParser* self = static_cast<HTTPParser*>(self_);	122✔
33	self->req.raw_url.insert(self->req.raw_url.end(), at, at + length);	122✔
34	self->req.url_params = query_string(self->req.raw_url);	122✔
35	self->req.url = self->req.raw_url.substr(0, self->qs_point != 0 ? self->qs_point : std::string::npos);	122✔
36
37	self->process_url();	122✔
38
39	return 0;	122✔
40	}
41	static int on_header_field(http_parser* self_, const char* at, size_t length)	166✔
42	{
43	HTTPParser* self = static_cast<HTTPParser*>(self_);	166✔
44	switch (self->header_building_state)	166✔
45	{
46	case 0:	166✔
47	if (!self->header_value.empty())	166✔
48	{
49	self->req.headers.emplace(std::move(self->header_field), std::move(self->header_value));	102✔
50	}
51	self->header_field.assign(at, at + length);	166✔
52	self->header_building_state = 1;	166✔
53	break;	166✔
UNCOV 54	case 1:	×
UNCOV 55	self->header_field.insert(self->header_field.end(), at, at + length);	×
UNCOV 56	break;	×
57	}
58	return 0;	166✔
59	}
60	static int on_header_value(http_parser* self_, const char* at, size_t length)	166✔
61	{
62	HTTPParser* self = static_cast<HTTPParser*>(self_);	166✔
63	switch (self->header_building_state)	166✔
64	{
65	case 0:	×
66	self->header_value.insert(self->header_value.end(), at, at + length);	×
67	break;	×
68	case 1:	166✔
69	self->header_building_state = 0;	166✔
70	self->header_value.assign(at, at + length);	166✔
71	break;	166✔
72	}
73	return 0;	166✔
74	}
75	static int on_headers_complete(http_parser* self_)	118✔
76	{
77	HTTPParser* self = static_cast<HTTPParser*>(self_);	118✔
78	if (!self->header_field.empty())	118✔
79	{
80	self->req.headers.emplace(std::move(self->header_field), std::move(self->header_value));	64✔
81	}
82
83	self->set_connection_parameters();	118✔
84
85	self->process_header();	118✔
86	return 0;	118✔
87	}
88	static int on_body(http_parser* self_, const char* at, size_t length)	6✔
89	{
90	HTTPParser* self = static_cast<HTTPParser*>(self_);	6✔
91	self->req.body.insert(self->req.body.end(), at, at + length);	6✔
92	return 0;	6✔
93	}
94	static int on_message_complete(http_parser* self_)	128✔
95	{
96	HTTPParser* self = static_cast<HTTPParser*>(self_);	128✔
97
98	self->message_complete = true;	128✔
99	self->process_message();	128✔
100	return 0;	122✔
101	}
102	HTTPParser(Handler* handler):	196✔
103	http_parser(),
104	handler_(handler)	196✔
105	{
106	http_parser_init(this);	196✔
107	}	196✔
108
109	// return false on error
110	/// Parse a buffer into the different sections of an HTTP request.
111	bool feed(const char* buffer, int length)	260✔
112	{
113	if (message_complete)	260✔
114	return true;	110✔
115
116	const static http_parser_settings settings_{
117	on_message_begin,
118	on_method,
119	on_url,
120	on_header_field,
121	on_header_value,
122	on_headers_complete,
123	on_body,
124	on_message_complete,
125	};
126
127	int nparsed = http_parser_execute(this, &settings_, buffer, length);	150✔
128	if (http_errno != CHPE_OK)	144✔
129	{
130	return false;	20✔
131	}
132	return nparsed == length;	124✔
133	}
134
135	bool done()	118✔
136	{
137	return feed(nullptr, 0);	118✔
138	}
139
140	void clear()	132✔
141	{
142	req = crow::request();	132✔
143	header_field.clear();	132✔
144	header_value.clear();	132✔
145	header_building_state = 0;	132✔
146	qs_point = 0;	132✔
147	message_complete = false;	132✔
148	state = CROW_NEW_MESSAGE();	132✔
149	}	132✔
150
151	inline void process_url()	122✔
152	{
153	handler_->handle_url();	122✔
154	}	122✔
155
156	inline void process_header()	118✔
157	{
158	handler_->handle_header();	118✔
159	}	118✔
160
161	inline void process_message()	128✔
162	{
163	handler_->handle();	128✔
164	}	122✔
165
166	inline void set_connection_parameters()	118✔
167	{
168	req.http_ver_major = http_major;	118✔
169	req.http_ver_minor = http_minor;	118✔
170
171	//NOTE(EDev): it seems that the problem is with crow's policy on closing the connection for HTTP_VERSION < 1.0, the behaviour for that in crow is "don't close the connection, but don't send a keep-alive either"
172
173	// HTTP1.1 = always send keep_alive, HTTP1.0 = only send if header exists, HTTP?.? = never send
174	req.keep_alive = (http_major == 1 && http_minor == 0) ?	226✔
175	((flags & F_CONNECTION_KEEP_ALIVE) ? true : false) :	10✔
176	((http_major == 1 && http_minor == 1) ? true : false);	108✔
177
178	// HTTP1.1 = only close if close header exists, HTTP1.0 = always close unless keep_alive header exists, HTTP?.?= never close
179	req.close_connection = (http_major == 1 && http_minor == 0) ?	226✔
180	((flags & F_CONNECTION_KEEP_ALIVE) ? false : true) :	10✔
181	((http_major == 1 && http_minor == 1) ? ((flags & F_CONNECTION_CLOSE) ? true : false) : false);	108✔
182	req.upgrade = static_cast<bool>(upgrade);	118✔
183	}	118✔
184
185	/// The final request that this parser outputs.
186	///
187	/// Data parsed is put directly into this object as soon as the related callback returns. (e.g. the request will have the cooorect method as soon as on_method() returns)
188	request req;
189
190	private:
191	int header_building_state = 0;
192	bool message_complete = false;
193	std::string header_field;
194	std::string header_value;
195
196	Handler* handler_; ///< This is currently an HTTP connection object (\ref crow.Connection).
197	};
198	} // namespace crow
199
200	#undef CROW_NEW_MESSAGE
201	#undef CROW_start_state

CrowCpp / Crow / 571

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous