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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Passenger: HttpStatusExtractor.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>HttpStatusExtractor.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Phusion Passenger - http://www.modrails.com/</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2010 Phusion</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<a name="l00008"></a>00008 <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span>
<a name="l00009"></a>00009 <span class="comment"> * in the Software without restriction, including without limitation the rights</span>
<a name="l00010"></a>00010 <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<a name="l00011"></a>00011 <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span>
<a name="l00012"></a>00012 <span class="comment"> * furnished to do so, subject to the following conditions:</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * The above copyright notice and this permission notice shall be included in</span>
<a name="l00015"></a>00015 <span class="comment"> * all copies or substantial portions of the Software.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00018"></a>00018 <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00019"></a>00019 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<a name="l00020"></a>00020 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00021"></a>00021 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
<a name="l00022"></a>00022 <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
<a name="l00023"></a>00023 <span class="comment"> * THE SOFTWARE.</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#include <string></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <cstdio></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <cstdlib></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">namespace </span>Passenger {
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">using namespace </span>std;
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/**</span>
<a name="l00035"></a>00035 <span class="comment"> * Utility class for extracting the HTTP status value from an HTTP response.</span>
<a name="l00036"></a>00036 <span class="comment"> *</span>
<a name="l00037"></a>00037 <span class="comment"> * This class is used for generating a proper HTTP response. The response data</span>
<a name="l00038"></a>00038 <span class="comment"> * that Passenger backend processes generate are like CGI responses, and do not</span>
<a name="l00039"></a>00039 <span class="comment"> * include an initial "HTTP/1.1 [status here]" line, so this class used to</span>
<a name="l00040"></a>00040 <span class="comment"> * extract the status from the response in order to generate a proper initial</span>
<a name="l00041"></a>00041 <span class="comment"> * HTTP response line.</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> * This class is supposed to be used as follows:</span>
<a name="l00044"></a>00044 <span class="comment"> * - Keep feeding HTTP response data until feed() returns true. feed()</span>
<a name="l00045"></a>00045 <span class="comment"> * buffers all fed data until it is able to extract the HTTP status.</span>
<a name="l00046"></a>00046 <span class="comment"> * - Call getStatusLine() to retrieve the status line, and use this to generate</span>
<a name="l00047"></a>00047 <span class="comment"> * an HTTP response line.</span>
<a name="l00048"></a>00048 <span class="comment"> * - Call getBuffer() to retrieve all fed data so far. This data can be sent to</span>
<a name="l00049"></a>00049 <span class="comment"> * the HTTP client.</span>
<a name="l00050"></a>00050 <span class="comment"> *</span>
<a name="l00051"></a>00051 <span class="comment"> * This class will also ensure that the status line contains a status text, e.g.</span>
<a name="l00052"></a>00052 <span class="comment"> * if the HTTP data's status value is only "200" then "OK" will be automatically</span>
<a name="l00053"></a>00053 <span class="comment"> * appended.</span>
<a name="l00054"></a>00054 <span class="comment"> *</span>
<a name="l00055"></a>00055 <span class="comment"> * @note</span>
<a name="l00056"></a>00056 <span class="comment"> * When the API documentation for this class refers to "\r\n", we actually</span>
<a name="l00057"></a>00057 <span class="comment"> * mean "\x0D\x0A" (the HTTP line termination string). "\r\n" is only written</span>
<a name="l00058"></a>00058 <span class="comment"> * out of convenience.</span>
<a name="l00059"></a>00059 <span class="comment"> */</span>
<a name="l00060"></a><a class="code" href="classPassenger_1_1HttpStatusExtractor.html">00060</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1HttpStatusExtractor.html" title="Utility class for extracting the HTTP status value from an HTTP response.">HttpStatusExtractor</a> {
<a name="l00061"></a>00061 <span class="keyword">private</span>:
<a name="l00062"></a>00062 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> CR = <span class="stringliteral">'\x0D'</span>;
<a name="l00063"></a>00063 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> LF = <span class="stringliteral">'\x0A'</span>;
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keywordtype">string</span> buffer;
<a name="l00066"></a>00066 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> searchStart;
<a name="l00067"></a>00067 <span class="keywordtype">bool</span> fullHeaderReceived;
<a name="l00068"></a>00068 <span class="keywordtype">string</span> statusLine;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">bool</span> extractStatusLine() {
<a name="l00071"></a>00071 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> statusHeaderName[] = <span class="stringliteral">"Status: "</span>;
<a name="l00072"></a>00072 string::size_type start_pos, newline_pos;
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="keywordflow">if</span> (buffer.size() > <span class="keyword">sizeof</span>(statusHeaderName) - 1
<a name="l00075"></a>00075 && memcmp(buffer.c_str(), statusHeaderName, <span class="keyword">sizeof</span>(statusHeaderName) - 1) == 0) {
<a name="l00076"></a>00076 <span class="comment">// Status line starts at beginning of the header.</span>
<a name="l00077"></a>00077 start_pos = <span class="keyword">sizeof</span>(statusHeaderName) - 1;
<a name="l00078"></a>00078 newline_pos = buffer.find(<span class="stringliteral">"\x0D\x0A"</span>, 0, 2) + 2;
<a name="l00079"></a>00079 } <span class="keywordflow">else</span> {
<a name="l00080"></a>00080 <span class="comment">// Status line is not at the beginning of the header.</span>
<a name="l00081"></a>00081 <span class="comment">// Look for it.</span>
<a name="l00082"></a>00082 start_pos = buffer.find(<span class="stringliteral">"\x0D\x0AStatus: "</span>);
<a name="l00083"></a>00083 <span class="keywordflow">if</span> (start_pos != string::npos) {
<a name="l00084"></a>00084 start_pos += 2 + <span class="keyword">sizeof</span>(statusHeaderName) - 1;
<a name="l00085"></a>00085 newline_pos = buffer.find(<span class="stringliteral">"\x0D\x0A"</span>, start_pos, 2) + 2;
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088 <span class="keywordflow">if</span> (start_pos != string::npos) {
<a name="l00089"></a>00089 <span class="comment">// Status line has been found. Extract it.</span>
<a name="l00090"></a>00090 statusLine = buffer.substr(start_pos, newline_pos - start_pos);
<a name="l00091"></a>00091 addStatusTextIfNecessary();
<a name="l00092"></a>00092 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00093"></a>00093 } <span class="keywordflow">else</span> {
<a name="l00094"></a>00094 <span class="comment">// Status line is not found. Do not change default</span>
<a name="l00095"></a>00095 <span class="comment">// status line value.</span>
<a name="l00096"></a>00096 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keywordtype">void</span> addStatusTextIfNecessary() {
<a name="l00101"></a>00101 <span class="keywordflow">if</span> (statusLine.find(<span class="charliteral">' '</span>) == string::npos) {
<a name="l00102"></a>00102 <span class="comment">// The status line doesn't contain a status text, so add it.</span>
<a name="l00103"></a>00103 <span class="keywordtype">int</span> statusCode = <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(statusLine.c_str());
<a name="l00104"></a>00104 <span class="keywordflow">switch</span> (statusCode) {
<a name="l00105"></a>00105 <span class="keywordflow">case</span> 100:
<a name="l00106"></a>00106 statusLine = <span class="stringliteral">"100 Continue\x0D\x0A"</span>;
<a name="l00107"></a>00107 <span class="keywordflow">break</span>;
<a name="l00108"></a>00108 <span class="keywordflow">case</span> 101:
<a name="l00109"></a>00109 statusLine = <span class="stringliteral">"101 Switching Protocols\x0D\x0A"</span>;
<a name="l00110"></a>00110 <span class="keywordflow">break</span>;
<a name="l00111"></a>00111 <span class="keywordflow">case</span> 102:
<a name="l00112"></a>00112 statusLine = <span class="stringliteral">"102 Processing\x0D\x0A"</span>;
<a name="l00113"></a>00113 <span class="keywordflow">break</span>;
<a name="l00114"></a>00114 <span class="keywordflow">case</span> 200:
<a name="l00115"></a>00115 statusLine = <span class="stringliteral">"200 OK\x0D\x0A"</span>;
<a name="l00116"></a>00116 <span class="keywordflow">break</span>;
<a name="l00117"></a>00117 <span class="keywordflow">case</span> 201:
<a name="l00118"></a>00118 statusLine = <span class="stringliteral">"201 Created\x0D\x0A"</span>;
<a name="l00119"></a>00119 <span class="keywordflow">break</span>;
<a name="l00120"></a>00120 <span class="keywordflow">case</span> 202:
<a name="l00121"></a>00121 statusLine = <span class="stringliteral">"202 Accepted\x0D\x0A"</span>;
<a name="l00122"></a>00122 <span class="keywordflow">break</span>;
<a name="l00123"></a>00123 <span class="keywordflow">case</span> 203:
<a name="l00124"></a>00124 statusLine = <span class="stringliteral">"203 Non-Authoritative Information\x0D\x0A"</span>;
<a name="l00125"></a>00125 <span class="keywordflow">break</span>;
<a name="l00126"></a>00126 <span class="keywordflow">case</span> 204:
<a name="l00127"></a>00127 statusLine = <span class="stringliteral">"204 No Content\x0D\x0A"</span>;
<a name="l00128"></a>00128 <span class="keywordflow">break</span>;
<a name="l00129"></a>00129 <span class="keywordflow">case</span> 205:
<a name="l00130"></a>00130 statusLine = <span class="stringliteral">"205 Reset Content\x0D\x0A"</span>;
<a name="l00131"></a>00131 <span class="keywordflow">break</span>;
<a name="l00132"></a>00132 <span class="keywordflow">case</span> 206:
<a name="l00133"></a>00133 statusLine = <span class="stringliteral">"206 Partial Content\x0D\x0A"</span>;
<a name="l00134"></a>00134 <span class="keywordflow">break</span>;
<a name="l00135"></a>00135 <span class="keywordflow">case</span> 207:
<a name="l00136"></a>00136 statusLine = <span class="stringliteral">"207 Multi-Status\x0D\x0A"</span>;
<a name="l00137"></a>00137 <span class="keywordflow">break</span>;
<a name="l00138"></a>00138 <span class="keywordflow">case</span> 300:
<a name="l00139"></a>00139 statusLine = <span class="stringliteral">"300 Multiple Choices\x0D\x0A"</span>;
<a name="l00140"></a>00140 <span class="keywordflow">break</span>;
<a name="l00141"></a>00141 <span class="keywordflow">case</span> 301:
<a name="l00142"></a>00142 statusLine = <span class="stringliteral">"301 Moved Permanently\x0D\x0A"</span>;
<a name="l00143"></a>00143 <span class="keywordflow">break</span>;
<a name="l00144"></a>00144 <span class="keywordflow">case</span> 302:
<a name="l00145"></a>00145 statusLine = <span class="stringliteral">"302 Found\x0D\x0A"</span>;
<a name="l00146"></a>00146 <span class="keywordflow">break</span>;
<a name="l00147"></a>00147 <span class="keywordflow">case</span> 303:
<a name="l00148"></a>00148 statusLine = <span class="stringliteral">"303 See Other\x0D\x0A"</span>;
<a name="l00149"></a>00149 <span class="keywordflow">break</span>;
<a name="l00150"></a>00150 <span class="keywordflow">case</span> 304:
<a name="l00151"></a>00151 statusLine = <span class="stringliteral">"304 Not Modified\x0D\x0A"</span>;
<a name="l00152"></a>00152 <span class="keywordflow">break</span>;
<a name="l00153"></a>00153 <span class="keywordflow">case</span> 305:
<a name="l00154"></a>00154 statusLine = <span class="stringliteral">"305 Use Proxy\x0D\x0A"</span>;
<a name="l00155"></a>00155 <span class="keywordflow">break</span>;
<a name="l00156"></a>00156 <span class="keywordflow">case</span> 306:
<a name="l00157"></a>00157 statusLine = <span class="stringliteral">"306 Switch Proxy\x0D\x0A"</span>;
<a name="l00158"></a>00158 <span class="keywordflow">break</span>;
<a name="l00159"></a>00159 <span class="keywordflow">case</span> 307:
<a name="l00160"></a>00160 statusLine = <span class="stringliteral">"307 Temporary Redirect\x0D\x0A"</span>;
<a name="l00161"></a>00161 <span class="keywordflow">break</span>;
<a name="l00162"></a>00162 <span class="keywordflow">case</span> 308:
<a name="l00163"></a>00163 <span class="comment">// Google Gears: http://code.google.com/p/gears/wiki/ResumableHttpRequestsProposal</span>
<a name="l00164"></a>00164 statusLine = <span class="stringliteral">"308 Resume Incomplete\x0D\x0A"</span>;
<a name="l00165"></a>00165 <span class="keywordflow">break</span>;
<a name="l00166"></a>00166 <span class="keywordflow">case</span> 400:
<a name="l00167"></a>00167 statusLine = <span class="stringliteral">"400 Bad Request\x0D\x0A"</span>;
<a name="l00168"></a>00168 <span class="keywordflow">break</span>;
<a name="l00169"></a>00169 <span class="keywordflow">case</span> 401:
<a name="l00170"></a>00170 statusLine = <span class="stringliteral">"401 Unauthorized\x0D\x0A"</span>;
<a name="l00171"></a>00171 <span class="keywordflow">break</span>;
<a name="l00172"></a>00172 <span class="keywordflow">case</span> 402:
<a name="l00173"></a>00173 statusLine = <span class="stringliteral">"402 Payment Required\x0D\x0A"</span>;
<a name="l00174"></a>00174 <span class="keywordflow">break</span>;
<a name="l00175"></a>00175 <span class="keywordflow">case</span> 403:
<a name="l00176"></a>00176 statusLine = <span class="stringliteral">"403 Forbidden\x0D\x0A"</span>;
<a name="l00177"></a>00177 <span class="keywordflow">break</span>;
<a name="l00178"></a>00178 <span class="keywordflow">case</span> 404:
<a name="l00179"></a>00179 statusLine = <span class="stringliteral">"404 Not Found\x0D\x0A"</span>;
<a name="l00180"></a>00180 <span class="keywordflow">break</span>;
<a name="l00181"></a>00181 <span class="keywordflow">case</span> 405:
<a name="l00182"></a>00182 statusLine = <span class="stringliteral">"405 Method Not Allowed\x0D\x0A"</span>;
<a name="l00183"></a>00183 <span class="keywordflow">break</span>;
<a name="l00184"></a>00184 <span class="keywordflow">case</span> 406:
<a name="l00185"></a>00185 statusLine = <span class="stringliteral">"406 Not Acceptable\x0D\x0A"</span>;
<a name="l00186"></a>00186 <span class="keywordflow">break</span>;
<a name="l00187"></a>00187 <span class="keywordflow">case</span> 407:
<a name="l00188"></a>00188 statusLine = <span class="stringliteral">"407 Proxy Authentication Required\x0D\x0A"</span>;
<a name="l00189"></a>00189 <span class="keywordflow">break</span>;
<a name="l00190"></a>00190 <span class="keywordflow">case</span> 408:
<a name="l00191"></a>00191 statusLine = <span class="stringliteral">"408 Request Timeout\x0D\x0A"</span>;
<a name="l00192"></a>00192 <span class="keywordflow">break</span>;
<a name="l00193"></a>00193 <span class="keywordflow">case</span> 409:
<a name="l00194"></a>00194 statusLine = <span class="stringliteral">"409 Conflict\x0D\x0A"</span>;
<a name="l00195"></a>00195 <span class="keywordflow">break</span>;
<a name="l00196"></a>00196 <span class="keywordflow">case</span> 410:
<a name="l00197"></a>00197 statusLine = <span class="stringliteral">"410 Gone\x0D\x0A"</span>;
<a name="l00198"></a>00198 <span class="keywordflow">break</span>;
<a name="l00199"></a>00199 <span class="keywordflow">case</span> 411:
<a name="l00200"></a>00200 statusLine = <span class="stringliteral">"411 Length Required\x0D\x0A"</span>;
<a name="l00201"></a>00201 <span class="keywordflow">break</span>;
<a name="l00202"></a>00202 <span class="keywordflow">case</span> 412:
<a name="l00203"></a>00203 statusLine = <span class="stringliteral">"412 Precondition Failed\x0D\x0A"</span>;
<a name="l00204"></a>00204 <span class="keywordflow">break</span>;
<a name="l00205"></a>00205 <span class="keywordflow">case</span> 413:
<a name="l00206"></a>00206 statusLine = <span class="stringliteral">"413 Request Entity Too Large\x0D\x0A"</span>;
<a name="l00207"></a>00207 <span class="keywordflow">break</span>;
<a name="l00208"></a>00208 <span class="keywordflow">case</span> 414:
<a name="l00209"></a>00209 statusLine = <span class="stringliteral">"414 Request-URI Too Long\x0D\x0A"</span>;
<a name="l00210"></a>00210 <span class="keywordflow">break</span>;
<a name="l00211"></a>00211 <span class="keywordflow">case</span> 415:
<a name="l00212"></a>00212 statusLine = <span class="stringliteral">"415 Unsupported Media Type\x0D\x0A"</span>;
<a name="l00213"></a>00213 <span class="keywordflow">break</span>;
<a name="l00214"></a>00214 <span class="keywordflow">case</span> 416:
<a name="l00215"></a>00215 statusLine = <span class="stringliteral">"416 Requested Range Not Satisfiable\x0D\x0A"</span>;
<a name="l00216"></a>00216 <span class="keywordflow">break</span>;
<a name="l00217"></a>00217 <span class="keywordflow">case</span> 417:
<a name="l00218"></a>00218 statusLine = <span class="stringliteral">"417 Expectation Failed\x0D\x0A"</span>;
<a name="l00219"></a>00219 <span class="keywordflow">break</span>;
<a name="l00220"></a>00220 <span class="keywordflow">case</span> 418:
<a name="l00221"></a>00221 statusLine = <span class="stringliteral">"418 Not A Funny April Fools Joke\x0D\x0A"</span>;
<a name="l00222"></a>00222 <span class="keywordflow">break</span>;
<a name="l00223"></a>00223 <span class="keywordflow">case</span> 422:
<a name="l00224"></a>00224 statusLine = <span class="stringliteral">"422 Unprocessable Entity\x0D\x0A"</span>;
<a name="l00225"></a>00225 <span class="keywordflow">break</span>;
<a name="l00226"></a>00226 <span class="keywordflow">case</span> 423:
<a name="l00227"></a>00227 statusLine = <span class="stringliteral">"423 Locked\x0D\x0A"</span>;
<a name="l00228"></a>00228 <span class="keywordflow">break</span>;
<a name="l00229"></a>00229 <span class="keywordflow">case</span> 424:
<a name="l00230"></a>00230 statusLine = <span class="stringliteral">"424 Unordered Collection\x0D\x0A"</span>;
<a name="l00231"></a>00231 <span class="keywordflow">break</span>;
<a name="l00232"></a>00232 <span class="keywordflow">case</span> 426:
<a name="l00233"></a>00233 statusLine = <span class="stringliteral">"426 Upgrade Required\x0D\x0A"</span>;
<a name="l00234"></a>00234 <span class="keywordflow">break</span>;
<a name="l00235"></a>00235 <span class="keywordflow">case</span> 449:
<a name="l00236"></a>00236 statusLine = <span class="stringliteral">"449 Retry With\x0D\x0A"</span>;
<a name="l00237"></a>00237 <span class="keywordflow">break</span>;
<a name="l00238"></a>00238 <span class="keywordflow">case</span> 450:
<a name="l00239"></a>00239 statusLine = <span class="stringliteral">"450 Blocked\x0D\x0A"</span>;
<a name="l00240"></a>00240 <span class="keywordflow">break</span>;
<a name="l00241"></a>00241 <span class="keywordflow">case</span> 500:
<a name="l00242"></a>00242 statusLine = <span class="stringliteral">"500 Internal Server Error\x0D\x0A"</span>;
<a name="l00243"></a>00243 <span class="keywordflow">break</span>;
<a name="l00244"></a>00244 <span class="keywordflow">case</span> 501:
<a name="l00245"></a>00245 statusLine = <span class="stringliteral">"501 Not Implemented\x0D\x0A"</span>;
<a name="l00246"></a>00246 <span class="keywordflow">break</span>;
<a name="l00247"></a>00247 <span class="keywordflow">case</span> 502:
<a name="l00248"></a>00248 statusLine = <span class="stringliteral">"502 Bad Gateway\x0D\x0A"</span>;
<a name="l00249"></a>00249 <span class="keywordflow">break</span>;
<a name="l00250"></a>00250 <span class="keywordflow">case</span> 503:
<a name="l00251"></a>00251 statusLine = <span class="stringliteral">"503 Service Unavailable\x0D\x0A"</span>;
<a name="l00252"></a>00252 <span class="keywordflow">break</span>;
<a name="l00253"></a>00253 <span class="keywordflow">case</span> 504:
<a name="l00254"></a>00254 statusLine = <span class="stringliteral">"504 Gateway Timeout\x0D\x0A"</span>;
<a name="l00255"></a>00255 <span class="keywordflow">break</span>;
<a name="l00256"></a>00256 <span class="keywordflow">case</span> 505:
<a name="l00257"></a>00257 statusLine = <span class="stringliteral">"505 HTTP Version Not Supported\x0D\x0A"</span>;
<a name="l00258"></a>00258 <span class="keywordflow">break</span>;
<a name="l00259"></a>00259 <span class="keywordflow">case</span> 506:
<a name="l00260"></a>00260 statusLine = <span class="stringliteral">"506 Variant Also Negotiates\x0D\x0A"</span>;
<a name="l00261"></a>00261 <span class="keywordflow">break</span>;
<a name="l00262"></a>00262 <span class="keywordflow">case</span> 507:
<a name="l00263"></a>00263 statusLine = <span class="stringliteral">"507 Insufficient Storage\x0D\x0A"</span>;
<a name="l00264"></a>00264 <span class="keywordflow">break</span>;
<a name="l00265"></a>00265 <span class="keywordflow">case</span> 509:
<a name="l00266"></a>00266 statusLine = <span class="stringliteral">"509 Bandwidth Limit Exceeded\x0D\x0A"</span>;
<a name="l00267"></a>00267 <span class="keywordflow">break</span>;
<a name="l00268"></a>00268 <span class="keywordflow">case</span> 510:
<a name="l00269"></a>00269 statusLine = <span class="stringliteral">"510 Not Extended\x0D\x0A"</span>;
<a name="l00270"></a>00270 <span class="keywordflow">break</span>;
<a name="l00271"></a>00271 <span class="keywordflow">default</span>:
<a name="l00272"></a>00272 <span class="keywordtype">char</span> temp[32];
<a name="l00273"></a>00273 snprintf(temp, <span class="keyword">sizeof</span>(temp),
<a name="l00274"></a>00274 <span class="stringliteral">"%d Unknown Status Code\x0D\x0A"</span>,
<a name="l00275"></a>00275 statusCode);
<a name="l00276"></a>00276 temp[<span class="keyword">sizeof</span>(temp) - 1] = <span class="charliteral">'\0'</span>;
<a name="l00277"></a>00277 statusLine = temp;
<a name="l00278"></a>00278 }
<a name="l00279"></a>00279 }
<a name="l00280"></a>00280 }
<a name="l00281"></a>00281
<a name="l00282"></a>00282 <span class="keyword">public</span>:
<a name="l00283"></a>00283 <a class="code" href="classPassenger_1_1HttpStatusExtractor.html" title="Utility class for extracting the HTTP status value from an HTTP response.">HttpStatusExtractor</a>() {
<a name="l00284"></a>00284 searchStart = 0;
<a name="l00285"></a>00285 fullHeaderReceived = <span class="keyword">false</span>;
<a name="l00286"></a>00286 statusLine = <span class="stringliteral">"200 OK\r\n"</span>;
<a name="l00287"></a>00287 }
<a name="l00288"></a>00288 <span class="comment"></span>
<a name="l00289"></a>00289 <span class="comment"> /**</span>
<a name="l00290"></a>00290 <span class="comment"> * Feed HTTP response data to this HttpStatusExtractor.</span>
<a name="l00291"></a>00291 <span class="comment"> *</span>
<a name="l00292"></a>00292 <span class="comment"> * One is to keep feeding data until this method returns true.</span>
<a name="l00293"></a>00293 <span class="comment"> * When a sufficient amount of data has been fed, this method will</span>
<a name="l00294"></a>00294 <span class="comment"> * extract the status line from the data that has been fed so far,</span>
<a name="l00295"></a>00295 <span class="comment"> * and return true.</span>
<a name="l00296"></a>00296 <span class="comment"> *</span>
<a name="l00297"></a>00297 <span class="comment"> * Do not call this method again once it has returned true.</span>
<a name="l00298"></a>00298 <span class="comment"> *</span>
<a name="l00299"></a>00299 <span class="comment"> * It is safe to feed excess data. That is, it is safe if the 'data'</span>
<a name="l00300"></a>00300 <span class="comment"> * argument contains a part of the HTTP response body.</span>
<a name="l00301"></a>00301 <span class="comment"> * HttpStatusExtractor will only look for the status line in the HTTP</span>
<a name="l00302"></a>00302 <span class="comment"> * response header, not in the HTTP response body. All fed data is</span>
<a name="l00303"></a>00303 <span class="comment"> * buffered and will be available via getBuffer(), so no data will be</span>
<a name="l00304"></a>00304 <span class="comment"> * lost.</span>
<a name="l00305"></a>00305 <span class="comment"> *</span>
<a name="l00306"></a>00306 <span class="comment"> * @return Whether the HTTP status has been extracted yet.</span>
<a name="l00307"></a>00307 <span class="comment"> * @pre feed() did not previously return true.</span>
<a name="l00308"></a>00308 <span class="comment"> * @pre data != NULL</span>
<a name="l00309"></a>00309 <span class="comment"> * @pre size > 0</span>
<a name="l00310"></a>00310 <span class="comment"> */</span>
<a name="l00311"></a><a class="code" href="classPassenger_1_1HttpStatusExtractor.html#ca6fd77038e76b313830757730780d51">00311</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1HttpStatusExtractor.html#ca6fd77038e76b313830757730780d51" title="Feed HTTP response data to this HttpStatusExtractor.">feed</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
<a name="l00312"></a>00312 <span class="keywordflow">if</span> (fullHeaderReceived) {
<a name="l00313"></a>00313 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00314"></a>00314 }
<a name="l00315"></a>00315 buffer.append(data, size);
<a name="l00316"></a>00316 <span class="keywordflow">for</span> (; buffer.size() >= 3 && searchStart < buffer.size() - 3; searchStart++) {
<a name="l00317"></a>00317 <span class="keywordflow">if</span> (buffer[searchStart] == CR &&
<a name="l00318"></a>00318 buffer[searchStart + 1] == LF &&
<a name="l00319"></a>00319 buffer[searchStart + 2] == CR &&
<a name="l00320"></a>00320 buffer[searchStart + 3] == LF) {
<a name="l00321"></a>00321 fullHeaderReceived = <span class="keyword">true</span>;
<a name="l00322"></a>00322 extractStatusLine();
<a name="l00323"></a>00323 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00324"></a>00324 }
<a name="l00325"></a>00325 }
<a name="l00326"></a>00326 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00327"></a>00327 }
<a name="l00328"></a>00328 <span class="comment"></span>
<a name="l00329"></a>00329 <span class="comment"> /**</span>
<a name="l00330"></a>00330 <span class="comment"> * Returns the HTTP status line that has been determined.</span>
<a name="l00331"></a>00331 <span class="comment"> *</span>
<a name="l00332"></a>00332 <span class="comment"> * The default value is "200 OK\r\n", which is returned if the HTTP</span>
<a name="l00333"></a>00333 <span class="comment"> * response data that has been fed so far does not include a status</span>
<a name="l00334"></a>00334 <span class="comment"> * line.</span>
<a name="l00335"></a>00335 <span class="comment"> *</span>
<a name="l00336"></a>00336 <span class="comment"> * @note The return value includes a trailing CRLF, e.g. "404 Not Found\r\n".</span>
<a name="l00337"></a>00337 <span class="comment"> */</span>
<a name="l00338"></a><a class="code" href="classPassenger_1_1HttpStatusExtractor.html#f0db266fc713f532047880c5eaae44d5">00338</a> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1HttpStatusExtractor.html#f0db266fc713f532047880c5eaae44d5" title="Returns the HTTP status line that has been determined.">getStatusLine</a>()<span class="keyword"> const </span>{
<a name="l00339"></a>00339 <span class="keywordflow">return</span> statusLine;
<a name="l00340"></a>00340 }
<a name="l00341"></a>00341 <span class="comment"></span>
<a name="l00342"></a>00342 <span class="comment"> /**</span>
<a name="l00343"></a>00343 <span class="comment"> * Get the data that has been fed so far.</span>
<a name="l00344"></a>00344 <span class="comment"> */</span>
<a name="l00345"></a><a class="code" href="classPassenger_1_1HttpStatusExtractor.html#3749842ba4f8f59b6b69c594da963f22">00345</a> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1HttpStatusExtractor.html#3749842ba4f8f59b6b69c594da963f22" title="Get the data that has been fed so far.">getBuffer</a>()<span class="keyword"> const </span>{
<a name="l00346"></a>00346 <span class="keywordflow">return</span> buffer;
<a name="l00347"></a>00347 }
<a name="l00348"></a>00348 };
<a name="l00349"></a>00349
<a name="l00350"></a>00350 } <span class="comment">// namespace Passenger</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:45 2010 for Passenger by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
