1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
|
/*
TODO:
* make the write handle a stream and write directly to it without creating buffers
* we assume everything is ascii
* allow chunked parsing of body (not really necessary as fastcgi protocol allows breaking up of body into separate messages
* allow writer to write to an existing buffer at offset passed in. should be a lot quicker than allocating and slicing...
* don't do pre-allocated buffers in parser. just pass back start and end of current buffer to the callee. should be a lot faster
* Add a resetonerror property to allow parser to stop processing immediately if an error is encountered
* Add a reset method to clear the current parser
* Pool of parsers?
* make buffering more efficent - maybe parse down into the body types and raise event for each param etc.
* think about overhead per connection
* allow a http stream to be parsed on the fly and wrapped in cgi (in and out). maybe inherit from node.js stream and implement pipe (like HTTPS)
* test for buffer overruns
* unit tests
* improve binary parser
*/
var constants = {
"version": 1,
"record": {
"FCGI_BEGIN": 1,
"FCGI_ABORT": 2,
"FCGI_END": 3,
"FCGI_PARAMS": 4,
"FCGI_STDIN": 5,
"FCGI_STDOUT": 6,
"FCGI_STDERR": 7,
"FCGI_DATA": 8,
"FCGI_GET_VALUES": 9,
"FCGI_GET_VALUES_RESULT": 10,
"FCGI_UNKNOWN_TYPE": 11
},
"keepalive": {
"OFF": 0,
"ON": 1
},
"parser": {
"state": {
"HEADER": 0,
"BODY": 1,
"PADDING": 2
}
},
"general": {
"FCGI_HEADER_LEN": 8,
"FCGI_MAX_BODY": Math.pow(2,16)
},
"errors": {
"BUFFER_OVERFLOW": {
"err": 1,
"description": "buffer overflow"
},
"MAX_BODY_EXCEEDED": {
"err": 2,
"description": "a body greater than maximum body size was read/written"
}
},
"flags": {
"FCGI_KEEP_CONN": 1
},
"role": {
"FCGI_RESPONDER": 1,
"FCGI_AUTHORIZER": 2,
"FCGI_FILTER": 3
},
"protocol": {
"status": {
"FCGI_REQUEST_COMPLETE": 0,
"FCGI_CANT_MPX_CONN": 1,
"FCGI_OVERLOADED": 2,
"FCGI_UNKNOWN_ROLE": 3
}
},
"values": {
"FCGI_MAX_CONNS": "FCGI_MAX_CONNS",
"FCGI_MAX_REQS": "FCGI_MAX_REQS",
"FCGI_MPXS_CONNS": "FCGI_MPXS_CONNS"
}
}
function Parser() {
var _parser = this;
var _loc = 0;
var _record = null;
// these are in here because code runs fastest with them in here
var FCGI_MAX_BODY = constants.general.FCGI_MAX_BODY;
var HEADER = constants.parser.state.HEADER;
var BODY = constants.parser.state.BODY;
var PADDING = constants.parser.state.PADDING;
var FCGI_HEADER_LEN = constants.general.FCGI_HEADER_LEN;
var FCGI_BEGIN = constants.record.FCGI_BEGIN;
var FCGI_ABORT = constants.record.FCGI_ABORT;
var FCGI_END = constants.record.FCGI_END;
var FCGI_PARAMS = constants.record.FCGI_PARAMS;
var FCGI_STDIN = constants.record.FCGI_STDIN;
var FCGI_STDOUT = constants.record.FCGI_STDOUT;
var FCGI_STDERR = constants.record.FCGI_STDERR;
var FCGI_DATA = constants.record.FCGI_DATA;
var FCGI_GET_VALUES = constants.record.FCGI_GET_VALUES;
var FCGI_GET_VALUES_RESULT = constants.record.FCGI_GET_VALUES_RESULT;
var FCGI_UNKNOWN_TYPE = constants.record.FCGI_UNKNOWN_TYPE;
var BUFFER_OVERRUN = constants.errors.BUFFER_OVERRUN;
var _header = new Buffer(FCGI_HEADER_LEN);
var _body = new Buffer(FCGI_MAX_BODY);
_parser.current = _record;
_parser.init = function() {
_parser.encoding = "utf8";
_parser.onRecord = _parser.onError = _parser.onHeader = _parser.onParam = _parser.onBody = function(){};
_parser.reset();
}
_parser.reset = function() {
_record = {
"header": {
"version": 0,
"type": 0,
"recordId": 0,
"contentLength": 0,
"paddingLength": 0
},
"body": {}
};
_parser.state = constants.parser.state.HEADER;
_loc = 0;
}
_parser.init();
_parser.execute = function(buffer, start, end) {
if(!start) start = 0;
if(!end) end = buffer.length;
for (var i = start; i < end; i++) {
switch(_parser.state) {
case HEADER:
if(_loc == FCGI_HEADER_LEN - 1) {
var header = _record.header;
_header[_loc] = buffer[i];
var j = 0;
header.version = _header[j++];
header.type = _header[j++];
header.recordId = (_header[j++] << 8) + _header[j++];
header.contentLength = (_header[j++] << 8) + _header[j++];
header.paddingLength = _header[j++];
_record.body = {};
if(_record.header.contentLength > 0) {
_parser.onHeader(header);
_parser.state = BODY;
}
else {
_parser.onRecord(_record);
}
_loc=0;
}
else {
_header[_loc++] = buffer[i];
}
break;
case BODY:
if(_loc == _record.header.contentLength - 1) {
_body[_loc] = buffer[i];
switch(_record.header.type) {
case FCGI_BEGIN:
var j = 0;
_record.body = {
"role": (_body[j++] << 8) + _body[j++],
"flags": _body[j++]
}
break;
case FCGI_ABORT:
break;
case FCGI_END:
var j = 0;
_record.body = {
"status": (_body[j++] << 24) + (_body[j++] << 16) + (_body[j++] << 8) + _body[j++],
"protocolStatus": _body[j++]
}
break;
case FCGI_PARAMS:
case FCGI_GET_VALUES:
case FCGI_GET_VALUES_RESULT:
var j = 0, name = "", value = "", vlen = 0, nlen = 0;
_record.body.params = {};
var rlen = _record.header.contentLength;
while(j < rlen) {
nlen = _body[j];
if(nlen >> 7 == 1) {
nlen = ((_body[j++] << 24) + (_body[j++] << 16) + (_body[j++] << 8) + _body[j++]) & 0x7fffffff;
}
else {
j++;
}
vlen = _body[j];
if(vlen >> 7 == 1) {
vlen = ((_body[j++] << 24) + (_body[j++] << 16) + (_body[j++] << 8) + _body[j++]) & 0x7fffffff;
}
else {
j++;
}
if((j + nlen + vlen) <= _body.length) {
var nv = _body.asciiSlice(j, j + nlen + vlen);
j += (nlen + vlen);
name = nv.substring(0, nlen);
value = nv.substring(nlen);
_parser.onParam(name, value);
_record.body.params[name] = value;
}
else {
_parser.onError(new Error(JSON.stringify(BUFFER_OVERRUN)));
j = rlen;
}
}
break;
case FCGI_STDIN:
case FCGI_STDOUT:
case FCGI_STDERR:
case FCGI_DATA:
switch(_parser.encoding) {
case "utf8":
_record.body = _body.utf8Slice(0, _record.header.contentLength);
break;
case "ascii":
_record.body = _body.asciiSlice(0, _record.header.contentLength);
break;
default:
_parser.onBody(_body, 0, _record.header.contentLength);
break;
}
break;
case FCGI_UNKNOWN_TYPE:
default:
_record.body = {
"type": _body[0]
}
break;
}
_parser.onRecord(_record);
_loc = 0;
if(_record.header.paddingLength > 0) {
_parser.state = PADDING;
}
else {
_parser.state = HEADER;
}
}
else {
_body[_loc++] = buffer[i];
}
break;
case PADDING:
if(_loc++ == _record.header.paddingLength - 1) {
_parser.state = HEADER;
_loc = 0;
}
break;
}
}
}
}
//TODO: add buffer overrun checks - won't be get errors thrown from pack method?? if so, add try/catch blocks
function Writer() {
var _writer = this;
var _pos = 0;
var FCGI_HEADER_LEN = constants.general.FCGI_HEADER_LEN;
var FCGI_MAX_BODY = constants.general.FCGI_MAX_BODY;
var _buffer = new Buffer(FCGI_MAX_BODY + FCGI_HEADER_LEN);
_writer.encoding = "utf8";
_writer.buffer = {
"length": 0,
"buffer": _buffer
};
_writer.tobuffer = function() {
return _buffer.slice(0, _writer.buffer.length);
}
_writer.writeHeader = function(header) {
var i = 0;
_buffer[i++] = header.version & 0xff;
_buffer[i++] = header.type & 0xff;
_buffer[i++] = (header.recordId >> 8) & 0xff;
_buffer[i++] = header.recordId & 0xff;
_buffer[i++] = (header.contentLength >> 8) & 0xff;
_buffer[i++] = header.contentLength & 0xff;
_buffer[i++] = header.paddingLength & 0xff;
_buffer[i++] = 0;
_writer.buffer.length = header.contentLength + header.paddingLength + FCGI_HEADER_LEN;
_pos = i;
}
_writer.writeParams = function(params) {
var i = _pos;
var plen = params.length;
var index = 0;
// loop optimisation
while(plen--) {
var param = params[index++];
var name = param[0];
var value = param[1].toString();
var nlen = name.length;
var vlen = value.length;
if(nlen > 127) {
var nlen1 = nlen | 0x80000000;
_buffer[i++] = (nlen1 >> 24) & 0xff;
_buffer[i++] = (nlen1 >> 16) & 0xff;
_buffer[i++] = (nlen1 >> 8) & 0xff;
_buffer[i++] = nlen1 & 0xff;
}
else {
_buffer[i++] = nlen & 0xff;
}
if(vlen > 127) {
var vlen1 = vlen | 0x80000000;
_buffer[i++] = (vlen1 >> 24) & 0xff;
_buffer[i++] = (vlen1 >> 16) & 0xff;
_buffer[i++] = (vlen1 >> 8) & 0xff;
_buffer[i++] = vlen1 & 0xff;
}
else {
_buffer[i++] = vlen & 0xff;
}
//_buffer.write(name + value, i, "ascii");
_buffer.asciiWrite(name + value, i, nlen + vlen);
i += (nlen + vlen);
}
_pos = i;
}
_writer.writeBody = function(body) {
switch(_writer.encoding) {
case "ascii":
_pos += _buffer.asciiWrite(body, _pos, _buffer.length - _pos);
break;
case "utf8":
_pos += _buffer.utf8Write(body, _pos, _buffer.length - _pos);
break;
default:
body.copy(_buffer, _pos);
_pos += body.length;
break;
}
}
_writer.writeBegin = function(begin) {
var i = _pos;
_buffer[i++] = (begin.role >> 8) & 0xff;
_buffer[i++] = begin.role & 0xff;
_buffer[i++] = begin.flags & 0xff;
_buffer[i++] = 0;
_buffer[i++] = 0;
_buffer[i++] = 0;
_buffer[i++] = 0;
_buffer[i++] = 0;
_pos = i;
}
_writer.writeEnd = function(end) {
var i = _pos;
_buffer[i++] = (end.status >> 24) & 0xff;
_buffer[i++] = (end.status >> 16) & 0xff;
_buffer[i++] = (end.status >> 8) & 0xff;
_buffer[i++] = end.status & 0xff;
_buffer[i++] = end.protocolStatus & 0xff;
_buffer[i++] = 0;
_buffer[i++] = 0;
_buffer[i++] = 0;
_pos = i;
}
}
exports.parser = Parser;
exports.writer = Writer;
exports.constants = constants;
exports.getParamLength = function(params) {
var size = 0;
params.forEach(function(param) {
size += (param[0].length + param[1].toString().length);
if(param[0].length > 127) {
size += 4;
}
else {
size++;
}
if(param[1].toString().length > 127) {
size += 4;
}
else {
size++;
}
});
return size;
}
|
