Skip to content

Commit 369d495

Browse files
jsorjsor
authored
Merge pull request #349 from clue-labs/optimize-parser
Refactor and optimize parsing request
2 parents f30fb12 + 658ca68 commit 369d495

6 files changed

Lines changed: 556 additions & 377 deletions

File tree

‎src/Io/EmptyBodyStream.php‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
<?php
2+
3+
namespace React\Http\Io;
4+
5+
use Evenement\EventEmitter;
6+
use Psr\Http\Message\StreamInterface;
7+
use React\Stream\ReadableStreamInterface;
8+
use React\Stream\Util;
9+
use React\Stream\WritableStreamInterface;
10+
11+
/**
12+
* [Internal] Bridge between an empty StreamInterface from PSR-7 and ReadableStreamInterface from ReactPHP
13+
*
14+
* This class is used in the server to represent an empty body stream of an
15+
* incoming response from the client. This is similar to the `HttpBodyStream`,
16+
* but is specifically designed for the common case of having an empty message
17+
* body.
18+
*
19+
* Note that this is an internal class only and nothing you should usually care
20+
* about. See the `StreamInterface` and `ReadableStreamInterface` for more
21+
* details.
22+
*
23+
* @see HttpBodyStream
24+
* @see StreamInterface
25+
* @see ReadableStreamInterface
26+
* @internal
27+
*/
28+
class EmptyBodyStream extends EventEmitter implements StreamInterface, ReadableStreamInterface
29+
{
30+
private $closed = false;
31+
32+
public function isReadable()
33+
{
34+
return !$this->closed;
35+
}
36+
37+
public function pause()
38+
{
39+
// NOOP
40+
}
41+
42+
public function resume()
43+
{
44+
// NOOP
45+
}
46+
47+
public function pipe(WritableStreamInterface $dest, array $options = array())
48+
{
49+
Util::pipe($this, $dest, $options);
50+
51+
return $dest;
52+
}
53+
54+
public function close()
55+
{
56+
if ($this->closed) {
57+
return;
58+
}
59+
60+
$this->closed = true;
61+
62+
$this->emit('close');
63+
$this->removeAllListeners();
64+
}
65+
66+
public function getSize()
67+
{
68+
return 0;
69+
}
70+
71+
/** @ignore */
72+
public function __toString()
73+
{
74+
return '';
75+
}
76+
77+
/** @ignore */
78+
public function detach()
79+
{
80+
return null;
81+
}
82+
83+
/** @ignore */
84+
public function tell()
85+
{
86+
throw new \BadMethodCallException();
87+
}
88+
89+
/** @ignore */
90+
public function eof()
91+
{
92+
throw new \BadMethodCallException();
93+
}
94+
95+
/** @ignore */
96+
public function isSeekable()
97+
{
98+
return false;
99+
}
100+
101+
/** @ignore */
102+
public function seek($offset, $whence = SEEK_SET)
103+
{
104+
throw new \BadMethodCallException();
105+
}
106+
107+
/** @ignore */
108+
public function rewind()
109+
{
110+
throw new \BadMethodCallException();
111+
}
112+
113+
/** @ignore */
114+
public function isWritable()
115+
{
116+
return false;
117+
}
118+
119+
/** @ignore */
120+
public function write($string)
121+
{
122+
throw new \BadMethodCallException();
123+
}
124+
125+
/** @ignore */
126+
public function read($length)
127+
{
128+
throw new \BadMethodCallException();
129+
}
130+
131+
/** @ignore */
132+
public function getContents()
133+
{
134+
return '';
135+
}
136+
137+
/** @ignore */
138+
public function getMetadata($key = null)
139+
{
140+
return ($key === null) ? array() : null;
141+
}
142+
}

‎src/Io/RequestHeaderParser.php‎

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,42 @@ public function handle(ConnectionInterface $conn)
6969
return;
7070
}
7171

72+
$contentLength = 0;
73+
if ($request->hasHeader('Transfer-Encoding')) {
74+
$contentLength = null;
75+
} elseif ($request->hasHeader('Content-Length')) {
76+
$contentLength = (int)$request->getHeaderLine('Content-Length');
77+
}
78+
79+
if ($contentLength === 0) {
80+
// happy path: request body is known to be empty
81+
$stream = new EmptyBodyStream();
82+
$request = $request->withBody($stream);
83+
} else {
84+
// otherwise body is present => delimit using Content-Length or ChunkedDecoder
85+
$stream = new CloseProtectionStream($conn);
86+
if ($contentLength !== null) {
87+
$stream = new LengthLimitedStream($stream, $contentLength);
88+
} else {
89+
$stream = new ChunkedDecoder($stream);
90+
}
91+
92+
$request = $request->withBody(new HttpBodyStream($stream, $contentLength));
93+
}
94+
7295
$bodyBuffer = isset($buffer[$endOfHeader + 4]) ? \substr($buffer, $endOfHeader + 4) : '';
7396
$buffer = '';
74-
$that->emit('headers', array($request, $bodyBuffer, $conn));
97+
$that->emit('headers', array($request, $conn));
98+
99+
if ($bodyBuffer !== '') {
100+
$conn->emit('data', array($bodyBuffer));
101+
}
102+
103+
// happy path: request body is known to be empty => immediately end stream
104+
if ($contentLength === 0) {
105+
$stream->emit('end');
106+
$stream->close();
107+
}
75108
});
76109

