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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 8 -*- */
/*
* soup-status.c: Status code descriptions
*
* Copyright (C) 2001-2003, Ximian, Inc.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "soup-status.h"
#include "soup.h"
/**
* SECTION:soup-status
* @section_id: SoupStatus
* @short_description: HTTP (and libsoup) status codes
*
* HTTP (and libsoup) status codes.
**/
/**
* SOUP_STATUS_IS_INFORMATIONAL:
* @status: an HTTP status code
*
* Tests if @status is an Informational (1xx) response.
*
* Returns: %TRUE or %FALSE
**/
/**
* SOUP_STATUS_IS_SUCCESSFUL:
* @status: an HTTP status code
*
* Tests if @status is a Successful (2xx) response.
*
* Returns: %TRUE or %FALSE
**/
/**
* SOUP_STATUS_IS_REDIRECTION:
* @status: an HTTP status code
*
* Tests if @status is a Redirection (3xx) response.
*
* Returns: %TRUE or %FALSE
**/
/**
* SOUP_STATUS_IS_CLIENT_ERROR:
* @status: an HTTP status code
*
* Tests if @status is a Client Error (4xx) response.
*
* Returns: %TRUE or %FALSE
**/
/**
* SOUP_STATUS_IS_SERVER_ERROR:
* @status: an HTTP status code
*
* Tests if @status is a Server Error (5xx) response.
*
* Returns: %TRUE or %FALSE
**/
/**
* SoupStatus:
* @SOUP_STATUS_NONE: No status available. (Eg, the message has not
* been sent yet)
* @SOUP_STATUS_CONTINUE: 100 Continue (HTTP)
* @SOUP_STATUS_SWITCHING_PROTOCOLS: 101 Switching Protocols (HTTP)
* @SOUP_STATUS_PROCESSING: 102 Processing (WebDAV)
* @SOUP_STATUS_OK: 200 Success (HTTP). Also used by many lower-level
* soup routines to indicate success.
* @SOUP_STATUS_CREATED: 201 Created (HTTP)
* @SOUP_STATUS_ACCEPTED: 202 Accepted (HTTP)
* @SOUP_STATUS_NON_AUTHORITATIVE: 203 Non-Authoritative Information
* (HTTP)
* @SOUP_STATUS_NO_CONTENT: 204 No Content (HTTP)
* @SOUP_STATUS_RESET_CONTENT: 205 Reset Content (HTTP)
* @SOUP_STATUS_PARTIAL_CONTENT: 206 Partial Content (HTTP)
* @SOUP_STATUS_MULTI_STATUS: 207 Multi-Status (WebDAV)
* @SOUP_STATUS_MULTIPLE_CHOICES: 300 Multiple Choices (HTTP)
* @SOUP_STATUS_MOVED_PERMANENTLY: 301 Moved Permanently (HTTP)
* @SOUP_STATUS_FOUND: 302 Found (HTTP)
* @SOUP_STATUS_MOVED_TEMPORARILY: 302 Moved Temporarily (old name,
* RFC 2068)
* @SOUP_STATUS_SEE_OTHER: 303 See Other (HTTP)
* @SOUP_STATUS_NOT_MODIFIED: 304 Not Modified (HTTP)
* @SOUP_STATUS_USE_PROXY: 305 Use Proxy (HTTP)
* @SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL: 306 [Unused] (HTTP)
* @SOUP_STATUS_TEMPORARY_REDIRECT: 307 Temporary Redirect (HTTP)
* @SOUP_STATUS_PERMANENT_REDIRECT: 308 Permanent Redirect (HTTP)
* @SOUP_STATUS_BAD_REQUEST: 400 Bad Request (HTTP)
* @SOUP_STATUS_UNAUTHORIZED: 401 Unauthorized (HTTP)
* @SOUP_STATUS_PAYMENT_REQUIRED: 402 Payment Required (HTTP)
* @SOUP_STATUS_FORBIDDEN: 403 Forbidden (HTTP)
* @SOUP_STATUS_NOT_FOUND: 404 Not Found (HTTP)
* @SOUP_STATUS_METHOD_NOT_ALLOWED: 405 Method Not Allowed (HTTP)
* @SOUP_STATUS_NOT_ACCEPTABLE: 406 Not Acceptable (HTTP)
* @SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED: 407 Proxy Authentication
* Required (HTTP)
* @SOUP_STATUS_PROXY_UNAUTHORIZED: shorter alias for
* %SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED
* @SOUP_STATUS_REQUEST_TIMEOUT: 408 Request Timeout (HTTP)
* @SOUP_STATUS_CONFLICT: 409 Conflict (HTTP)
* @SOUP_STATUS_GONE: 410 Gone (HTTP)
* @SOUP_STATUS_LENGTH_REQUIRED: 411 Length Required (HTTP)
* @SOUP_STATUS_PRECONDITION_FAILED: 412 Precondition Failed (HTTP)
* @SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE: 413 Request Entity Too Large
* (HTTP)
* @SOUP_STATUS_REQUEST_URI_TOO_LONG: 414 Request-URI Too Long (HTTP)
* @SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE: 415 Unsupported Media Type
* (HTTP)
* @SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE: 416 Requested Range
* Not Satisfiable (HTTP)
* @SOUP_STATUS_INVALID_RANGE: shorter alias for
* %SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE
* @SOUP_STATUS_EXPECTATION_FAILED: 417 Expectation Failed (HTTP)
* @SOUP_STATUS_MISDIRECTED_REQUEST: 421 Misdirected Request
* @SOUP_STATUS_UNPROCESSABLE_ENTITY: 422 Unprocessable Entity
* (WebDAV)
* @SOUP_STATUS_LOCKED: 423 Locked (WebDAV)
* @SOUP_STATUS_FAILED_DEPENDENCY: 424 Failed Dependency (WebDAV)
* @SOUP_STATUS_INTERNAL_SERVER_ERROR: 500 Internal Server Error
* (HTTP)
* @SOUP_STATUS_NOT_IMPLEMENTED: 501 Not Implemented (HTTP)
* @SOUP_STATUS_BAD_GATEWAY: 502 Bad Gateway (HTTP)
* @SOUP_STATUS_SERVICE_UNAVAILABLE: 503 Service Unavailable (HTTP)
* @SOUP_STATUS_GATEWAY_TIMEOUT: 504 Gateway Timeout (HTTP)
* @SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED: 505 HTTP Version Not
* Supported (HTTP)
* @SOUP_STATUS_INSUFFICIENT_STORAGE: 507 Insufficient Storage
* (WebDAV)
* @SOUP_STATUS_NOT_EXTENDED: 510 Not Extended (RFC 2774)
*
* These represent the known HTTP status code values, plus various
* network and internal errors.
*
* Note that no libsoup functions take or return this type directly;
* any function that works with status codes will accept unrecognized
* status codes as well.
**/
/* The reason_phrases are not localized because:
*
* 1. Only ASCII can be used portably in the HTTP Status-Line, so we
* would not be able to return localized reason phrases from
* SoupServer anyway.
*
* 2. Having a way for clients to get a localized version of a status
* code would just encourage them to present those strings to the
* user, which is bad because many of them are fairly
* incomprehensible anyway.
*/
static const struct {
guint code;
const char *phrase;
} reason_phrases [] = {
/* Informational */
{ SOUP_STATUS_CONTINUE, "Continue" },
{ SOUP_STATUS_SWITCHING_PROTOCOLS, "Switching Protocols" },
{ SOUP_STATUS_PROCESSING, "Processing" },
/* Success */
{ SOUP_STATUS_OK, "OK" },
{ SOUP_STATUS_CREATED, "Created" },
{ SOUP_STATUS_ACCEPTED, "Accepted" },
{ SOUP_STATUS_NON_AUTHORITATIVE, "Non-Authoritative Information" },
{ SOUP_STATUS_NO_CONTENT, "No Content" },
{ SOUP_STATUS_RESET_CONTENT, "Reset Content" },
{ SOUP_STATUS_PARTIAL_CONTENT, "Partial Content" },
{ SOUP_STATUS_MULTI_STATUS, "Multi-Status" },
/* Redirection */
{ SOUP_STATUS_MULTIPLE_CHOICES, "Multiple Choices" },
{ SOUP_STATUS_MOVED_PERMANENTLY, "Moved Permanently" },
{ SOUP_STATUS_FOUND, "Found" },
{ SOUP_STATUS_SEE_OTHER, "See Other" },
{ SOUP_STATUS_NOT_MODIFIED, "Not Modified" },
{ SOUP_STATUS_USE_PROXY, "Use Proxy" },
{ SOUP_STATUS_TEMPORARY_REDIRECT, "Temporary Redirect" },
{ SOUP_STATUS_PERMANENT_REDIRECT, "Permanent Redirect" },
/* Client error */
{ SOUP_STATUS_BAD_REQUEST, "Bad Request" },
{ SOUP_STATUS_UNAUTHORIZED, "Unauthorized" },
{ SOUP_STATUS_PAYMENT_REQUIRED, "Payment Required" },
{ SOUP_STATUS_FORBIDDEN, "Forbidden" },
{ SOUP_STATUS_NOT_FOUND, "Not Found" },
{ SOUP_STATUS_METHOD_NOT_ALLOWED, "Method Not Allowed" },
{ SOUP_STATUS_NOT_ACCEPTABLE, "Not Acceptable" },
{ SOUP_STATUS_PROXY_UNAUTHORIZED, "Proxy Authentication Required" },
{ SOUP_STATUS_REQUEST_TIMEOUT, "Request Timeout" },
{ SOUP_STATUS_CONFLICT, "Conflict" },
{ SOUP_STATUS_GONE, "Gone" },
{ SOUP_STATUS_LENGTH_REQUIRED, "Length Required" },
{ SOUP_STATUS_PRECONDITION_FAILED, "Precondition Failed" },
{ SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE, "Request Entity Too Large" },
{ SOUP_STATUS_REQUEST_URI_TOO_LONG, "Request-URI Too Long" },
{ SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE, "Unsupported Media Type" },
{ SOUP_STATUS_INVALID_RANGE, "Requested Range Not Satisfiable" },
{ SOUP_STATUS_EXPECTATION_FAILED, "Expectation Failed" },
{ SOUP_STATUS_UNPROCESSABLE_ENTITY, "Unprocessable Entity" },
{ SOUP_STATUS_LOCKED, "Locked" },
{ SOUP_STATUS_FAILED_DEPENDENCY, "Failed Dependency" },
/* Server error */
{ SOUP_STATUS_INTERNAL_SERVER_ERROR, "Internal Server Error" },
{ SOUP_STATUS_NOT_IMPLEMENTED, "Not Implemented" },
{ SOUP_STATUS_BAD_GATEWAY, "Bad Gateway" },
{ SOUP_STATUS_SERVICE_UNAVAILABLE, "Service Unavailable" },
{ SOUP_STATUS_GATEWAY_TIMEOUT, "Gateway Timeout" },
{ SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED, "HTTP Version Not Supported" },
{ SOUP_STATUS_INSUFFICIENT_STORAGE, "Insufficient Storage" },
{ SOUP_STATUS_NOT_EXTENDED, "Not Extended" },
{ 0 }
};
/**
* soup_status_get_phrase:
* @status_code: an HTTP status code
*
* Looks up the stock HTTP description of @status_code.
*
* <emphasis>There is no reason for you to ever use this
* function.</emphasis> If you wanted the textual description for the
* #SoupMessage:status_code of a given #SoupMessage, you should just
* look at the message's #SoupMessage:reason_phrase. However, you
* should only do that for use in debugging messages; HTTP reason
* phrases are not localized, and are not generally very descriptive
* anyway, and so they should never be presented to the user directly.
* Instead, you should create you own error messages based on the
* status code, and on what you were trying to do.
*
* Returns: the (terse, English) description of @status_code
**/
const char *
soup_status_get_phrase (guint status_code)
{
int i;
for (i = 0; reason_phrases [i].code; i++) {
if (reason_phrases [i].code == status_code)
return reason_phrases [i].phrase;
}
return "Unknown Error";
}
/**
* SoupHTTPVersion:
* @SOUP_HTTP_1_0: HTTP 1.0 (RFC 1945)
* @SOUP_HTTP_1_1: HTTP 1.1 (RFC 2616)
* @SOUP_HTTP_2_0: HTTP 2.0 (RFC 7540)
*
* Indicates the HTTP protocol version being used.
*/
|
