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
|
<!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: ScgiRequestParser.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>ScgiRequestParser.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 <google/dense_hash_map></span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <map></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#include "StaticString.h"</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>Passenger {
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">using namespace </span>std;
<a name="l00036"></a>00036 <span class="keyword">using namespace </span>google;
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/**</span>
<a name="l00039"></a>00039 <span class="comment"> * A parser for SCGI requests. It parses the request header and ignores the</span>
<a name="l00040"></a>00040 <span class="comment"> * body data.</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * You can use it by constructing a parser object, then feeding data to the</span>
<a name="l00043"></a>00043 <span class="comment"> * parser until it has reached a final state.</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * Example:</span>
<a name="l00046"></a>00046 <span class="comment"> * @code</span>
<a name="l00047"></a>00047 <span class="comment"> * ScgiRequestParser parser;</span>
<a name="l00048"></a>00048 <span class="comment"> * char buf[1024 * 16];</span>
<a name="l00049"></a>00049 <span class="comment"> * ssize_t size;</span>
<a name="l00050"></a>00050 <span class="comment"> * unsigned in bytesAccepted;</span>
<a name="l00051"></a>00051 <span class="comment"> * </span>
<a name="l00052"></a>00052 <span class="comment"> * do {</span>
<a name="l00053"></a>00053 <span class="comment"> * size = read(fd, buf, sizeof(buf));</span>
<a name="l00054"></a>00054 <span class="comment"> * bytesAccepted = parser.feed(buf, size);</span>
<a name="l00055"></a>00055 <span class="comment"> * } while (parser.acceptingInput());</span>
<a name="l00056"></a>00056 <span class="comment"> * // Parser is done when its return value isn't equal to the input size.</span>
<a name="l00057"></a>00057 <span class="comment"> * </span>
<a name="l00058"></a>00058 <span class="comment"> * // Check whether a parse error occured.</span>
<a name="l00059"></a>00059 <span class="comment"> * if (parser.getState() == ScgiRequestParser::ERROR) {</span>
<a name="l00060"></a>00060 <span class="comment"> * bailOut();</span>
<a name="l00061"></a>00061 <span class="comment"> * } else {</span>
<a name="l00062"></a>00062 <span class="comment"> * // All good! Do something with the SCGI header that the parser parsed.</span>
<a name="l00063"></a>00063 <span class="comment"> * processHeader(parser.getHeaderData());</span>
<a name="l00064"></a>00064 <span class="comment"> * </span>
<a name="l00065"></a>00065 <span class="comment"> * // If the last buffer passed to the parser also contains body data,</span>
<a name="l00066"></a>00066 <span class="comment"> * // then the body data starts at 'buf + bytesAccepted'.</span>
<a name="l00067"></a>00067 <span class="comment"> * if (bytesAccepted < size) {</span>
<a name="l00068"></a>00068 <span class="comment"> * processBody(buf + bytesAccepted);</span>
<a name="l00069"></a>00069 <span class="comment"> * }</span>
<a name="l00070"></a>00070 <span class="comment"> * while (!end_of_file(fd)) {</span>
<a name="l00071"></a>00071 <span class="comment"> * ... read(...) ...</span>
<a name="l00072"></a>00072 <span class="comment"> * processBody(...);</span>
<a name="l00073"></a>00073 <span class="comment"> * }</span>
<a name="l00074"></a>00074 <span class="comment"> * }</span>
<a name="l00075"></a>00075 <span class="comment"> * @endcode</span>
<a name="l00076"></a>00076 <span class="comment"> *</span>
<a name="l00077"></a>00077 <span class="comment"> * Parser properties:</span>
<a name="l00078"></a>00078 <span class="comment"> * - A parser object can only process a single SCGI request. You must discard</span>
<a name="l00079"></a>00079 <span class="comment"> * the existing parser object and create a new one if you want to process</span>
<a name="l00080"></a>00080 <span class="comment"> * another SCGI request.</span>
<a name="l00081"></a>00081 <span class="comment"> * - This parser checks whether the header netstring is valid. It will enter</span>
<a name="l00082"></a>00082 <span class="comment"> * the error state if it encounters a parse error.</span>
<a name="l00083"></a>00083 <span class="comment"> * - However, this parser does not perform any validation of the actual header</span>
<a name="l00084"></a>00084 <span class="comment"> * contents. For example, it doesn't check that CONTENT_LENGTH is the first</span>
<a name="l00085"></a>00085 <span class="comment"> * header, or that the SCGI header is present.</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html">00087</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1ScgiRequestParser.html" title="A parser for SCGI requests.">ScgiRequestParser</a> {
<a name="l00088"></a>00088 <span class="keyword">public</span>:
<a name="l00089"></a>00089 <span class="keyword">enum</span> State {
<a name="l00090"></a>00090 READING_LENGTH_STRING,
<a name="l00091"></a>00091 READING_HEADER_DATA,
<a name="l00092"></a>00092 EXPECTING_COMMA,
<a name="l00093"></a>00093 DONE,
<a name="l00094"></a>00094 ERROR
<a name="l00095"></a>00095 };
<a name="l00096"></a>00096
<a name="l00097"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">00097</a> <span class="keyword">enum</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">ErrorReason</a> {
<a name="l00098"></a>00098 NONE,
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment"> /** The length string is too large. */</span>
<a name="l00101"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b9ba3d5851af9ffae1e9202bc9f73ac5b">00101</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b9ba3d5851af9ffae1e9202bc9f73ac5b" title="The length string is too large.">LENGTH_STRING_TOO_LARGE</a>,
<a name="l00102"></a>00102 <span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment"> /** The header is larger than the maxSize value provided to the constructor. */</span>
<a name="l00104"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b876574447523322b9d7b4921e490032d">00104</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b876574447523322b9d7b4921e490032d" title="The header is larger than the maxSize value provided to the constructor.">LIMIT_REACHED</a>,
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment"> /** The length string contains an invalid character. */</span>
<a name="l00107"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bfe61dd339024beaed48f6eed6e6f3332">00107</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bfe61dd339024beaed48f6eed6e6f3332" title="The length string contains an invalid character.">INVALID_LENGTH_STRING</a>,
<a name="l00108"></a>00108 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment"> /** A header terminator character (",") was expected, but some else</span>
<a name="l00110"></a>00110 <span class="comment"> * was encountered instead. */</span>
<a name="l00111"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44">00111</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44" title="A header terminator character (&quot;,&quot;) was expected, but some else was encountered...">HEADER_TERMINATOR_EXPECTED</a>,
<a name="l00112"></a>00112 <span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment"> /** The header data itself contains errors. */</span>
<a name="l00114"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add">00114</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add" title="The header data itself contains errors.">INVALID_HEADER_DATA</a>
<a name="l00115"></a>00115 };
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keyword">private</span>:
<a name="l00118"></a>00118 <span class="keyword">typedef</span> dense_hash_map<StaticString, StaticString, StaticString::Hash> HeaderMap;
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxSize;
<a name="l00121"></a>00121
<a name="l00122"></a>00122 State state;
<a name="l00123"></a>00123 <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">ErrorReason</a> errorReason;
<a name="l00124"></a>00124 <span class="keywordtype">char</span> lengthStringBuffer[<span class="keyword">sizeof</span>(<span class="stringliteral">"4294967296"</span>)];
<a name="l00125"></a>00125 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> lengthStringBufferSize;
<a name="l00126"></a>00126 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> headerSize;
<a name="l00127"></a>00127 <span class="keywordtype">string</span> headerBuffer;
<a name="l00128"></a>00128 HeaderMap headers;
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> isDigit(<span class="keywordtype">char</span> byte) {
<a name="l00131"></a>00131 <span class="keywordflow">return</span> byte >= <span class="charliteral">'0'</span> && byte <= <span class="charliteral">'9'</span>;
<a name="l00132"></a>00132 }
<a name="l00133"></a>00133 <span class="comment"></span>
<a name="l00134"></a>00134 <span class="comment"> /**</span>
<a name="l00135"></a>00135 <span class="comment"> * Parse the given header data into key-value pairs.</span>
<a name="l00136"></a>00136 <span class="comment"> */</span>
<a name="l00137"></a>00137 <span class="keywordtype">bool</span> parseHeaderData(<span class="keyword">const</span> <span class="keywordtype">string</span> &data, HeaderMap &output) {
<a name="l00138"></a>00138 <span class="keywordtype">bool</span> isName = <span class="keyword">true</span>; <span class="comment">// Whether we're currently expecting a name or a value.</span>
<a name="l00139"></a>00139 <span class="keyword">const</span> <span class="keywordtype">char</span> *startOfString, *current, *end;
<a name="l00140"></a>00140 StaticString key, value;
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keywordflow">if</span> (data.size() == 0) {
<a name="l00143"></a>00143 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145
<a name="l00146"></a>00146 startOfString = data.c_str();
<a name="l00147"></a>00147 end = data.c_str() + data.size();
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="keywordflow">if</span> (*(end - 1) != <span class="charliteral">'\0'</span>) {
<a name="l00150"></a>00150 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00151"></a>00151 }
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="keywordflow">for</span> (current = data.c_str(); current != end; current++) {
<a name="l00154"></a>00154 <span class="keywordflow">if</span> (isName && *current == <span class="charliteral">'\0'</span>) {
<a name="l00155"></a>00155 key = StaticString(startOfString, current - startOfString);
<a name="l00156"></a>00156 startOfString = current + 1;
<a name="l00157"></a>00157 isName = <span class="keyword">false</span>;
<a name="l00158"></a>00158 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!isName && *current == <span class="charliteral">'\0'</span>) {
<a name="l00159"></a>00159 value = StaticString(startOfString, current - startOfString);
<a name="l00160"></a>00160 startOfString = current + 1;
<a name="l00161"></a>00161 isName = <span class="keyword">true</span>;
<a name="l00162"></a>00162
<a name="l00163"></a>00163 output[key] = value;
<a name="l00164"></a>00164 key = StaticString();
<a name="l00165"></a>00165 value = StaticString();
<a name="l00166"></a>00166 }
<a name="l00167"></a>00167 }
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="keywordflow">return</span> isName;
<a name="l00170"></a>00170 }
<a name="l00171"></a>00171 <span class="comment"></span>
<a name="l00172"></a>00172 <span class="comment"> /**</span>
<a name="l00173"></a>00173 <span class="comment"> * Process the given data, which contains header data and possibly</span>
<a name="l00174"></a>00174 <span class="comment"> * some body data as well.</span>
<a name="l00175"></a>00175 <span class="comment"> */</span>
<a name="l00176"></a>00176 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> readHeaderData(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
<a name="l00177"></a>00177 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bytesToRead;
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="comment">// Calculate how many bytes of header data is left to be read.</span>
<a name="l00180"></a>00180 <span class="comment">// Do not read past the header data.</span>
<a name="l00181"></a>00181 <span class="keywordflow">if</span> (size < headerSize - headerBuffer.size()) {
<a name="l00182"></a>00182 bytesToRead = size;
<a name="l00183"></a>00183 } <span class="keywordflow">else</span> {
<a name="l00184"></a>00184 bytesToRead = headerSize - headerBuffer.size();
<a name="l00185"></a>00185 }
<a name="l00186"></a>00186 <span class="comment">// Append the newly received header data to the header data buffer.</span>
<a name="l00187"></a>00187 headerBuffer.append(data, bytesToRead);
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="keywordflow">if</span> (headerBuffer.size() == headerSize) {
<a name="l00190"></a>00190 <span class="comment">// We've received all header data. Now attempt to parse this.</span>
<a name="l00191"></a>00191 <span class="keywordflow">if</span> (bytesToRead < size) {
<a name="l00192"></a>00192 <span class="keywordflow">if</span> (data[bytesToRead] == <span class="charliteral">','</span>) {
<a name="l00193"></a>00193 <span class="keywordflow">if</span> (parseHeaderData(headerBuffer, headers)) {
<a name="l00194"></a>00194 state = DONE;
<a name="l00195"></a>00195 <span class="keywordflow">return</span> bytesToRead + 1;
<a name="l00196"></a>00196 } <span class="keywordflow">else</span> {
<a name="l00197"></a>00197 state = ERROR;
<a name="l00198"></a>00198 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add" title="The header data itself contains errors.">INVALID_HEADER_DATA</a>;
<a name="l00199"></a>00199 <span class="keywordflow">return</span> bytesToRead;
<a name="l00200"></a>00200 }
<a name="l00201"></a>00201 } <span class="keywordflow">else</span> {
<a name="l00202"></a>00202 state = ERROR;
<a name="l00203"></a>00203 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44" title="A header terminator character (&quot;,&quot;) was expected, but some else was encountered...">HEADER_TERMINATOR_EXPECTED</a>;
<a name="l00204"></a>00204 <span class="keywordflow">return</span> bytesToRead;
<a name="l00205"></a>00205 }
<a name="l00206"></a>00206 } <span class="keywordflow">else</span> {
<a name="l00207"></a>00207 <span class="keywordflow">if</span> (parseHeaderData(headerBuffer, headers)) {
<a name="l00208"></a>00208 state = EXPECTING_COMMA;
<a name="l00209"></a>00209 } <span class="keywordflow">else</span> {
<a name="l00210"></a>00210 state = ERROR;
<a name="l00211"></a>00211 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bc162062c109fe310d5923d12b6147add" title="The header data itself contains errors.">INVALID_HEADER_DATA</a>;
<a name="l00212"></a>00212 }
<a name="l00213"></a>00213 <span class="keywordflow">return</span> bytesToRead;
<a name="l00214"></a>00214 }
<a name="l00215"></a>00215 } <span class="keywordflow">else</span> {
<a name="l00216"></a>00216 <span class="comment">// Not all header data has been received yet.</span>
<a name="l00217"></a>00217 <span class="keywordflow">return</span> bytesToRead;
<a name="l00218"></a>00218 }
<a name="l00219"></a>00219 }
<a name="l00220"></a>00220
<a name="l00221"></a>00221 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00222"></a>00222 <span class="comment"> /**</span>
<a name="l00223"></a>00223 <span class="comment"> * Create a new ScgiRequestParser, ready to parse a request.</span>
<a name="l00224"></a>00224 <span class="comment"> *</span>
<a name="l00225"></a>00225 <span class="comment"> * @param maxSize The maximum size that the SCGI data is allowed to</span>
<a name="l00226"></a>00226 <span class="comment"> * be, or 0 if no limit is desired.</span>
<a name="l00227"></a>00227 <span class="comment"> */</span>
<a name="l00228"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#1108e7ce9162289db8a5b14479325e7a">00228</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#1108e7ce9162289db8a5b14479325e7a" title="Create a new ScgiRequestParser, ready to parse a request.">ScgiRequestParser</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxSize = 0) {
<a name="l00229"></a>00229 this->maxSize = maxSize;
<a name="l00230"></a>00230 state = READING_LENGTH_STRING;
<a name="l00231"></a>00231 errorReason = NONE;
<a name="l00232"></a>00232 lengthStringBufferSize = 0;
<a name="l00233"></a>00233 headerSize = 0;
<a name="l00234"></a>00234 headers.set_empty_key(<span class="stringliteral">""</span>);
<a name="l00235"></a>00235 }
<a name="l00236"></a>00236 <span class="comment"></span>
<a name="l00237"></a>00237 <span class="comment"> /**</span>
<a name="l00238"></a>00238 <span class="comment"> * Feed SCGI request data to the parser.</span>
<a name="l00239"></a>00239 <span class="comment"> *</span>
<a name="l00240"></a>00240 <span class="comment"> * @param data The data to feed.</span>
<a name="l00241"></a>00241 <span class="comment"> * @param size The size of the data, in bytes.</span>
<a name="l00242"></a>00242 <span class="comment"> * @return The number of recognized SCGI header bytes. If this value</span>
<a name="l00243"></a>00243 <span class="comment"> * equals 'size', then it means all data in 'data' is part of</span>
<a name="l00244"></a>00244 <span class="comment"> * the SCGI header. If this value is less than size, then it</span>
<a name="l00245"></a>00245 <span class="comment"> * means only some data in 'data' is part of the SCGI header,</span>
<a name="l00246"></a>00246 <span class="comment"> * and the remaining 'size - result' bytes are part of the</span>
<a name="l00247"></a>00247 <span class="comment"> * request body.</span>
<a name="l00248"></a>00248 <span class="comment"> * @pre size > 0</span>
<a name="l00249"></a>00249 <span class="comment"> * @post result <= size</span>
<a name="l00250"></a>00250 <span class="comment"> * @post if result <= size: getState() == DONE || getState() == ERROR</span>
<a name="l00251"></a>00251 <span class="comment"> */</span>
<a name="l00252"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#0498c9529029969d5a77e1f74f95baa3">00252</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#0498c9529029969d5a77e1f74f95baa3" title="Feed SCGI request data to the parser.">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="l00253"></a>00253 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i;
<a name="l00254"></a>00254
<a name="l00255"></a>00255 <span class="keywordflow">switch</span> (state) {
<a name="l00256"></a>00256 <span class="keywordflow">case</span> READING_LENGTH_STRING:
<a name="l00257"></a>00257 <span class="comment">// Keep processing length string data...</span>
<a name="l00258"></a>00258 <span class="keywordflow">for</span> (i = 0; i < size; i++) {
<a name="l00259"></a>00259 <span class="keywordtype">char</span> byte = data[i];
<a name="l00260"></a>00260
<a name="l00261"></a>00261 <span class="keywordflow">if</span> (lengthStringBufferSize == <span class="keyword">sizeof</span>(lengthStringBuffer) - 1) {
<a name="l00262"></a>00262 <span class="comment">// ...and abort if the length string is too long.</span>
<a name="l00263"></a>00263 state = ERROR;
<a name="l00264"></a>00264 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b9ba3d5851af9ffae1e9202bc9f73ac5b" title="The length string is too large.">LENGTH_STRING_TOO_LARGE</a>;
<a name="l00265"></a>00265 <span class="keywordflow">return</span> i;
<a name="l00266"></a>00266 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!isDigit(byte)) {
<a name="l00267"></a>00267 <span class="keywordflow">if</span> (byte == <span class="charliteral">':'</span>) {
<a name="l00268"></a>00268 <span class="comment">// ...until the end of the length string has been reached.</span>
<a name="l00269"></a>00269 state = READING_HEADER_DATA;
<a name="l00270"></a>00270 lengthStringBuffer[lengthStringBufferSize] = <span class="charliteral">'\0'</span>;
<a name="l00271"></a>00271 headerSize = <a class="code" href="group__Support.html#g7b50461f1bc2b370c956967870da2762" title="Converts the given string to a long integer.">atol</a>(lengthStringBuffer);
<a name="l00272"></a>00272 <span class="keywordflow">if</span> (maxSize > 0 && headerSize > maxSize) {
<a name="l00273"></a>00273 state = ERROR;
<a name="l00274"></a>00274 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b876574447523322b9d7b4921e490032d" title="The header is larger than the maxSize value provided to the constructor.">LIMIT_REACHED</a>;
<a name="l00275"></a>00275 } <span class="keywordflow">else</span> {
<a name="l00276"></a>00276 headerBuffer.reserve(headerSize);
<a name="l00277"></a>00277 <span class="comment">// From here on, process the rest of the data that we've</span>
<a name="l00278"></a>00278 <span class="comment">// received, as header data.</span>
<a name="l00279"></a>00279 <span class="keywordflow">return</span> readHeaderData(data + i + 1, size - i - 1) + i + 1;
<a name="l00280"></a>00280 }
<a name="l00281"></a>00281 } <span class="keywordflow">else</span> {
<a name="l00282"></a>00282 <span class="comment">// ...until we encounter a parse error.</span>
<a name="l00283"></a>00283 state = ERROR;
<a name="l00284"></a>00284 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8bfe61dd339024beaed48f6eed6e6f3332" title="The length string contains an invalid character.">INVALID_LENGTH_STRING</a>;
<a name="l00285"></a>00285 <span class="keywordflow">return</span> i;
<a name="l00286"></a>00286 }
<a name="l00287"></a>00287 } <span class="keywordflow">else</span> {
<a name="l00288"></a>00288 lengthStringBuffer[lengthStringBufferSize] = byte;
<a name="l00289"></a>00289 lengthStringBufferSize++;
<a name="l00290"></a>00290 }
<a name="l00291"></a>00291 }
<a name="l00292"></a>00292 <span class="keywordflow">return</span> i;
<a name="l00293"></a>00293
<a name="l00294"></a>00294 <span class="keywordflow">case</span> READING_HEADER_DATA:
<a name="l00295"></a>00295 <span class="keywordflow">return</span> readHeaderData(data, size);
<a name="l00296"></a>00296
<a name="l00297"></a>00297 <span class="keywordflow">case</span> EXPECTING_COMMA:
<a name="l00298"></a>00298 <span class="keywordflow">if</span> (data[0] == <span class="charliteral">','</span>) {
<a name="l00299"></a>00299 state = DONE;
<a name="l00300"></a>00300 <span class="keywordflow">return</span> 1;
<a name="l00301"></a>00301 } <span class="keywordflow">else</span> {
<a name="l00302"></a>00302 state = ERROR;
<a name="l00303"></a>00303 errorReason = <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b44078eaf2ae1ee592d65d122dbda4a44" title="A header terminator character (&quot;,&quot;) was expected, but some else was encountered...">HEADER_TERMINATOR_EXPECTED</a>;
<a name="l00304"></a>00304 <span class="keywordflow">return</span> 0;
<a name="l00305"></a>00305 }
<a name="l00306"></a>00306
<a name="l00307"></a>00307 <span class="keywordflow">default</span>:
<a name="l00308"></a>00308 <span class="keywordflow">return</span> 0;
<a name="l00309"></a>00309 }
<a name="l00310"></a>00310 }
<a name="l00311"></a>00311 <span class="comment"></span>
<a name="l00312"></a>00312 <span class="comment"> /**</span>
<a name="l00313"></a>00313 <span class="comment"> * Get the raw header data that has been processed so far.</span>
<a name="l00314"></a>00314 <span class="comment"> */</span>
<a name="l00315"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#a96dbb7c4c642ac74f30ed5b14a64e86">00315</a> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#a96dbb7c4c642ac74f30ed5b14a64e86" title="Get the raw header data that has been processed so far.">getHeaderData</a>()<span class="keyword"> const </span>{
<a name="l00316"></a>00316 <span class="keywordflow">return</span> headerBuffer;
<a name="l00317"></a>00317 }
<a name="l00318"></a>00318 <span class="comment"></span>
<a name="l00319"></a>00319 <span class="comment"> /**</span>
<a name="l00320"></a>00320 <span class="comment"> * Get the value of the header with the given name.</span>
<a name="l00321"></a>00321 <span class="comment"> * Lookup is case-sensitive.</span>
<a name="l00322"></a>00322 <span class="comment"> *</span>
<a name="l00323"></a>00323 <span class="comment"> * Returns the empty string if there is no such header.</span>
<a name="l00324"></a>00324 <span class="comment"> *</span>
<a name="l00325"></a>00325 <span class="comment"> * @pre getState() == DONE</span>
<a name="l00326"></a>00326 <span class="comment"> */</span>
<a name="l00327"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#82321480ad2f8ac7ba58ff865131f6b4">00327</a> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#82321480ad2f8ac7ba58ff865131f6b4" title="Get the value of the header with the given name.">getHeader</a>(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> &name)<span class="keyword"> const </span>{
<a name="l00328"></a>00328 HeaderMap::const_iterator it(headers.find(name));
<a name="l00329"></a>00329 <span class="keywordflow">if</span> (it == headers.end()) {
<a name="l00330"></a>00330 <span class="keywordflow">return</span> <span class="stringliteral">""</span>;
<a name="l00331"></a>00331 } <span class="keywordflow">else</span> {
<a name="l00332"></a>00332 <span class="keywordflow">return</span> it->second;
<a name="l00333"></a>00333 }
<a name="l00334"></a>00334 }
<a name="l00335"></a>00335 <span class="comment"></span>
<a name="l00336"></a>00336 <span class="comment"> /**</span>
<a name="l00337"></a>00337 <span class="comment"> * Checks whether there is a header with the given name.</span>
<a name="l00338"></a>00338 <span class="comment"> * Lookup is case-sensitive.</span>
<a name="l00339"></a>00339 <span class="comment"> *</span>
<a name="l00340"></a>00340 <span class="comment"> * @pre getState() == DONE</span>
<a name="l00341"></a>00341 <span class="comment"> */</span>
<a name="l00342"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#d82e358a0ad051ab2bdd2374e9ab4ff8">00342</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#d82e358a0ad051ab2bdd2374e9ab4ff8" title="Checks whether there is a header with the given name.">hasHeader</a>(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> &name)<span class="keyword"> const </span>{
<a name="l00343"></a>00343 <span class="keywordflow">return</span> headers.find(name) != headers.end();
<a name="l00344"></a>00344 }
<a name="l00345"></a>00345 <span class="comment"></span>
<a name="l00346"></a>00346 <span class="comment"> /**</span>
<a name="l00347"></a>00347 <span class="comment"> * Get the parser's current state.</span>
<a name="l00348"></a>00348 <span class="comment"> */</span>
<a name="l00349"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#5bd7dbce81c69ae9e3462e84daf09012">00349</a> State <a class="code" href="classPassenger_1_1ScgiRequestParser.html#5bd7dbce81c69ae9e3462e84daf09012" title="Get the parser&#39;s current state.">getState</a>()<span class="keyword"> const </span>{
<a name="l00350"></a>00350 <span class="keywordflow">return</span> state;
<a name="l00351"></a>00351 }
<a name="l00352"></a>00352 <span class="comment"></span>
<a name="l00353"></a>00353 <span class="comment"> /**</span>
<a name="l00354"></a>00354 <span class="comment"> * Returns the reason why the parser entered the error state.</span>
<a name="l00355"></a>00355 <span class="comment"> *</span>
<a name="l00356"></a>00356 <span class="comment"> * @pre getState() == ERROR</span>
<a name="l00357"></a>00357 <span class="comment"> */</span>
<a name="l00358"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#4114253f47d3e7e5c0dddc3cd11c5596">00358</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#495e2aec6deffd64fd3d53dc81379f8b">ErrorReason</a> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#4114253f47d3e7e5c0dddc3cd11c5596" title="Returns the reason why the parser entered the error state.">getErrorReason</a>()<span class="keyword"> const </span>{
<a name="l00359"></a>00359 <span class="keywordflow">return</span> errorReason;
<a name="l00360"></a>00360 }
<a name="l00361"></a>00361 <span class="comment"></span>
<a name="l00362"></a>00362 <span class="comment"> /**</span>
<a name="l00363"></a>00363 <span class="comment"> * Checks whether this parser is still capable of accepting input (that</span>
<a name="l00364"></a>00364 <span class="comment"> * is, that this parser is not in a final state).</span>
<a name="l00365"></a>00365 <span class="comment"> */</span>
<a name="l00366"></a><a class="code" href="classPassenger_1_1ScgiRequestParser.html#5368ed40bf7c896f68d7ffaae164a092">00366</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1ScgiRequestParser.html#5368ed40bf7c896f68d7ffaae164a092" title="Checks whether this parser is still capable of accepting input (that is, that this...">acceptingInput</a>()<span class="keyword"> const </span>{
<a name="l00367"></a>00367 <span class="keywordflow">return</span> state != DONE && state != ERROR;
<a name="l00368"></a>00368 }
<a name="l00369"></a>00369 };
<a name="l00370"></a>00370
<a name="l00371"></a>00371 } <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:46 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>
|
