Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-11 04:15:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 462864 - Expose request body as a stream, state-machine refactoring in httpd.js. r=honzab

Browse Source
This commit is contained in:
Jeff Walden 2008-11-05 15:31:30 -08:00
parent 05179c6434
commit 5fcf8aa9f1
6 changed files with 265 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
content/base/test/bug435425.sjs
View File

@ -1,12 +1,24 @@
const CC = Components.Constructor;
const BinaryInputStream = CC("@mozilla.org/binaryinputstream;1",
"nsIBinaryInputStream",
"setInputStream");
function handleRequest(request, response)
{
response.setHeader("Content-Type", "text/plain", false);
if (request.method == "GET") {
response.write(request.queryString);
} else {
var rawdata = request.body.purge();
var data = String.fromCharCode.apply(null, rawdata);
response.write(data);
var body = new BinaryInputStream(request.bodyInputStream);
var avail;
var bytes = [];
while ((avail = body.available()) > 0)
Array.prototype.push.apply(bytes, body.readByteArray(avail));
var data = String.fromCharCode.apply(null, bytes);
response.bodyOutputStream.write(data, data.length);
}
}

20
content/base/test/bug444546.sjs
View File

@ -1,10 +1,20 @@
const CC = Components.Constructor;
const BinaryInputStream = CC("@mozilla.org/binaryinputstream;1",
"nsIBinaryInputStream",
"setInputStream");
function handleRequest(request, response)
{
response.setHeader("Content-Type", "text/plain", false);
var rawdata = request.body.purge();
var data = String.fromCharCode.apply(null, rawdata);
for (var i = 0; i < 10; ++i) {
response.write(data);
}
var body = new BinaryInputStream(request.bodyInputStream);
var avail;
var bytes = [];
while ((avail = body.available()) > 0)
Array.prototype.push.apply(bytes, body.readByteArray(avail));
var data = String.fromCharCode.apply(null, bytes);
response.bodyOutputStream.write(data, data.length);
}

257
netwerk/test/httpserver/httpd.js
View File