77110
$conn->on('close', function () use (&$buffer, &$fn) {
@@ -135,7 +168,7 @@ public function parseRequest($headers, $remoteSocketUri, $localSocketUri)
135168

136169
// apply SERVER_ADDR and SERVER_PORT if server address is known
137170
// address should always be known, even for Unix domain sockets (UDS)
138-
// but skip UDS as it doesn't have a concept of host/port.s
171+
// but skip UDS as it doesn't have a concept of host/port.
139172
if ($localSocketUri !== null) {
140173
$localAddress = \parse_url($localSocketUri);
141174
if (isset($localAddress['host'], $localAddress['port'])) {
@@ -199,6 +232,26 @@ public function parseRequest($headers, $remoteSocketUri, $localSocketUri)
199232
}
200233
}
201234

235+
// ensure message boundaries are valid according to Content-Length and Transfer-Encoding request headers
236+
if ($request->hasHeader('Transfer-Encoding')) {
237+
if (\strtolower($request->getHeaderLine('Transfer-Encoding')) !== 'chunked') {
238+
throw new \InvalidArgumentException('Only chunked-encoding is allowed for Transfer-Encoding', 501);
239+
}
240+
241+
// Transfer-Encoding: chunked and Content-Length header MUST NOT be used at the same time
242+
// as per https://tools.ietf.org/html/rfc7230#section-3.3.3
243+
if ($request->hasHeader('Content-Length')) {
244+
throw new \InvalidArgumentException('Using both `Transfer-Encoding: chunked` and `Content-Length` is not allowed', 400);
245+
}
246+
} elseif ($request->hasHeader('Content-Length')) {
247+
$string = $request->getHeaderLine('Content-Length');
248+
249+
if ((string)(int)$string !== $string) {
250+
// Content-Length value is not an integer or not a single integer
251+
throw new \InvalidArgumentException('The value of `Content-Length` is not valid', 400);
252+
}
253+
}
254+
202255
// set URI components from socket address if not already filled via Host header
203256
if ($request->getUri()->getHost() === '') {
204257
$parts = \parse_url($localSocketUri);

‎src/StreamingServer.php‎

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,8 @@ public function __construct($requestHandler)
112112
$this->parser = new RequestHeaderParser();
113113

114114
$that = $this;
115-
$this->parser->on('headers', function (ServerRequestInterface $request, $bodyBuffer, ConnectionInterface $conn) use ($that) {
115+
$this->parser->on('headers', function (ServerRequestInterface $request, ConnectionInterface $conn) use ($that) {
116116
$that->handleRequest($conn, $request);
117-
118-
if ($bodyBuffer !== '') {
119-
$conn->emit('data', array($bodyBuffer));
120-
}
121117
});
122118

123119
$this->parser->on('error', function(\Exception $e, ConnectionInterface $conn) use ($that) {
@@ -182,38 +178,6 @@ public function listen(ServerInterface $socket)
182178
/** @internal */
183179
public function handleRequest(ConnectionInterface $conn, ServerRequestInterface $request)
184180
{
185-
$contentLength = 0;
186-
$stream = new CloseProtectionStream($conn);
187-
if ($request->hasHeader('Transfer-Encoding')) {
188-
if (\strtolower($request->getHeaderLine('Transfer-Encoding')) !== 'chunked') {
189-
$this->emit('error', array(new \InvalidArgumentException('Only chunked-encoding is allowed for Transfer-Encoding')));
190-
return $this->writeError($conn, 501, $request);
191-
}
192-
193-
// Transfer-Encoding: chunked and Content-Length header MUST NOT be used at the same time
194-
// as per https://tools.ietf.org/html/rfc7230#section-3.3.3
195-
if ($request->hasHeader('Content-Length')) {
196-
$this->emit('error', array(new \InvalidArgumentException('Using both `Transfer-Encoding: chunked` and `Content-Length` is not allowed')));
197-
return $this->writeError($conn, 400, $request);
198-
}
199-
200-
$stream = new ChunkedDecoder($stream);
201-
$contentLength = null;
202-
} elseif ($request->hasHeader('Content-Length')) {
203-
$string = $request->getHeaderLine('Content-Length');
204-
205-
$contentLength = (int)$string;
206-
if ((string)$contentLength !== $string) {
207-
// Content-Length value is not an integer or not a single integer
208-
$this->emit('error', array(new \InvalidArgumentException('The value of `Content-Length` is not valid')));
209-
return $this->writeError($conn, 400, $request);
210-
}
211-
212-
$stream = new LengthLimitedStream($stream, $contentLength);
213-
}
214-
215-
$request = $request->withBody(new HttpBodyStream($stream, $contentLength));
216-
217181
if ($request->getProtocolVersion() !== '1.0' && '100-continue' === \strtolower($request->getHeaderLine('Expect'))) {
218182
$conn->write("HTTP/1.1 100 Continue\r\n\r\n");
219183
}
@@ -237,12 +201,6 @@ public function handleRequest(ConnectionInterface $conn, ServerRequestInterface
237201
});
238202
}
239203

240-
// happy path: request body is known to be empty => immediately end stream
241-
if ($contentLength === 0) {
242-
$stream->emit('end');
243-
$stream->close();
244-
}
245-
246204
// happy path: response returned, handle and return immediately
247205
if ($response instanceof ResponseInterface) {
248206
return $this->handleResponse($conn, $request, $response);

0 commit comments

Comments
 (0)