File: WebRequest.h

package info (click to toggle)
jazz2-native 3.5.0-3
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid
  • size: 16,912 kB
  • sloc: cpp: 172,557; xml: 113; python: 36; makefile: 5; sh: 2
file content (501 lines) | stat: -rw-r--r-- 16,701 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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
#pragma once

#include "Stream.h"
#include "../Containers/ComPtr.h"
#include "../Containers/Function.h"
#include "../Containers/SmallVector.h"
#include "../Containers/String.h"

namespace Death { namespace IO {
//###==##====#=====--==~--~=~- --- -- -  -  -   -

	/** @brief Contains the username and password to use for authenticating */
	class WebCredentials
	{
	public:
		WebCredentials(Containers::StringView user = {}, Containers::StringView password = {})
			: _user(user), _password(password) {}

		/** @brief Returns username */
		Containers::StringView GetUser() const {
			return _user;
		}

		/** @brief Returns password */
		Containers::StringView GetPassword() const {
			return _password;
		}

	private:
		Containers::String _user;
		Containers::String _password;
	};

	class WebSessionFactory;
	class WebRequestEvent;

#ifndef DOXYGEN_GENERATING_OUTPUT
	typedef struct WebRequestHandleOpaque* WebRequestHandle;
	typedef struct WebSessionHandleOpaque* WebSessionHandle;

	class WebAuthChallengeImpl;
	class WebRequestImpl;
	class WebResponseImpl;
	class WebSessionAsync;
	class WebSessionImpl;

	typedef Containers::ComPtr<WebAuthChallengeImpl> WebAuthChallengeImplPtr;
	typedef Containers::ComPtr<WebRequestImpl> WebRequestImplPtr;
	typedef Containers::ComPtr<WebResponseImpl> WebResponseImplPtr;
	typedef Containers::ComPtr<WebSessionImpl> WebSessionImplPtr;
#endif

	/** @brief Contains the authentication challenge information */
	class WebAuthChallenge
	{
		friend class WebRequestAsync;

	public:
		/** @brief Authentication challenge source */
		enum class Source {
			Server,			/**< Server requested authentication */
			Proxy			/**< Proxy requested authentication */
		};

		WebAuthChallenge();
		WebAuthChallenge(const WebAuthChallenge& other);
		WebAuthChallenge& operator=(const WebAuthChallenge& other);
		~WebAuthChallenge();

		/** @brief Whether the object is valid */
		explicit operator bool() const noexcept {
			return IsValid();
		}
		
		/** @brief Returns `true` if the object is valid */
		bool IsValid() const noexcept {
			return _impl;
		}

		/** @brief Returns which source requested credentials with this challenge */
		Source GetSource() const;

		/** @brief Sets credentials */
		void SetCredentials(const WebCredentials& cred);

	private:
		WebAuthChallengeImplPtr _impl;

		explicit WebAuthChallenge(const WebAuthChallengeImplPtr& impl);
	};

	/** @brief Describes the server response of the web request */
	class WebResponse
	{
		friend class WebRequestBase;
		friend class WebRequestImpl;
		friend class WebResponseImpl;

	public:
		WebResponse();
		WebResponse(const WebResponse& other);
		WebResponse& operator=(const WebResponse& other);
		~WebResponse();

		/** @brief Whether the object is valid */
		explicit operator bool() const noexcept {
			return IsValid();
		}
		
		/** @brief Returns `true` if the object is valid */
		bool IsValid() const noexcept {
			return _impl;
		}

		/** @brief Returns the content length of the response data */
		std::int64_t GetContentLength() const;
		/** @brief Returns the effective URL of the request */
		Containers::String GetURL() const;
		/** @brief Returns value of the specified header */
		Containers::String GetHeader(Containers::StringView name) const;
		/** @brief Returns all values of the specified header */
		Containers::Array<Containers::String> GetAllHeaderValues(Containers::StringView name) const;
		/** @brief Returns the MIME type of the response */
		Containers::String GetMimeType() const;
		/** @brief Returns the value of the "Content-Type" header */
		Containers::String GetContentType() const;
		/** @brief Returns the status code returned by the server */
		std::int32_t GetStatus() const;
		/** @brief Returns the status text returned by the server */
		Containers::String GetStatusText() const;
		/** @brief Returns a stream which represents the response data sent by the server */
		Stream* GetStream() const;
		/** @brief Returns a suggested filename for the response data */
		Containers::String GetSuggestedFileName() const;
		/** @brief Returns all response data as a string */
		Containers::String AsString() const;
		/** @brief Returns the full path of the file to which data is being saved when the storage is @relativeref{WebRequestBase,Storage::File} */
		Containers::String GetDataFile() const;

