forked from j-ulrich/http-status-codes-cpp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathHttpStatusCodes_Qt.h
349 lines (313 loc) · 24.9 KB
/
HttpStatusCodes_Qt.h
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
/*! \file
*
* HTTP Status Codes - Qt Variant
*
* https://github.com/j-ulrich/http-status-codes-cpp
*
* \version 1.5.0
* \author Jochen Ulrich <jochenulrich@t-online.de>
* \copyright Licensed under Creative Commons CC0 (http://creativecommons.org/publicdomain/zero/1.0/)
*/
#ifndef HTTPSTATUSCODES_QT5_H_
#define HTTPSTATUSCODES_QT5_H_
#include <QString>
#include <QObject>
#ifdef QT_NETWORK_LIB
# include <QNetworkReply>
#endif // QT_NETWORK_LIB
/*! Namespace for HTTP status codes and reason phrases.
*/
namespace HttpStatus
{
#if (QT_VERSION >= QT_VERSION_CHECK(5,8,0))
Q_NAMESPACE
#endif // Qt >= 5.8.0
/*! Enum for the HTTP status codes.
*/
enum class Code
{
Invalid = -1,
/*####### 1xx - Informational #######*/
/* Indicates an interim response for communicating connection status
* or request progress prior to completing the requested action and
* sending a final response.
*/
Continue = 100, //!< Indicates that the initial part of a request has been received and has not yet been rejected by the server.
SwitchingProtocols = 101, //!< Indicates that the server understands and is willing to comply with the client's request, via the Upgrade header field, for a change in the application protocol being used on this connection.
Processing = 102, //!< Is an interim response used to inform the client that the server has accepted the complete request, but has not yet completed it.
EarlyHints = 103, //!< Indicates to the client that the server is likely to send a final response with the header fields included in the informational response.
/*####### 2xx - Successful #######*/
/* Indicates that the client's request was successfully received,
* understood, and accepted.
*/
OK = 200, //!< Indicates that the request has succeeded.
Created = 201, //!< Indicates that the request has been fulfilled and has resulted in one or more new resources being created.
Accepted = 202, //!< Indicates that the request has been accepted for processing, but the processing has not been completed.
NonAuthoritativeInformation = 203, //!< Indicates that the request was successful but the enclosed payload has been modified from that of the origin server's 200 (OK) response by a transforming proxy.
NoContent = 204, //!< Indicates that the server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
ResetContent = 205, //!< Indicates that the server has fulfilled the request and desires that the user agent reset the \"document view\", which caused the request to be sent, to its original state as received from the origin server.
PartialContent = 206, //!< Indicates that the server is successfully fulfilling a range request for the target resource by transferring one or more parts of the selected representation that correspond to the satisfiable ranges found in the requests's Range header field.
MultiStatus = 207, //!< Provides status for multiple independent operations.
AlreadyReported = 208, //!< Used inside a DAV:propstat response element to avoid enumerating the internal members of multiple bindings to the same collection repeatedly. [RFC 5842]
IMUsed = 226, //!< The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.
/*####### 3xx - Redirection #######*/
/* Indicates that further action needs to be taken by the user agent
* in order to fulfill the request.
*/
MultipleChoices = 300, //!< Indicates that the target resource has more than one representation, each with its own more specific identifier, and information about the alternatives is being provided so that the user (or user agent) can select a preferred representation by redirecting its request to one or more of those identifiers.
MovedPermanently = 301, //!< Indicates that the target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs.
Found = 302, //!< Indicates that the target resource resides temporarily under a different URI.
SeeOther = 303, //!< Indicates that the server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, that is intended to provide an indirect response to the original request.
NotModified = 304, //!< Indicates that a conditional GET request has been received and would have resulted in a 200 (OK) response if it were not for the fact that the condition has evaluated to false.
UseProxy = 305, //!< \deprecated \parblock Due to security concerns regarding in-band configuration of a proxy. \endparblock
//!< The requested resource MUST be accessed through the proxy given by the Location field.
TemporaryRedirect = 307, //!< Indicates that the target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI.
PermanentRedirect = 308, //!< The target resource has been assigned a new permanent URI and any future references to this resource outght to use one of the enclosed URIs. [...] This status code is similar to 301 Moved Permanently (Section 7.3.2 of rfc7231), except that it does not allow rewriting the request method from POST to GET.
/*####### 4xx - Client Error #######*/
/* Indicates that the client seems to have erred.
*/
BadRequest = 400, //!< Indicates that the server cannot or will not process the request because the received syntax is invalid, nonsensical, or exceeds some limitation on what the server is willing to process.
Unauthorized = 401, //!< Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.
PaymentRequired = 402, //!< *Reserved*
Forbidden = 403, //!< Indicates that the server understood the request but refuses to authorize it.
NotFound = 404, //!< Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
MethodNotAllowed = 405, //!< Indicates that the method specified in the request-line is known by the origin server but not supported by the target resource.
NotAcceptable = 406, //!< Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request, and the server is unwilling to supply a default representation.
ProxyAuthenticationRequired = 407, //!< Is similar to 401 (Unauthorized), but indicates that the client needs to authenticate itself in order to use a proxy.
RequestTimeout = 408, //!< Indicates that the server did not receive a complete request message within the time that it was prepared to wait.
Conflict = 409, //!< Indicates that the request could not be completed due to a conflict with the current state of the resource.
Gone = 410, //!< Indicates that access to the target resource is no longer available at the origin server and that this condition is likely to be permanent.
LengthRequired = 411, //!< Indicates that the server refuses to accept the request without a defined Content-Length.
PreconditionFailed = 412, //!< Indicates that one or more preconditions given in the request header fields evaluated to false when tested on the server.
ContentTooLarge = 413, //!< Indicates that the server is refusing to process a request because the request payload is larger than the server is willing or able to process.
PayloadTooLarge = 413, //!< Alias for ContentTooLarge for backward compatibility.
URITooLong = 414, //!< Indicates that the server is refusing to service the request because the request-target is longer than the server is willing to interpret.
UnsupportedMediaType = 415, //!< Indicates that the origin server is refusing to service the request because the payload is in a format not supported by the target resource for this method.
RangeNotSatisfiable = 416, //!< Indicates that none of the ranges in the request's Range header field overlap the current extent of the selected resource or that the set of ranges requested has been rejected due to invalid ranges or an excessive request of small or overlapping ranges.
ExpectationFailed = 417, //!< Indicates that the expectation given in the request's Expect header field could not be met by at least one of the inbound servers.
ImATeapot = 418, //!< Any attempt to brew coffee with a teapot should result in the error code 418 I'm a teapot.
MisdirectedRequest = 421, //!< Indicates that the request was directed at a server that is unable or unwilling to produce an authoritative response for the target URI.
UnprocessableContent = 422, //!< Means the server understands the content type of the request entity (hence a 415(Unsupported Media Type) status code is inappropriate), and the syntax of the request entity is correct (thus a 400 (Bad Request) status code is inappropriate) but was unable to process the contained instructions.
UnprocessableEntity = 422, //!< Alias for UnprocessableContent for backward compatibility.
Locked = 423, //!< Means the source or destination resource of a method is locked.
FailedDependency = 424, //!< Means that the method could not be performed on the resource because the requested action depended on another action and that action failed.
TooEarly = 425, //!< Indicates that the server is unwilling to risk processing a request that might be replayed.
UpgradeRequired = 426, //!< Indicates that the server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol.
PreconditionRequired = 428, //!< Indicates that the origin server requires the request to be conditional.
TooManyRequests = 429, //!< Indicates that the user has sent too many requests in a given amount of time (\"rate limiting\").
RequestHeaderFieldsTooLarge = 431, //!< Indicates that the server is unwilling to process the request because its header fields are too large.
UnavailableForLegalReasons = 451, //!< This status code indicates that the server is denying access to the resource in response to a legal demand.
/*####### 5xx - Server Error #######*/
/* Indicates that the server is aware that it has erred
* or is incapable of performing the requested method.
*/
InternalServerError = 500, //!< Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
NotImplemented = 501, //!< Indicates that the server does not support the functionality required to fulfill the request.
BadGateway = 502, //!< Indicates that the server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request.
ServiceUnavailable = 503, //!< Indicates that the server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.
GatewayTimeout = 504, //!< Indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request.
HTTPVersionNotSupported = 505, //!< Indicates that the server does not support, or refuses to support, the protocol version that was used in the request message.
VariantAlsoNegotiates = 506, //!< Indicates that the server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process.
InsufficientStorage = 507, //!< Means the method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
LoopDetected = 508, //!< Indicates that the server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity". [RFC 5842]
NotExtended = 510, //!< \deprecated \parblock Obsoleted as the experiment has ended and there is no evidence of widespread use. \endparblock
//!< The policy for accessing the resource has not been met in the request. [RFC 2774]
NetworkAuthenticationRequired = 511, //!< Indicates that the client needs to authenticate to gain network access.
NetworkConnectTimeoutError = 599, //!< An error used by some HTTP proxies to signal a network connect timeout behind the proxy to a client in front of the proxy.
xxx_max = 1023
};
#if (QT_VERSION >= QT_VERSION_CHECK(5,8,0))
Q_ENUM_NS(Code)
#endif // Qt >= 5.8.0
inline bool isInformational(Code code) { return (code >= Code::Continue && code < Code::OK); } //!< \returns \c true if the given \p code is an informational code.
inline bool isSuccessful(Code code) { return (code >= Code::OK && code < Code::MultipleChoices); } //!< \returns \c true if the given \p code is a successful code.
inline bool isRedirection(Code code) { return (code >= Code::MultipleChoices && code < Code::BadRequest); } //!< \returns \c true if the given \p code is a redirectional code.
inline bool isClientError(Code code) { return (code >= Code::BadRequest && code < Code::InternalServerError); } //!< \returns \c true if the given \p code is a client error code.
inline bool isServerError(Code code) { return (code >= Code::InternalServerError && code <= Code::NetworkConnectTimeoutError); } //!< \returns \c true if the given \p code is a server error code.
inline bool isError(Code code) { return (code >= Code::BadRequest); } //!< \returns \c true if the given \p code is any type of error code.
/*! Returns the standard HTTP reason phrase for a HTTP status code.
* \param code An HTTP status code.
* \return The standard HTTP reason phrase for the given \p code or a null \c QString()
* if no standard phrase for the given \p code is known.
*/
inline QString reasonPhrase(Code code)
{
switch (code)
{
//####### 1xx - Informational #######
case Code::Continue: return QStringLiteral("Continue");
case Code::SwitchingProtocols: return QStringLiteral("Switching Protocols");
case Code::Processing: return QStringLiteral("Processing");
case Code::EarlyHints: return QStringLiteral("Early Hints");
//####### 2xx - Successful #######
case Code::OK: return QStringLiteral("OK");
case Code::Created: return QStringLiteral("Created");
case Code::Accepted: return QStringLiteral("Accepted");
case Code::NonAuthoritativeInformation: return QStringLiteral("Non-Authoritative Information");
case Code::NoContent: return QStringLiteral("No Content");
case Code::ResetContent: return QStringLiteral("Reset Content");
case Code::PartialContent: return QStringLiteral("Partial Content");
case Code::MultiStatus: return QStringLiteral("Multi-Status");
case Code::AlreadyReported: return QStringLiteral("Already Reported");
case Code::IMUsed: return QStringLiteral("IM Used");
//####### 3xx - Redirection #######
case Code::MultipleChoices: return QStringLiteral("Multiple Choices");
case Code::MovedPermanently: return QStringLiteral("Moved Permanently");
case Code::Found: return QStringLiteral("Found");
case Code::SeeOther: return QStringLiteral("See Other");
case Code::NotModified: return QStringLiteral("Not Modified");
case Code::UseProxy: return QStringLiteral("Use Proxy");
case Code::TemporaryRedirect: return QStringLiteral("Temporary Redirect");
case Code::PermanentRedirect: return QStringLiteral("Permanent Redirect");
//####### 4xx - Client Error #######
case Code::BadRequest: return QStringLiteral("Bad Request");
case Code::Unauthorized: return QStringLiteral("Unauthorized");
case Code::PaymentRequired: return QStringLiteral("Payment Required");
case Code::Forbidden: return QStringLiteral("Forbidden");
case Code::NotFound: return QStringLiteral("Not Found");
case Code::MethodNotAllowed: return QStringLiteral("Method Not Allowed");
case Code::NotAcceptable: return QStringLiteral("Not Acceptable");
case Code::ProxyAuthenticationRequired: return QStringLiteral("Proxy Authentication Required");
case Code::RequestTimeout: return QStringLiteral("Request Timeout");
case Code::Conflict: return QStringLiteral("Conflict");
case Code::Gone: return QStringLiteral("Gone");
case Code::LengthRequired: return QStringLiteral("Length Required");
case Code::PreconditionFailed: return QStringLiteral("Precondition Failed");
case Code::ContentTooLarge: return QStringLiteral("Content Too Large");
case Code::URITooLong: return QStringLiteral("URI Too Long");
case Code::UnsupportedMediaType: return QStringLiteral("Unsupported Media Type");
case Code::RangeNotSatisfiable: return QStringLiteral("Range Not Satisfiable");
case Code::ExpectationFailed: return QStringLiteral("Expectation Failed");
case Code::ImATeapot: return QStringLiteral("I'm a teapot");
case Code::MisdirectedRequest: return QStringLiteral("Misdirected Request");
case Code::UnprocessableContent: return QStringLiteral("Unprocessable Content");
case Code::Locked: return QStringLiteral("Locked");
case Code::FailedDependency: return QStringLiteral("Failed Dependency");
case Code::TooEarly: return QStringLiteral("Too Early");
case Code::UpgradeRequired: return QStringLiteral("Upgrade Required");
case Code::PreconditionRequired: return QStringLiteral("Precondition Required");
case Code::TooManyRequests: return QStringLiteral("Too Many Requests");
case Code::RequestHeaderFieldsTooLarge: return QStringLiteral("Request Header Fields Too Large");
case Code::UnavailableForLegalReasons: return QStringLiteral("Unavailable For Legal Reasons");
//####### 5xx - Server Error #######
case Code::InternalServerError: return QStringLiteral("Internal Server Error");
case Code::NotImplemented: return QStringLiteral("Not Implemented");
case Code::BadGateway: return QStringLiteral("Bad Gateway");
case Code::ServiceUnavailable: return QStringLiteral("Service Unavailable");
case Code::GatewayTimeout: return QStringLiteral("Gateway Timeout");
case Code::HTTPVersionNotSupported: return QStringLiteral("HTTP Version Not Supported");
case Code::VariantAlsoNegotiates: return QStringLiteral("Variant Also Negotiates");
case Code::InsufficientStorage: return QStringLiteral("Insufficient Storage");
case Code::LoopDetected: return QStringLiteral("Loop Detected");
case Code::NotExtended: return QStringLiteral("Not Extended");
case Code::NetworkAuthenticationRequired: return QStringLiteral("Network Authentication Required");
case Code::NetworkConnectTimeoutError: return QStringLiteral("Network Connection Timeout");
default: return QString();
}
}
#ifdef QT_NETWORK_LIB
/*! Returns a Code corresponding to a given NetworkError.
*
* \param error The NetworkError whose HTTP status code should be returned.
* \return The HTTP status code corresponding to the given \p error if there is one.\n
* If there is no exact matching status code, the first code from the best matching status
* code class is returned (`200`, `400` or `500`).\n
* If no matching status code exists, an invalid status code (`-1`) is returned.
* This is typically the case for errors concerning the OSI layers below HTTP.
*
* \sa [statusCodeFromHttp() in qhttpthreaddelegate.cpp](http://code.qt.io/cgit/qt/qtbase.git/tree/src/network/access/qhttpthreaddelegate.cpp#n57)
*/
inline Code networkErrorToStatusCode(QNetworkReply::NetworkError error)
{
switch (error)
{
// Exact matches
case QNetworkReply::AuthenticationRequiredError: return Code::Unauthorized; // 401
case QNetworkReply::ContentAccessDenied: return Code::Forbidden; // 403
case QNetworkReply::ContentNotFoundError: return Code::NotFound; // 404
case QNetworkReply::ContentOperationNotPermittedError: return Code::MethodNotAllowed; // 405
case QNetworkReply::ProxyAuthenticationRequiredError: return Code::ProxyAuthenticationRequired; // 407
#if QT_VERSION >= QT_VERSION_CHECK(5,3,0)
case QNetworkReply::TimeoutError: return Code::RequestTimeout; // 408
case QNetworkReply::ContentConflictError: return Code::Conflict; // 409
case QNetworkReply::ContentGoneError: return Code::Gone; // 410
case QNetworkReply::InternalServerError: return Code::InternalServerError; // 500
case QNetworkReply::OperationNotImplementedError: return Code::NotImplemented; // 501
case QNetworkReply::ServiceUnavailableError: return Code::ServiceUnavailable; // 503
#endif // Qt >= 5.3.0
// Mapping error codes matching multiple HTTP status codes to a best matching "base" code
case QNetworkReply::NoError: return Code::OK; // 200
case QNetworkReply::ProtocolInvalidOperationError: return Code::BadRequest; // 400
case QNetworkReply::UnknownContentError: return Code::BadRequest; // 400
#if QT_VERSION >= QT_VERSION_CHECK(5,3,0)
case QNetworkReply::UnknownServerError: return Code::InternalServerError; // 500
#endif // Qt >= 5.3.0
/* Other errors do not match any HTTP status code.
* Therefore, we return an invalid code.
*/
default:
return static_cast<Code>(-1);
}
}
/*! Returns a NetworkError corresponding to a given Code.
*
* \param code The HTTP status code whose NetworkError should be returned.
* \return The QNetworkReply::NetworkError corresponding to the given \p code.\n
* Note that some NetworkErrors are used for multiple HTTP status codes:\n
* For status codes which do not represent errors, QNetworkReply::NoError is returned.\n
* For client error status codes which do not have an exact matching NetworkError,
* QNetworkReply::UnknownContentError is returned.\n
* For server error status codes which do not have an exact matching NetworkError,
* QNetworkReply::UnknownServerError is returned.\n
* For status codes 600 or higher, QNetworkReply::ProtocolFailure is returned.
*
* \sa [statusCodeFromHttp() in qhttpthreaddelegate.cpp](http://code.qt.io/cgit/qt/qtbase.git/tree/src/network/access/qhttpthreaddelegate.cpp#n57)
*/
inline QNetworkReply::NetworkError statusCodeToNetworkError(Code code)
{
// below 400
if (!isError(code))
return QNetworkReply::NoError;
// Specific error status codes
switch (code)
{
case Code::BadRequest: return QNetworkReply::ProtocolInvalidOperationError; // 400
case Code::Unauthorized: return QNetworkReply::AuthenticationRequiredError; // 401
case Code::Forbidden: return QNetworkReply::ContentAccessDenied; // 403
case Code::NotFound: return QNetworkReply::ContentNotFoundError; // 404
case Code::MethodNotAllowed: return QNetworkReply::ContentOperationNotPermittedError; // 405
case Code::ProxyAuthenticationRequired: return QNetworkReply::ProxyAuthenticationRequiredError; // 407
#if QT_VERSION >= QT_VERSION_CHECK(5,3,0)
case Code::RequestTimeout: return QNetworkReply::TimeoutError;
case Code::Conflict: return QNetworkReply::ContentConflictError; // 409
case Code::Gone: return QNetworkReply::ContentGoneError; // 410
#endif // Qt >= 5.3.0
case Code::ImATeapot: return QNetworkReply::ProtocolInvalidOperationError; // 418
#if QT_VERSION >= QT_VERSION_CHECK(5,3,0)
case Code::InternalServerError: return QNetworkReply::InternalServerError; // 500
case Code::NotImplemented: return QNetworkReply::OperationNotImplementedError; // 501
case Code::ServiceUnavailable: return QNetworkReply::ServiceUnavailableError; // 503
#endif // Qt >= 5.3.0
default:
break;
}
if (isClientError(code)) // 4xx
return QNetworkReply::UnknownContentError;
#if QT_VERSION >= QT_VERSION_CHECK(5,3,0)
if (isServerError(code)) // 5xx
return QNetworkReply::UnknownServerError;
#endif // Qt >= 5.3.0
// 600 or above
return QNetworkReply::ProtocolFailure;
}
#endif // QT_NETWORK_LIB
#ifdef THIS_IS_A_TRICK_TO_FORCE_CMAKE_QMAKE_AND_SIMILAR_TOOLS_TO_RUN_MOC_ON_THIS_FILE
namespace {
class DummyQGadget
{
Q_GADGET
};
}
#endif
} // namespace HttpStatus
#endif /* HTTPSTATUSCODES_QT5_8_H_ */