@ -52,6 +52,8 @@ const Cr = Components.results;
const Cu = Components.utils;
const CC = Components.Constructor;
const PR_UINT32_MAX = Math.pow(2, 32) - 1;
/** True if debugging output is enabled, false otherwise. */
var DEBUG = false; // non-const *only* so tweakable in server tests
@ -195,6 +197,9 @@ const ServerSocket = CC("@mozilla.org/network/server-socket;1",
const BinaryInputStream = CC("@mozilla.org/binaryinputstream;1",
"nsIBinaryInputStream",
"setInputStream");
const BinaryOutputStream = CC("@mozilla.org/binaryoutputstream;1",
"nsIBinaryOutputStream",
"setOutputStream");
const ScriptableInputStream = CC("@mozilla.org/scriptableinputstream;1",
"nsIScriptableInputStream",
"init");
@ -951,26 +956,26 @@ function readBytes(inputStream, count)
/** Request reader processing states; see RequestReader for details. */
const READER_INITIAL = 0;
const READER_IN_HEADERS = 1;
const READER_IN_BODY = 2;
const READER_IN_REQUEST_LINE = 0;
const READER_IN_HEADERS = 1;
const READER_IN_BODY = 2;
const READER_FINISHED = 3;
/**
* Reads incoming request data asynchronously, does any necessary preprocessing,
* and forwards it to the request handler. Processing occurs in three states:
*
* READER_INITIAL Haven't read the entire request line yet
* READER_IN_REQUEST_LINE Reading the request's status line
* READER_IN_HEADERS Reading headers in the request
* READER_IN_BODY Finished reading all request headers (when body
* support's added, will be reading the body)
* READER_IN_BODY Reading the body of the request
* READER_FINISHED Entire request has been read and processed
*
* During the first two stages, initial metadata about the request is gathered
* into a Request object. Once the status line and headers have been processed,
* we create a Response and hand it off to the ServerHandler to be given to the
* appropriate request handler.
*
* XXX we should set up a stream to provide lazy access to the request body
* we start processing the body of the request into the Request. Finally, when
* the entire body has been read, we create a Response and hand it off to the
* ServerHandler to be given to the appropriate request handler.
*
* @param connection : Connection
* the connection for the request being read
@ -988,10 +993,15 @@ function RequestReader(connection)
*/
this._data = new LineData();
/**
* The amount of data remaining to be read from the body of this request.
* After all headers in the request have been read this is the value in the
* Content-Length header, but as the body is read its value decreases to zero.
*/
this._contentLength = 0;
/** The current state of parsing the incoming request. */
this._state = READER_INITIAL;
this._state = READER_IN_REQUEST_LINE;
/** Metadata constructed from the incoming request for the request handler. */
this._metadata = new Request(connection.port);
@ -1024,38 +1034,35 @@ RequestReader.prototype =
gThreadManager.mainThread + ")");
dumpn("*** this._state == " + this._state);
var count = input.available();
// Handle cases where we get more data after a request error has been
// discovered but *before* we can close the connection.
if (!this._data)
var data = this._data;
if (!data)
return;
var moreAvailable = false;
var wasInBody = false;
data.appendBytes(readBytes(input, input.available()));
switch (this._state)
{
case READER_INITIAL:
moreAvailable = this._processRequestLine(input, count);
break;
case READER_IN_HEADERS:
moreAvailable = this._processHeaders(input, count);
break;
case READER_IN_BODY:
wasInBody = true;
moreAvailable = this._processBody(input, count);
break;
default:
NS_ASSERT(false);
break;
case READER_IN_REQUEST_LINE:
if (!this._processRequestLine())
break;
/* fall through */
case READER_IN_HEADERS:
if (!this._processHeaders())
break;
/* fall through */
case READER_IN_BODY:
this._processBody();
}
if (!wasInBody && this._state == READER_IN_BODY && moreAvailable)
moreAvailable = this._processBody(input, count);
if (moreAvailable)
if (this._state != READER_FINISHED)
input.asyncWait(this, 0, 0, gThreadManager.currentThread);
},
@ -1075,26 +1082,19 @@ RequestReader.prototype =
// PRIVATE API
/**
* Reads count bytes from input and processes unprocessed, downloaded data as
* a request line.
* Processes unprocessed, downloaded data as a request line.
*
* @param input : nsIInputStream
* stream from which count bytes of data must be read
* @param count : PRUint32
* the number of bytes of data which must be read from input
* @returns boolean
* true if more data must be read from the request, false otherwise
* true iff the request line has been fully processed
*/
_processRequestLine: function(input, count)
_processRequestLine: function()
{
NS_ASSERT(this._state == READER_INITIAL);
var data = this._data;
data.appendBytes(readBytes(input, count));
NS_ASSERT(this._state == READER_IN_REQUEST_LINE);
// servers SHOULD ignore any empty line(s) received where a Request-Line
// is expected (section 4.1)
var data = this._data;
var line = {};
var readSuccess;
while ((readSuccess = data.readLine(line)) && line.value == "")
@ -1108,18 +1108,8 @@ RequestReader.prototype =
try
{
this._parseRequestLine(line.value);
// do we have more header data to read?
if (!this._parseHeaders())
return true;
dumpn("_processRequestLine, Content-length="+this._contentLength);
if (this._contentLength > 0)
return true;
// headers complete, do a data check and then forward to the handler
this._validateRequest();
return this._handleResponse();
this._state = READER_IN_HEADERS;
return true;
}
catch (e)
{
@ -1129,17 +1119,13 @@ RequestReader.prototype =
},
/**
* Reads data from input and processes it, assuming it is either at the
* beginning or in the middle of processing request headers.
* Processes stored data, assuming it is either at the beginning or in
* the middle of processing request headers.
*
* @param input : nsIInputStream
* stream from which count bytes of data must be read
* @param count : PRUint32
* the number of bytes of data which must be read from input
* @returns boolean
* true if more data must be read from the request, false otherwise
* true iff header data in the request has been fully processed
*/
_processHeaders: function(input, count)
_processHeaders: function()
{
NS_ASSERT(this._state == READER_IN_HEADERS);
@ -1147,21 +1133,24 @@ RequestReader.prototype =
//
// - need to support RFC 2047-encoded non-US-ASCII characters
this._data.appendBytes(readBytes(input, count));
try
{
// do we have all the headers?
if (!this._parseHeaders())
return true;
var done = this._parseHeaders();
if (done)
{
var request = this._metadata;
dumpn("_processHeaders, Content-length="+this._contentLength);
if (this._contentLength > 0)
return true;
// XXX this is wrong for requests with transfer-encodings applied to
// them, particularly chunked (which by its nature can have no
// meaningful Content-Length header)!
this._contentLength = request.hasHeader("Content-Length")
? parseInt(request.getHeader("Content-Length"), 10)
: 0;
dumpn("_processHeaders, Content-length=" + this._contentLength);
// we have all the headers, continue with the body
this._validateRequest();
return this._handleResponse();
this._state = READER_IN_BODY;
}
return done;
}
catch (e)
{
@ -1170,34 +1159,43 @@ RequestReader.prototype =
}
},
_processBody: function(input, count)
/**
* Processes stored data, assuming it is either at the beginning or in
* the middle of processing the request body.
*
* @returns boolean
* true iff the request body has been fully processed
*/
_processBody: function()
{
NS_ASSERT(this._state == READER_IN_BODY);
// XXX handle chunked transfer-coding request bodies!
try
{
if (this._contentLength > 0)
{
var bodyData = this._data.purge();
if (!bodyData || bodyData.length == 0)
{
if (count > this._contentLength)
count = this._contentLength;
var data = this._data.purge();
var count = Math.min(data.length, this._contentLength);
dumpn("*** loading data=" + data + " len=" + data.length +
" excess=" + (data.length - count));
bodyData = readBytes(input, count);
}
dumpn("*** loading data="+bodyData+" len="+bodyData.length);
this._metadata._body.appendBytes(bodyData);
this._contentLength -= bodyData.length;
var bos = new BinaryOutputStream(this._metadata._bodyOutputStream);
bos.writeByteArray(data, count);
this._contentLength -= count;
}
dumpn("*** remainig body data len="+this._contentLength);
if (this._contentLength > 0)
dumpn("*** remaining body data len=" + this._contentLength);
if (this._contentLength == 0)
{
this._validateRequest();
this._state = READER_FINISHED;
this._handleResponse();
return true;
this._validateRequest();
return this._handleResponse();
}
return false;
}
catch (e)
{
@ -1306,6 +1304,8 @@ RequestReader.prototype =
*/
_handleError: function(e)
{
this._state = READER_FINISHED;
var server = this._connection.server;
if (e instanceof HttpError)
{
@ -1330,21 +1330,16 @@ RequestReader.prototype =
*
* This method is called once per request, after the request line and all
* headers and the body, if any, have been received.
*
* @returns boolean
* true if more data must be read, false otherwise
*/
_handleResponse: function()
{
NS_ASSERT(this._state == READER_IN_BODY);
NS_ASSERT(this._state == READER_FINISHED);
// We don't need the line-based data any more, so make attempted reuse an
// error.
this._data = null;
this._connection.process(this._metadata);
return false;
},
@ -1358,7 +1353,7 @@ RequestReader.prototype =
*/
_parseRequestLine: function(line)
{
NS_ASSERT(this._state == READER_INITIAL);
NS_ASSERT(this._state == READER_IN_REQUEST_LINE);
dumpn("*** _parseRequestLine('" + line + "')");
@ -1449,9 +1444,6 @@ RequestReader.prototype =
metadata._scheme = scheme;
metadata._host = host;
metadata._port = port;
// our work here is finished
this._state = READER_IN_HEADERS;
},
/**
@ -1517,12 +1509,6 @@ RequestReader.prototype =
// either way, we're done processing headers
this._state = READER_IN_BODY;
try
{
this._contentLength = parseInt(headers.getHeader("Content-Length"));
dumpn("Content-Length="+this._contentLength);
}
catch (e) {}
return true;
}
else if (firstChar == " " || firstChar == "\t")
@ -1652,16 +1638,15 @@ LineData.prototype =
},
/**
* Retrieve any bytes we may have overread from the request's postdata. After
* this method is called, this must not be used in any way.
* Removes the bytes currently within this and returns them in an array.
*
* @returns Array
* the bytes read past the CRLFCRLF at the end of request headers
* the bytes within this when this method is called
*/
purge: function()
{
var data = this._data;
this._data = null;
this._data = [];
return data;
}
};
@ -1979,8 +1964,13 @@ ServerHandler.prototype =
if (metadata.method == "PUT")
{
// remotely set path override
var data = metadata.body.purge();
data = String.fromCharCode.apply(null, data.splice(0, data.length + 2));
var avail;
var bytes = [];
var body = new BinaryInputStream(metadata.bodyInputStream);
while ((avail = body.available()) > 0)
Array.prototype.push.apply(bytes, body.readByteArray(avail));
var data = String.fromCharCode.apply(null, bytes);
var contentType;
try
{
@ -1991,13 +1981,13 @@ ServerHandler.prototype =
contentType = "application/octet-stream";
}
dumpn("PUT data \'"+data+"\' for "+path);
dumpn("PUT data \'" + data + "\' for " + path);
this._putDataOverrides[path] =
function(ametadata, aresponse)
{
aresponse.setStatusLine(metadata.httpVersion, 200, "OK");
aresponse.setStatusLine(ametadata.httpVersion, 200, "OK");
aresponse.setHeader("Content-Type", contentType, false);
dumpn("*** writting PUT data=\'"+data+"\'");
dumpn("*** writing PUT data=\'" + data + "\'");
aresponse.bodyOutputStream.write(data, data.length);
};
@ -2008,12 +1998,12 @@ ServerHandler.prototype =
if (path in this._putDataOverrides)
{
delete this._putDataOverrides[path];
dumpn("clearing PUT data for "+path);
dumpn("clearing PUT data for " + path);
response.setStatusLine(metadata.httpVersion, 200, "OK");
}
else
{
dumpn("no PUT data for "+path+" to delete");
dumpn("no PUT data for " + path + " to delete");
response.setStatusLine(metadata.httpVersion, 204, "No Content");
}
}
@ -2021,14 +2011,14 @@ ServerHandler.prototype =
{
// PUT data overrides are priviledged before all
// other overrides.
dumpn("calling PUT data override for "+path);
dumpn("calling PUT data override for " + path);
this._putDataOverrides[path](metadata, response);
}
else if (path in this._overridePaths)
{
// explicit paths first, then files based on existing directory mappings,
// then (if the file doesn't exist) built-in server default paths
dumpn("calling override for "+path);
dumpn("calling override for " + path);
this._overridePaths[path](metadata, response);
}
else
@ -3098,7 +3088,6 @@ Response.prototype =
if (!this._bodyOutputStream && !this._outputProcessed)
{
const PR_UINT32_MAX = Math.pow(2, 32) - 1;
var pipe = new Pipe(false, false, 0, PR_UINT32_MAX, null);
this._bodyOutputStream = pipe.outputStream;
this._bodyInputStream = pipe.inputStream;
@ -3683,8 +3672,13 @@ function Request(port)
/** Port number over which the request was received. */
this._port = port;
/** Body data of the request */
this._body = new LineData();
var bodyPipe = new Pipe(false, false, 0, PR_UINT32_MAX, null);
/** Stream from which data in this request's body may be read. */
this._bodyInputStream = bodyPipe.inputStream;
/** Stream to which data in this request's body is written. */
this._bodyOutputStream = bodyPipe.outputStream;
/**
* The headers in this request.
@ -3795,6 +3789,14 @@ Request.prototype =
return this._bag.enumerator;
},
//
// see nsIHttpRequestMetadata.headers
//
get bodyInputStream()
{
return this._bodyInputStream;
},
//
// see nsIPropertyBag.getProperty
//
@ -3809,11 +3811,6 @@ Request.prototype =
{
if (!this._bag)
this._bag = new WritablePropertyBag();
},
get body()
{
return this._body;
}
};

15
netwerk/test/httpserver/nsIHttpServer.idl
View File

@ -38,9 +38,10 @@
#include "nsIPropertyBag.idl"
interface nsIInputStream;
interface nsILocalFile;
interface nsISimpleEnumerator;
interface nsIOutputStream;
interface nsISimpleEnumerator;
interface nsIHttpServer;
interface nsIHttpRequestHandler;
@ -322,7 +323,7 @@ interface nsIHttpRequestHandler : nsISupports
/**
* A representation of the data included in an HTTP request.
*/
[scriptable, uuid(45b92a9e-5e0a-42da-81a6-983e4b1bc1b0)]
[scriptable, uuid(ed8bdb6b-83e0-43aB-a412-a9863bd79394)]
interface nsIHttpRequestMetadata : nsIPropertyBag
{
/**
@ -354,13 +355,14 @@ interface nsIHttpRequestMetadata : nsIPropertyBag
/**
* The requested path, without any query string (e.g. "/dir/file.txt"). It is
* guaranteed to begin with a "/". This string is in the
* guaranteed to begin with a "/". The individual components in this string
* are URL-encoded.
*/
readonly attribute string path;
/**
* The URL-encoded query string associated with this request, not including
* the initial "?".
* the initial "?", or "" if no query string was present.
*/
readonly attribute string queryString;
@ -411,7 +413,10 @@ interface nsIHttpRequestMetadata : nsIPropertyBag
*/
readonly attribute nsISimpleEnumerator headers;
// XXX expose request body here!
/**
* A stream from which data appearing in the body of this request can be read.
*/
readonly attribute nsIInputStream bodyInputStream;
};

97
netwerk/test/httpserver/test/test_body_length.js Normal file
View File

@ -0,0 +1,97 @@
/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et: */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is httpd.js code.
*
* The Initial Developer of the Original Code is
* the Mozilla Corporation.
* Portions created by the Initial Developer are Copyright (C) 2008
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Jeff Walden <jwalden+code@mit.edu>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
* Tests that the Content-Length header in incoming requests is interpreted as
* a decimal number, even if it has the form (including leading zero) of an
* octal number.
*/
const PORT = 4444;
var srv;
function run_test()
{
srv = createServer();
srv.registerPathHandler("/content-length", contentLength);
srv.start(PORT);
runHttpTests(tests, function() { srv.stop(); });
}
const REQUEST_DATA = "12345678901234567";
function contentLength(request, response)
{
do_check_eq(request.method, "POST");
do_check_eq(request.getHeader("Content-Length"), "017");
var body = new ScriptableInputStream(request.bodyInputStream);
var avail;
var data = "";
while ((avail = body.available()) > 0)
data += body.read(avail);
do_check_eq(data, REQUEST_DATA);
}
/***************
* BEGIN TESTS *
***************/
var tests = [
new Test("http://localhost:4444/content-length",
init_content_length),
];
function init_content_length(ch)
{
var content = Cc["@mozilla.org/io/string-input-stream;1"]
.createInstance(Ci.nsIStringInputStream);
content.data = REQUEST_DATA;
ch.QueryInterface(Ci.nsIUploadChannel)
.setUploadStream(content, "text/plain", REQUEST_DATA.length);
// Override the values implicitly set by setUploadStream above.
ch.requestMethod = "POST";
ch.setRequestHeader("Content-Length", "017", false); // 17 bytes, not 15
}

2
netwerk/test/httpserver/test/test_remotesetpath.js
View File

@ -36,7 +36,7 @@
*
* ***** END LICENSE BLOCK ***** */
// Make sure setIndexHandler works as expected
// Make sure PUT/GET support work as expected
var paths =