	protected:
#ifndef DOXYGEN_GENERATING_OUTPUT
		WebResponseImplPtr _impl;

		explicit WebResponse(const WebResponseImplPtr& impl);
#endif
	};

	/** @brief Base class of web requests */
	class WebRequestBase
	{
	public:
		/** @brief Request state */
		enum class State {
			Idle,			/**< The request has just been created and @ref WebRequestAsync::Run() has not been called */
			Unauthorized,	/**< The request is currently unauthorized */
			Active,			/**< The request is about to start */
			Completed,		/**< The request completed successfully and all data has been received */
			Failed,			/**< The request failed */
			Cancelled		/**< The request has been cancelled before completion by calling @ref WebRequestAsync::Cancel() */
		};

		/** @brief Storage for response data */
		enum class Storage {
			Memory,			/**< Response is collected in memory until the request is complete */
			File,			/**< Response is written to a file on disk as it is received */
			None			/**< Response is not stored by the request */
		};

		/** @brief Result of synchronous operation */
		struct Result
		{
			/** @brief Creates a successful or partial result */
			static Result Ok(State state = State::Active) {
				Result result;
				result.state = state;
				return result;
			}

			/** @brief Creates a cancelled result */
			static Result Cancelled() {
				Result result;
				result.state = State::Cancelled;
				return result;
			}

			/** @brief Creates a failed result */
			static Result Error(Containers::StringView error) {
				Result result;
				result.state = State::Failed;
				result.error = error;
				return result;
			}

			/** @brief Creates a result waiting for authorization */
			static Result Unauthorized(Containers::StringView error) {
				Result result;
				result.state = State::Unauthorized;
				result.error = error;
				return result;
			}

			/** @brief Whether the request did not fail */
			explicit operator bool() const noexcept {
				return (state != State::Failed);
			}

			/** @brief The state of the request */
			State state = State::Idle;
			/** @brief The error message in case of a failure */
			Containers::String error;
		};

		/** @brief Whether the object is valid */
		explicit operator bool() const noexcept {
			return IsValid();
		}
		
		/** @brief Returns `true` if the object is valid */
		bool IsValid() const noexcept {
			return _impl;
		}

		/** @brief Sets a request header which will be sent to the server by this request */
		void SetHeader(Containers::StringView name, Containers::StringView value);
		/** @brief Sets the HTTP request method */
		void SetMethod(Containers::StringView method);
		/** @brief Sets the text to be posted to the server in this request */
		void SetData(Containers::StringView text, Containers::StringView contentType);
		/** @brief Sets the binary data to be posted to the server in this request */
		bool SetData(std::unique_ptr<Stream> dataStream, Containers::StringView contentType, std::int64_t dataSize = -1);
		/** @brief Returns the destination storage where the response data will be stored */
		Storage GetStorage() const;
		/** @brief Sets the destination storage where the response data will be stored */
		void SetStorage(Storage storage);

		/** @brief Returns the server response */
		WebResponse GetResponse() const;

		/** @brief Returns the number of bytes sent to the server */
		std::int64_t GetBytesSent() const;
		/** @brief Returns the total number of bytes expected to be sent to the server */
		std::int64_t GetBytesExpectedToSend() const;
		/** @brief Returns the number of bytes received from the server */
		std::int64_t GetBytesReceived() const;
		/** @brief Returns the number of bytes expected to be received from the server */
		std::int64_t GetBytesExpectedToReceive() const;

		/** @brief Returns the native handle corresponding to this request object */
		WebRequestHandle GetNativeHandle() const noexcept;

		/** @brief Flags for disabling security features, supports a bitwise combination of its member values */
		enum class Ignore {
			None = 0,					/**< None */
			Certificate = 1,			/**< Disable SSL certificate verification */
			Host = 2,					/**< Disable hostname verification */
			All = Certificate | Host	/**< Disable all security checks for maximum insecurity */
		};

