File: request.hpp

package info (click to toggle)
libzeep 7.3.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,372 kB
  • sloc: cpp: 17,430; javascript: 180; makefile: 12; sh: 11
file content (248 lines) | stat: -rw-r--r-- 8,257 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
// Copyright Maarten L. Hekkelman, Radboud University 2008-2013.
//        Copyright Maarten L. Hekkelman, 2014-2026
//  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)

#pragma once

/// \file
/// definition of the zeep::http::request class encapsulating a valid HTTP request

#include "zeep/el/object.hpp"
#include "zeep/http/asio.hpp"
#include "zeep/http/header.hpp"
#include "zeep/uri.hpp"

#include <array>

#include <chrono>
#include <cstddef>
#include <cstdint>
#include <iosfwd>
#include <locale>
#include <map>
#include <optional>
#include <string>
#include <string_view>
#include <tuple>
#include <type_traits>
#include <utility>
#include <vector>
#include <zeem/detail/charconv.hpp>
#include <zeem/serialize.hpp>

namespace zeep::http
{

// --------------------------------------------------------------------
// TODO: maarten - one day this should be able to work with temporary files

/// \brief container for file parameter information
///
/// Files submitted using multipart/form-data contain a filename and
/// mimetype that might be interesting to the client.
struct file_param
{
	std::string filename;
	std::string mimetype;
	const char *data;
	size_t length;

	explicit operator bool() const
	{
		return data != nullptr;
	}
};

// Some type traits to detect arrays of file_params.
// Should eventually be made more generic for all request parameters

template <typename T, typename = void>
struct is_file_param_array_type : std::false_type
{
};

template <typename T>
struct is_file_param_array_type<T,
	std::enable_if_t<
		zeem::detail::is_detected_v<zeem::value_type_t, T> and
		zeem::detail::is_detected_v<zeem::iterator_t, T> and
		not zeem::detail::is_detected_v<zeem::std_string_npos_t, T>>>
{
	static constexpr bool value = std::is_same_v<typename T::value_type, file_param>;
};

template <typename T>
inline constexpr bool is_file_param_array_type_v = is_file_param_array_type<T>::value;

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

/// request contains the parsed original HTTP request as received
/// by the server.

class request
{
  public:
	friend class message_parser;
	friend class request_parser;
	friend class basic_server;

	using param = header; // alias name
	using cookie_directive = header;

	request(std::string method, uri uri_, std::tuple<int, int> version = { 1, 0 },
		std::vector<header> &&headers = {}, std::string &&payload = {});

	request(const request &req) = default;

	request(request &&rhs) noexcept
	{
		swap(*this, rhs);
	}

	request &operator=(request rhs) noexcept
	{
		swap(*this, rhs);
		return *this;
	}

	friend void swap(request &lhs, request &rhs) noexcept;

	/// \brief Fetch the local address from the connected socket
	void set_local_endpoint(std::string address, uint16_t port)
	{
		m_local_address = std::move(address);
		m_local_port = port;
	}

	[[nodiscard]] std::tuple<std::string, uint16_t> get_local_endpoint() const { return { m_local_address, m_local_port }; }

	/// \brief Get the HTTP version requested
	[[nodiscard]] std::tuple<int, int> get_version() const { return { m_version[0] - '0', m_version[2] - '0' }; }

	/// \brief Set the METHOD type (POST, GET, etc)
	void set_method(std::string method) { m_method = std::move(method); }

	/// \brief Return the METHOD type (POST, GET, etc)
	[[nodiscard]] const std::string &get_method() const { return m_method; }

	/// \brief Return the original URI as requested
	[[nodiscard]] const uri &get_uri() const { return m_uri; }

	/// \brief Set the URI
	void set_uri(const uri &uri_) { m_uri = uri_; }

	/// \brief Get the address of the connecting remote
	[[nodiscard]] const std::string &get_remote_address() const { return m_remote_address; }

	/// \brief Get the entire request line (convenience method)
	[[nodiscard]] std::string get_request_line() const
	{
		return m_method + ' ' + m_uri.string() + " HTTP/" + std::string(m_version.data(), m_version.data() + m_version.size());
	}