		DEATH_PRIVATE_ENUM_FLAGS(Ignore);

		/** @brief Makes the connection insecure by disabling security checks */
		void MakeInsecure(Ignore flags = Ignore::All);
		/** @brief Returns security bypass flags */
		Ignore GetSecurityFlags() const;

		/** @brief Disables SSL certificate verification */
		void DisablePeerVerify(bool disable = true) {
			MakeInsecure(disable ? Ignore::Certificate : Ignore::None);
		}

		/** @brief Returns `true` if SSL certificate verification is disabled */
		bool IsPeerVerifyDisabled() const {
			return (GetSecurityFlags() & Ignore::Certificate) != Ignore::None;
		}

	protected:
#ifndef DOXYGEN_GENERATING_OUTPUT
		WebRequestImplPtr _impl;

		WebRequestBase();
		explicit WebRequestBase(const WebRequestImplPtr& impl);
		WebRequestBase(const WebRequestBase& other);
		WebRequestBase& operator=(const WebRequestBase& other);
		~WebRequestBase();
#endif
	};

	/** @brief Represents web request */
	class WebRequest : public WebRequestBase
	{
		friend class WebSession;

	public:
		WebRequest() = default;
		WebRequest(const WebRequest& other) = default;
		WebRequest& operator=(const WebRequest& other) = default;

		/** @brief Executes the request synchronously */
		Result Execute() const;

	private:
		explicit WebRequest(const WebRequestImplPtr& impl)
			: WebRequestBase(impl) {}
	};

	/** @brief Represents asynchronous web request */
	class WebRequestAsync : public WebRequestBase
	{
		friend class WebSessionAsync;
		friend class WebRequestImpl;
		friend class WebResponseImpl;

	public:
		WebRequestAsync() = default;
		WebRequestAsync(const WebRequestAsync& other) = default;
		WebRequestAsync& operator=(const WebRequestAsync& other) = default;

		/** @brief Executes the request to the server asynchronously */
		void Run();
		/** @brief Cancels the active request */
		void Cancel();
		/** @brief Returns the current authentication challenge while the state of the request is @ref State::Unauthorized */
		WebAuthChallenge GetAuthChallenge() const;
		/** @brief Returns the ID specified while creating the request */
		std::int32_t GetId() const;
		/** @brief Returns the underlying session */
		WebSessionAsync& GetSession() const;
		/** @brief Returns the current state of the request */
		State GetState() const;

	private:
		explicit WebRequestAsync(const WebRequestImplPtr& impl)
			: WebRequestBase(impl) {}
	};

	/** @brief Describes the proxy settings to be used by the session */
	class WebProxy
	{
	public:
		/** @brief Creates proxy settings from the specified URL */
		static WebProxy FromURL(Containers::StringView url) {
			return WebProxy(Type::URL, url);
		}

		/** @brief Creates proxy settings to disable proxy even if one is configured */
		static WebProxy Disable() {
			return WebProxy(Type::Disabled);
		}

		/** @brief Creates default proxy settings */
		static WebProxy Default() {
			return WebProxy(Type::Default);
		}

		/** @brief Proxy type */
		enum class Type {
			URL,			/**< URL */
			Disabled,		/**< Disabled */
			Default			/**< Default */
		};

		/** @brief Returns proxy type */
		Type GetType() const;
		/** @brief Returns proxy URL if @ref Type::URL is selected */
		Containers::StringView GetURL() const;

	private:
		Type _type;
		Containers::String _url;

		WebProxy(Type type, Containers::StringView url = {});
	};

	/** @brief Base class of web sessions */
	class WebSessionBase
	{
	public:
		WebSessionBase();

		WebSessionBase(const WebSessionBase& other);
		WebSessionBase& operator=(const WebSessionBase& other);
		~WebSessionBase();
		
		/** @brief Whether the session was successfully opened and can be used */
		explicit operator bool() const noexcept {
			return IsOpened();
		}

		/** @brief Returns `true` if the network backend is available and web requests can be made */
		static bool IsBackendAvailable();

		/** @brief Sets a request header in every request created from this session after it has been set. */
		void AddCommonHeader(Containers::StringView name, Containers::StringView value);
		/** @brief Returns the current temporary directory */
		Containers::String GetTempDirectory() const;
		/** @brief Sets the current temporary directory */
		void SetTempDirectory(Containers::StringView path);
		/** @brief Sets the proxy to use for all requests initiated by this session */
		bool SetProxy(const WebProxy& proxy);
		/** @brief Returns `true` if the session was successfully opened and can be used */
		bool IsOpened() const noexcept;
		/** @brief Closes the session */
		void Dispose();
		/** @brief Allows to enable persistent storage for the session */
		bool EnablePersistentStorage(bool enable);
		/** @brief Returns the native handle corresponding to this session object */
		WebSessionHandle GetNativeHandle() const noexcept;

	protected:
#ifndef DOXYGEN_GENERATING_OUTPUT
		WebSessionImplPtr _impl;

		/** @brief Returns the internal session factory */
		static WebSessionFactory* FindFactory();

		explicit WebSessionBase(const WebSessionImplPtr& impl);
#endif
	};

	/** @brief Represents web session that allows @ref WebRequest to be created */
	class WebSession : public WebSessionBase
	{
	public:
		WebSession() = default;

		WebSession(const WebSession& other) = default;
		WebSession& operator=(const WebSession& other) = default;

		/** @brief Returns the default session for synchronous requests */
		static WebSession& GetDefault();

		/** @brief Creates a new session for synchronous requests */
		static WebSession New();

		/** @brief Creates a new synchronous request */
		WebRequest CreateRequest(Containers::StringView url);

	private:
		explicit WebSession(const WebSessionImplPtr& impl)
			: WebSessionBase(impl) {}
	};

	/** @brief Represents web session that allows @ref WebRequestAsync to be created */
	class WebSessionAsync : public WebSessionBase
	{
	public:
		WebSessionAsync() = default;

		WebSessionAsync(const WebSessionAsync& other) = default;
		WebSessionAsync& operator=(const WebSessionAsync& other) = default;

		/** @brief Returns the default session for asynchronous requests */
		static WebSessionAsync& GetDefault();

		/** @brief Creates a new session for asynchronous requests */
		static WebSessionAsync New();

		/** @brief Creates a new asynchronous request */
		WebRequestAsync CreateRequest(Containers::StringView url, Containers::Function<void(WebRequestEvent& e)>&& callback, std::int32_t id = -1);

	private:
		explicit WebSessionAsync(const WebSessionImplPtr& impl)
			: WebSessionBase(impl) {}
	};

	/** @brief Result of the asynchronous web request */
	class WebRequestEvent
	{
	public:
		WebRequestEvent(std::int32_t id = -1, WebRequest::State state = WebRequest::State::Idle,
						const WebRequestAsync& request = {}, const WebResponse& response = {}, Containers::StringView errorDesc = {});

		/** @brief Returns the current state of the request */
		WebRequestAsync::State GetState() const;
		/** @brief 	Returns a reference to the @ref WebRequestAsync object which initiated this event */
		const WebRequestAsync& GetRequest() const;
		/** @brief Returns the response when the state is @relativeref{WebRequestBase,State::Completed} */
		const WebResponse& GetResponse() const;
		/** @brief Returns a textual error description when the state is @relativeref{WebRequestBase,State::Failed} */
		Containers::StringView GetErrorDescription() const;
		/** @brief Returns the full path of a temporary file containing the response data when the state is @relativeref{WebRequestBase,State::Completed} and storage is @relativeref{WebRequestBase,Storage::File} */
		Containers::StringView GetDataFile() const;
		/** @brief Returns the underlying buffer */
		Containers::ArrayView<char> GetDataBuffer() const;

#ifndef DOXYGEN_GENERATING_OUTPUT
		void SetDataFile(Containers::StringView dataFile);
		void SetDataBuffer(Containers::ArrayView<char> dataBuffer);
#endif

	private:
		std::int32_t _id;
		WebRequestAsync::State _state;
		const WebRequestAsync _request;
		const WebResponse _response;
		Containers::String _dataFile;
		Containers::ArrayView<char> _dataBuffer;
		Containers::String _errorDescription;
	};

}}