	/// \brief Return the payload
	[[nodiscard]] const std::string &get_payload() const { return m_payload; }

	/// \brief Set the payload
	void set_payload(std::string payload) { m_payload = std::move(payload); }

	/// \brief Return the time at which this request was received
	[[nodiscard]] std::chrono::system_clock::time_point get_timestamp() const { return m_timestamp; }

	/// \brief Return the value in the Accept header for type
	[[nodiscard]] float get_accept(std::string_view type) const;

	/// \brief Check for Connection: keep-alive header
	[[nodiscard]] bool keep_alive() const;

	/// \brief Set or replace a named header
	void set_header(std::string name, std::string value);

	/// \brief Return the list of headers
	[[nodiscard]] auto get_headers() const { return m_headers; }

	/// \brief Return the named header
	[[nodiscard]] std::string get_header(std::string_view name) const;

	/// \brief Remove this header from the list of headers
	void remove_header(std::string_view name);

	/// \brief Get the credentials. This is filled in if the request was validated
	[[nodiscard]] el::object get_credentials() const { return m_credentials; }

	/// \brief Set the credentials for the request
	void set_credentials(el::object &&credentials) { m_credentials = std::move(credentials); }

	/// \brief Return the named parameter
	///
	/// Fetch parameters from a request, either from the URL or from the payload in case
	/// the request contains a url-encoded or multi-part content-type header
	[[nodiscard]] std::optional<std::string> get_parameter(std::string_view name) const;

	/// \brief Return the value of the parameter named \a name or the \a defaultValue if this parameter was not found
	[[nodiscard]] std::string get_parameter(std::string_view name, const std::string &defaultValue) const
	{
		return get_parameter(name).value_or(defaultValue);
	}

	/// \brief Return a std::multimap of name/value pairs for all parameters
	[[nodiscard]] std::multimap<std::string, std::string> get_parameters() const;

	/// \brief Return the info for a file parameter with name \a name
	///
	[[nodiscard]] file_param get_file_parameter(std::string name) const;

	/// \brief Return the info for all file parameters with name \a name
	///
	[[nodiscard]] std::vector<file_param> get_file_parameters(std::string name) const;

	/// \brief Return the value of HTTP Cookie with name \a name
	[[nodiscard]] std::string get_cookie(std::string_view name) const;

	/// \brief Set the value of HTTP Cookie with name \a name to \a value
	void set_cookie(const std::string &name, std::string value);

	/// \brief Return the content of this request in a sequence of const_buffers
	///
	/// Can be used in code that sends HTTP requests
	[[nodiscard]] std::vector<std::string_view> to_buffers() const;

	/// \brief Return the Accept-Language header value in the request as a std::locale object
	[[nodiscard]] std::locale get_locale() const;

	/// \brief For debugging purposes
	friend std::ostream &operator<<(std::ostream &io, const request &req);

	/// \brief suppose we want to construct requests...
	void set_content(std::string text, std::string contentType)
	{
		set_header("content-type", std::move(contentType));
		set_header("content-length", std::to_string(text.length()));
		m_payload = std::move(text);
	}

  private:
	void set_remote_address(std::string address)
	{
		m_remote_address = std::move(address);
	}

	std::string m_local_address; ///< Local endpoint address
	uint16_t m_local_port = 80;  ///< Local endpoint port

	std::string m_method = "UNDEFINED"; ///< POST, GET, etc.
	uri m_uri;                          ///< The uri as requested
	std::array<char, 3> m_version{};    ///< The version string
	std::vector<header> m_headers;      ///< A list with zeep::http::header values
	std::string m_payload;              ///< For POST requests
	bool m_close = false;               ///< Whether 'Connection: close' was specified

	std::chrono::system_clock::time_point m_timestamp = std::chrono::system_clock::now();
	el::object m_credentials; ///< The credentials as found in the validated access-token

	std::string m_remote_address; ///< Address of connecting client
};

} // namespace zeep::http