.gitignore000064400000000206144760126270006543 0ustar00phpunit.xml composer.phar composer.lock composer-test.lock vendor/ build/artifacts/ artifacts/ docs/_build docs/*.pyc .idea .DS_STORE .travis.yml000064400000000351144760126270006665 0ustar00language: php php: - 5.4 - 5.5 - 5.6 - 7.0 - hhvm sudo: false install: - travis_retry composer install --no-interaction --prefer-source script: make test matrix: allow_failures: - php: hhvm fast_finish: true CHANGELOG.md000064400000005055144760126270006373 0ustar00# CHANGELOG ## 1.3.1 - 2016-06-25 * Fix `Uri::__toString` for network path references, e.g. `//example.org`. * Fix missing lowercase normalization for host. * Fix handling of URI components in case they are `'0'` in a lot of places, e.g. as a user info password. * Fix `Uri::withAddedHeader` to correctly merge headers with different case. * Fix trimming of header values in `Uri::withAddedHeader`. Header values may be surrounded by whitespace which should be ignored according to RFC 7230 Section 3.2.4. This does not apply to header names. * Fix `Uri::withAddedHeader` with an array of header values. * Fix `Uri::resolve` when base path has no slash and handling of fragment. * Fix handling of encoding in `Uri::with(out)QueryValue` so one can pass the key/value both in encoded as well as decoded form to those methods. This is consistent with withPath, withQuery etc. * Fix `ServerRequest::withoutAttribute` when attribute value is null. ## 1.3.0 - 2016-04-13 * Added remaining interfaces needed for full PSR7 compatibility (ServerRequestInterface, UploadedFileInterface, etc.). * Added support for stream_for from scalars. * Can now extend Uri. * Fixed a bug in validating request methods by making it more permissive. ## 1.2.3 - 2016-02-18 * Fixed support in `GuzzleHttp\Psr7\CachingStream` for seeking forward on remote streams, which can sometimes return fewer bytes than requested with `fread`. * Fixed handling of gzipped responses with FNAME headers. ## 1.2.2 - 2016-01-22 * Added support for URIs without any authority. * Added support for HTTP 451 'Unavailable For Legal Reasons.' * Added support for using '0' as a filename. * Added support for including non-standard ports in Host headers. ## 1.2.1 - 2015-11-02 * Now supporting negative offsets when seeking to SEEK_END. ## 1.2.0 - 2015-08-15 * Body as `"0"` is now properly added to a response. * Now allowing forward seeking in CachingStream. * Now properly parsing HTTP requests that contain proxy targets in `parse_request`. * functions.php is now conditionally required. * user-info is no longer dropped when resolving URIs. ## 1.1.0 - 2015-06-24 * URIs can now be relative. * `multipart/form-data` headers are now overridden case-insensitively. * URI paths no longer encode the following characters because they are allowed in URIs: "(", ")", "*", "!", "'" * A port is no longer added to a URI when the scheme is missing and no port is present. ## 1.0.0 - 2015-05-19 Initial release. Currently unsupported: - `Psr\Http\Message\ServerRequestInterface` - `Psr\Http\Message\UploadedFileInterface` LICENSE000064400000002127144760126270005564 0ustar00Copyright (c) 2015 Michael Dowling, https://github.com/mtdowling Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Makefile000064400000001115144760126270006213 0ustar00all: clean test test: vendor/bin/phpunit $(TEST) coverage: vendor/bin/phpunit --coverage-html=artifacts/coverage $(TEST) view-coverage: open artifacts/coverage/index.html check-tag: $(if $(TAG),,$(error TAG is not defined. Pass via "make tag TAG=4.2.1")) tag: check-tag @echo Tagging $(TAG) chag update $(TAG) git commit -a -m '$(TAG) release' chag tag @echo "Release has been created. Push using 'make release'" @echo "Changes made in the release commit" git diff HEAD~1 HEAD release: check-tag git push origin master git push origin $(TAG) clean: rm -rf artifacts/* README.md000064400000035124144760126270006041 0ustar00# PSR-7 Message Implementation This repository contains a full [PSR-7](http://www.php-fig.org/psr/psr-7/) message implementation, several stream decorators, and some helpful functionality like query string parsing. [![Build Status](https://travis-ci.org/guzzle/psr7.svg?branch=master)](https://travis-ci.org/guzzle/psr7) # Stream implementation This package comes with a number of stream implementations and stream decorators. ## AppendStream `GuzzleHttp\Psr7\AppendStream` Reads from multiple streams, one after the other. ```php use GuzzleHttp\Psr7; $a = Psr7\stream_for('abc, '); $b = Psr7\stream_for('123.'); $composed = new Psr7\AppendStream([$a, $b]); $composed->addStream(Psr7\stream_for(' Above all listen to me')); echo $composed; // abc, 123. Above all listen to me. ``` ## BufferStream `GuzzleHttp\Psr7\BufferStream` Provides a buffer stream that can be written to fill a buffer, and read from to remove bytes from the buffer. This stream returns a "hwm" metadata value that tells upstream consumers what the configured high water mark of the stream is, or the maximum preferred size of the buffer. ```php use GuzzleHttp\Psr7; // When more than 1024 bytes are in the buffer, it will begin returning // false to writes. This is an indication that writers should slow down. $buffer = new Psr7\BufferStream(1024); ``` ## CachingStream The CachingStream is used to allow seeking over previously read bytes on non-seekable streams. This can be useful when transferring a non-seekable entity body fails due to needing to rewind the stream (for example, resulting from a redirect). Data that is read from the remote stream will be buffered in a PHP temp stream so that previously read bytes are cached first in memory, then on disk. ```php use GuzzleHttp\Psr7; $original = Psr7\stream_for(fopen('http://www.google.com', 'r')); $stream = new Psr7\CachingStream($original); $stream->read(1024); echo $stream->tell(); // 1024 $stream->seek(0); echo $stream->tell(); // 0 ``` ## DroppingStream `GuzzleHttp\Psr7\DroppingStream` Stream decorator that begins dropping data once the size of the underlying stream becomes too full. ```php use GuzzleHttp\Psr7; // Create an empty stream $stream = Psr7\stream_for(); // Start dropping data when the stream has more than 10 bytes $dropping = new Psr7\DroppingStream($stream, 10); $dropping->write('01234567890123456789'); echo $stream; // 0123456789 ``` ## FnStream `GuzzleHttp\Psr7\FnStream` Compose stream implementations based on a hash of functions. Allows for easy testing and extension of a provided stream without needing to create a concrete class for a simple extension point. ```php use GuzzleHttp\Psr7; $stream = Psr7\stream_for('hi'); $fnStream = Psr7\FnStream::decorate($stream, [ 'rewind' => function () use ($stream) { echo 'About to rewind - '; $stream->rewind(); echo 'rewound!'; } ]); $fnStream->rewind(); // Outputs: About to rewind - rewound! ``` ## InflateStream `GuzzleHttp\Psr7\InflateStream` Uses PHP's zlib.inflate filter to inflate deflate or gzipped content. This stream decorator skips the first 10 bytes of the given stream to remove the gzip header, converts the provided stream to a PHP stream resource, then appends the zlib.inflate filter. The stream is then converted back to a Guzzle stream resource to be used as a Guzzle stream. ## LazyOpenStream `GuzzleHttp\Psr7\LazyOpenStream` Lazily reads or writes to a file that is opened only after an IO operation take place on the stream. ```php use GuzzleHttp\Psr7; $stream = new Psr7\LazyOpenStream('/path/to/file', 'r'); // The file has not yet been opened... echo $stream->read(10); // The file is opened and read from only when needed. ``` ## LimitStream `GuzzleHttp\Psr7\LimitStream` LimitStream can be used to read a subset or slice of an existing stream object. This can be useful for breaking a large file into smaller pieces to be sent in chunks (e.g. Amazon S3's multipart upload API). ```php use GuzzleHttp\Psr7; $original = Psr7\stream_for(fopen('/tmp/test.txt', 'r+')); echo $original->getSize(); // >>> 1048576 // Limit the size of the body to 1024 bytes and start reading from byte 2048 $stream = new Psr7\LimitStream($original, 1024, 2048); echo $stream->getSize(); // >>> 1024 echo $stream->tell(); // >>> 0 ``` ## MultipartStream `GuzzleHttp\Psr7\MultipartStream` Stream that when read returns bytes for a streaming multipart or multipart/form-data stream. ## NoSeekStream `GuzzleHttp\Psr7\NoSeekStream` NoSeekStream wraps a stream and does not allow seeking. ```php use GuzzleHttp\Psr7; $original = Psr7\stream_for('foo'); $noSeek = new Psr7\NoSeekStream($original); echo $noSeek->read(3); // foo var_export($noSeek->isSeekable()); // false $noSeek->seek(0); var_export($noSeek->read(3)); // NULL ``` ## PumpStream `GuzzleHttp\Psr7\PumpStream` Provides a read only stream that pumps data from a PHP callable. When invoking the provided callable, the PumpStream will pass the amount of data requested to read to the callable. The callable can choose to ignore this value and return fewer or more bytes than requested. Any extra data returned by the provided callable is buffered internally until drained using the read() function of the PumpStream. The provided callable MUST return false when there is no more data to read. ## Implementing stream decorators Creating a stream decorator is very easy thanks to the `GuzzleHttp\Psr7\StreamDecoratorTrait`. This trait provides methods that implement `Psr\Http\Message\StreamInterface` by proxying to an underlying stream. Just `use` the `StreamDecoratorTrait` and implement your custom methods. For example, let's say we wanted to call a specific function each time the last byte is read from a stream. This could be implemented by overriding the `read()` method. ```php use Psr\Http\Message\StreamInterface; use GuzzleHttp\Psr7\StreamDecoratorTrait; class EofCallbackStream implements StreamInterface { use StreamDecoratorTrait; private $callback; public function __construct(StreamInterface $stream, callable $cb) { $this->stream = $stream; $this->callback = $cb; } public function read($length) { $result = $this->stream->read($length); // Invoke the callback when EOF is hit. if ($this->eof()) { call_user_func($this->callback); } return $result; } } ``` This decorator could be added to any existing stream and used like so: ```php use GuzzleHttp\Psr7; $original = Psr7\stream_for('foo'); $eofStream = new EofCallbackStream($original, function () { echo 'EOF!'; }); $eofStream->read(2); $eofStream->read(1); // echoes "EOF!" $eofStream->seek(0); $eofStream->read(3); // echoes "EOF!" ``` ## PHP StreamWrapper You can use the `GuzzleHttp\Psr7\StreamWrapper` class if you need to use a PSR-7 stream as a PHP stream resource. Use the `GuzzleHttp\Psr7\StreamWrapper::getResource()` method to create a PHP stream from a PSR-7 stream. ```php use GuzzleHttp\Psr7\StreamWrapper; $stream = GuzzleHttp\Psr7\stream_for('hello!'); $resource = StreamWrapper::getResource($stream); echo fread($resource, 6); // outputs hello! ``` # Function API There are various functions available under the `GuzzleHttp\Psr7` namespace. ## `function str` `function str(MessageInterface $message)` Returns the string representation of an HTTP message. ```php $request = new GuzzleHttp\Psr7\Request('GET', 'http://example.com'); echo GuzzleHttp\Psr7\str($request); ``` ## `function uri_for` `function uri_for($uri)` This function accepts a string or `Psr\Http\Message\UriInterface` and returns a UriInterface for the given value. If the value is already a `UriInterface`, it is returned as-is. ```php $uri = GuzzleHttp\Psr7\uri_for('http://example.com'); assert($uri === GuzzleHttp\Psr7\uri_for($uri)); ``` ## `function stream_for` `function stream_for($resource = '', array $options = [])` Create a new stream based on the input type. Options is an associative array that can contain the following keys: * - metadata: Array of custom metadata. * - size: Size of the stream. This method accepts the following `$resource` types: - `Psr\Http\Message\StreamInterface`: Returns the value as-is. - `string`: Creates a stream object that uses the given string as the contents. - `resource`: Creates a stream object that wraps the given PHP stream resource. - `Iterator`: If the provided value implements `Iterator`, then a read-only stream object will be created that wraps the given iterable. Each time the stream is read from, data from the iterator will fill a buffer and will be continuously called until the buffer is equal to the requested read size. Subsequent read calls will first read from the buffer and then call `next` on the underlying iterator until it is exhausted. - `object` with `__toString()`: If the object has the `__toString()` method, the object will be cast to a string and then a stream will be returned that uses the string value. - `NULL`: When `null` is passed, an empty stream object is returned. - `callable` When a callable is passed, a read-only stream object will be created that invokes the given callable. The callable is invoked with the number of suggested bytes to read. The callable can return any number of bytes, but MUST return `false` when there is no more data to return. The stream object that wraps the callable will invoke the callable until the number of requested bytes are available. Any additional bytes will be buffered and used in subsequent reads. ```php $stream = GuzzleHttp\Psr7\stream_for('foo'); $stream = GuzzleHttp\Psr7\stream_for(fopen('/path/to/file', 'r')); $generator function ($bytes) { for ($i = 0; $i < $bytes; $i++) { yield ' '; } } $stream = GuzzleHttp\Psr7\stream_for($generator(100)); ``` ## `function parse_header` `function parse_header($header)` Parse an array of header values containing ";" separated data into an array of associative arrays representing the header key value pair data of the header. When a parameter does not contain a value, but just contains a key, this function will inject a key with a '' string value. ## `function normalize_header` `function normalize_header($header)` Converts an array of header values that may contain comma separated headers into an array of headers with no comma separated values. ## `function modify_request` `function modify_request(RequestInterface $request, array $changes)` Clone and modify a request with the given changes. This method is useful for reducing the number of clones needed to mutate a message. The changes can be one of: - method: (string) Changes the HTTP method. - set_headers: (array) Sets the given headers. - remove_headers: (array) Remove the given headers. - body: (mixed) Sets the given body. - uri: (UriInterface) Set the URI. - query: (string) Set the query string value of the URI. - version: (string) Set the protocol version. ## `function rewind_body` `function rewind_body(MessageInterface $message)` Attempts to rewind a message body and throws an exception on failure. The body of the message will only be rewound if a call to `tell()` returns a value other than `0`. ## `function try_fopen` `function try_fopen($filename, $mode)` Safely opens a PHP stream resource using a filename. When fopen fails, PHP normally raises a warning. This function adds an error handler that checks for errors and throws an exception instead. ## `function copy_to_string` `function copy_to_string(StreamInterface $stream, $maxLen = -1)` Copy the contents of a stream into a string until the given number of bytes have been read. ## `function copy_to_stream` `function copy_to_stream(StreamInterface $source, StreamInterface $dest, $maxLen = -1)` Copy the contents of a stream into another stream until the given number of bytes have been read. ## `function hash` `function hash(StreamInterface $stream, $algo, $rawOutput = false)` Calculate a hash of a Stream. This method reads the entire stream to calculate a rolling hash (based on PHP's hash_init functions). ## `function readline` `function readline(StreamInterface $stream, $maxLength = null)` Read a line from the stream up to the maximum allowed buffer length. ## `function parse_request` `function parse_request($message)` Parses a request message string into a request object. ## `function parse_response` `function parse_response($message)` Parses a response message string into a response object. ## `function parse_query` `function parse_query($str, $urlEncoding = true)` Parse a query string into an associative array. If multiple values are found for the same key, the value of that key value pair will become an array. This function does not parse nested PHP style arrays into an associative array (e.g., `foo[a]=1&foo[b]=2` will be parsed into `['foo[a]' => '1', 'foo[b]' => '2']`). ## `function build_query` `function build_query(array $params, $encoding = PHP_QUERY_RFC3986)` Build a query string from an array of key value pairs. This function can use the return value of parse_query() to build a query string. This function does not modify the provided keys when an array is encountered (like http_build_query would). ## `function mimetype_from_filename` `function mimetype_from_filename($filename)` Determines the mimetype of a file by looking at its extension. ## `function mimetype_from_extension` `function mimetype_from_extension($extension)` Maps a file extensions to a mimetype. # Static URI methods The `GuzzleHttp\Psr7\Uri` class has several static methods to manipulate URIs. ## `GuzzleHttp\Psr7\Uri::removeDotSegments` `public static function removeDotSegments(string $path): string` Removes dot segments from a path and returns the new path. See http://tools.ietf.org/html/rfc3986#section-5.2.4 ## `GuzzleHttp\Psr7\Uri::resolve` `public static function resolve(UriInterface $base, $rel): UriInterface` Resolve a base URI with a relative URI and return a new URI. See http://tools.ietf.org/html/rfc3986#section-5 ## `GuzzleHttp\Psr7\Uri::withQueryValue` `public static function withQueryValue(UriInterface $uri, $key, $value): UriInterface` Create a new URI with a specific query string value. Any existing query string values that exactly match the provided key are removed and replaced with the given key value pair. ## `GuzzleHttp\Psr7\Uri::withoutQueryValue` `public static function withoutQueryValue(UriInterface $uri, $key): UriInterface` Create a new URI with a specific query string value removed. Any existing query string values that exactly match the provided key are removed. ## `GuzzleHttp\Psr7\Uri::fromParts` `public static function fromParts(array $parts): UriInterface` Create a `GuzzleHttp\Psr7\Uri` object from a hash of `parse_url` parts. composer.json000064400000001467144760126270007307 0ustar00{ "name": "guzzlehttp/psr7", "type": "library", "description": "PSR-7 message implementation", "keywords": ["message", "stream", "http", "uri"], "license": "MIT", "authors": [ { "name": "Michael Dowling", "email": "mtdowling@gmail.com", "homepage": "https://github.com/mtdowling" } ], "require": { "php": ">=5.4.0", "psr/http-message": "~1.0" }, "require-dev": { "phpunit/phpunit": "~4.0" }, "provide": { "psr/http-message-implementation": "1.0" }, "autoload": { "psr-4": { "GuzzleHttp\\Psr7\\": "src/" }, "files": ["src/functions_include.php"] }, "extra": { "branch-alias": { "dev-master": "1.4-dev" } } } phpunit.xml.dist000064400000000633144760126270007732 0ustar00 tests src src/ src/AppendStream.php000064400000012575144760126270010452 0ustar00addStream($stream); } } public function __toString() { try { $this->rewind(); return $this->getContents(); } catch (\Exception $e) { return ''; } } /** * Add a stream to the AppendStream * * @param StreamInterface $stream Stream to append. Must be readable. * * @throws \InvalidArgumentException if the stream is not readable */ public function addStream(StreamInterface $stream) { if (!$stream->isReadable()) { throw new \InvalidArgumentException('Each stream must be readable'); } // The stream is only seekable if all streams are seekable if (!$stream->isSeekable()) { $this->seekable = false; } $this->streams[] = $stream; } public function getContents() { return copy_to_string($this); } /** * Closes each attached stream. * * {@inheritdoc} */ public function close() { $this->pos = $this->current = 0; foreach ($this->streams as $stream) { $stream->close(); } $this->streams = []; } /** * Detaches each attached stream * * {@inheritdoc} */ public function detach() { $this->close(); $this->detached = true; } public function tell() { return $this->pos; } /** * Tries to calculate the size by adding the size of each stream. * * If any of the streams do not return a valid number, then the size of the * append stream cannot be determined and null is returned. * * {@inheritdoc} */ public function getSize() { $size = 0; foreach ($this->streams as $stream) { $s = $stream->getSize(); if ($s === null) { return null; } $size += $s; } return $size; } public function eof() { return !$this->streams || ($this->current >= count($this->streams) - 1 && $this->streams[$this->current]->eof()); } public function rewind() { $this->seek(0); } /** * Attempts to seek to the given position. Only supports SEEK_SET. * * {@inheritdoc} */ public function seek($offset, $whence = SEEK_SET) { if (!$this->seekable) { throw new \RuntimeException('This AppendStream is not seekable'); } elseif ($whence !== SEEK_SET) { throw new \RuntimeException('The AppendStream can only seek with SEEK_SET'); } $this->pos = $this->current = 0; // Rewind each stream foreach ($this->streams as $i => $stream) { try { $stream->rewind(); } catch (\Exception $e) { throw new \RuntimeException('Unable to seek stream ' . $i . ' of the AppendStream', 0, $e); } } // Seek to the actual position by reading from each stream while ($this->pos < $offset && !$this->eof()) { $result = $this->read(min(8096, $offset - $this->pos)); if ($result === '') { break; } } } /** * Reads from all of the appended streams until the length is met or EOF. * * {@inheritdoc} */ public function read($length) { $buffer = ''; $total = count($this->streams) - 1; $remaining = $length; $progressToNext = false; while ($remaining > 0) { // Progress to the next stream if needed. if ($progressToNext || $this->streams[$this->current]->eof()) { $progressToNext = false; if ($this->current === $total) { break; } $this->current++; } $result = $this->streams[$this->current]->read($remaining); // Using a loose comparison here to match on '', false, and null if ($result == null) { $progressToNext = true; continue; } $buffer .= $result; $remaining = $length - strlen($buffer); } $this->pos += strlen($buffer); return $buffer; } public function isReadable() { return true; } public function isWritable() { return false; } public function isSeekable() { return $this->seekable; } public function write($string) { throw new \RuntimeException('Cannot write to an AppendStream'); } public function getMetadata($key = null) { return $key ? null : []; } } src/BufferStream.php000064400000005743144760126270010453 0ustar00hwm = $hwm; } public function __toString() { return $this->getContents(); } public function getContents() { $buffer = $this->buffer; $this->buffer = ''; return $buffer; } public function close() { $this->buffer = ''; } public function detach() { $this->close(); } public function getSize() { return strlen($this->buffer); } public function isReadable() { return true; } public function isWritable() { return true; } public function isSeekable() { return false; } public function rewind() { $this->seek(0); } public function seek($offset, $whence = SEEK_SET) { throw new \RuntimeException('Cannot seek a BufferStream'); } public function eof() { return strlen($this->buffer) === 0; } public function tell() { throw new \RuntimeException('Cannot determine the position of a BufferStream'); } /** * Reads data from the buffer. */ public function read($length) { $currentLength = strlen($this->buffer); if ($length >= $currentLength) { // No need to slice the buffer because we don't have enough data. $result = $this->buffer; $this->buffer = ''; } else { // Slice up the result to provide a subset of the buffer. $result = substr($this->buffer, 0, $length); $this->buffer = substr($this->buffer, $length); } return $result; } /** * Writes data to the buffer. */ public function write($string) { $this->buffer .= $string; // TODO: What should happen here? if (strlen($this->buffer) >= $this->hwm) { return false; } return strlen($string); } public function getMetadata($key = null) { if ($key == 'hwm') { return $this->hwm; } return $key ? null : []; } } src/CachingStream.php000064400000010234144760126270010565 0ustar00remoteStream = $stream; $this->stream = $target ?: new Stream(fopen('php://temp', 'r+')); } public function getSize() { return max($this->stream->getSize(), $this->remoteStream->getSize()); } public function rewind() { $this->seek(0); } public function seek($offset, $whence = SEEK_SET) { if ($whence == SEEK_SET) { $byte = $offset; } elseif ($whence == SEEK_CUR) { $byte = $offset + $this->tell(); } elseif ($whence == SEEK_END) { $size = $this->remoteStream->getSize(); if ($size === null) { $size = $this->cacheEntireStream(); } $byte = $size + $offset; } else { throw new \InvalidArgumentException('Invalid whence'); } $diff = $byte - $this->stream->getSize(); if ($diff > 0) { // Read the remoteStream until we have read in at least the amount // of bytes requested, or we reach the end of the file. while ($diff > 0 && !$this->remoteStream->eof()) { $this->read($diff); $diff = $byte - $this->stream->getSize(); } } else { // We can just do a normal seek since we've already seen this byte. $this->stream->seek($byte); } } public function read($length) { // Perform a regular read on any previously read data from the buffer $data = $this->stream->read($length); $remaining = $length - strlen($data); // More data was requested so read from the remote stream if ($remaining) { // If data was written to the buffer in a position that would have // been filled from the remote stream, then we must skip bytes on // the remote stream to emulate overwriting bytes from that // position. This mimics the behavior of other PHP stream wrappers. $remoteData = $this->remoteStream->read( $remaining + $this->skipReadBytes ); if ($this->skipReadBytes) { $len = strlen($remoteData); $remoteData = substr($remoteData, $this->skipReadBytes); $this->skipReadBytes = max(0, $this->skipReadBytes - $len); } $data .= $remoteData; $this->stream->write($remoteData); } return $data; } public function write($string) { // When appending to the end of the currently read stream, you'll want // to skip bytes from being read from the remote stream to emulate // other stream wrappers. Basically replacing bytes of data of a fixed // length. $overflow = (strlen($string) + $this->tell()) - $this->remoteStream->tell(); if ($overflow > 0) { $this->skipReadBytes += $overflow; } return $this->stream->write($string); } public function eof() { return $this->stream->eof() && $this->remoteStream->eof(); } /** * Close both the remote stream and buffer stream */ public function close() { $this->remoteStream->close() && $this->stream->close(); } private function cacheEntireStream() { $target = new FnStream(['write' => 'strlen']); copy_to_stream($this, $target); return $this->tell(); } } src/DroppingStream.php000064400000002070144760126270011012 0ustar00stream = $stream; $this->maxLength = $maxLength; } public function write($string) { $diff = $this->maxLength - $this->stream->getSize(); // Begin returning 0 when the underlying stream is too large. if ($diff <= 0) { return 0; } // Write the stream or a subset of the stream if needed. if (strlen($string) < $diff) { return $this->stream->write($string); } return $this->stream->write(substr($string, 0, $diff)); } } src/FnStream.php000064400000007114144760126270007577 0ustar00methods = $methods; // Create the functions on the class foreach ($methods as $name => $fn) { $this->{'_fn_' . $name} = $fn; } } /** * Lazily determine which methods are not implemented. * @throws \BadMethodCallException */ public function __get($name) { throw new \BadMethodCallException(str_replace('_fn_', '', $name) . '() is not implemented in the FnStream'); } /** * The close method is called on the underlying stream only if possible. */ public function __destruct() { if (isset($this->_fn_close)) { call_user_func($this->_fn_close); } } /** * Adds custom functionality to an underlying stream by intercepting * specific method calls. * * @param StreamInterface $stream Stream to decorate * @param array $methods Hash of method name to a closure * * @return FnStream */ public static function decorate(StreamInterface $stream, array $methods) { // If any of the required methods were not provided, then simply // proxy to the decorated stream. foreach (array_diff(self::$slots, array_keys($methods)) as $diff) { $methods[$diff] = [$stream, $diff]; } return new self($methods); } public function __toString() { return call_user_func($this->_fn___toString); } public function close() { return call_user_func($this->_fn_close); } public function detach() { return call_user_func($this->_fn_detach); } public function getSize() { return call_user_func($this->_fn_getSize); } public function tell() { return call_user_func($this->_fn_tell); } public function eof() { return call_user_func($this->_fn_eof); } public function isSeekable() { return call_user_func($this->_fn_isSeekable); } public function rewind() { call_user_func($this->_fn_rewind); } public function seek($offset, $whence = SEEK_SET) { call_user_func($this->_fn_seek, $offset, $whence); } public function isWritable() { return call_user_func($this->_fn_isWritable); } public function write($string) { return call_user_func($this->_fn_write, $string); } public function isReadable() { return call_user_func($this->_fn_isReadable); } public function read($length) { return call_user_func($this->_fn_read, $length); } public function getContents() { return call_user_func($this->_fn_getContents); } public function getMetadata($key = null) { return call_user_func($this->_fn_getMetadata, $key); } } src/InflateStream.php000064400000003336144760126270010620 0ustar00read(10); $filenameHeaderLength = $this->getLengthOfPossibleFilenameHeader($stream, $header); // Skip the header, that is 10 + length of filename + 1 (nil) bytes $stream = new LimitStream($stream, -1, 10 + $filenameHeaderLength); $resource = StreamWrapper::getResource($stream); stream_filter_append($resource, 'zlib.inflate', STREAM_FILTER_READ); $this->stream = new Stream($resource); } /** * @param StreamInterface $stream * @param $header * @return int */ private function getLengthOfPossibleFilenameHeader(StreamInterface $stream, $header) { $filename_header_length = 0; if (substr(bin2hex($header), 6, 2) === '08') { // we have a filename, read until nil $filename_header_length = 1; while ($stream->read(1) !== chr(0)) { $filename_header_length++; } } return $filename_header_length; } } src/LazyOpenStream.php000064400000001560144760126270010774 0ustar00filename = $filename; $this->mode = $mode; } /** * Creates the underlying stream lazily when required. * * @return StreamInterface */ protected function createStream() { return stream_for(try_fopen($this->filename, $this->mode)); } } src/LimitStream.php000064400000010162144760126270010307 0ustar00stream = $stream; $this->setLimit($limit); $this->setOffset($offset); } public function eof() { // Always return true if the underlying stream is EOF if ($this->stream->eof()) { return true; } // No limit and the underlying stream is not at EOF if ($this->limit == -1) { return false; } return $this->stream->tell() >= $this->offset + $this->limit; } /** * Returns the size of the limited subset of data * {@inheritdoc} */ public function getSize() { if (null === ($length = $this->stream->getSize())) { return null; } elseif ($this->limit == -1) { return $length - $this->offset; } else { return min($this->limit, $length - $this->offset); } } /** * Allow for a bounded seek on the read limited stream * {@inheritdoc} */ public function seek($offset, $whence = SEEK_SET) { if ($whence !== SEEK_SET || $offset < 0) { throw new \RuntimeException(sprintf( 'Cannot seek to offset % with whence %s', $offset, $whence )); } $offset += $this->offset; if ($this->limit !== -1) { if ($offset > $this->offset + $this->limit) { $offset = $this->offset + $this->limit; } } $this->stream->seek($offset); } /** * Give a relative tell() * {@inheritdoc} */ public function tell() { return $this->stream->tell() - $this->offset; } /** * Set the offset to start limiting from * * @param int $offset Offset to seek to and begin byte limiting from * * @throws \RuntimeException if the stream cannot be seeked. */ public function setOffset($offset) { $current = $this->stream->tell(); if ($current !== $offset) { // If the stream cannot seek to the offset position, then read to it if ($this->stream->isSeekable()) { $this->stream->seek($offset); } elseif ($current > $offset) { throw new \RuntimeException("Could not seek to stream offset $offset"); } else { $this->stream->read($offset - $current); } } $this->offset = $offset; } /** * Set the limit of bytes that the decorator allows to be read from the * stream. * * @param int $limit Number of bytes to allow to be read from the stream. * Use -1 for no limit. */ public function setLimit($limit) { $this->limit = $limit; } public function read($length) { if ($this->limit == -1) { return $this->stream->read($length); } // Check if the current position is less than the total allowed // bytes + original offset $remaining = ($this->offset + $this->limit) - $this->stream->tell(); if ($remaining > 0) { // Only return the amount of requested data, ensuring that the byte // limit is not exceeded return $this->stream->read(min($remaining, $length)); } return ''; } } src/MessageTrait.php000064400000010743144760126270010452 0ustar00 array of values */ private $headers = []; /** @var array Map of lowercase header name => original name at registration */ private $headerNames = []; /** @var string */ private $protocol = '1.1'; /** @var StreamInterface */ private $stream; public function getProtocolVersion() { return $this->protocol; } public function withProtocolVersion($version) { if ($this->protocol === $version) { return $this; } $new = clone $this; $new->protocol = $version; return $new; } public function getHeaders() { return $this->headers; } public function hasHeader($header) { return isset($this->headerNames[strtolower($header)]); } public function getHeader($header) { $header = strtolower($header); if (!isset($this->headerNames[$header])) { return []; } $header = $this->headerNames[$header]; return $this->headers[$header]; } public function getHeaderLine($header) { return implode(', ', $this->getHeader($header)); } public function withHeader($header, $value) { if (!is_array($value)) { $value = [$value]; } $value = $this->trimHeaderValues($value); $normalized = strtolower($header); $new = clone $this; if (isset($new->headerNames[$normalized])) { unset($new->headers[$new->headerNames[$normalized]]); } $new->headerNames[$normalized] = $header; $new->headers[$header] = $value; return $new; } public function withAddedHeader($header, $value) { if (!is_array($value)) { $value = [$value]; } $value = $this->trimHeaderValues($value); $normalized = strtolower($header); $new = clone $this; if (isset($new->headerNames[$normalized])) { $header = $this->headerNames[$normalized]; $new->headers[$header] = array_merge($this->headers[$header], $value); } else { $new->headerNames[$normalized] = $header; $new->headers[$header] = $value; } return $new; } public function withoutHeader($header) { $normalized = strtolower($header); if (!isset($this->headerNames[$normalized])) { return $this; } $header = $this->headerNames[$normalized]; $new = clone $this; unset($new->headers[$header], $new->headerNames[$normalized]); return $new; } public function getBody() { if (!$this->stream) { $this->stream = stream_for(''); } return $this->stream; } public function withBody(StreamInterface $body) { if ($body === $this->stream) { return $this; } $new = clone $this; $new->stream = $body; return $new; } private function setHeaders(array $headers) { $this->headerNames = $this->headers = []; foreach ($headers as $header => $value) { if (!is_array($value)) { $value = [$value]; } $value = $this->trimHeaderValues($value); $normalized = strtolower($header); if (isset($this->headerNames[$normalized])) { $header = $this->headerNames[$normalized]; $this->headers[$header] = array_merge($this->headers[$header], $value); } else { $this->headerNames[$normalized] = $header; $this->headers[$header] = $value; } } } /** * Trims whitespace from the header values. * * Spaces and tabs ought to be excluded by parsers when extracting the field value from a header field. * * header-field = field-name ":" OWS field-value OWS * OWS = *( SP / HTAB ) * * @param string[] $values Header values * * @return string[] Trimmed header values * * @see https://tools.ietf.org/html/rfc7230#section-3.2.4 */ private function trimHeaderValues(array $values) { return array_map(function ($value) { return trim($value, " \t"); }, $values); } } src/MultipartStream.php000064400000011067144760126270011217 0ustar00boundary = $boundary ?: uniqid(); $this->stream = $this->createStream($elements); } /** * Get the boundary * * @return string */ public function getBoundary() { return $this->boundary; } public function isWritable() { return false; } /** * Get the headers needed before transferring the content of a POST file */ private function getHeaders(array $headers) { $str = ''; foreach ($headers as $key => $value) { $str .= "{$key}: {$value}\r\n"; } return "--{$this->boundary}\r\n" . trim($str) . "\r\n\r\n"; } /** * Create the aggregate stream that will be used to upload the POST data */ protected function createStream(array $elements) { $stream = new AppendStream(); foreach ($elements as $element) { $this->addElement($stream, $element); } // Add the trailing boundary with CRLF $stream->addStream(stream_for("--{$this->boundary}--\r\n")); return $stream; } private function addElement(AppendStream $stream, array $element) { foreach (['contents', 'name'] as $key) { if (!array_key_exists($key, $element)) { throw new \InvalidArgumentException("A '{$key}' key is required"); } } $element['contents'] = stream_for($element['contents']); if (empty($element['filename'])) { $uri = $element['contents']->getMetadata('uri'); if (substr($uri, 0, 6) !== 'php://') { $element['filename'] = $uri; } } list($body, $headers) = $this->createElement( $element['name'], $element['contents'], isset($element['filename']) ? $element['filename'] : null, isset($element['headers']) ? $element['headers'] : [] ); $stream->addStream(stream_for($this->getHeaders($headers))); $stream->addStream($body); $stream->addStream(stream_for("\r\n")); } /** * @return array */ private function createElement($name, $stream, $filename, array $headers) { // Set a default content-disposition header if one was no provided $disposition = $this->getHeader($headers, 'content-disposition'); if (!$disposition) { $headers['Content-Disposition'] = ($filename === '0' || $filename) ? sprintf('form-data; name="%s"; filename="%s"', $name, basename($filename)) : "form-data; name=\"{$name}\""; } // Set a default content-length header if one was no provided $length = $this->getHeader($headers, 'content-length'); if (!$length) { if ($length = $stream->getSize()) { $headers['Content-Length'] = (string) $length; } } // Set a default Content-Type if one was not supplied $type = $this->getHeader($headers, 'content-type'); if (!$type && ($filename === '0' || $filename)) { if ($type = mimetype_from_filename($filename)) { $headers['Content-Type'] = $type; } } return [$stream, $headers]; } private function getHeader(array $headers, $key) { $lowercaseHeader = strtolower($key); foreach ($headers as $k => $v) { if (strtolower($k) === $lowercaseHeader) { return $v; } } return null; } } src/NoSeekStream.php000064400000000650144760126270010416 0ustar00source = $source; $this->size = isset($options['size']) ? $options['size'] : null; $this->metadata = isset($options['metadata']) ? $options['metadata'] : []; $this->buffer = new BufferStream(); } public function __toString() { try { return copy_to_string($this); } catch (\Exception $e) { return ''; } } public function close() { $this->detach(); } public function detach() { $this->tellPos = false; $this->source = null; } public function getSize() { return $this->size; } public function tell() { return $this->tellPos; } public function eof() { return !$this->source; } public function isSeekable() { return false; } public function rewind() { $this->seek(0); } public function seek($offset, $whence = SEEK_SET) { throw new \RuntimeException('Cannot seek a PumpStream'); } public function isWritable() { return false; } public function write($string) { throw new \RuntimeException('Cannot write to a PumpStream'); } public function isReadable() { return true; } public function read($length) { $data = $this->buffer->read($length); $readLen = strlen($data); $this->tellPos += $readLen; $remaining = $length - $readLen; if ($remaining) { $this->pump($remaining); $data .= $this->buffer->read($remaining); $this->tellPos += strlen($data) - $readLen; } return $data; } public function getContents() { $result = ''; while (!$this->eof()) { $result .= $this->read(1000000); } return $result; } public function getMetadata($key = null) { if (!$key) { return $this->metadata; } return isset($this->metadata[$key]) ? $this->metadata[$key] : null; } private function pump($length) { if ($this->source) { do { $data = call_user_func($this->source, $length); if ($data === false || $data === null) { $this->source = null; return; } $this->buffer->write($data); $length -= strlen($data); } while ($length > 0); } } } src/Request.php000064400000006474144760126270007520 0ustar00method = strtoupper($method); $this->uri = $uri; $this->setHeaders($headers); $this->protocol = $version; if (!$this->hasHeader('Host')) { $this->updateHostFromUri(); } if ($body !== '' && $body !== null) { $this->stream = stream_for($body); } } public function getRequestTarget() { if ($this->requestTarget !== null) { return $this->requestTarget; } $target = $this->uri->getPath(); if ($target == '') { $target = '/'; } if ($this->uri->getQuery() != '') { $target .= '?' . $this->uri->getQuery(); } return $target; } public function withRequestTarget($requestTarget) { if (preg_match('#\s#', $requestTarget)) { throw new InvalidArgumentException( 'Invalid request target provided; cannot contain whitespace' ); } $new = clone $this; $new->requestTarget = $requestTarget; return $new; } public function getMethod() { return $this->method; } public function withMethod($method) { $new = clone $this; $new->method = strtoupper($method); return $new; } public function getUri() { return $this->uri; } public function withUri(UriInterface $uri, $preserveHost = false) { if ($uri === $this->uri) { return $this; } $new = clone $this; $new->uri = $uri; if (!$preserveHost) { $new->updateHostFromUri(); } return $new; } private function updateHostFromUri() { $host = $this->uri->getHost(); if ($host == '') { return; } if (($port = $this->uri->getPort()) !== null) { $host .= ':' . $port; } if (isset($this->headerNames['host'])) { $header = $this->headerNames['host']; } else { $header = 'Host'; $this->headerNames['host'] = 'Host'; } // Ensure Host is the first header. // See: http://tools.ietf.org/html/rfc7230#section-5.4 $this->headers = [$header => [$host]] + $this->headers; } } src/Response.php000064400000007656144760126270007671 0ustar00 'Continue', 101 => 'Switching Protocols', 102 => 'Processing', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 207 => 'Multi-status', 208 => 'Already Reported', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 306 => 'Switch Proxy', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Large', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 422 => 'Unprocessable Entity', 423 => 'Locked', 424 => 'Failed Dependency', 425 => 'Unordered Collection', 426 => 'Upgrade Required', 428 => 'Precondition Required', 429 => 'Too Many Requests', 431 => 'Request Header Fields Too Large', 451 => 'Unavailable For Legal Reasons', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported', 506 => 'Variant Also Negotiates', 507 => 'Insufficient Storage', 508 => 'Loop Detected', 511 => 'Network Authentication Required', ]; /** @var string */ private $reasonPhrase = ''; /** @var int */ private $statusCode = 200; /** * @param int $status Status code * @param array $headers Response headers * @param string|null|resource|StreamInterface $body Response body * @param string $version Protocol version * @param string|null $reason Reason phrase (when empty a default will be used based on the status code) */ public function __construct( $status = 200, array $headers = [], $body = null, $version = '1.1', $reason = null ) { $this->statusCode = (int) $status; if ($body !== '' && $body !== null) { $this->stream = stream_for($body); } $this->setHeaders($headers); if ($reason == '' && isset(self::$phrases[$this->statusCode])) { $this->reasonPhrase = self::$phrases[$status]; } else { $this->reasonPhrase = (string) $reason; } $this->protocol = $version; } public function getStatusCode() { return $this->statusCode; } public function getReasonPhrase() { return $this->reasonPhrase; } public function withStatus($code, $reasonPhrase = '') { $new = clone $this; $new->statusCode = (int) $code; if ($reasonPhrase == '' && isset(self::$phrases[$new->statusCode])) { $reasonPhrase = self::$phrases[$new->statusCode]; } $new->reasonPhrase = $reasonPhrase; return $new; } } src/ServerRequest.php000064400000021165144760126270010701 0ustar00serverParams = $serverParams; parent::__construct($method, $uri, $headers, $body, $version); } /** * Return an UploadedFile instance array. * * @param array $files A array which respect $_FILES structure * @throws InvalidArgumentException for unrecognized values * @return array */ public static function normalizeFiles(array $files) { $normalized = []; foreach ($files as $key => $value) { if ($value instanceof UploadedFileInterface) { $normalized[$key] = $value; } elseif (is_array($value) && isset($value['tmp_name'])) { $normalized[$key] = self::createUploadedFileFromSpec($value); } elseif (is_array($value)) { $normalized[$key] = self::normalizeFiles($value); continue; } else { throw new InvalidArgumentException('Invalid value in files specification'); } } return $normalized; } /** * Create and return an UploadedFile instance from a $_FILES specification. * * If the specification represents an array of values, this method will * delegate to normalizeNestedFileSpec() and return that return value. * * @param array $value $_FILES struct * @return array|UploadedFileInterface */ private static function createUploadedFileFromSpec(array $value) { if (is_array($value['tmp_name'])) { return self::normalizeNestedFileSpec($value); } return new UploadedFile( $value['tmp_name'], (int) $value['size'], (int) $value['error'], $value['name'], $value['type'] ); } /** * Normalize an array of file specifications. * * Loops through all nested files and returns a normalized array of * UploadedFileInterface instances. * * @param array $files * @return UploadedFileInterface[] */ private static function normalizeNestedFileSpec(array $files = []) { $normalizedFiles = []; foreach (array_keys($files['tmp_name']) as $key) { $spec = [ 'tmp_name' => $files['tmp_name'][$key], 'size' => $files['size'][$key], 'error' => $files['error'][$key], 'name' => $files['name'][$key], 'type' => $files['type'][$key], ]; $normalizedFiles[$key] = self::createUploadedFileFromSpec($spec); } return $normalizedFiles; } /** * Return a ServerRequest populated with superglobals: * $_GET * $_POST * $_COOKIE * $_FILES * $_SERVER * * @return ServerRequestInterface */ public static function fromGlobals() { $method = isset($_SERVER['REQUEST_METHOD']) ? $_SERVER['REQUEST_METHOD'] : 'GET'; $headers = function_exists('getallheaders') ? getallheaders() : []; $uri = self::getUriFromGlobals(); $body = new LazyOpenStream('php://input', 'r+'); $protocol = isset($_SERVER['SERVER_PROTOCOL']) ? str_replace('HTTP/', '', $_SERVER['SERVER_PROTOCOL']) : '1.1'; $serverRequest = new ServerRequest($method, $uri, $headers, $body, $protocol, $_SERVER); return $serverRequest ->withCookieParams($_COOKIE) ->withQueryParams($_GET) ->withParsedBody($_POST) ->withUploadedFiles(self::normalizeFiles($_FILES)); } /** * Get a Uri populated with values from $_SERVER. * * @return UriInterface */ public static function getUriFromGlobals() { $uri = new Uri(''); if (isset($_SERVER['HTTPS'])) { $uri = $uri->withScheme($_SERVER['HTTPS'] == 'on' ? 'https' : 'http'); } if (isset($_SERVER['HTTP_HOST'])) { $uri = $uri->withHost($_SERVER['HTTP_HOST']); } elseif (isset($_SERVER['SERVER_NAME'])) { $uri = $uri->withHost($_SERVER['SERVER_NAME']); } if (isset($_SERVER['SERVER_PORT'])) { $uri = $uri->withPort($_SERVER['SERVER_PORT']); } if (isset($_SERVER['REQUEST_URI'])) { $uri = $uri->withPath(current(explode('?', $_SERVER['REQUEST_URI']))); } if (isset($_SERVER['QUERY_STRING'])) { $uri = $uri->withQuery($_SERVER['QUERY_STRING']); } return $uri; } /** * {@inheritdoc} */ public function getServerParams() { return $this->serverParams; } /** * {@inheritdoc} */ public function getUploadedFiles() { return $this->uploadedFiles; } /** * {@inheritdoc} */ public function withUploadedFiles(array $uploadedFiles) { $new = clone $this; $new->uploadedFiles = $uploadedFiles; return $new; } /** * {@inheritdoc} */ public function getCookieParams() { return $this->cookieParams; } /** * {@inheritdoc} */ public function withCookieParams(array $cookies) { $new = clone $this; $new->cookieParams = $cookies; return $new; } /** * {@inheritdoc} */ public function getQueryParams() { return $this->queryParams; } /** * {@inheritdoc} */ public function withQueryParams(array $query) { $new = clone $this; $new->queryParams = $query; return $new; } /** * {@inheritdoc} */ public function getParsedBody() { return $this->parsedBody; } /** * {@inheritdoc} */ public function withParsedBody($data) { $new = clone $this; $new->parsedBody = $data; return $new; } /** * {@inheritdoc} */ public function getAttributes() { return $this->attributes; } /** * {@inheritdoc} */ public function getAttribute($attribute, $default = null) { if (false === array_key_exists($attribute, $this->attributes)) { return $default; } return $this->attributes[$attribute]; } /** * {@inheritdoc} */ public function withAttribute($attribute, $value) { $new = clone $this; $new->attributes[$attribute] = $value; return $new; } /** * {@inheritdoc} */ public function withoutAttribute($attribute) { if (false === array_key_exists($attribute, $this->attributes)) { return $this; } $new = clone $this; unset($new->attributes[$attribute]); return $new; } } src/Stream.php000064400000014433144760126270007315 0ustar00 [ 'r' => true, 'w+' => true, 'r+' => true, 'x+' => true, 'c+' => true, 'rb' => true, 'w+b' => true, 'r+b' => true, 'x+b' => true, 'c+b' => true, 'rt' => true, 'w+t' => true, 'r+t' => true, 'x+t' => true, 'c+t' => true, 'a+' => true ], 'write' => [ 'w' => true, 'w+' => true, 'rw' => true, 'r+' => true, 'x+' => true, 'c+' => true, 'wb' => true, 'w+b' => true, 'r+b' => true, 'x+b' => true, 'c+b' => true, 'w+t' => true, 'r+t' => true, 'x+t' => true, 'c+t' => true, 'a' => true, 'a+' => true ] ]; /** * This constructor accepts an associative array of options. * * - size: (int) If a read stream would otherwise have an indeterminate * size, but the size is known due to foreknowledge, then you can * provide that size, in bytes. * - metadata: (array) Any additional metadata to return when the metadata * of the stream is accessed. * * @param resource $stream Stream resource to wrap. * @param array $options Associative array of options. * * @throws \InvalidArgumentException if the stream is not a stream resource */ public function __construct($stream, $options = []) { if (!is_resource($stream)) { throw new \InvalidArgumentException('Stream must be a resource'); } if (isset($options['size'])) { $this->size = $options['size']; } $this->customMetadata = isset($options['metadata']) ? $options['metadata'] : []; $this->stream = $stream; $meta = stream_get_meta_data($this->stream); $this->seekable = $meta['seekable']; $this->readable = isset(self::$readWriteHash['read'][$meta['mode']]); $this->writable = isset(self::$readWriteHash['write'][$meta['mode']]); $this->uri = $this->getMetadata('uri'); } public function __get($name) { if ($name == 'stream') { throw new \RuntimeException('The stream is detached'); } throw new \BadMethodCallException('No value for ' . $name); } /** * Closes the stream when the destructed */ public function __destruct() { $this->close(); } public function __toString() { try { $this->seek(0); return (string) stream_get_contents($this->stream); } catch (\Exception $e) { return ''; } } public function getContents() { $contents = stream_get_contents($this->stream); if ($contents === false) { throw new \RuntimeException('Unable to read stream contents'); } return $contents; } public function close() { if (isset($this->stream)) { if (is_resource($this->stream)) { fclose($this->stream); } $this->detach(); } } public function detach() { if (!isset($this->stream)) { return null; } $result = $this->stream; unset($this->stream); $this->size = $this->uri = null; $this->readable = $this->writable = $this->seekable = false; return $result; } public function getSize() { if ($this->size !== null) { return $this->size; } if (!isset($this->stream)) { return null; } // Clear the stat cache if the stream has a URI if ($this->uri) { clearstatcache(true, $this->uri); } $stats = fstat($this->stream); if (isset($stats['size'])) { $this->size = $stats['size']; return $this->size; } return null; } public function isReadable() { return $this->readable; } public function isWritable() { return $this->writable; } public function isSeekable() { return $this->seekable; } public function eof() { return !$this->stream || feof($this->stream); } public function tell() { $result = ftell($this->stream); if ($result === false) { throw new \RuntimeException('Unable to determine stream position'); } return $result; } public function rewind() { $this->seek(0); } public function seek($offset, $whence = SEEK_SET) { if (!$this->seekable) { throw new \RuntimeException('Stream is not seekable'); } elseif (fseek($this->stream, $offset, $whence) === -1) { throw new \RuntimeException('Unable to seek to stream position ' . $offset . ' with whence ' . var_export($whence, true)); } } public function read($length) { if (!$this->readable) { throw new \RuntimeException('Cannot read from non-readable stream'); } return fread($this->stream, $length); } public function write($string) { if (!$this->writable) { throw new \RuntimeException('Cannot write to a non-writable stream'); } // We can't know the size after writing anything $this->size = null; $result = fwrite($this->stream, $string); if ($result === false) { throw new \RuntimeException('Unable to write to stream'); } return $result; } public function getMetadata($key = null) { if (!isset($this->stream)) { return $key ? null : []; } elseif (!$key) { return $this->customMetadata + stream_get_meta_data($this->stream); } elseif (isset($this->customMetadata[$key])) { return $this->customMetadata[$key]; } $meta = stream_get_meta_data($this->stream); return isset($meta[$key]) ? $meta[$key] : null; } } src/StreamDecoratorTrait.php000064400000006313144760126270012162 0ustar00stream = $stream; } /** * Magic method used to create a new stream if streams are not added in * the constructor of a decorator (e.g., LazyOpenStream). * * @param string $name Name of the property (allows "stream" only). * * @return StreamInterface */ public function __get($name) { if ($name == 'stream') { $this->stream = $this->createStream(); return $this->stream; } throw new \UnexpectedValueException("$name not found on class"); } public function __toString() { try { if ($this->isSeekable()) { $this->seek(0); } return $this->getContents(); } catch (\Exception $e) { // Really, PHP? https://bugs.php.net/bug.php?id=53648 trigger_error('StreamDecorator::__toString exception: ' . (string) $e, E_USER_ERROR); return ''; } } public function getContents() { return copy_to_string($this); } /** * Allow decorators to implement custom methods * * @param string $method Missing method name * @param array $args Method arguments * * @return mixed */ public function __call($method, array $args) { $result = call_user_func_array([$this->stream, $method], $args); // Always return the wrapped object if the result is a return $this return $result === $this->stream ? $this : $result; } public function close() { $this->stream->close(); } public function getMetadata($key = null) { return $this->stream->getMetadata($key); } public function detach() { return $this->stream->detach(); } public function getSize() { return $this->stream->getSize(); } public function eof() { return $this->stream->eof(); } public function tell() { return $this->stream->tell(); } public function isReadable() { return $this->stream->isReadable(); } public function isWritable() { return $this->stream->isWritable(); } public function isSeekable() { return $this->stream->isSeekable(); } public function rewind() { $this->seek(0); } public function seek($offset, $whence = SEEK_SET) { $this->stream->seek($offset, $whence); } public function read($length) { return $this->stream->read($length); } public function write($string) { return $this->stream->write($string); } /** * Implement in subclasses to dynamically create streams when requested. * * @return StreamInterface * @throws \BadMethodCallException */ protected function createStream() { throw new \BadMethodCallException('Not implemented'); } } src/StreamWrapper.php000064400000005366144760126270010663 0ustar00isReadable()) { $mode = $stream->isWritable() ? 'r+' : 'r'; } elseif ($stream->isWritable()) { $mode = 'w'; } else { throw new \InvalidArgumentException('The stream must be readable, ' . 'writable, or both.'); } return fopen('guzzle://stream', $mode, null, stream_context_create([ 'guzzle' => ['stream' => $stream] ])); } /** * Registers the stream wrapper if needed */ public static function register() { if (!in_array('guzzle', stream_get_wrappers())) { stream_wrapper_register('guzzle', __CLASS__); } } public function stream_open($path, $mode, $options, &$opened_path) { $options = stream_context_get_options($this->context); if (!isset($options['guzzle']['stream'])) { return false; } $this->mode = $mode; $this->stream = $options['guzzle']['stream']; return true; } public function stream_read($count) { return $this->stream->read($count); } public function stream_write($data) { return (int) $this->stream->write($data); } public function stream_tell() { return $this->stream->tell(); } public function stream_eof() { return $this->stream->eof(); } public function stream_seek($offset, $whence) { $this->stream->seek($offset, $whence); return true; } public function stream_stat() { static $modeMap = [ 'r' => 33060, 'r+' => 33206, 'w' => 33188 ]; return [ 'dev' => 0, 'ino' => 0, 'mode' => $modeMap[$this->mode], 'nlink' => 0, 'uid' => 0, 'gid' => 0, 'rdev' => 0, 'size' => $this->stream->getSize() ?: 0, 'atime' => 0, 'mtime' => 0, 'ctime' => 0, 'blksize' => 0, 'blocks' => 0 ]; } } src/UploadedFile.php000064400000016567144760126270010431 0ustar00setError($errorStatus); $this->setSize($size); $this->setClientFilename($clientFilename); $this->setClientMediaType($clientMediaType); if ($this->isOk()) { $this->setStreamOrFile($streamOrFile); } } /** * Depending on the value set file or stream variable * * @param mixed $streamOrFile * @throws InvalidArgumentException */ private function setStreamOrFile($streamOrFile) { if (is_string($streamOrFile)) { $this->file = $streamOrFile; } elseif (is_resource($streamOrFile)) { $this->stream = new Stream($streamOrFile); } elseif ($streamOrFile instanceof StreamInterface) { $this->stream = $streamOrFile; } else { throw new InvalidArgumentException( 'Invalid stream or file provided for UploadedFile' ); } } /** * @param int $error * @throws InvalidArgumentException */ private function setError($error) { if (false === is_int($error)) { throw new InvalidArgumentException( 'Upload file error status must be an integer' ); } if (false === in_array($error, UploadedFile::$errors)) { throw new InvalidArgumentException( 'Invalid error status for UploadedFile' ); } $this->error = $error; } /** * @param int $size * @throws InvalidArgumentException */ private function setSize($size) { if (false === is_int($size)) { throw new InvalidArgumentException( 'Upload file size must be an integer' ); } $this->size = $size; } /** * @param mixed $param * @return boolean */ private function isStringOrNull($param) { return in_array(gettype($param), ['string', 'NULL']); } /** * @param mixed $param * @return boolean */ private function isStringNotEmpty($param) { return is_string($param) && false === empty($param); } /** * @param string|null $clientFilename * @throws InvalidArgumentException */ private function setClientFilename($clientFilename) { if (false === $this->isStringOrNull($clientFilename)) { throw new InvalidArgumentException( 'Upload file client filename must be a string or null' ); } $this->clientFilename = $clientFilename; } /** * @param string|null $clientMediaType * @throws InvalidArgumentException */ private function setClientMediaType($clientMediaType) { if (false === $this->isStringOrNull($clientMediaType)) { throw new InvalidArgumentException( 'Upload file client media type must be a string or null' ); } $this->clientMediaType = $clientMediaType; } /** * Return true if there is no upload error * * @return boolean */ private function isOk() { return $this->error === UPLOAD_ERR_OK; } /** * @return boolean */ public function isMoved() { return $this->moved; } /** * @throws RuntimeException if is moved or not ok */ private function validateActive() { if (false === $this->isOk()) { throw new RuntimeException('Cannot retrieve stream due to upload error'); } if ($this->isMoved()) { throw new RuntimeException('Cannot retrieve stream after it has already been moved'); } } /** * {@inheritdoc} * @throws RuntimeException if the upload was not successful. */ public function getStream() { $this->validateActive(); if ($this->stream instanceof StreamInterface) { return $this->stream; } return new LazyOpenStream($this->file, 'r+'); } /** * {@inheritdoc} * * @see http://php.net/is_uploaded_file * @see http://php.net/move_uploaded_file * @param string $targetPath Path to which to move the uploaded file. * @throws RuntimeException if the upload was not successful. * @throws InvalidArgumentException if the $path specified is invalid. * @throws RuntimeException on any error during the move operation, or on * the second or subsequent call to the method. */ public function moveTo($targetPath) { $this->validateActive(); if (false === $this->isStringNotEmpty($targetPath)) { throw new InvalidArgumentException( 'Invalid path provided for move operation; must be a non-empty string' ); } if ($this->file) { $this->moved = php_sapi_name() == 'cli' ? rename($this->file, $targetPath) : move_uploaded_file($this->file, $targetPath); } else { copy_to_stream( $this->getStream(), new LazyOpenStream($targetPath, 'w') ); $this->moved = true; } if (false === $this->moved) { throw new RuntimeException( sprintf('Uploaded file could not be moved to %s', $targetPath) ); } } /** * {@inheritdoc} * * @return int|null The file size in bytes or null if unknown. */ public function getSize() { return $this->size; } /** * {@inheritdoc} * * @see http://php.net/manual/en/features.file-upload.errors.php * @return int One of PHP's UPLOAD_ERR_XXX constants. */ public function getError() { return $this->error; } /** * {@inheritdoc} * * @return string|null The filename sent by the client or null if none * was provided. */ public function getClientFilename() { return $this->clientFilename; } /** * {@inheritdoc} */ public function getClientMediaType() { return $this->clientMediaType; } } src/Uri.php000064400000036567144760126270006635 0ustar00 80, 'https' => 443, ]; private static $charUnreserved = 'a-zA-Z0-9_\-\.~'; private static $charSubDelims = '!\$&\'\(\)\*\+,;='; private static $replaceQuery = ['=' => '%3D', '&' => '%26']; /** @var string Uri scheme. */ private $scheme = ''; /** @var string Uri user info. */ private $userInfo = ''; /** @var string Uri host. */ private $host = ''; /** @var int|null Uri port. */ private $port; /** @var string Uri path. */ private $path = ''; /** @var string Uri query string. */ private $query = ''; /** @var string Uri fragment. */ private $fragment = ''; /** * @param string $uri URI to parse */ public function __construct($uri = '') { if ($uri != '') { $parts = parse_url($uri); if ($parts === false) { throw new \InvalidArgumentException("Unable to parse URI: $uri"); } $this->applyParts($parts); } } public function __toString() { return self::createUriString( $this->scheme, $this->getAuthority(), $this->path, $this->query, $this->fragment ); } /** * Removes dot segments from a path and returns the new path. * * @param string $path * * @return string * @link http://tools.ietf.org/html/rfc3986#section-5.2.4 */ public static function removeDotSegments($path) { static $noopPaths = ['' => true, '/' => true, '*' => true]; static $ignoreSegments = ['.' => true, '..' => true]; if (isset($noopPaths[$path])) { return $path; } $results = []; $segments = explode('/', $path); foreach ($segments as $segment) { if ($segment === '..') { array_pop($results); } elseif (!isset($ignoreSegments[$segment])) { $results[] = $segment; } } $newPath = implode('/', $results); // Add the leading slash if necessary if (substr($path, 0, 1) === '/' && substr($newPath, 0, 1) !== '/' ) { $newPath = '/' . $newPath; } // Add the trailing slash if necessary if ($newPath !== '/' && isset($ignoreSegments[end($segments)])) { $newPath .= '/'; } return $newPath; } /** * Resolve a base URI with a relative URI and return a new URI. * * @param UriInterface $base Base URI * @param string|UriInterface $rel Relative URI * * @return UriInterface * @link http://tools.ietf.org/html/rfc3986#section-5.2 */ public static function resolve(UriInterface $base, $rel) { if (!($rel instanceof UriInterface)) { $rel = new self($rel); } if ((string) $rel === '') { // we can simply return the same base URI instance for this same-document reference return $base; } if ($rel->getScheme() != '') { return $rel->withPath(self::removeDotSegments($rel->getPath())); } if ($rel->getAuthority() != '') { $targetAuthority = $rel->getAuthority(); $targetPath = self::removeDotSegments($rel->getPath()); $targetQuery = $rel->getQuery(); } else { $targetAuthority = $base->getAuthority(); if ($rel->getPath() === '') { $targetPath = $base->getPath(); $targetQuery = $rel->getQuery() != '' ? $rel->getQuery() : $base->getQuery(); } else { if ($rel->getPath()[0] === '/') { $targetPath = $rel->getPath(); } else { if ($targetAuthority != '' && $base->getPath() === '') { $targetPath = '/' . $rel->getPath(); } else { $lastSlashPos = strrpos($base->getPath(), '/'); if ($lastSlashPos === false) { $targetPath = $rel->getPath(); } else { $targetPath = substr($base->getPath(), 0, $lastSlashPos + 1) . $rel->getPath(); } } } $targetPath = self::removeDotSegments($targetPath); $targetQuery = $rel->getQuery(); } } return new self(self::createUriString( $base->getScheme(), $targetAuthority, $targetPath, $targetQuery, $rel->getFragment() )); } /** * Create a new URI with a specific query string value removed. * * Any existing query string values that exactly match the provided key are * removed. * * @param UriInterface $uri URI to use as a base. * @param string $key Query string key to remove. * * @return UriInterface */ public static function withoutQueryValue(UriInterface $uri, $key) { $current = $uri->getQuery(); if ($current == '') { return $uri; } $decodedKey = rawurldecode($key); $result = array_filter(explode('&', $current), function ($part) use ($decodedKey) { return rawurldecode(explode('=', $part)[0]) !== $decodedKey; }); return $uri->withQuery(implode('&', $result)); } /** * Create a new URI with a specific query string value. * * Any existing query string values that exactly match the provided key are * removed and replaced with the given key value pair. * * A value of null will set the query string key without a value, e.g. "key" * instead of "key=value". * * @param UriInterface $uri URI to use as a base. * @param string $key Key to set. * @param string|null $value Value to set * * @return UriInterface */ public static function withQueryValue(UriInterface $uri, $key, $value) { $current = $uri->getQuery(); if ($current == '') { $result = []; } else { $decodedKey = rawurldecode($key); $result = array_filter(explode('&', $current), function ($part) use ($decodedKey) { return rawurldecode(explode('=', $part)[0]) !== $decodedKey; }); } // Query string separators ("=", "&") within the key or value need to be encoded // (while preventing double-encoding) before setting the query string. All other // chars that need percent-encoding will be encoded by withQuery(). $key = strtr($key, self::$replaceQuery); if ($value !== null) { $result[] = $key . '=' . strtr($value, self::$replaceQuery); } else { $result[] = $key; } return $uri->withQuery(implode('&', $result)); } /** * Create a URI from a hash of parse_url parts. * * @param array $parts * * @return self */ public static function fromParts(array $parts) { $uri = new self(); $uri->applyParts($parts); return $uri; } public function getScheme() { return $this->scheme; } public function getAuthority() { if ($this->host == '') { return ''; } $authority = $this->host; if ($this->userInfo != '') { $authority = $this->userInfo . '@' . $authority; } if ($this->port !== null) { $authority .= ':' . $this->port; } return $authority; } public function getUserInfo() { return $this->userInfo; } public function getHost() { return $this->host; } public function getPort() { return $this->port; } public function getPath() { return $this->path; } public function getQuery() { return $this->query; } public function getFragment() { return $this->fragment; } public function withScheme($scheme) { $scheme = $this->filterScheme($scheme); if ($this->scheme === $scheme) { return $this; } $new = clone $this; $new->scheme = $scheme; $new->port = $new->filterPort($new->port); return $new; } public function withUserInfo($user, $password = null) { $info = $user; if ($password != '') { $info .= ':' . $password; } if ($this->userInfo === $info) { return $this; } $new = clone $this; $new->userInfo = $info; return $new; } public function withHost($host) { $host = $this->filterHost($host); if ($this->host === $host) { return $this; } $new = clone $this; $new->host = $host; return $new; } public function withPort($port) { $port = $this->filterPort($port); if ($this->port === $port) { return $this; } $new = clone $this; $new->port = $port; return $new; } public function withPath($path) { $path = $this->filterPath($path); if ($this->path === $path) { return $this; } $new = clone $this; $new->path = $path; return $new; } public function withQuery($query) { $query = $this->filterQueryAndFragment($query); if ($this->query === $query) { return $this; } $new = clone $this; $new->query = $query; return $new; } public function withFragment($fragment) { $fragment = $this->filterQueryAndFragment($fragment); if ($this->fragment === $fragment) { return $this; } $new = clone $this; $new->fragment = $fragment; return $new; } /** * Apply parse_url parts to a URI. * * @param array $parts Array of parse_url parts to apply. */ private function applyParts(array $parts) { $this->scheme = isset($parts['scheme']) ? $this->filterScheme($parts['scheme']) : ''; $this->userInfo = isset($parts['user']) ? $parts['user'] : ''; $this->host = isset($parts['host']) ? $this->filterHost($parts['host']) : ''; $this->port = isset($parts['port']) ? $this->filterPort($parts['port']) : null; $this->path = isset($parts['path']) ? $this->filterPath($parts['path']) : ''; $this->query = isset($parts['query']) ? $this->filterQueryAndFragment($parts['query']) : ''; $this->fragment = isset($parts['fragment']) ? $this->filterQueryAndFragment($parts['fragment']) : ''; if (isset($parts['pass'])) { $this->userInfo .= ':' . $parts['pass']; } } /** * Create a URI string from its various parts * * @param string $scheme * @param string $authority * @param string $path * @param string $query * @param string $fragment * @return string */ private static function createUriString($scheme, $authority, $path, $query, $fragment) { $uri = ''; if ($scheme != '') { $uri .= $scheme . ':'; } if ($authority != '') { $uri .= '//' . $authority; } if ($path != '') { if ($path[0] !== '/') { if ($authority != '') { // If the path is rootless and an authority is present, the path MUST be prefixed by "/" $path = '/' . $path; } } elseif (isset($path[1]) && $path[1] === '/') { if ($authority == '') { // If the path is starting with more than one "/" and no authority is present, the // starting slashes MUST be reduced to one. $path = '/' . ltrim($path, '/'); } } $uri .= $path; } if ($query != '') { $uri .= '?' . $query; } if ($fragment != '') { $uri .= '#' . $fragment; } return $uri; } /** * Is a given port non-standard for the current scheme? * * @param string $scheme * @param int $port * * @return bool */ private static function isNonStandardPort($scheme, $port) { return !isset(self::$schemes[$scheme]) || $port !== self::$schemes[$scheme]; } /** * @param string $scheme * * @return string * * @throws \InvalidArgumentException If the scheme is invalid. */ private function filterScheme($scheme) { if (!is_string($scheme)) { throw new \InvalidArgumentException('Scheme must be a string'); } return strtolower($scheme); } /** * @param string $host * * @return string * * @throws \InvalidArgumentException If the host is invalid. */ private function filterHost($host) { if (!is_string($host)) { throw new \InvalidArgumentException('Host must be a string'); } return strtolower($host); } /** * @param int|null $port * * @return int|null * * @throws \InvalidArgumentException If the port is invalid. */ private function filterPort($port) { if ($port === null) { return null; } $port = (int) $port; if (1 > $port || 0xffff < $port) { throw new \InvalidArgumentException( sprintf('Invalid port: %d. Must be between 1 and 65535', $port) ); } return self::isNonStandardPort($this->scheme, $port) ? $port : null; } /** * Filters the path of a URI * * @param string $path * * @return string * * @throws \InvalidArgumentException If the path is invalid. */ private function filterPath($path) { if (!is_string($path)) { throw new \InvalidArgumentException('Path must be a string'); } return preg_replace_callback( '/(?:[^' . self::$charUnreserved . self::$charSubDelims . '%:@\/]++|%(?![A-Fa-f0-9]{2}))/', [$this, 'rawurlencodeMatchZero'], $path ); } /** * Filters the query string or fragment of a URI. * * @param string $str * * @return string * * @throws \InvalidArgumentException If the query or fragment is invalid. */ private function filterQueryAndFragment($str) { if (!is_string($str)) { throw new \InvalidArgumentException('Query and fragment must be a string'); } return preg_replace_callback( '/(?:[^' . self::$charUnreserved . self::$charSubDelims . '%:@\/\?]++|%(?![A-Fa-f0-9]{2}))/', [$this, 'rawurlencodeMatchZero'], $str ); } private function rawurlencodeMatchZero(array $match) { return rawurlencode($match[0]); } } src/functions.php000064400000057164144760126270010102 0ustar00getMethod() . ' ' . $message->getRequestTarget()) . ' HTTP/' . $message->getProtocolVersion(); if (!$message->hasHeader('host')) { $msg .= "\r\nHost: " . $message->getUri()->getHost(); } } elseif ($message instanceof ResponseInterface) { $msg = 'HTTP/' . $message->getProtocolVersion() . ' ' . $message->getStatusCode() . ' ' . $message->getReasonPhrase(); } else { throw new \InvalidArgumentException('Unknown message type'); } foreach ($message->getHeaders() as $name => $values) { $msg .= "\r\n{$name}: " . implode(', ', $values); } return "{$msg}\r\n\r\n" . $message->getBody(); } /** * Returns a UriInterface for the given value. * * This function accepts a string or {@see Psr\Http\Message\UriInterface} and * returns a UriInterface for the given value. If the value is already a * `UriInterface`, it is returned as-is. * * @param string|UriInterface $uri * * @return UriInterface * @throws \InvalidArgumentException */ function uri_for($uri) { if ($uri instanceof UriInterface) { return $uri; } elseif (is_string($uri)) { return new Uri($uri); } throw new \InvalidArgumentException('URI must be a string or UriInterface'); } /** * Create a new stream based on the input type. * * Options is an associative array that can contain the following keys: * - metadata: Array of custom metadata. * - size: Size of the stream. * * @param resource|string|null|int|float|bool|StreamInterface|callable $resource Entity body data * @param array $options Additional options * * @return Stream * @throws \InvalidArgumentException if the $resource arg is not valid. */ function stream_for($resource = '', array $options = []) { if (is_scalar($resource)) { $stream = fopen('php://temp', 'r+'); if ($resource !== '') { fwrite($stream, $resource); fseek($stream, 0); } return new Stream($stream, $options); } switch (gettype($resource)) { case 'resource': return new Stream($resource, $options); case 'object': if ($resource instanceof StreamInterface) { return $resource; } elseif ($resource instanceof \Iterator) { return new PumpStream(function () use ($resource) { if (!$resource->valid()) { return false; } $result = $resource->current(); $resource->next(); return $result; }, $options); } elseif (method_exists($resource, '__toString')) { return stream_for((string) $resource, $options); } break; case 'NULL': return new Stream(fopen('php://temp', 'r+'), $options); } if (is_callable($resource)) { return new PumpStream($resource, $options); } throw new \InvalidArgumentException('Invalid resource type: ' . gettype($resource)); } /** * Parse an array of header values containing ";" separated data into an * array of associative arrays representing the header key value pair * data of the header. When a parameter does not contain a value, but just * contains a key, this function will inject a key with a '' string value. * * @param string|array $header Header to parse into components. * * @return array Returns the parsed header values. */ function parse_header($header) { static $trimmed = "\"' \n\t\r"; $params = $matches = []; foreach (normalize_header($header) as $val) { $part = []; foreach (preg_split('/;(?=([^"]*"[^"]*")*[^"]*$)/', $val) as $kvp) { if (preg_match_all('/<[^>]+>|[^=]+/', $kvp, $matches)) { $m = $matches[0]; if (isset($m[1])) { $part[trim($m[0], $trimmed)] = trim($m[1], $trimmed); } else { $part[] = trim($m[0], $trimmed); } } } if ($part) { $params[] = $part; } } return $params; } /** * Converts an array of header values that may contain comma separated * headers into an array of headers with no comma separated values. * * @param string|array $header Header to normalize. * * @return array Returns the normalized header field values. */ function normalize_header($header) { if (!is_array($header)) { return array_map('trim', explode(',', $header)); } $result = []; foreach ($header as $value) { foreach ((array) $value as $v) { if (strpos($v, ',') === false) { $result[] = $v; continue; } foreach (preg_split('/,(?=([^"]*"[^"]*")*[^"]*$)/', $v) as $vv) { $result[] = trim($vv); } } } return $result; } /** * Clone and modify a request with the given changes. * * The changes can be one of: * - method: (string) Changes the HTTP method. * - set_headers: (array) Sets the given headers. * - remove_headers: (array) Remove the given headers. * - body: (mixed) Sets the given body. * - uri: (UriInterface) Set the URI. * - query: (string) Set the query string value of the URI. * - version: (string) Set the protocol version. * * @param RequestInterface $request Request to clone and modify. * @param array $changes Changes to apply. * * @return RequestInterface */ function modify_request(RequestInterface $request, array $changes) { if (!$changes) { return $request; } $headers = $request->getHeaders(); if (!isset($changes['uri'])) { $uri = $request->getUri(); } else { // Remove the host header if one is on the URI if ($host = $changes['uri']->getHost()) { $changes['set_headers']['Host'] = $host; if ($port = $changes['uri']->getPort()) { $standardPorts = ['http' => 80, 'https' => 443]; $scheme = $changes['uri']->getScheme(); if (isset($standardPorts[$scheme]) && $port != $standardPorts[$scheme]) { $changes['set_headers']['Host'] .= ':'.$port; } } } $uri = $changes['uri']; } if (!empty($changes['remove_headers'])) { $headers = _caseless_remove($changes['remove_headers'], $headers); } if (!empty($changes['set_headers'])) { $headers = _caseless_remove(array_keys($changes['set_headers']), $headers); $headers = $changes['set_headers'] + $headers; } if (isset($changes['query'])) { $uri = $uri->withQuery($changes['query']); } if ($request instanceof ServerRequestInterface) { return new ServerRequest( isset($changes['method']) ? $changes['method'] : $request->getMethod(), $uri, $headers, isset($changes['body']) ? $changes['body'] : $request->getBody(), isset($changes['version']) ? $changes['version'] : $request->getProtocolVersion(), $request->getServerParams() ); } return new Request( isset($changes['method']) ? $changes['method'] : $request->getMethod(), $uri, $headers, isset($changes['body']) ? $changes['body'] : $request->getBody(), isset($changes['version']) ? $changes['version'] : $request->getProtocolVersion() ); } /** * Attempts to rewind a message body and throws an exception on failure. * * The body of the message will only be rewound if a call to `tell()` returns a * value other than `0`. * * @param MessageInterface $message Message to rewind * * @throws \RuntimeException */ function rewind_body(MessageInterface $message) { $body = $message->getBody(); if ($body->tell()) { $body->rewind(); } } /** * Safely opens a PHP stream resource using a filename. * * When fopen fails, PHP normally raises a warning. This function adds an * error handler that checks for errors and throws an exception instead. * * @param string $filename File to open * @param string $mode Mode used to open the file * * @return resource * @throws \RuntimeException if the file cannot be opened */ function try_fopen($filename, $mode) { $ex = null; set_error_handler(function () use ($filename, $mode, &$ex) { $ex = new \RuntimeException(sprintf( 'Unable to open %s using mode %s: %s', $filename, $mode, func_get_args()[1] )); }); $handle = fopen($filename, $mode); restore_error_handler(); if ($ex) { /** @var $ex \RuntimeException */ throw $ex; } return $handle; } /** * Copy the contents of a stream into a string until the given number of * bytes have been read. * * @param StreamInterface $stream Stream to read * @param int $maxLen Maximum number of bytes to read. Pass -1 * to read the entire stream. * @return string * @throws \RuntimeException on error. */ function copy_to_string(StreamInterface $stream, $maxLen = -1) { $buffer = ''; if ($maxLen === -1) { while (!$stream->eof()) { $buf = $stream->read(1048576); // Using a loose equality here to match on '' and false. if ($buf == null) { break; } $buffer .= $buf; } return $buffer; } $len = 0; while (!$stream->eof() && $len < $maxLen) { $buf = $stream->read($maxLen - $len); // Using a loose equality here to match on '' and false. if ($buf == null) { break; } $buffer .= $buf; $len = strlen($buffer); } return $buffer; } /** * Copy the contents of a stream into another stream until the given number * of bytes have been read. * * @param StreamInterface $source Stream to read from * @param StreamInterface $dest Stream to write to * @param int $maxLen Maximum number of bytes to read. Pass -1 * to read the entire stream. * * @throws \RuntimeException on error. */ function copy_to_stream( StreamInterface $source, StreamInterface $dest, $maxLen = -1 ) { if ($maxLen === -1) { while (!$source->eof()) { if (!$dest->write($source->read(1048576))) { break; } } return; } $bytes = 0; while (!$source->eof()) { $buf = $source->read($maxLen - $bytes); if (!($len = strlen($buf))) { break; } $bytes += $len; $dest->write($buf); if ($bytes == $maxLen) { break; } } } /** * Calculate a hash of a Stream * * @param StreamInterface $stream Stream to calculate the hash for * @param string $algo Hash algorithm (e.g. md5, crc32, etc) * @param bool $rawOutput Whether or not to use raw output * * @return string Returns the hash of the stream * @throws \RuntimeException on error. */ function hash( StreamInterface $stream, $algo, $rawOutput = false ) { $pos = $stream->tell(); if ($pos > 0) { $stream->rewind(); } $ctx = hash_init($algo); while (!$stream->eof()) { hash_update($ctx, $stream->read(1048576)); } $out = hash_final($ctx, (bool) $rawOutput); $stream->seek($pos); return $out; } /** * Read a line from the stream up to the maximum allowed buffer length * * @param StreamInterface $stream Stream to read from * @param int $maxLength Maximum buffer length * * @return string|bool */ function readline(StreamInterface $stream, $maxLength = null) { $buffer = ''; $size = 0; while (!$stream->eof()) { // Using a loose equality here to match on '' and false. if (null == ($byte = $stream->read(1))) { return $buffer; } $buffer .= $byte; // Break when a new line is found or the max length - 1 is reached if ($byte === "\n" || ++$size === $maxLength - 1) { break; } } return $buffer; } /** * Parses a request message string into a request object. * * @param string $message Request message string. * * @return Request */ function parse_request($message) { $data = _parse_message($message); $matches = []; if (!preg_match('/^[\S]+\s+([a-zA-Z]+:\/\/|\/).*/', $data['start-line'], $matches)) { throw new \InvalidArgumentException('Invalid request string'); } $parts = explode(' ', $data['start-line'], 3); $version = isset($parts[2]) ? explode('/', $parts[2])[1] : '1.1'; $request = new Request( $parts[0], $matches[1] === '/' ? _parse_request_uri($parts[1], $data['headers']) : $parts[1], $data['headers'], $data['body'], $version ); return $matches[1] === '/' ? $request : $request->withRequestTarget($parts[1]); } /** * Parses a response message string into a response object. * * @param string $message Response message string. * * @return Response */ function parse_response($message) { $data = _parse_message($message); if (!preg_match('/^HTTP\/.* [0-9]{3} .*/', $data['start-line'])) { throw new \InvalidArgumentException('Invalid response string'); } $parts = explode(' ', $data['start-line'], 3); return new Response( $parts[1], $data['headers'], $data['body'], explode('/', $parts[0])[1], isset($parts[2]) ? $parts[2] : null ); } /** * Parse a query string into an associative array. * * If multiple values are found for the same key, the value of that key * value pair will become an array. This function does not parse nested * PHP style arrays into an associative array (e.g., foo[a]=1&foo[b]=2 will * be parsed into ['foo[a]' => '1', 'foo[b]' => '2']). * * @param string $str Query string to parse * @param bool|string $urlEncoding How the query string is encoded * * @return array */ function parse_query($str, $urlEncoding = true) { $result = []; if ($str === '') { return $result; } if ($urlEncoding === true) { $decoder = function ($value) { return rawurldecode(str_replace('+', ' ', $value)); }; } elseif ($urlEncoding == PHP_QUERY_RFC3986) { $decoder = 'rawurldecode'; } elseif ($urlEncoding == PHP_QUERY_RFC1738) { $decoder = 'urldecode'; } else { $decoder = function ($str) { return $str; }; } foreach (explode('&', $str) as $kvp) { $parts = explode('=', $kvp, 2); $key = $decoder($parts[0]); $value = isset($parts[1]) ? $decoder($parts[1]) : null; if (!isset($result[$key])) { $result[$key] = $value; } else { if (!is_array($result[$key])) { $result[$key] = [$result[$key]]; } $result[$key][] = $value; } } return $result; } /** * Build a query string from an array of key value pairs. * * This function can use the return value of parse_query() to build a query * string. This function does not modify the provided keys when an array is * encountered (like http_build_query would). * * @param array $params Query string parameters. * @param int|false $encoding Set to false to not encode, PHP_QUERY_RFC3986 * to encode using RFC3986, or PHP_QUERY_RFC1738 * to encode using RFC1738. * @return string */ function build_query(array $params, $encoding = PHP_QUERY_RFC3986) { if (!$params) { return ''; } if ($encoding === false) { $encoder = function ($str) { return $str; }; } elseif ($encoding === PHP_QUERY_RFC3986) { $encoder = 'rawurlencode'; } elseif ($encoding === PHP_QUERY_RFC1738) { $encoder = 'urlencode'; } else { throw new \InvalidArgumentException('Invalid type'); } $qs = ''; foreach ($params as $k => $v) { $k = $encoder($k); if (!is_array($v)) { $qs .= $k; if ($v !== null) { $qs .= '=' . $encoder($v); } $qs .= '&'; } else { foreach ($v as $vv) { $qs .= $k; if ($vv !== null) { $qs .= '=' . $encoder($vv); } $qs .= '&'; } } } return $qs ? (string) substr($qs, 0, -1) : ''; } /** * Determines the mimetype of a file by looking at its extension. * * @param $filename * * @return null|string */ function mimetype_from_filename($filename) { return mimetype_from_extension(pathinfo($filename, PATHINFO_EXTENSION)); } /** * Maps a file extensions to a mimetype. * * @param $extension string The file extension. * * @return string|null * @link http://svn.apache.org/repos/asf/httpd/httpd/branches/1.3.x/conf/mime.types */ function mimetype_from_extension($extension) { static $mimetypes = [ '7z' => 'application/x-7z-compressed', 'aac' => 'audio/x-aac', 'ai' => 'application/postscript', 'aif' => 'audio/x-aiff', 'asc' => 'text/plain', 'asf' => 'video/x-ms-asf', 'atom' => 'application/atom+xml', 'avi' => 'video/x-msvideo', 'bmp' => 'image/bmp', 'bz2' => 'application/x-bzip2', 'cer' => 'application/pkix-cert', 'crl' => 'application/pkix-crl', 'crt' => 'application/x-x509-ca-cert', 'css' => 'text/css', 'csv' => 'text/csv', 'cu' => 'application/cu-seeme', 'deb' => 'application/x-debian-package', 'doc' => 'application/msword', 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'dvi' => 'application/x-dvi', 'eot' => 'application/vnd.ms-fontobject', 'eps' => 'application/postscript', 'epub' => 'application/epub+zip', 'etx' => 'text/x-setext', 'flac' => 'audio/flac', 'flv' => 'video/x-flv', 'gif' => 'image/gif', 'gz' => 'application/gzip', 'htm' => 'text/html', 'html' => 'text/html', 'ico' => 'image/x-icon', 'ics' => 'text/calendar', 'ini' => 'text/plain', 'iso' => 'application/x-iso9660-image', 'jar' => 'application/java-archive', 'jpe' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'jpg' => 'image/jpeg', 'js' => 'text/javascript', 'json' => 'application/json', 'latex' => 'application/x-latex', 'log' => 'text/plain', 'm4a' => 'audio/mp4', 'm4v' => 'video/mp4', 'mid' => 'audio/midi', 'midi' => 'audio/midi', 'mov' => 'video/quicktime', 'mp3' => 'audio/mpeg', 'mp4' => 'video/mp4', 'mp4a' => 'audio/mp4', 'mp4v' => 'video/mp4', 'mpe' => 'video/mpeg', 'mpeg' => 'video/mpeg', 'mpg' => 'video/mpeg', 'mpg4' => 'video/mp4', 'oga' => 'audio/ogg', 'ogg' => 'audio/ogg', 'ogv' => 'video/ogg', 'ogx' => 'application/ogg', 'pbm' => 'image/x-portable-bitmap', 'pdf' => 'application/pdf', 'pgm' => 'image/x-portable-graymap', 'png' => 'image/png', 'pnm' => 'image/x-portable-anymap', 'ppm' => 'image/x-portable-pixmap', 'ppt' => 'application/vnd.ms-powerpoint', 'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'ps' => 'application/postscript', 'qt' => 'video/quicktime', 'rar' => 'application/x-rar-compressed', 'ras' => 'image/x-cmu-raster', 'rss' => 'application/rss+xml', 'rtf' => 'application/rtf', 'sgm' => 'text/sgml', 'sgml' => 'text/sgml', 'svg' => 'image/svg+xml', 'swf' => 'application/x-shockwave-flash', 'tar' => 'application/x-tar', 'tif' => 'image/tiff', 'tiff' => 'image/tiff', 'torrent' => 'application/x-bittorrent', 'ttf' => 'application/x-font-ttf', 'txt' => 'text/plain', 'wav' => 'audio/x-wav', 'webm' => 'video/webm', 'wma' => 'audio/x-ms-wma', 'wmv' => 'video/x-ms-wmv', 'woff' => 'application/x-font-woff', 'wsdl' => 'application/wsdl+xml', 'xbm' => 'image/x-xbitmap', 'xls' => 'application/vnd.ms-excel', 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'xml' => 'application/xml', 'xpm' => 'image/x-xpixmap', 'xwd' => 'image/x-xwindowdump', 'yaml' => 'text/yaml', 'yml' => 'text/yaml', 'zip' => 'application/zip', ]; $extension = strtolower($extension); return isset($mimetypes[$extension]) ? $mimetypes[$extension] : null; } /** * Parses an HTTP message into an associative array. * * The array contains the "start-line" key containing the start line of * the message, "headers" key containing an associative array of header * array values, and a "body" key containing the body of the message. * * @param string $message HTTP request or response to parse. * * @return array * @internal */ function _parse_message($message) { if (!$message) { throw new \InvalidArgumentException('Invalid message'); } // Iterate over each line in the message, accounting for line endings $lines = preg_split('/(\\r?\\n)/', $message, -1, PREG_SPLIT_DELIM_CAPTURE); $result = ['start-line' => array_shift($lines), 'headers' => [], 'body' => '']; array_shift($lines); for ($i = 0, $totalLines = count($lines); $i < $totalLines; $i += 2) { $line = $lines[$i]; // If two line breaks were encountered, then this is the end of body if (empty($line)) { if ($i < $totalLines - 1) { $result['body'] = implode('', array_slice($lines, $i + 2)); } break; } if (strpos($line, ':')) { $parts = explode(':', $line, 2); $key = trim($parts[0]); $value = isset($parts[1]) ? trim($parts[1]) : ''; $result['headers'][$key][] = $value; } } return $result; } /** * Constructs a URI for an HTTP request message. * * @param string $path Path from the start-line * @param array $headers Array of headers (each value an array). * * @return string * @internal */ function _parse_request_uri($path, array $headers) { $hostKey = array_filter(array_keys($headers), function ($k) { return strtolower($k) === 'host'; }); // If no host is found, then a full URI cannot be constructed. if (!$hostKey) { return $path; } $host = $headers[reset($hostKey)][0]; $scheme = substr($host, -4) === ':443' ? 'https' : 'http'; return $scheme . '://' . $host . '/' . ltrim($path, '/'); } /** @internal */ function _caseless_remove($keys, array $data) { $result = []; foreach ($keys as &$key) { $key = strtolower($key); } foreach ($data as $k => $v) { if (!in_array(strtolower($k), $keys)) { $result[$k] = $v; } } return $result; } src/functions_include.php000064400000000234144760126270011567 0ustar00getMockBuilder('Psr\Http\Message\StreamInterface') ->setMethods(['isReadable']) ->getMockForAbstractClass(); $s->expects($this->once()) ->method('isReadable') ->will($this->returnValue(false)); $a->addStream($s); } /** * @expectedException \RuntimeException * @expectedExceptionMessage The AppendStream can only seek with SEEK_SET */ public function testValidatesSeekType() { $a = new AppendStream(); $a->seek(100, SEEK_CUR); } /** * @expectedException \RuntimeException * @expectedExceptionMessage Unable to seek stream 0 of the AppendStream */ public function testTriesToRewindOnSeek() { $a = new AppendStream(); $s = $this->getMockBuilder('Psr\Http\Message\StreamInterface') ->setMethods(['isReadable', 'rewind', 'isSeekable']) ->getMockForAbstractClass(); $s->expects($this->once()) ->method('isReadable') ->will($this->returnValue(true)); $s->expects($this->once()) ->method('isSeekable') ->will($this->returnValue(true)); $s->expects($this->once()) ->method('rewind') ->will($this->throwException(new \RuntimeException())); $a->addStream($s); $a->seek(10); } public function testSeeksToPositionByReading() { $a = new AppendStream([ Psr7\stream_for('foo'), Psr7\stream_for('bar'), Psr7\stream_for('baz'), ]); $a->seek(3); $this->assertEquals(3, $a->tell()); $this->assertEquals('bar', $a->read(3)); $a->seek(6); $this->assertEquals(6, $a->tell()); $this->assertEquals('baz', $a->read(3)); } public function testDetachesEachStream() { $s1 = Psr7\stream_for('foo'); $s2 = Psr7\stream_for('bar'); $a = new AppendStream([$s1, $s2]); $this->assertSame('foobar', (string) $a); $a->detach(); $this->assertSame('', (string) $a); $this->assertSame(0, $a->getSize()); } public function testClosesEachStream() { $s1 = Psr7\stream_for('foo'); $a = new AppendStream([$s1]); $a->close(); $this->assertSame('', (string) $a); } /** * @expectedExceptionMessage Cannot write to an AppendStream * @expectedException \RuntimeException */ public function testIsNotWritable() { $a = new AppendStream([Psr7\stream_for('foo')]); $this->assertFalse($a->isWritable()); $this->assertTrue($a->isSeekable()); $this->assertTrue($a->isReadable()); $a->write('foo'); } public function testDoesNotNeedStreams() { $a = new AppendStream(); $this->assertEquals('', (string) $a); } public function testCanReadFromMultipleStreams() { $a = new AppendStream([ Psr7\stream_for('foo'), Psr7\stream_for('bar'), Psr7\stream_for('baz'), ]); $this->assertFalse($a->eof()); $this->assertSame(0, $a->tell()); $this->assertEquals('foo', $a->read(3)); $this->assertEquals('bar', $a->read(3)); $this->assertEquals('baz', $a->read(3)); $this->assertSame('', $a->read(1)); $this->assertTrue($a->eof()); $this->assertSame(9, $a->tell()); $this->assertEquals('foobarbaz', (string) $a); } public function testCanDetermineSizeFromMultipleStreams() { $a = new AppendStream([ Psr7\stream_for('foo'), Psr7\stream_for('bar') ]); $this->assertEquals(6, $a->getSize()); $s = $this->getMockBuilder('Psr\Http\Message\StreamInterface') ->setMethods(['isSeekable', 'isReadable']) ->getMockForAbstractClass(); $s->expects($this->once()) ->method('isSeekable') ->will($this->returnValue(null)); $s->expects($this->once()) ->method('isReadable') ->will($this->returnValue(true)); $a->addStream($s); $this->assertNull($a->getSize()); } public function testCatchesExceptionsWhenCastingToString() { $s = $this->getMockBuilder('Psr\Http\Message\StreamInterface') ->setMethods(['isSeekable', 'read', 'isReadable', 'eof']) ->getMockForAbstractClass(); $s->expects($this->once()) ->method('isSeekable') ->will($this->returnValue(true)); $s->expects($this->once()) ->method('read') ->will($this->throwException(new \RuntimeException('foo'))); $s->expects($this->once()) ->method('isReadable') ->will($this->returnValue(true)); $s->expects($this->any()) ->method('eof') ->will($this->returnValue(false)); $a = new AppendStream([$s]); $this->assertFalse($a->eof()); $this->assertSame('', (string) $a); } public function testCanDetach() { $s = new AppendStream(); $s->detach(); } public function testReturnsEmptyMetadata() { $s = new AppendStream(); $this->assertEquals([], $s->getMetadata()); $this->assertNull($s->getMetadata('foo')); } } tests/BufferStreamTest.php000064400000003624144760126270011662 0ustar00assertTrue($b->isReadable()); $this->assertTrue($b->isWritable()); $this->assertFalse($b->isSeekable()); $this->assertEquals(null, $b->getMetadata('foo')); $this->assertEquals(10, $b->getMetadata('hwm')); $this->assertEquals([], $b->getMetadata()); } public function testRemovesReadDataFromBuffer() { $b = new BufferStream(); $this->assertEquals(3, $b->write('foo')); $this->assertEquals(3, $b->getSize()); $this->assertFalse($b->eof()); $this->assertEquals('foo', $b->read(10)); $this->assertTrue($b->eof()); $this->assertEquals('', $b->read(10)); } /** * @expectedException \RuntimeException * @expectedExceptionMessage Cannot determine the position of a BufferStream */ public function testCanCastToStringOrGetContents() { $b = new BufferStream(); $b->write('foo'); $b->write('baz'); $this->assertEquals('foo', $b->read(3)); $b->write('bar'); $this->assertEquals('bazbar', (string) $b); $b->tell(); } public function testDetachClearsBuffer() { $b = new BufferStream(); $b->write('foo'); $b->detach(); $this->assertTrue($b->eof()); $this->assertEquals(3, $b->write('abc')); $this->assertEquals('abc', $b->read(10)); } public function testExceedingHighwaterMarkReturnsFalseButStillBuffers() { $b = new BufferStream(5); $this->assertEquals(3, $b->write('hi ')); $this->assertFalse($b->write('hello')); $this->assertEquals('hi hello', (string) $b); $this->assertEquals(4, $b->write('test')); } } tests/CachingStreamTest.php000064400000014607144760126270012010 0ustar00decorated = Psr7\stream_for('testing'); $this->body = new CachingStream($this->decorated); } public function tearDown() { $this->decorated->close(); $this->body->close(); } public function testUsesRemoteSizeIfPossible() { $body = Psr7\stream_for('test'); $caching = new CachingStream($body); $this->assertEquals(4, $caching->getSize()); } public function testReadsUntilCachedToByte() { $this->body->seek(5); $this->assertEquals('n', $this->body->read(1)); $this->body->seek(0); $this->assertEquals('t', $this->body->read(1)); } public function testCanSeekNearEndWithSeekEnd() { $baseStream = Psr7\stream_for(implode('', range('a', 'z'))); $cached = new CachingStream($baseStream); $cached->seek(-1, SEEK_END); $this->assertEquals(25, $baseStream->tell()); $this->assertEquals('z', $cached->read(1)); $this->assertEquals(26, $cached->getSize()); } public function testCanSeekToEndWithSeekEnd() { $baseStream = Psr7\stream_for(implode('', range('a', 'z'))); $cached = new CachingStream($baseStream); $cached->seek(0, SEEK_END); $this->assertEquals(26, $baseStream->tell()); $this->assertEquals('', $cached->read(1)); $this->assertEquals(26, $cached->getSize()); } public function testCanUseSeekEndWithUnknownSize() { $baseStream = Psr7\stream_for('testing'); $decorated = Psr7\FnStream::decorate($baseStream, [ 'getSize' => function () { return null; } ]); $cached = new CachingStream($decorated); $cached->seek(-1, SEEK_END); $this->assertEquals('g', $cached->read(1)); } public function testRewindUsesSeek() { $a = Psr7\stream_for('foo'); $d = $this->getMockBuilder('GuzzleHttp\Psr7\CachingStream') ->setMethods(array('seek')) ->setConstructorArgs(array($a)) ->getMock(); $d->expects($this->once()) ->method('seek') ->with(0) ->will($this->returnValue(true)); $d->seek(0); } public function testCanSeekToReadBytes() { $this->assertEquals('te', $this->body->read(2)); $this->body->seek(0); $this->assertEquals('test', $this->body->read(4)); $this->assertEquals(4, $this->body->tell()); $this->body->seek(2); $this->assertEquals(2, $this->body->tell()); $this->body->seek(2, SEEK_CUR); $this->assertEquals(4, $this->body->tell()); $this->assertEquals('ing', $this->body->read(3)); } public function testCanSeekToReadBytesWithPartialBodyReturned() { $stream = fopen('php://temp', 'r+'); fwrite($stream, 'testing'); fseek($stream, 0); $this->decorated = $this->getMockBuilder('\GuzzleHttp\Psr7\Stream') ->setConstructorArgs([$stream]) ->setMethods(['read']) ->getMock(); $this->decorated->expects($this->exactly(2)) ->method('read') ->willReturnCallback(function($length) use ($stream){ return fread($stream, 2); }); $this->body = new CachingStream($this->decorated); $this->assertEquals(0, $this->body->tell()); $this->body->seek(4, SEEK_SET); $this->assertEquals(4, $this->body->tell()); $this->body->seek(0); $this->assertEquals('test', $this->body->read(4)); } public function testWritesToBufferStream() { $this->body->read(2); $this->body->write('hi'); $this->body->seek(0); $this->assertEquals('tehiing', (string) $this->body); } public function testSkipsOverwrittenBytes() { $decorated = Psr7\stream_for( implode("\n", array_map(function ($n) { return str_pad($n, 4, '0', STR_PAD_LEFT); }, range(0, 25))) ); $body = new CachingStream($decorated); $this->assertEquals("0000\n", Psr7\readline($body)); $this->assertEquals("0001\n", Psr7\readline($body)); // Write over part of the body yet to be read, so skip some bytes $this->assertEquals(5, $body->write("TEST\n")); $this->assertEquals(5, $this->readAttribute($body, 'skipReadBytes')); // Read, which skips bytes, then reads $this->assertEquals("0003\n", Psr7\readline($body)); $this->assertEquals(0, $this->readAttribute($body, 'skipReadBytes')); $this->assertEquals("0004\n", Psr7\readline($body)); $this->assertEquals("0005\n", Psr7\readline($body)); // Overwrite part of the cached body (so don't skip any bytes) $body->seek(5); $this->assertEquals(5, $body->write("ABCD\n")); $this->assertEquals(0, $this->readAttribute($body, 'skipReadBytes')); $this->assertEquals("TEST\n", Psr7\readline($body)); $this->assertEquals("0003\n", Psr7\readline($body)); $this->assertEquals("0004\n", Psr7\readline($body)); $this->assertEquals("0005\n", Psr7\readline($body)); $this->assertEquals("0006\n", Psr7\readline($body)); $this->assertEquals(5, $body->write("1234\n")); $this->assertEquals(5, $this->readAttribute($body, 'skipReadBytes')); // Seek to 0 and ensure the overwritten bit is replaced $body->seek(0); $this->assertEquals("0000\nABCD\nTEST\n0003\n0004\n0005\n0006\n1234\n0008\n0009\n", $body->read(50)); // Ensure that casting it to a string does not include the bit that was overwritten $this->assertContains("0000\nABCD\nTEST\n0003\n0004\n0005\n0006\n1234\n0008\n0009\n", (string) $body); } public function testClosesBothStreams() { $s = fopen('php://temp', 'r'); $a = Psr7\stream_for($s); $d = new CachingStream($a); $d->close(); $this->assertFalse(is_resource($s)); } /** * @expectedException \InvalidArgumentException */ public function testEnsuresValidWhence() { $this->body->seek(10, -123456); } } tests/DroppingStreamTest.php000064400000001624144760126270012231 0ustar00assertEquals(3, $drop->write('hel')); $this->assertEquals(2, $drop->write('lo')); $this->assertEquals(5, $drop->getSize()); $this->assertEquals('hello', $drop->read(5)); $this->assertEquals(0, $drop->getSize()); $drop->write('12345678910'); $this->assertEquals(5, $stream->getSize()); $this->assertEquals(5, $drop->getSize()); $this->assertEquals('12345', (string) $drop); $this->assertEquals(0, $drop->getSize()); $drop->write('hello'); $this->assertSame(0, $drop->write('test')); } } tests/FnStreamTest.php000064400000004732144760126270011015 0ustar00seek(1); } public function testProxiesToFunction() { $s = new FnStream([ 'read' => function ($len) { $this->assertEquals(3, $len); return 'foo'; } ]); $this->assertEquals('foo', $s->read(3)); } public function testCanCloseOnDestruct() { $called = false; $s = new FnStream([ 'close' => function () use (&$called) { $called = true; } ]); unset($s); $this->assertTrue($called); } public function testDoesNotRequireClose() { $s = new FnStream([]); unset($s); } public function testDecoratesStream() { $a = Psr7\stream_for('foo'); $b = FnStream::decorate($a, []); $this->assertEquals(3, $b->getSize()); $this->assertEquals($b->isWritable(), true); $this->assertEquals($b->isReadable(), true); $this->assertEquals($b->isSeekable(), true); $this->assertEquals($b->read(3), 'foo'); $this->assertEquals($b->tell(), 3); $this->assertEquals($a->tell(), 3); $this->assertSame('', $a->read(1)); $this->assertEquals($b->eof(), true); $this->assertEquals($a->eof(), true); $b->seek(0); $this->assertEquals('foo', (string) $b); $b->seek(0); $this->assertEquals('foo', $b->getContents()); $this->assertEquals($a->getMetadata(), $b->getMetadata()); $b->seek(0, SEEK_END); $b->write('bar'); $this->assertEquals('foobar', (string) $b); $this->assertInternalType('resource', $b->detach()); $b->close(); } public function testDecoratesWithCustomizations() { $called = false; $a = Psr7\stream_for('foo'); $b = FnStream::decorate($a, [ 'read' => function ($len) use (&$called, $a) { $called = true; return $a->read($len); } ]); $this->assertEquals('foo', $b->read(3)); $this->assertTrue($called); } } tests/FunctionsTest.php000064400000052106144760126270011244 0ustar00assertEquals('foobaz', Psr7\copy_to_string($s)); $s->seek(0); $this->assertEquals('foo', Psr7\copy_to_string($s, 3)); $this->assertEquals('baz', Psr7\copy_to_string($s, 3)); $this->assertEquals('', Psr7\copy_to_string($s)); } public function testCopiesToStringStopsWhenReadFails() { $s1 = Psr7\stream_for('foobaz'); $s1 = FnStream::decorate($s1, [ 'read' => function () { return ''; } ]); $result = Psr7\copy_to_string($s1); $this->assertEquals('', $result); } public function testCopiesToStream() { $s1 = Psr7\stream_for('foobaz'); $s2 = Psr7\stream_for(''); Psr7\copy_to_stream($s1, $s2); $this->assertEquals('foobaz', (string) $s2); $s2 = Psr7\stream_for(''); $s1->seek(0); Psr7\copy_to_stream($s1, $s2, 3); $this->assertEquals('foo', (string) $s2); Psr7\copy_to_stream($s1, $s2, 3); $this->assertEquals('foobaz', (string) $s2); } public function testStopsCopyToStreamWhenWriteFails() { $s1 = Psr7\stream_for('foobaz'); $s2 = Psr7\stream_for(''); $s2 = FnStream::decorate($s2, ['write' => function () { return 0; }]); Psr7\copy_to_stream($s1, $s2); $this->assertEquals('', (string) $s2); } public function testStopsCopyToSteamWhenWriteFailsWithMaxLen() { $s1 = Psr7\stream_for('foobaz'); $s2 = Psr7\stream_for(''); $s2 = FnStream::decorate($s2, ['write' => function () { return 0; }]); Psr7\copy_to_stream($s1, $s2, 10); $this->assertEquals('', (string) $s2); } public function testStopsCopyToSteamWhenReadFailsWithMaxLen() { $s1 = Psr7\stream_for('foobaz'); $s1 = FnStream::decorate($s1, ['read' => function () { return ''; }]); $s2 = Psr7\stream_for(''); Psr7\copy_to_stream($s1, $s2, 10); $this->assertEquals('', (string) $s2); } public function testReadsLines() { $s = Psr7\stream_for("foo\nbaz\nbar"); $this->assertEquals("foo\n", Psr7\readline($s)); $this->assertEquals("baz\n", Psr7\readline($s)); $this->assertEquals("bar", Psr7\readline($s)); } public function testReadsLinesUpToMaxLength() { $s = Psr7\stream_for("12345\n"); $this->assertEquals("123", Psr7\readline($s, 4)); $this->assertEquals("45\n", Psr7\readline($s)); } public function testReadsLineUntilFalseReturnedFromRead() { $s = $this->getMockBuilder('GuzzleHttp\Psr7\Stream') ->setMethods(['read', 'eof']) ->disableOriginalConstructor() ->getMock(); $s->expects($this->exactly(2)) ->method('read') ->will($this->returnCallback(function () { static $c = false; if ($c) { return false; } $c = true; return 'h'; })); $s->expects($this->exactly(2)) ->method('eof') ->will($this->returnValue(false)); $this->assertEquals("h", Psr7\readline($s)); } public function testCalculatesHash() { $s = Psr7\stream_for('foobazbar'); $this->assertEquals(md5('foobazbar'), Psr7\hash($s, 'md5')); } /** * @expectedException \RuntimeException */ public function testCalculatesHashThrowsWhenSeekFails() { $s = new NoSeekStream(Psr7\stream_for('foobazbar')); $s->read(2); Psr7\hash($s, 'md5'); } public function testCalculatesHashSeeksToOriginalPosition() { $s = Psr7\stream_for('foobazbar'); $s->seek(4); $this->assertEquals(md5('foobazbar'), Psr7\hash($s, 'md5')); $this->assertEquals(4, $s->tell()); } public function testOpensFilesSuccessfully() { $r = Psr7\try_fopen(__FILE__, 'r'); $this->assertInternalType('resource', $r); fclose($r); } /** * @expectedException \RuntimeException * @expectedExceptionMessage Unable to open /path/to/does/not/exist using mode r */ public function testThrowsExceptionNotWarning() { Psr7\try_fopen('/path/to/does/not/exist', 'r'); } public function parseQueryProvider() { return [ // Does not need to parse when the string is empty ['', []], // Can parse mult-values items ['q=a&q=b', ['q' => ['a', 'b']]], // Can parse multi-valued items that use numeric indices ['q[0]=a&q[1]=b', ['q[0]' => 'a', 'q[1]' => 'b']], // Can parse duplicates and does not include numeric indices ['q[]=a&q[]=b', ['q[]' => ['a', 'b']]], // Ensures that the value of "q" is an array even though one value ['q[]=a', ['q[]' => 'a']], // Does not modify "." to "_" like PHP's parse_str() ['q.a=a&q.b=b', ['q.a' => 'a', 'q.b' => 'b']], // Can decode %20 to " " ['q%20a=a%20b', ['q a' => 'a b']], // Can parse funky strings with no values by assigning each to null ['q&a', ['q' => null, 'a' => null]], // Does not strip trailing equal signs ['data=abc=', ['data' => 'abc=']], // Can store duplicates without affecting other values ['foo=a&foo=b&?µ=c', ['foo' => ['a', 'b'], '?µ' => 'c']], // Sets value to null when no "=" is present ['foo', ['foo' => null]], // Preserves "0" keys. ['0', ['0' => null]], // Sets the value to an empty string when "=" is present ['0=', ['0' => '']], // Preserves falsey keys ['var=0', ['var' => '0']], ['a[b][c]=1&a[b][c]=2', ['a[b][c]' => ['1', '2']]], ['a[b]=c&a[d]=e', ['a[b]' => 'c', 'a[d]' => 'e']], // Ensure it doesn't leave things behind with repeated values // Can parse mult-values items ['q=a&q=b&q=c', ['q' => ['a', 'b', 'c']]], ]; } /** * @dataProvider parseQueryProvider */ public function testParsesQueries($input, $output) { $result = Psr7\parse_query($input); $this->assertSame($output, $result); } public function testDoesNotDecode() { $str = 'foo%20=bar'; $data = Psr7\parse_query($str, false); $this->assertEquals(['foo%20' => 'bar'], $data); } /** * @dataProvider parseQueryProvider */ public function testParsesAndBuildsQueries($input, $output) { $result = Psr7\parse_query($input, false); $this->assertSame($input, Psr7\build_query($result, false)); } public function testEncodesWithRfc1738() { $str = Psr7\build_query(['foo bar' => 'baz+'], PHP_QUERY_RFC1738); $this->assertEquals('foo+bar=baz%2B', $str); } public function testEncodesWithRfc3986() { $str = Psr7\build_query(['foo bar' => 'baz+'], PHP_QUERY_RFC3986); $this->assertEquals('foo%20bar=baz%2B', $str); } public function testDoesNotEncode() { $str = Psr7\build_query(['foo bar' => 'baz+'], false); $this->assertEquals('foo bar=baz+', $str); } public function testCanControlDecodingType() { $result = Psr7\parse_query('var=foo+bar', PHP_QUERY_RFC3986); $this->assertEquals('foo+bar', $result['var']); $result = Psr7\parse_query('var=foo+bar', PHP_QUERY_RFC1738); $this->assertEquals('foo bar', $result['var']); } public function testParsesRequestMessages() { $req = "GET /abc HTTP/1.0\r\nHost: foo.com\r\nFoo: Bar\r\nBaz: Bam\r\nBaz: Qux\r\n\r\nTest"; $request = Psr7\parse_request($req); $this->assertEquals('GET', $request->getMethod()); $this->assertEquals('/abc', $request->getRequestTarget()); $this->assertEquals('1.0', $request->getProtocolVersion()); $this->assertEquals('foo.com', $request->getHeaderLine('Host')); $this->assertEquals('Bar', $request->getHeaderLine('Foo')); $this->assertEquals('Bam, Qux', $request->getHeaderLine('Baz')); $this->assertEquals('Test', (string) $request->getBody()); $this->assertEquals('http://foo.com/abc', (string) $request->getUri()); } public function testParsesRequestMessagesWithHttpsScheme() { $req = "PUT /abc?baz=bar HTTP/1.1\r\nHost: foo.com:443\r\n\r\n"; $request = Psr7\parse_request($req); $this->assertEquals('PUT', $request->getMethod()); $this->assertEquals('/abc?baz=bar', $request->getRequestTarget()); $this->assertEquals('1.1', $request->getProtocolVersion()); $this->assertEquals('foo.com:443', $request->getHeaderLine('Host')); $this->assertEquals('', (string) $request->getBody()); $this->assertEquals('https://foo.com/abc?baz=bar', (string) $request->getUri()); } public function testParsesRequestMessagesWithUriWhenHostIsNotFirst() { $req = "PUT / HTTP/1.1\r\nFoo: Bar\r\nHost: foo.com\r\n\r\n"; $request = Psr7\parse_request($req); $this->assertEquals('PUT', $request->getMethod()); $this->assertEquals('/', $request->getRequestTarget()); $this->assertEquals('http://foo.com/', (string) $request->getUri()); } public function testParsesRequestMessagesWithFullUri() { $req = "GET https://www.google.com:443/search?q=foobar HTTP/1.1\r\nHost: www.google.com\r\n\r\n"; $request = Psr7\parse_request($req); $this->assertEquals('GET', $request->getMethod()); $this->assertEquals('https://www.google.com:443/search?q=foobar', $request->getRequestTarget()); $this->assertEquals('1.1', $request->getProtocolVersion()); $this->assertEquals('www.google.com', $request->getHeaderLine('Host')); $this->assertEquals('', (string) $request->getBody()); $this->assertEquals('https://www.google.com/search?q=foobar', (string) $request->getUri()); } public function testParsesRequestMessagesWithCustomMethod() { $req = "GET_DATA / HTTP/1.1\r\nFoo: Bar\r\nHost: foo.com\r\n\r\n"; $request = Psr7\parse_request($req); $this->assertEquals('GET_DATA', $request->getMethod()); } /** * @expectedException \InvalidArgumentException */ public function testValidatesRequestMessages() { Psr7\parse_request("HTTP/1.1 200 OK\r\n\r\n"); } public function testParsesResponseMessages() { $res = "HTTP/1.0 200 OK\r\nFoo: Bar\r\nBaz: Bam\r\nBaz: Qux\r\n\r\nTest"; $response = Psr7\parse_response($res); $this->assertEquals(200, $response->getStatusCode()); $this->assertEquals('OK', $response->getReasonPhrase()); $this->assertEquals('1.0', $response->getProtocolVersion()); $this->assertEquals('Bar', $response->getHeaderLine('Foo')); $this->assertEquals('Bam, Qux', $response->getHeaderLine('Baz')); $this->assertEquals('Test', (string) $response->getBody()); } /** * @expectedException \InvalidArgumentException */ public function testValidatesResponseMessages() { Psr7\parse_response("GET / HTTP/1.1\r\n\r\n"); } public function testDetermineMimetype() { $this->assertNull(Psr7\mimetype_from_extension('not-a-real-extension')); $this->assertEquals( 'application/json', Psr7\mimetype_from_extension('json') ); $this->assertEquals( 'image/jpeg', Psr7\mimetype_from_filename('/tmp/images/IMG034821.JPEG') ); } public function testCreatesUriForValue() { $this->assertInstanceOf('GuzzleHttp\Psr7\Uri', Psr7\uri_for('/foo')); $this->assertInstanceOf( 'GuzzleHttp\Psr7\Uri', Psr7\uri_for(new Psr7\Uri('/foo')) ); } /** * @expectedException \InvalidArgumentException */ public function testValidatesUri() { Psr7\uri_for([]); } public function testKeepsPositionOfResource() { $h = fopen(__FILE__, 'r'); fseek($h, 10); $stream = Psr7\stream_for($h); $this->assertEquals(10, $stream->tell()); $stream->close(); } public function testCreatesWithFactory() { $stream = Psr7\stream_for('foo'); $this->assertInstanceOf('GuzzleHttp\Psr7\Stream', $stream); $this->assertEquals('foo', $stream->getContents()); $stream->close(); } public function testFactoryCreatesFromEmptyString() { $s = Psr7\stream_for(); $this->assertInstanceOf('GuzzleHttp\Psr7\Stream', $s); } public function testFactoryCreatesFromNull() { $s = Psr7\stream_for(null); $this->assertInstanceOf('GuzzleHttp\Psr7\Stream', $s); } public function testFactoryCreatesFromResource() { $r = fopen(__FILE__, 'r'); $s = Psr7\stream_for($r); $this->assertInstanceOf('GuzzleHttp\Psr7\Stream', $s); $this->assertSame(file_get_contents(__FILE__), (string) $s); } public function testFactoryCreatesFromObjectWithToString() { $r = new HasToString(); $s = Psr7\stream_for($r); $this->assertInstanceOf('GuzzleHttp\Psr7\Stream', $s); $this->assertEquals('foo', (string) $s); } public function testCreatePassesThrough() { $s = Psr7\stream_for('foo'); $this->assertSame($s, Psr7\stream_for($s)); } /** * @expectedException \InvalidArgumentException */ public function testThrowsExceptionForUnknown() { Psr7\stream_for(new \stdClass()); } public function testReturnsCustomMetadata() { $s = Psr7\stream_for('foo', ['metadata' => ['hwm' => 3]]); $this->assertEquals(3, $s->getMetadata('hwm')); $this->assertArrayHasKey('hwm', $s->getMetadata()); } public function testCanSetSize() { $s = Psr7\stream_for('', ['size' => 10]); $this->assertEquals(10, $s->getSize()); } public function testCanCreateIteratorBasedStream() { $a = new \ArrayIterator(['foo', 'bar', '123']); $p = Psr7\stream_for($a); $this->assertInstanceOf('GuzzleHttp\Psr7\PumpStream', $p); $this->assertEquals('foo', $p->read(3)); $this->assertFalse($p->eof()); $this->assertEquals('b', $p->read(1)); $this->assertEquals('a', $p->read(1)); $this->assertEquals('r12', $p->read(3)); $this->assertFalse($p->eof()); $this->assertEquals('3', $p->getContents()); $this->assertTrue($p->eof()); $this->assertEquals(9, $p->tell()); } public function testConvertsRequestsToStrings() { $request = new Psr7\Request('PUT', 'http://foo.com/hi?123', [ 'Baz' => 'bar', 'Qux' => 'ipsum' ], 'hello', '1.0'); $this->assertEquals( "PUT /hi?123 HTTP/1.0\r\nHost: foo.com\r\nBaz: bar\r\nQux: ipsum\r\n\r\nhello", Psr7\str($request) ); } public function testConvertsResponsesToStrings() { $response = new Psr7\Response(200, [ 'Baz' => 'bar', 'Qux' => 'ipsum' ], 'hello', '1.0', 'FOO'); $this->assertEquals( "HTTP/1.0 200 FOO\r\nBaz: bar\r\nQux: ipsum\r\n\r\nhello", Psr7\str($response) ); } public function parseParamsProvider() { $res1 = array( array( '', 'rel' => 'front', 'type' => 'image/jpeg', ), array( '', 'rel' => 'back', 'type' => 'image/jpeg', ), ); return array( array( '; rel="front"; type="image/jpeg", ; rel=back; type="image/jpeg"', $res1 ), array( '; rel="front"; type="image/jpeg",; rel=back; type="image/jpeg"', $res1 ), array( 'foo="baz"; bar=123, boo, test="123", foobar="foo;bar"', array( array('foo' => 'baz', 'bar' => '123'), array('boo'), array('test' => '123'), array('foobar' => 'foo;bar') ) ), array( '; rel="side"; type="image/jpeg",; rel=side; type="image/jpeg"', array( array('', 'rel' => 'side', 'type' => 'image/jpeg'), array('', 'rel' => 'side', 'type' => 'image/jpeg') ) ), array( '', array() ) ); } /** * @dataProvider parseParamsProvider */ public function testParseParams($header, $result) { $this->assertEquals($result, Psr7\parse_header($header)); } public function testParsesArrayHeaders() { $header = ['a, b', 'c', 'd, e']; $this->assertEquals(['a', 'b', 'c', 'd', 'e'], Psr7\normalize_header($header)); } public function testRewindsBody() { $body = Psr7\stream_for('abc'); $res = new Psr7\Response(200, [], $body); Psr7\rewind_body($res); $this->assertEquals(0, $body->tell()); $body->rewind(1); Psr7\rewind_body($res); $this->assertEquals(0, $body->tell()); } /** * @expectedException \RuntimeException */ public function testThrowsWhenBodyCannotBeRewound() { $body = Psr7\stream_for('abc'); $body->read(1); $body = FnStream::decorate($body, [ 'rewind' => function () { throw new \RuntimeException('a'); } ]); $res = new Psr7\Response(200, [], $body); Psr7\rewind_body($res); } public function testCanModifyRequestWithUri() { $r1 = new Psr7\Request('GET', 'http://foo.com'); $r2 = Psr7\modify_request($r1, [ 'uri' => new Psr7\Uri('http://www.foo.com') ]); $this->assertEquals('http://www.foo.com', (string) $r2->getUri()); $this->assertEquals('www.foo.com', (string) $r2->getHeaderLine('host')); } public function testCanModifyRequestWithUriAndPort() { $r1 = new Psr7\Request('GET', 'http://foo.com:8000'); $r2 = Psr7\modify_request($r1, [ 'uri' => new Psr7\Uri('http://www.foo.com:8000') ]); $this->assertEquals('http://www.foo.com:8000', (string) $r2->getUri()); $this->assertEquals('www.foo.com:8000', (string) $r2->getHeaderLine('host')); } public function testCanModifyRequestWithCaseInsensitiveHeader() { $r1 = new Psr7\Request('GET', 'http://foo.com', ['User-Agent' => 'foo']); $r2 = Psr7\modify_request($r1, ['set_headers' => ['User-agent' => 'bar']]); $this->assertEquals('bar', $r2->getHeaderLine('User-Agent')); $this->assertEquals('bar', $r2->getHeaderLine('User-agent')); } public function testReturnsAsIsWhenNoChanges() { $r1 = new Psr7\Request('GET', 'http://foo.com'); $r2 = Psr7\modify_request($r1, []); $this->assertTrue($r2 instanceof Psr7\Request); $r1 = new Psr7\ServerRequest('GET', 'http://foo.com'); $r2 = Psr7\modify_request($r1, []); $this->assertTrue($r2 instanceof \Psr\Http\Message\ServerRequestInterface); } public function testReturnsUriAsIsWhenNoChanges() { $r1 = new Psr7\Request('GET', 'http://foo.com'); $r2 = Psr7\modify_request($r1, ['set_headers' => ['foo' => 'bar']]); $this->assertNotSame($r1, $r2); $this->assertEquals('bar', $r2->getHeaderLine('foo')); } public function testRemovesHeadersFromMessage() { $r1 = new Psr7\Request('GET', 'http://foo.com', ['foo' => 'bar']); $r2 = Psr7\modify_request($r1, ['remove_headers' => ['foo']]); $this->assertNotSame($r1, $r2); $this->assertFalse($r2->hasHeader('foo')); } public function testAddsQueryToUri() { $r1 = new Psr7\Request('GET', 'http://foo.com'); $r2 = Psr7\modify_request($r1, ['query' => 'foo=bar']); $this->assertNotSame($r1, $r2); $this->assertEquals('foo=bar', $r2->getUri()->getQuery()); } public function testModifyRequestKeepInstanceOfRequest() { $r1 = new Psr7\Request('GET', 'http://foo.com'); $r2 = Psr7\modify_request($r1, ['remove_headers' => ['non-existent']]); $this->assertTrue($r2 instanceof Psr7\Request); $r1 = new Psr7\ServerRequest('GET', 'http://foo.com'); $r2 = Psr7\modify_request($r1, ['remove_headers' => ['non-existent']]); $this->assertTrue($r2 instanceof \Psr\Http\Message\ServerRequestInterface); } } tests/InflateStreamTest.php000064400000002021144760126270012021 0ustar00assertEquals('test', (string) $b); } public function testInflatesStreamsWithFilename() { $content = $this->getGzipStringWithFilename('test'); $a = Psr7\stream_for($content); $b = new InflateStream($a); $this->assertEquals('test', (string) $b); } private function getGzipStringWithFilename($original_string) { $gzipped = bin2hex(gzencode($original_string)); $header = substr($gzipped, 0, 20); // set FNAME flag $header[6]=0; $header[7]=8; // make a dummy filename $filename = "64756d6d7900"; $rest = substr($gzipped, 20); return hex2bin($header . $filename . $rest); } } tests/LazyOpenStreamTest.php000064400000003465144760126270012215 0ustar00fname = tempnam('/tmp', 'tfile'); if (file_exists($this->fname)) { unlink($this->fname); } } public function tearDown() { if (file_exists($this->fname)) { unlink($this->fname); } } public function testOpensLazily() { $l = new LazyOpenStream($this->fname, 'w+'); $l->write('foo'); $this->assertInternalType('array', $l->getMetadata()); $this->assertFileExists($this->fname); $this->assertEquals('foo', file_get_contents($this->fname)); $this->assertEquals('foo', (string) $l); } public function testProxiesToFile() { file_put_contents($this->fname, 'foo'); $l = new LazyOpenStream($this->fname, 'r'); $this->assertEquals('foo', $l->read(4)); $this->assertTrue($l->eof()); $this->assertEquals(3, $l->tell()); $this->assertTrue($l->isReadable()); $this->assertTrue($l->isSeekable()); $this->assertFalse($l->isWritable()); $l->seek(1); $this->assertEquals('oo', $l->getContents()); $this->assertEquals('foo', (string) $l); $this->assertEquals(3, $l->getSize()); $this->assertInternalType('array', $l->getMetadata()); $l->close(); } public function testDetachesUnderlyingStream() { file_put_contents($this->fname, 'foo'); $l = new LazyOpenStream($this->fname, 'r'); $r = $l->detach(); $this->assertInternalType('resource', $r); fseek($r, 0); $this->assertEquals('foo', stream_get_contents($r)); fclose($r); } } tests/LimitStreamTest.php000064400000011560144760126270011525 0ustar00decorated = Psr7\stream_for(fopen(__FILE__, 'r')); $this->body = new LimitStream($this->decorated, 10, 3); } public function testReturnsSubset() { $body = new LimitStream(Psr7\stream_for('foo'), -1, 1); $this->assertEquals('oo', (string) $body); $this->assertTrue($body->eof()); $body->seek(0); $this->assertFalse($body->eof()); $this->assertEquals('oo', $body->read(100)); $this->assertSame('', $body->read(1)); $this->assertTrue($body->eof()); } public function testReturnsSubsetWhenCastToString() { $body = Psr7\stream_for('foo_baz_bar'); $limited = new LimitStream($body, 3, 4); $this->assertEquals('baz', (string) $limited); } /** * @expectedException \RuntimeException * @expectedExceptionMessage Unable to seek to stream position 10 with whence 0 */ public function testEnsuresPositionCanBeekSeekedTo() { new LimitStream(Psr7\stream_for(''), 0, 10); } public function testReturnsSubsetOfEmptyBodyWhenCastToString() { $body = Psr7\stream_for('01234567891234'); $limited = new LimitStream($body, 0, 10); $this->assertEquals('', (string) $limited); } public function testReturnsSpecificSubsetOBodyWhenCastToString() { $body = Psr7\stream_for('0123456789abcdef'); $limited = new LimitStream($body, 3, 10); $this->assertEquals('abc', (string) $limited); } public function testSeeksWhenConstructed() { $this->assertEquals(0, $this->body->tell()); $this->assertEquals(3, $this->decorated->tell()); } public function testAllowsBoundedSeek() { $this->body->seek(100); $this->assertEquals(10, $this->body->tell()); $this->assertEquals(13, $this->decorated->tell()); $this->body->seek(0); $this->assertEquals(0, $this->body->tell()); $this->assertEquals(3, $this->decorated->tell()); try { $this->body->seek(-10); $this->fail(); } catch (\RuntimeException $e) {} $this->assertEquals(0, $this->body->tell()); $this->assertEquals(3, $this->decorated->tell()); $this->body->seek(5); $this->assertEquals(5, $this->body->tell()); $this->assertEquals(8, $this->decorated->tell()); // Fail try { $this->body->seek(1000, SEEK_END); $this->fail(); } catch (\RuntimeException $e) {} } public function testReadsOnlySubsetOfData() { $data = $this->body->read(100); $this->assertEquals(10, strlen($data)); $this->assertSame('', $this->body->read(1000)); $this->body->setOffset(10); $newData = $this->body->read(100); $this->assertEquals(10, strlen($newData)); $this->assertNotSame($data, $newData); } /** * @expectedException \RuntimeException * @expectedExceptionMessage Could not seek to stream offset 2 */ public function testThrowsWhenCurrentGreaterThanOffsetSeek() { $a = Psr7\stream_for('foo_bar'); $b = new NoSeekStream($a); $c = new LimitStream($b); $a->getContents(); $c->setOffset(2); } public function testCanGetContentsWithoutSeeking() { $a = Psr7\stream_for('foo_bar'); $b = new NoSeekStream($a); $c = new LimitStream($b); $this->assertEquals('foo_bar', $c->getContents()); } public function testClaimsConsumedWhenReadLimitIsReached() { $this->assertFalse($this->body->eof()); $this->body->read(1000); $this->assertTrue($this->body->eof()); } public function testContentLengthIsBounded() { $this->assertEquals(10, $this->body->getSize()); } public function testGetContentsIsBasedOnSubset() { $body = new LimitStream(Psr7\stream_for('foobazbar'), 3, 3); $this->assertEquals('baz', $body->getContents()); } public function testReturnsNullIfSizeCannotBeDetermined() { $a = new FnStream([ 'getSize' => function () { return null; }, 'tell' => function () { return 0; }, ]); $b = new LimitStream($a); $this->assertNull($b->getSize()); } public function testLengthLessOffsetWhenNoLimitSize() { $a = Psr7\stream_for('foo_bar'); $b = new LimitStream($a, -1, 4); $this->assertEquals(3, $b->getSize()); } } tests/MultipartStreamTest.php000064400000014212144760126270012425 0ustar00assertNotEmpty($b->getBoundary()); } public function testCanProvideBoundary() { $b = new MultipartStream([], 'foo'); $this->assertEquals('foo', $b->getBoundary()); } public function testIsNotWritable() { $b = new MultipartStream(); $this->assertFalse($b->isWritable()); } public function testCanCreateEmptyStream() { $b = new MultipartStream(); $boundary = $b->getBoundary(); $this->assertSame("--{$boundary}--\r\n", $b->getContents()); $this->assertSame(strlen($boundary) + 6, $b->getSize()); } /** * @expectedException \InvalidArgumentException */ public function testValidatesFilesArrayElement() { new MultipartStream([['foo' => 'bar']]); } /** * @expectedException \InvalidArgumentException */ public function testEnsuresFileHasName() { new MultipartStream([['contents' => 'bar']]); } public function testSerializesFields() { $b = new MultipartStream([ [ 'name' => 'foo', 'contents' => 'bar' ], [ 'name' => 'baz', 'contents' => 'bam' ] ], 'boundary'); $this->assertEquals( "--boundary\r\nContent-Disposition: form-data; name=\"foo\"\r\nContent-Length: 3\r\n\r\n" . "bar\r\n--boundary\r\nContent-Disposition: form-data; name=\"baz\"\r\nContent-Length: 3" . "\r\n\r\nbam\r\n--boundary--\r\n", (string) $b); } public function testSerializesNonStringFields() { $b = new MultipartStream([ [ 'name' => 'int', 'contents' => (int) 1 ], [ 'name' => 'bool', 'contents' => (boolean) false ], [ 'name' => 'bool2', 'contents' => (boolean) true ], [ 'name' => 'float', 'contents' => (float) 1.1 ] ], 'boundary'); $this->assertEquals( "--boundary\r\nContent-Disposition: form-data; name=\"int\"\r\nContent-Length: 1\r\n\r\n" . "1\r\n--boundary\r\nContent-Disposition: form-data; name=\"bool\"\r\n\r\n\r\n--boundary" . "\r\nContent-Disposition: form-data; name=\"bool2\"\r\nContent-Length: 1\r\n\r\n" . "1\r\n--boundary\r\nContent-Disposition: form-data; name=\"float\"\r\nContent-Length: 3" . "\r\n\r\n1.1\r\n--boundary--\r\n", (string) $b); } public function testSerializesFiles() { $f1 = Psr7\FnStream::decorate(Psr7\stream_for('foo'), [ 'getMetadata' => function () { return '/foo/bar.txt'; } ]); $f2 = Psr7\FnStream::decorate(Psr7\stream_for('baz'), [ 'getMetadata' => function () { return '/foo/baz.jpg'; } ]); $f3 = Psr7\FnStream::decorate(Psr7\stream_for('bar'), [ 'getMetadata' => function () { return '/foo/bar.gif'; } ]); $b = new MultipartStream([ [ 'name' => 'foo', 'contents' => $f1 ], [ 'name' => 'qux', 'contents' => $f2 ], [ 'name' => 'qux', 'contents' => $f3 ], ], 'boundary'); $expected = <<assertEquals($expected, str_replace("\r", '', $b)); } public function testSerializesFilesWithCustomHeaders() { $f1 = Psr7\FnStream::decorate(Psr7\stream_for('foo'), [ 'getMetadata' => function () { return '/foo/bar.txt'; } ]); $b = new MultipartStream([ [ 'name' => 'foo', 'contents' => $f1, 'headers' => [ 'x-foo' => 'bar', 'content-disposition' => 'custom' ] ] ], 'boundary'); $expected = <<assertEquals($expected, str_replace("\r", '', $b)); } public function testSerializesFilesWithCustomHeadersAndMultipleValues() { $f1 = Psr7\FnStream::decorate(Psr7\stream_for('foo'), [ 'getMetadata' => function () { return '/foo/bar.txt'; } ]); $f2 = Psr7\FnStream::decorate(Psr7\stream_for('baz'), [ 'getMetadata' => function () { return '/foo/baz.jpg'; } ]); $b = new MultipartStream([ [ 'name' => 'foo', 'contents' => $f1, 'headers' => [ 'x-foo' => 'bar', 'content-disposition' => 'custom' ] ], [ 'name' => 'foo', 'contents' => $f2, 'headers' => ['cOntenT-Type' => 'custom'], ] ], 'boundary'); $expected = <<assertEquals($expected, str_replace("\r", '', $b)); } } tests/NoSeekStreamTest.php000064400000002161144760126270011630 0ustar00getMockBuilder('Psr\Http\Message\StreamInterface') ->setMethods(['isSeekable', 'seek']) ->getMockForAbstractClass(); $s->expects($this->never())->method('seek'); $s->expects($this->never())->method('isSeekable'); $wrapped = new NoSeekStream($s); $this->assertFalse($wrapped->isSeekable()); $wrapped->seek(2); } /** * @expectedException \RuntimeException * @expectedExceptionMessage Cannot write to a non-writable stream */ public function testHandlesClose() { $s = Psr7\stream_for('foo'); $wrapped = new NoSeekStream($s); $wrapped->close(); $wrapped->write('foo'); } } tests/PumpStreamTest.php000064400000004224144760126270011367 0ustar00 ['foo' => 'bar'], 'size' => 100 ]); $this->assertEquals('bar', $p->getMetadata('foo')); $this->assertEquals(['foo' => 'bar'], $p->getMetadata()); $this->assertEquals(100, $p->getSize()); } public function testCanReadFromCallable() { $p = Psr7\stream_for(function ($size) { return 'a'; }); $this->assertEquals('a', $p->read(1)); $this->assertEquals(1, $p->tell()); $this->assertEquals('aaaaa', $p->read(5)); $this->assertEquals(6, $p->tell()); } public function testStoresExcessDataInBuffer() { $called = []; $p = Psr7\stream_for(function ($size) use (&$called) { $called[] = $size; return 'abcdef'; }); $this->assertEquals('a', $p->read(1)); $this->assertEquals('b', $p->read(1)); $this->assertEquals('cdef', $p->read(4)); $this->assertEquals('abcdefabc', $p->read(9)); $this->assertEquals([1, 9, 3], $called); } public function testInifiniteStreamWrappedInLimitStream() { $p = Psr7\stream_for(function () { return 'a'; }); $s = new LimitStream($p, 5); $this->assertEquals('aaaaa', (string) $s); } public function testDescribesCapabilities() { $p = Psr7\stream_for(function () {}); $this->assertTrue($p->isReadable()); $this->assertFalse($p->isSeekable()); $this->assertFalse($p->isWritable()); $this->assertNull($p->getSize()); $this->assertEquals('', $p->getContents()); $this->assertEquals('', (string) $p); $p->close(); $this->assertEquals('', $p->read(10)); $this->assertTrue($p->eof()); try { $this->assertFalse($p->write('aa')); $this->fail(); } catch (\RuntimeException $e) {} } } tests/RequestTest.php000064400000013656144760126270010733 0ustar00assertEquals('/', (string) $r->getUri()); } public function testRequestUriMayBeUri() { $uri = new Uri('/'); $r = new Request('GET', $uri); $this->assertSame($uri, $r->getUri()); } /** * @expectedException \InvalidArgumentException */ public function testValidateRequestUri() { new Request('GET', '///'); } public function testCanConstructWithBody() { $r = new Request('GET', '/', [], 'baz'); $this->assertInstanceOf('Psr\Http\Message\StreamInterface', $r->getBody()); $this->assertEquals('baz', (string) $r->getBody()); } public function testNullBody() { $r = new Request('GET', '/', [], null); $this->assertInstanceOf('Psr\Http\Message\StreamInterface', $r->getBody()); $this->assertSame('', (string) $r->getBody()); } public function testFalseyBody() { $r = new Request('GET', '/', [], '0'); $this->assertInstanceOf('Psr\Http\Message\StreamInterface', $r->getBody()); $this->assertSame('0', (string) $r->getBody()); } public function testConstructorDoesNotReadStreamBody() { $streamIsRead = false; $body = Psr7\FnStream::decorate(Psr7\stream_for(''), [ '__toString' => function () use (&$streamIsRead) { $streamIsRead = true; return ''; } ]); $r = new Request('GET', '/', [], $body); $this->assertFalse($streamIsRead); $this->assertSame($body, $r->getBody()); } public function testCapitalizesMethod() { $r = new Request('get', '/'); $this->assertEquals('GET', $r->getMethod()); } public function testCapitalizesWithMethod() { $r = new Request('GET', '/'); $this->assertEquals('PUT', $r->withMethod('put')->getMethod()); } public function testWithUri() { $r1 = new Request('GET', '/'); $u1 = $r1->getUri(); $u2 = new Uri('http://www.example.com'); $r2 = $r1->withUri($u2); $this->assertNotSame($r1, $r2); $this->assertSame($u2, $r2->getUri()); $this->assertSame($u1, $r1->getUri()); } public function testSameInstanceWhenSameUri() { $r1 = new Request('GET', 'http://foo.com'); $r2 = $r1->withUri($r1->getUri()); $this->assertSame($r1, $r2); } public function testWithRequestTarget() { $r1 = new Request('GET', '/'); $r2 = $r1->withRequestTarget('*'); $this->assertEquals('*', $r2->getRequestTarget()); $this->assertEquals('/', $r1->getRequestTarget()); } /** * @expectedException \InvalidArgumentException */ public function testRequestTargetDoesNotAllowSpaces() { $r1 = new Request('GET', '/'); $r1->withRequestTarget('/foo bar'); } public function testRequestTargetDefaultsToSlash() { $r1 = new Request('GET', ''); $this->assertEquals('/', $r1->getRequestTarget()); $r2 = new Request('GET', '*'); $this->assertEquals('*', $r2->getRequestTarget()); $r3 = new Request('GET', 'http://foo.com/bar baz/'); $this->assertEquals('/bar%20baz/', $r3->getRequestTarget()); } public function testBuildsRequestTarget() { $r1 = new Request('GET', 'http://foo.com/baz?bar=bam'); $this->assertEquals('/baz?bar=bam', $r1->getRequestTarget()); } public function testBuildsRequestTargetWithFalseyQuery() { $r1 = new Request('GET', 'http://foo.com/baz?0'); $this->assertEquals('/baz?0', $r1->getRequestTarget()); } public function testHostIsAddedFirst() { $r = new Request('GET', 'http://foo.com/baz?bar=bam', ['Foo' => 'Bar']); $this->assertEquals([ 'Host' => ['foo.com'], 'Foo' => ['Bar'] ], $r->getHeaders()); } public function testCanGetHeaderAsCsv() { $r = new Request('GET', 'http://foo.com/baz?bar=bam', [ 'Foo' => ['a', 'b', 'c'] ]); $this->assertEquals('a, b, c', $r->getHeaderLine('Foo')); $this->assertEquals('', $r->getHeaderLine('Bar')); } public function testHostIsNotOverwrittenWhenPreservingHost() { $r = new Request('GET', 'http://foo.com/baz?bar=bam', ['Host' => 'a.com']); $this->assertEquals(['Host' => ['a.com']], $r->getHeaders()); $r2 = $r->withUri(new Uri('http://www.foo.com/bar'), true); $this->assertEquals('a.com', $r2->getHeaderLine('Host')); } public function testOverridesHostWithUri() { $r = new Request('GET', 'http://foo.com/baz?bar=bam'); $this->assertEquals(['Host' => ['foo.com']], $r->getHeaders()); $r2 = $r->withUri(new Uri('http://www.baz.com/bar')); $this->assertEquals('www.baz.com', $r2->getHeaderLine('Host')); } public function testAggregatesHeaders() { $r = new Request('GET', '', [ 'ZOO' => 'zoobar', 'zoo' => ['foobar', 'zoobar'] ]); $this->assertEquals(['ZOO' => ['zoobar', 'foobar', 'zoobar']], $r->getHeaders()); $this->assertEquals('zoobar, foobar, zoobar', $r->getHeaderLine('zoo')); } public function testAddsPortToHeader() { $r = new Request('GET', 'http://foo.com:8124/bar'); $this->assertEquals('foo.com:8124', $r->getHeaderLine('host')); } public function testAddsPortToHeaderAndReplacePreviousPort() { $r = new Request('GET', 'http://foo.com:8124/bar'); $r = $r->withUri(new Uri('http://foo.com:8125/bar')); $this->assertEquals('foo.com:8125', $r->getHeaderLine('host')); } } tests/ResponseTest.php000064400000021434144760126270011072 0ustar00assertSame(200, $r->getStatusCode()); $this->assertSame('1.1', $r->getProtocolVersion()); $this->assertSame('OK', $r->getReasonPhrase()); $this->assertSame([], $r->getHeaders()); $this->assertInstanceOf('Psr\Http\Message\StreamInterface', $r->getBody()); $this->assertSame('', (string) $r->getBody()); } public function testCanConstructWithStatusCode() { $r = new Response(404); $this->assertSame(404, $r->getStatusCode()); $this->assertSame('Not Found', $r->getReasonPhrase()); } public function testConstructorDoesNotReadStreamBody() { $streamIsRead = false; $body = Psr7\FnStream::decorate(Psr7\stream_for(''), [ '__toString' => function () use (&$streamIsRead) { $streamIsRead = true; return ''; } ]); $r = new Response(200, [], $body); $this->assertFalse($streamIsRead); $this->assertSame($body, $r->getBody()); } public function testStatusCanBeNumericString() { $r = new Response('404'); $r2 = $r->withStatus('201'); $this->assertSame(404, $r->getStatusCode()); $this->assertSame('Not Found', $r->getReasonPhrase()); $this->assertSame(201, $r2->getStatusCode()); $this->assertSame('Created', $r2->getReasonPhrase()); } public function testCanConstructWithHeaders() { $r = new Response(200, ['Foo' => 'Bar']); $this->assertSame(['Foo' => ['Bar']], $r->getHeaders()); $this->assertSame('Bar', $r->getHeaderLine('Foo')); $this->assertSame(['Bar'], $r->getHeader('Foo')); } public function testCanConstructWithHeadersAsArray() { $r = new Response(200, [ 'Foo' => ['baz', 'bar'] ]); $this->assertSame(['Foo' => ['baz', 'bar']], $r->getHeaders()); $this->assertSame('baz, bar', $r->getHeaderLine('Foo')); $this->assertSame(['baz', 'bar'], $r->getHeader('Foo')); } public function testCanConstructWithBody() { $r = new Response(200, [], 'baz'); $this->assertInstanceOf('Psr\Http\Message\StreamInterface', $r->getBody()); $this->assertSame('baz', (string) $r->getBody()); } public function testNullBody() { $r = new Response(200, [], null); $this->assertInstanceOf('Psr\Http\Message\StreamInterface', $r->getBody()); $this->assertSame('', (string) $r->getBody()); } public function testFalseyBody() { $r = new Response(200, [], '0'); $this->assertInstanceOf('Psr\Http\Message\StreamInterface', $r->getBody()); $this->assertSame('0', (string) $r->getBody()); } public function testCanConstructWithReason() { $r = new Response(200, [], null, '1.1', 'bar'); $this->assertSame('bar', $r->getReasonPhrase()); $r = new Response(200, [], null, '1.1', '0'); $this->assertSame('0', $r->getReasonPhrase(), 'Falsey reason works'); } public function testCanConstructWithProtocolVersion() { $r = new Response(200, [], null, '1000'); $this->assertSame('1000', $r->getProtocolVersion()); } public function testWithStatusCodeAndNoReason() { $r = (new Response())->withStatus(201); $this->assertSame(201, $r->getStatusCode()); $this->assertSame('Created', $r->getReasonPhrase()); } public function testWithStatusCodeAndReason() { $r = (new Response())->withStatus(201, 'Foo'); $this->assertSame(201, $r->getStatusCode()); $this->assertSame('Foo', $r->getReasonPhrase()); $r = (new Response())->withStatus(201, '0'); $this->assertSame(201, $r->getStatusCode()); $this->assertSame('0', $r->getReasonPhrase(), 'Falsey reason works'); } public function testWithProtocolVersion() { $r = (new Response())->withProtocolVersion('1000'); $this->assertSame('1000', $r->getProtocolVersion()); } public function testSameInstanceWhenSameProtocol() { $r = new Response(); $this->assertSame($r, $r->withProtocolVersion('1.1')); } public function testWithBody() { $b = Psr7\stream_for('0'); $r = (new Response())->withBody($b); $this->assertInstanceOf('Psr\Http\Message\StreamInterface', $r->getBody()); $this->assertSame('0', (string) $r->getBody()); } public function testSameInstanceWhenSameBody() { $r = new Response(); $b = $r->getBody(); $this->assertSame($r, $r->withBody($b)); } public function testWithHeader() { $r = new Response(200, ['Foo' => 'Bar']); $r2 = $r->withHeader('baZ', 'Bam'); $this->assertSame(['Foo' => ['Bar']], $r->getHeaders()); $this->assertSame(['Foo' => ['Bar'], 'baZ' => ['Bam']], $r2->getHeaders()); $this->assertSame('Bam', $r2->getHeaderLine('baz')); $this->assertSame(['Bam'], $r2->getHeader('baz')); } public function testWithHeaderAsArray() { $r = new Response(200, ['Foo' => 'Bar']); $r2 = $r->withHeader('baZ', ['Bam', 'Bar']); $this->assertSame(['Foo' => ['Bar']], $r->getHeaders()); $this->assertSame(['Foo' => ['Bar'], 'baZ' => ['Bam', 'Bar']], $r2->getHeaders()); $this->assertSame('Bam, Bar', $r2->getHeaderLine('baz')); $this->assertSame(['Bam', 'Bar'], $r2->getHeader('baz')); } public function testWithHeaderReplacesDifferentCase() { $r = new Response(200, ['Foo' => 'Bar']); $r2 = $r->withHeader('foO', 'Bam'); $this->assertSame(['Foo' => ['Bar']], $r->getHeaders()); $this->assertSame(['foO' => ['Bam']], $r2->getHeaders()); $this->assertSame('Bam', $r2->getHeaderLine('foo')); $this->assertSame(['Bam'], $r2->getHeader('foo')); } public function testWithAddedHeader() { $r = new Response(200, ['Foo' => 'Bar']); $r2 = $r->withAddedHeader('foO', 'Baz'); $this->assertSame(['Foo' => ['Bar']], $r->getHeaders()); $this->assertSame(['Foo' => ['Bar', 'Baz']], $r2->getHeaders()); $this->assertSame('Bar, Baz', $r2->getHeaderLine('foo')); $this->assertSame(['Bar', 'Baz'], $r2->getHeader('foo')); } public function testWithAddedHeaderAsArray() { $r = new Response(200, ['Foo' => 'Bar']); $r2 = $r->withAddedHeader('foO', ['Baz', 'Bam']); $this->assertSame(['Foo' => ['Bar']], $r->getHeaders()); $this->assertSame(['Foo' => ['Bar', 'Baz', 'Bam']], $r2->getHeaders()); $this->assertSame('Bar, Baz, Bam', $r2->getHeaderLine('foo')); $this->assertSame(['Bar', 'Baz', 'Bam'], $r2->getHeader('foo')); } public function testWithAddedHeaderThatDoesNotExist() { $r = new Response(200, ['Foo' => 'Bar']); $r2 = $r->withAddedHeader('nEw', 'Baz'); $this->assertSame(['Foo' => ['Bar']], $r->getHeaders()); $this->assertSame(['Foo' => ['Bar'], 'nEw' => ['Baz']], $r2->getHeaders()); $this->assertSame('Baz', $r2->getHeaderLine('new')); $this->assertSame(['Baz'], $r2->getHeader('new')); } public function testWithoutHeaderThatExists() { $r = new Response(200, ['Foo' => 'Bar', 'Baz' => 'Bam']); $r2 = $r->withoutHeader('foO'); $this->assertTrue($r->hasHeader('foo')); $this->assertSame(['Foo' => ['Bar'], 'Baz' => ['Bam']], $r->getHeaders()); $this->assertFalse($r2->hasHeader('foo')); $this->assertSame(['Baz' => ['Bam']], $r2->getHeaders()); } public function testWithoutHeaderThatDoesNotExist() { $r = new Response(200, ['Baz' => 'Bam']); $r2 = $r->withoutHeader('foO'); $this->assertSame($r, $r2); $this->assertFalse($r2->hasHeader('foo')); $this->assertSame(['Baz' => ['Bam']], $r2->getHeaders()); } public function testSameInstanceWhenRemovingMissingHeader() { $r = new Response(); $this->assertSame($r, $r->withoutHeader('foo')); } public function testHeaderValuesAreTrimmed() { $r1 = new Response(200, ['OWS' => " \t \tFoo\t \t "]); $r2 = (new Response())->withHeader('OWS', " \t \tFoo\t \t "); $r3 = (new Response())->withAddedHeader('OWS', " \t \tFoo\t \t ");; foreach ([$r1, $r2, $r3] as $r) { $this->assertSame(['OWS' => ['Foo']], $r->getHeaders()); $this->assertSame('Foo', $r->getHeaderLine('OWS')); $this->assertSame(['Foo'], $r->getHeader('OWS')); } } } tests/ServerRequestTest.php000064400000045077144760126270012124 0ustar00 [ [ 'file' => [ 'name' => 'MyFile.txt', 'type' => 'text/plain', 'tmp_name' => '/tmp/php/php1h4j1o', 'error' => '0', 'size' => '123' ] ], [ 'file' => new UploadedFile( '/tmp/php/php1h4j1o', 123, UPLOAD_ERR_OK, 'MyFile.txt', 'text/plain' ) ] ], 'Empty file' => [ [ 'image_file' => [ 'name' => '', 'type' => '', 'tmp_name' => '', 'error' => '4', 'size' => '0' ] ], [ 'image_file' => new UploadedFile( '', 0, UPLOAD_ERR_NO_FILE, '', '' ) ] ], 'Already Converted' => [ [ 'file' => new UploadedFile( '/tmp/php/php1h4j1o', 123, UPLOAD_ERR_OK, 'MyFile.txt', 'text/plain' ) ], [ 'file' => new UploadedFile( '/tmp/php/php1h4j1o', 123, UPLOAD_ERR_OK, 'MyFile.txt', 'text/plain' ) ] ], 'Already Converted array' => [ [ 'file' => [ new UploadedFile( '/tmp/php/php1h4j1o', 123, UPLOAD_ERR_OK, 'MyFile.txt', 'text/plain' ), new UploadedFile( '', 0, UPLOAD_ERR_NO_FILE, '', '' ) ], ], [ 'file' => [ new UploadedFile( '/tmp/php/php1h4j1o', 123, UPLOAD_ERR_OK, 'MyFile.txt', 'text/plain' ), new UploadedFile( '', 0, UPLOAD_ERR_NO_FILE, '', '' ) ], ] ], 'Multiple files' => [ [ 'text_file' => [ 'name' => 'MyFile.txt', 'type' => 'text/plain', 'tmp_name' => '/tmp/php/php1h4j1o', 'error' => '0', 'size' => '123' ], 'image_file' => [ 'name' => '', 'type' => '', 'tmp_name' => '', 'error' => '4', 'size' => '0' ] ], [ 'text_file' => new UploadedFile( '/tmp/php/php1h4j1o', 123, UPLOAD_ERR_OK, 'MyFile.txt', 'text/plain' ), 'image_file' => new UploadedFile( '', 0, UPLOAD_ERR_NO_FILE, '', '' ) ] ], 'Nested files' => [ [ 'file' => [ 'name' => [ 0 => 'MyFile.txt', 1 => 'Image.png', ], 'type' => [ 0 => 'text/plain', 1 => 'image/png', ], 'tmp_name' => [ 0 => '/tmp/php/hp9hskjhf', 1 => '/tmp/php/php1h4j1o', ], 'error' => [ 0 => '0', 1 => '0', ], 'size' => [ 0 => '123', 1 => '7349', ], ], 'nested' => [ 'name' => [ 'other' => 'Flag.txt', 'test' => [ 0 => 'Stuff.txt', 1 => '', ], ], 'type' => [ 'other' => 'text/plain', 'test' => [ 0 => 'text/plain', 1 => '', ], ], 'tmp_name' => [ 'other' => '/tmp/php/hp9hskjhf', 'test' => [ 0 => '/tmp/php/asifu2gp3', 1 => '', ], ], 'error' => [ 'other' => '0', 'test' => [ 0 => '0', 1 => '4', ], ], 'size' => [ 'other' => '421', 'test' => [ 0 => '32', 1 => '0', ] ] ], ], [ 'file' => [ 0 => new UploadedFile( '/tmp/php/hp9hskjhf', 123, UPLOAD_ERR_OK, 'MyFile.txt', 'text/plain' ), 1 => new UploadedFile( '/tmp/php/php1h4j1o', 7349, UPLOAD_ERR_OK, 'Image.png', 'image/png' ), ], 'nested' => [ 'other' => new UploadedFile( '/tmp/php/hp9hskjhf', 421, UPLOAD_ERR_OK, 'Flag.txt', 'text/plain' ), 'test' => [ 0 => new UploadedFile( '/tmp/php/asifu2gp3', 32, UPLOAD_ERR_OK, 'Stuff.txt', 'text/plain' ), 1 => new UploadedFile( '', 0, UPLOAD_ERR_NO_FILE, '', '' ), ] ] ] ] ]; } /** * @dataProvider dataNormalizeFiles */ public function testNormalizeFiles($files, $expected) { $result = ServerRequest::normalizeFiles($files); $this->assertEquals($expected, $result); } public function testNormalizeFilesRaisesException() { $this->setExpectedException('InvalidArgumentException', 'Invalid value in files specification'); ServerRequest::normalizeFiles(['test' => 'something']); } public function dataGetUriFromGlobals() { $server = [ 'PHP_SELF' => '/blog/article.php', 'GATEWAY_INTERFACE' => 'CGI/1.1', 'SERVER_ADDR' => 'Server IP: 217.112.82.20', 'SERVER_NAME' => 'www.blakesimpson.co.uk', 'SERVER_SOFTWARE' => 'Apache/2.2.15 (Win32) JRun/4.0 PHP/5.2.13', 'SERVER_PROTOCOL' => 'HTTP/1.0', 'REQUEST_METHOD' => 'POST', 'REQUEST_TIME' => 'Request start time: 1280149029', 'QUERY_STRING' => 'id=10&user=foo', 'DOCUMENT_ROOT' => '/path/to/your/server/root/', 'HTTP_ACCEPT' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', 'HTTP_ACCEPT_CHARSET' => 'ISO-8859-1,utf-8;q=0.7,*;q=0.7', 'HTTP_ACCEPT_ENCODING' => 'gzip,deflate', 'HTTP_ACCEPT_LANGUAGE' => 'en-gb,en;q=0.5', 'HTTP_CONNECTION' => 'keep-alive', 'HTTP_HOST' => 'www.blakesimpson.co.uk', 'HTTP_REFERER' => 'http://previous.url.com', 'HTTP_USER_AGENT' => 'Mozilla/5.0 (Windows; U; Windows NT 6.0; en-GB; rv:1.9.2.6) Gecko/20100625 Firefox/3.6.6 ( .NET CLR 3.5.30729)', 'HTTPS' => '1', 'REMOTE_ADDR' => '193.60.168.69', 'REMOTE_HOST' => 'Client server\'s host name', 'REMOTE_PORT' => '5390', 'SCRIPT_FILENAME' => '/path/to/this/script.php', 'SERVER_ADMIN' => 'webmaster@blakesimpson.co.uk', 'SERVER_PORT' => '80', 'SERVER_SIGNATURE' => 'Version signature: 5.123', 'SCRIPT_NAME' => '/blog/article.php', 'REQUEST_URI' => '/blog/article.php?id=10&user=foo', ]; return [ 'Normal request' => [ 'http://www.blakesimpson.co.uk/blog/article.php?id=10&user=foo', $server, ], 'Secure request' => [ 'https://www.blakesimpson.co.uk/blog/article.php?id=10&user=foo', array_merge($server, ['HTTPS' => 'on', 'SERVER_PORT' => '443']), ], 'HTTP_HOST missing' => [ 'http://www.blakesimpson.co.uk/blog/article.php?id=10&user=foo', array_merge($server, ['HTTP_HOST' => null]), ], 'No query String' => [ 'http://www.blakesimpson.co.uk/blog/article.php', array_merge($server, ['REQUEST_URI' => '/blog/article.php', 'QUERY_STRING' => '']), ], 'Different port' => [ 'http://www.blakesimpson.co.uk:8324/blog/article.php?id=10&user=foo', array_merge($server, ['SERVER_PORT' => '8324']), ], 'Empty server variable' => [ '', [], ], ]; } /** * @dataProvider dataGetUriFromGlobals */ public function testGetUriFromGlobals($expected, $serverParams) { $_SERVER = $serverParams; $this->assertEquals(new Uri($expected), ServerRequest::getUriFromGlobals()); } public function testFromGlobals() { $_SERVER = [ 'PHP_SELF' => '/blog/article.php', 'GATEWAY_INTERFACE' => 'CGI/1.1', 'SERVER_ADDR' => 'Server IP: 217.112.82.20', 'SERVER_NAME' => 'www.blakesimpson.co.uk', 'SERVER_SOFTWARE' => 'Apache/2.2.15 (Win32) JRun/4.0 PHP/5.2.13', 'SERVER_PROTOCOL' => 'HTTP/1.0', 'REQUEST_METHOD' => 'POST', 'REQUEST_TIME' => 'Request start time: 1280149029', 'QUERY_STRING' => 'id=10&user=foo', 'DOCUMENT_ROOT' => '/path/to/your/server/root/', 'HTTP_ACCEPT' => 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', 'HTTP_ACCEPT_CHARSET' => 'ISO-8859-1,utf-8;q=0.7,*;q=0.7', 'HTTP_ACCEPT_ENCODING' => 'gzip,deflate', 'HTTP_ACCEPT_LANGUAGE' => 'en-gb,en;q=0.5', 'HTTP_CONNECTION' => 'keep-alive', 'HTTP_HOST' => 'www.blakesimpson.co.uk', 'HTTP_REFERER' => 'http://previous.url.com', 'HTTP_USER_AGENT' => 'Mozilla/5.0 (Windows; U; Windows NT 6.0; en-GB; rv:1.9.2.6) Gecko/20100625 Firefox/3.6.6 ( .NET CLR 3.5.30729)', 'HTTPS' => '1', 'REMOTE_ADDR' => '193.60.168.69', 'REMOTE_HOST' => 'Client server\'s host name', 'REMOTE_PORT' => '5390', 'SCRIPT_FILENAME' => '/path/to/this/script.php', 'SERVER_ADMIN' => 'webmaster@blakesimpson.co.uk', 'SERVER_PORT' => '80', 'SERVER_SIGNATURE' => 'Version signature: 5.123', 'SCRIPT_NAME' => '/blog/article.php', 'REQUEST_URI' => '/blog/article.php?id=10&user=foo', ]; $_COOKIE = [ 'logged-in' => 'yes!' ]; $_POST = [ 'name' => 'Pesho', 'email' => 'pesho@example.com', ]; $_GET = [ 'id' => 10, 'user' => 'foo', ]; $_FILES = [ 'file' => [ 'name' => 'MyFile.txt', 'type' => 'text/plain', 'tmp_name' => '/tmp/php/php1h4j1o', 'error' => UPLOAD_ERR_OK, 'size' => 123, ] ]; $server = ServerRequest::fromGlobals(); $this->assertEquals('POST', $server->getMethod()); $this->assertEquals(['Host' => ['www.blakesimpson.co.uk']], $server->getHeaders()); $this->assertEquals('', (string) $server->getBody()); $this->assertEquals('1.0', $server->getProtocolVersion()); $this->assertEquals($_COOKIE, $server->getCookieParams()); $this->assertEquals($_POST, $server->getParsedBody()); $this->assertEquals($_GET, $server->getQueryParams()); $this->assertEquals( new Uri('http://www.blakesimpson.co.uk/blog/article.php?id=10&user=foo'), $server->getUri() ); $expectedFiles = [ 'file' => new UploadedFile( '/tmp/php/php1h4j1o', 123, UPLOAD_ERR_OK, 'MyFile.txt', 'text/plain' ), ]; $this->assertEquals($expectedFiles, $server->getUploadedFiles()); } public function testUploadedFiles() { $request1 = new ServerRequest('GET', '/'); $files = [ 'file' => new UploadedFile('test', 123, UPLOAD_ERR_OK) ]; $request2 = $request1->withUploadedFiles($files); $this->assertNotSame($request2, $request1); $this->assertSame([], $request1->getUploadedFiles()); $this->assertSame($files, $request2->getUploadedFiles()); } public function testServerParams() { $params = ['name' => 'value']; $request = new ServerRequest('GET', '/', [], null, '1.1', $params); $this->assertSame($params, $request->getServerParams()); } public function testCookieParams() { $request1 = new ServerRequest('GET', '/'); $params = ['name' => 'value']; $request2 = $request1->withCookieParams($params); $this->assertNotSame($request2, $request1); $this->assertEmpty($request1->getCookieParams()); $this->assertSame($params, $request2->getCookieParams()); } public function testQueryParams() { $request1 = new ServerRequest('GET', '/'); $params = ['name' => 'value']; $request2 = $request1->withQueryParams($params); $this->assertNotSame($request2, $request1); $this->assertEmpty($request1->getQueryParams()); $this->assertSame($params, $request2->getQueryParams()); } public function testParsedBody() { $request1 = new ServerRequest('GET', '/'); $params = ['name' => 'value']; $request2 = $request1->withParsedBody($params); $this->assertNotSame($request2, $request1); $this->assertEmpty($request1->getParsedBody()); $this->assertSame($params, $request2->getParsedBody()); } public function testAttributes() { $request1 = new ServerRequest('GET', '/'); $request2 = $request1->withAttribute('name', 'value'); $request3 = $request2->withAttribute('other', 'otherValue'); $request4 = $request3->withoutAttribute('other'); $request5 = $request3->withoutAttribute('unknown'); $this->assertNotSame($request2, $request1); $this->assertNotSame($request3, $request2); $this->assertNotSame($request4, $request3); $this->assertNotSame($request5, $request4); $this->assertEmpty($request1->getAttributes()); $this->assertEmpty($request1->getAttribute('name')); $this->assertEquals( 'something', $request1->getAttribute('name', 'something'), 'Should return the default value' ); $this->assertEquals('value', $request2->getAttribute('name')); $this->assertEquals(['name' => 'value'], $request2->getAttributes()); $this->assertEquals(['name' => 'value', 'other' => 'otherValue'], $request3->getAttributes()); $this->assertEquals(['name' => 'value'], $request4->getAttributes()); } public function testNullAttribute() { $request = (new ServerRequest('GET', '/'))->withAttribute('name', null); $this->assertSame(['name' => null], $request->getAttributes()); $this->assertNull($request->getAttribute('name', 'different-default')); $requestWithoutAttribute = $request->withoutAttribute('name'); $this->assertSame([], $requestWithoutAttribute->getAttributes()); $this->assertSame('different-default', $requestWithoutAttribute->getAttribute('name', 'different-default')); } } tests/StreamDecoratorTraitTest.php000064400000006727144760126270013406 0ustar00c = fopen('php://temp', 'r+'); fwrite($this->c, 'foo'); fseek($this->c, 0); $this->a = Psr7\stream_for($this->c); $this->b = new Str($this->a); } public function testCatchesExceptionsWhenCastingToString() { $s = $this->getMockBuilder('Psr\Http\Message\StreamInterface') ->setMethods(['read']) ->getMockForAbstractClass(); $s->expects($this->once()) ->method('read') ->will($this->throwException(new \Exception('foo'))); $msg = ''; set_error_handler(function ($errNo, $str) use (&$msg) { $msg = $str; }); echo new Str($s); restore_error_handler(); $this->assertContains('foo', $msg); } public function testToString() { $this->assertEquals('foo', (string) $this->b); } public function testHasSize() { $this->assertEquals(3, $this->b->getSize()); } public function testReads() { $this->assertEquals('foo', $this->b->read(10)); } public function testCheckMethods() { $this->assertEquals($this->a->isReadable(), $this->b->isReadable()); $this->assertEquals($this->a->isWritable(), $this->b->isWritable()); $this->assertEquals($this->a->isSeekable(), $this->b->isSeekable()); } public function testSeeksAndTells() { $this->b->seek(1); $this->assertEquals(1, $this->a->tell()); $this->assertEquals(1, $this->b->tell()); $this->b->seek(0); $this->assertEquals(0, $this->a->tell()); $this->assertEquals(0, $this->b->tell()); $this->b->seek(0, SEEK_END); $this->assertEquals(3, $this->a->tell()); $this->assertEquals(3, $this->b->tell()); } public function testGetsContents() { $this->assertEquals('foo', $this->b->getContents()); $this->assertEquals('', $this->b->getContents()); $this->b->seek(1); $this->assertEquals('oo', $this->b->getContents(1)); } public function testCloses() { $this->b->close(); $this->assertFalse(is_resource($this->c)); } public function testDetaches() { $this->b->detach(); $this->assertFalse($this->b->isReadable()); } public function testWrapsMetadata() { $this->assertSame($this->b->getMetadata(), $this->a->getMetadata()); $this->assertSame($this->b->getMetadata('uri'), $this->a->getMetadata('uri')); } public function testWrapsWrites() { $this->b->seek(0, SEEK_END); $this->b->write('foo'); $this->assertEquals('foofoo', (string) $this->a); } /** * @expectedException \UnexpectedValueException */ public function testThrowsWithInvalidGetter() { $this->b->foo; } /** * @expectedException \BadMethodCallException */ public function testThrowsWhenGetterNotImplemented() { $s = new BadStream(); $s->stream; } } class BadStream { use StreamDecoratorTrait; public function __construct() {} } tests/StreamTest.php000064400000012005144760126270010521 0ustar00assertTrue($stream->isReadable()); $this->assertTrue($stream->isWritable()); $this->assertTrue($stream->isSeekable()); $this->assertEquals('php://temp', $stream->getMetadata('uri')); $this->assertInternalType('array', $stream->getMetadata()); $this->assertEquals(4, $stream->getSize()); $this->assertFalse($stream->eof()); $stream->close(); } public function testStreamClosesHandleOnDestruct() { $handle = fopen('php://temp', 'r'); $stream = new Stream($handle); unset($stream); $this->assertFalse(is_resource($handle)); } public function testConvertsToString() { $handle = fopen('php://temp', 'w+'); fwrite($handle, 'data'); $stream = new Stream($handle); $this->assertEquals('data', (string) $stream); $this->assertEquals('data', (string) $stream); $stream->close(); } public function testGetsContents() { $handle = fopen('php://temp', 'w+'); fwrite($handle, 'data'); $stream = new Stream($handle); $this->assertEquals('', $stream->getContents()); $stream->seek(0); $this->assertEquals('data', $stream->getContents()); $this->assertEquals('', $stream->getContents()); } public function testChecksEof() { $handle = fopen('php://temp', 'w+'); fwrite($handle, 'data'); $stream = new Stream($handle); $this->assertFalse($stream->eof()); $stream->read(4); $this->assertTrue($stream->eof()); $stream->close(); } public function testGetSize() { $size = filesize(__FILE__); $handle = fopen(__FILE__, 'r'); $stream = new Stream($handle); $this->assertEquals($size, $stream->getSize()); // Load from cache $this->assertEquals($size, $stream->getSize()); $stream->close(); } public function testEnsuresSizeIsConsistent() { $h = fopen('php://temp', 'w+'); $this->assertEquals(3, fwrite($h, 'foo')); $stream = new Stream($h); $this->assertEquals(3, $stream->getSize()); $this->assertEquals(4, $stream->write('test')); $this->assertEquals(7, $stream->getSize()); $this->assertEquals(7, $stream->getSize()); $stream->close(); } public function testProvidesStreamPosition() { $handle = fopen('php://temp', 'w+'); $stream = new Stream($handle); $this->assertEquals(0, $stream->tell()); $stream->write('foo'); $this->assertEquals(3, $stream->tell()); $stream->seek(1); $this->assertEquals(1, $stream->tell()); $this->assertSame(ftell($handle), $stream->tell()); $stream->close(); } public function testCanDetachStream() { $r = fopen('php://temp', 'w+'); $stream = new Stream($r); $stream->write('foo'); $this->assertTrue($stream->isReadable()); $this->assertSame($r, $stream->detach()); $stream->detach(); $this->assertFalse($stream->isReadable()); $this->assertFalse($stream->isWritable()); $this->assertFalse($stream->isSeekable()); $throws = function (callable $fn) use ($stream) { try { $fn($stream); $this->fail(); } catch (\Exception $e) {} }; $throws(function ($stream) { $stream->read(10); }); $throws(function ($stream) { $stream->write('bar'); }); $throws(function ($stream) { $stream->seek(10); }); $throws(function ($stream) { $stream->tell(); }); $throws(function ($stream) { $stream->eof(); }); $throws(function ($stream) { $stream->getSize(); }); $throws(function ($stream) { $stream->getContents(); }); $this->assertSame('', (string) $stream); $stream->close(); } public function testCloseClearProperties() { $handle = fopen('php://temp', 'r+'); $stream = new Stream($handle); $stream->close(); $this->assertFalse($stream->isSeekable()); $this->assertFalse($stream->isReadable()); $this->assertFalse($stream->isWritable()); $this->assertNull($stream->getSize()); $this->assertEmpty($stream->getMetadata()); } public function testDoesNotThrowInToString() { $s = \GuzzleHttp\Psr7\stream_for('foo'); $s = new NoSeekStream($s); $this->assertEquals('foo', (string) $s); } } tests/StreamWrapperTest.php000064400000006317144760126270012073 0ustar00assertSame('foo', fread($handle, 3)); $this->assertSame(3, ftell($handle)); $this->assertSame(3, fwrite($handle, 'bar')); $this->assertSame(0, fseek($handle, 0)); $this->assertSame('foobar', fread($handle, 6)); $this->assertSame('', fread($handle, 1)); $this->assertTrue(feof($handle)); $stBlksize = defined('PHP_WINDOWS_VERSION_BUILD') ? -1 : 0; // This fails on HHVM for some reason if (!defined('HHVM_VERSION')) { $this->assertEquals([ 'dev' => 0, 'ino' => 0, 'mode' => 33206, 'nlink' => 0, 'uid' => 0, 'gid' => 0, 'rdev' => 0, 'size' => 6, 'atime' => 0, 'mtime' => 0, 'ctime' => 0, 'blksize' => $stBlksize, 'blocks' => $stBlksize, 0 => 0, 1 => 0, 2 => 33206, 3 => 0, 4 => 0, 5 => 0, 6 => 0, 7 => 6, 8 => 0, 9 => 0, 10 => 0, 11 => $stBlksize, 12 => $stBlksize, ], fstat($handle)); } $this->assertTrue(fclose($handle)); $this->assertSame('foobar', (string) $stream); } /** * @expectedException \InvalidArgumentException */ public function testValidatesStream() { $stream = $this->getMockBuilder('Psr\Http\Message\StreamInterface') ->setMethods(['isReadable', 'isWritable']) ->getMockForAbstractClass(); $stream->expects($this->once()) ->method('isReadable') ->will($this->returnValue(false)); $stream->expects($this->once()) ->method('isWritable') ->will($this->returnValue(false)); StreamWrapper::getResource($stream); } /** * @expectedException \PHPUnit_Framework_Error_Warning */ public function testReturnsFalseWhenStreamDoesNotExist() { fopen('guzzle://foo', 'r'); } public function testCanOpenReadonlyStream() { $stream = $this->getMockBuilder('Psr\Http\Message\StreamInterface') ->setMethods(['isReadable', 'isWritable']) ->getMockForAbstractClass(); $stream->expects($this->once()) ->method('isReadable') ->will($this->returnValue(false)); $stream->expects($this->once()) ->method('isWritable') ->will($this->returnValue(true)); $r = StreamWrapper::getResource($stream); $this->assertInternalType('resource', $r); fclose($r); } } tests/UploadedFileTest.php000064400000020415144760126270011627 0ustar00cleanup = []; } public function tearDown() { foreach ($this->cleanup as $file) { if (is_scalar($file) && file_exists($file)) { unlink($file); } } } public function invalidStreams() { return [ 'null' => [null], 'true' => [true], 'false' => [false], 'int' => [1], 'float' => [1.1], 'array' => [['filename']], 'object' => [(object) ['filename']], ]; } /** * @dataProvider invalidStreams */ public function testRaisesExceptionOnInvalidStreamOrFile($streamOrFile) { $this->setExpectedException('InvalidArgumentException'); new UploadedFile($streamOrFile, 0, UPLOAD_ERR_OK); } public function invalidSizes() { return [ 'null' => [null], 'float' => [1.1], 'array' => [[1]], 'object' => [(object) [1]], ]; } /** * @dataProvider invalidSizes */ public function testRaisesExceptionOnInvalidSize($size) { $this->setExpectedException('InvalidArgumentException', 'size'); new UploadedFile(fopen('php://temp', 'wb+'), $size, UPLOAD_ERR_OK); } public function invalidErrorStatuses() { return [ 'null' => [null], 'true' => [true], 'false' => [false], 'float' => [1.1], 'string' => ['1'], 'array' => [[1]], 'object' => [(object) [1]], 'negative' => [-1], 'too-big' => [9], ]; } /** * @dataProvider invalidErrorStatuses */ public function testRaisesExceptionOnInvalidErrorStatus($status) { $this->setExpectedException('InvalidArgumentException', 'status'); new UploadedFile(fopen('php://temp', 'wb+'), 0, $status); } public function invalidFilenamesAndMediaTypes() { return [ 'true' => [true], 'false' => [false], 'int' => [1], 'float' => [1.1], 'array' => [['string']], 'object' => [(object) ['string']], ]; } /** * @dataProvider invalidFilenamesAndMediaTypes */ public function testRaisesExceptionOnInvalidClientFilename($filename) { $this->setExpectedException('InvalidArgumentException', 'filename'); new UploadedFile(fopen('php://temp', 'wb+'), 0, UPLOAD_ERR_OK, $filename); } /** * @dataProvider invalidFilenamesAndMediaTypes */ public function testRaisesExceptionOnInvalidClientMediaType($mediaType) { $this->setExpectedException('InvalidArgumentException', 'media type'); new UploadedFile(fopen('php://temp', 'wb+'), 0, UPLOAD_ERR_OK, 'foobar.baz', $mediaType); } public function testGetStreamReturnsOriginalStreamObject() { $stream = new Stream(fopen('php://temp', 'r')); $upload = new UploadedFile($stream, 0, UPLOAD_ERR_OK); $this->assertSame($stream, $upload->getStream()); } public function testGetStreamReturnsWrappedPhpStream() { $stream = fopen('php://temp', 'wb+'); $upload = new UploadedFile($stream, 0, UPLOAD_ERR_OK); $uploadStream = $upload->getStream()->detach(); $this->assertSame($stream, $uploadStream); } public function testGetStreamReturnsStreamForFile() { $this->cleanup[] = $stream = tempnam(sys_get_temp_dir(), 'stream_file'); $upload = new UploadedFile($stream, 0, UPLOAD_ERR_OK); $uploadStream = $upload->getStream(); $r = new ReflectionProperty($uploadStream, 'filename'); $r->setAccessible(true); $this->assertSame($stream, $r->getValue($uploadStream)); } public function testSuccessful() { $stream = \GuzzleHttp\Psr7\stream_for('Foo bar!'); $upload = new UploadedFile($stream, $stream->getSize(), UPLOAD_ERR_OK, 'filename.txt', 'text/plain'); $this->assertEquals($stream->getSize(), $upload->getSize()); $this->assertEquals('filename.txt', $upload->getClientFilename()); $this->assertEquals('text/plain', $upload->getClientMediaType()); $this->cleanup[] = $to = tempnam(sys_get_temp_dir(), 'successful'); $upload->moveTo($to); $this->assertFileExists($to); $this->assertEquals($stream->__toString(), file_get_contents($to)); } public function invalidMovePaths() { return [ 'null' => [null], 'true' => [true], 'false' => [false], 'int' => [1], 'float' => [1.1], 'empty' => [''], 'array' => [['filename']], 'object' => [(object) ['filename']], ]; } /** * @dataProvider invalidMovePaths */ public function testMoveRaisesExceptionForInvalidPath($path) { $stream = \GuzzleHttp\Psr7\stream_for('Foo bar!'); $upload = new UploadedFile($stream, 0, UPLOAD_ERR_OK); $this->cleanup[] = $path; $this->setExpectedException('InvalidArgumentException', 'path'); $upload->moveTo($path); } public function testMoveCannotBeCalledMoreThanOnce() { $stream = \GuzzleHttp\Psr7\stream_for('Foo bar!'); $upload = new UploadedFile($stream, 0, UPLOAD_ERR_OK); $this->cleanup[] = $to = tempnam(sys_get_temp_dir(), 'diac'); $upload->moveTo($to); $this->assertTrue(file_exists($to)); $this->setExpectedException('RuntimeException', 'moved'); $upload->moveTo($to); } public function testCannotRetrieveStreamAfterMove() { $stream = \GuzzleHttp\Psr7\stream_for('Foo bar!'); $upload = new UploadedFile($stream, 0, UPLOAD_ERR_OK); $this->cleanup[] = $to = tempnam(sys_get_temp_dir(), 'diac'); $upload->moveTo($to); $this->assertFileExists($to); $this->setExpectedException('RuntimeException', 'moved'); $upload->getStream(); } public function nonOkErrorStatus() { return [ 'UPLOAD_ERR_INI_SIZE' => [ UPLOAD_ERR_INI_SIZE ], 'UPLOAD_ERR_FORM_SIZE' => [ UPLOAD_ERR_FORM_SIZE ], 'UPLOAD_ERR_PARTIAL' => [ UPLOAD_ERR_PARTIAL ], 'UPLOAD_ERR_NO_FILE' => [ UPLOAD_ERR_NO_FILE ], 'UPLOAD_ERR_NO_TMP_DIR' => [ UPLOAD_ERR_NO_TMP_DIR ], 'UPLOAD_ERR_CANT_WRITE' => [ UPLOAD_ERR_CANT_WRITE ], 'UPLOAD_ERR_EXTENSION' => [ UPLOAD_ERR_EXTENSION ], ]; } /** * @dataProvider nonOkErrorStatus */ public function testConstructorDoesNotRaiseExceptionForInvalidStreamWhenErrorStatusPresent($status) { $uploadedFile = new UploadedFile('not ok', 0, $status); $this->assertSame($status, $uploadedFile->getError()); } /** * @dataProvider nonOkErrorStatus */ public function testMoveToRaisesExceptionWhenErrorStatusPresent($status) { $uploadedFile = new UploadedFile('not ok', 0, $status); $this->setExpectedException('RuntimeException', 'upload error'); $uploadedFile->moveTo(__DIR__ . '/' . uniqid()); } /** * @dataProvider nonOkErrorStatus */ public function testGetStreamRaisesExceptionWhenErrorStatusPresent($status) { $uploadedFile = new UploadedFile('not ok', 0, $status); $this->setExpectedException('RuntimeException', 'upload error'); $stream = $uploadedFile->getStream(); } public function testMoveToCreatesStreamIfOnlyAFilenameWasProvided() { $this->cleanup[] = $from = tempnam(sys_get_temp_dir(), 'copy_from'); $this->cleanup[] = $to = tempnam(sys_get_temp_dir(), 'copy_to'); copy(__FILE__, $from); $uploadedFile = new UploadedFile($from, 100, UPLOAD_ERR_OK, basename($from), 'text/plain'); $uploadedFile->moveTo($to); $this->assertFileEquals(__FILE__, $to); } } tests/UriTest.php000064400000052467144760126270010045 0ustar00assertSame('https', $uri->getScheme()); $this->assertSame('user:pass@example.com:8080', $uri->getAuthority()); $this->assertSame('user:pass', $uri->getUserInfo()); $this->assertSame('example.com', $uri->getHost()); $this->assertSame(8080, $uri->getPort()); $this->assertSame('/path/123', $uri->getPath()); $this->assertSame('q=abc', $uri->getQuery()); $this->assertSame('test', $uri->getFragment()); $this->assertSame('https://user:pass@example.com:8080/path/123?q=abc#test', (string) $uri); } public function testCanTransformAndRetrievePartsIndividually() { $uri = (new Uri()) ->withScheme('https') ->withUserInfo('user', 'pass') ->withHost('example.com') ->withPort(8080) ->withPath('/path/123') ->withQuery('q=abc') ->withFragment('test'); $this->assertSame('https', $uri->getScheme()); $this->assertSame('user:pass@example.com:8080', $uri->getAuthority()); $this->assertSame('user:pass', $uri->getUserInfo()); $this->assertSame('example.com', $uri->getHost()); $this->assertSame(8080, $uri->getPort()); $this->assertSame('/path/123', $uri->getPath()); $this->assertSame('q=abc', $uri->getQuery()); $this->assertSame('test', $uri->getFragment()); $this->assertSame('https://user:pass@example.com:8080/path/123?q=abc#test', (string) $uri); } /** * @dataProvider getValidUris */ public function testValidUrisStayValid($input) { $uri = new Uri($input); $this->assertSame($input, (string) $uri); } /** * @dataProvider getValidUris */ public function testFromParts($input) { $uri = Uri::fromParts(parse_url($input)); $this->assertSame($input, (string) $uri); } public function getValidUris() { return [ ['urn:path-rootless'], ['urn:path:with:colon'], ['urn:/path-absolute'], ['urn:/'], // only scheme with empty path ['urn:'], // only path ['/'], ['relative/'], ['0'], // same document reference [''], // network path without scheme ['//example.org'], ['//example.org/'], ['//example.org?q#h'], // only query ['?q'], ['?q=abc&foo=bar'], // only fragment ['#fragment'], // dot segments are not removed automatically ['./foo/../bar'], ]; } /** * @expectedException \InvalidArgumentException * @expectedExceptionMessage Unable to parse URI * @dataProvider getInvalidUris */ public function testInvalidUrisThrowException($invalidUri) { new Uri($invalidUri); } public function getInvalidUris() { return [ // parse_url() requires the host component which makes sense for http(s) // but not when the scheme is not known or different. So '//' or '///' is // currently invalid as well but should not according to RFC 3986. ['http://'], ['urn://host:with:colon'], // host cannot contain ":" ]; } /** * @expectedException \InvalidArgumentException * @expectedExceptionMessage Invalid port: 100000. Must be between 1 and 65535 */ public function testPortMustBeValid() { (new Uri())->withPort(100000); } /** * @expectedException \InvalidArgumentException * @expectedExceptionMessage Invalid port: 0. Must be between 1 and 65535 */ public function testWithPortCannotBeZero() { (new Uri())->withPort(0); } /** * @expectedException \InvalidArgumentException * @expectedExceptionMessage Unable to parse URI */ public function testParseUriPortCannotBeZero() { new Uri('//example.com:0'); } /** * @expectedException \InvalidArgumentException */ public function testSchemeMustHaveCorrectType() { (new Uri())->withScheme([]); } /** * @expectedException \InvalidArgumentException */ public function testHostMustHaveCorrectType() { (new Uri())->withHost([]); } /** * @expectedException \InvalidArgumentException */ public function testPathMustHaveCorrectType() { (new Uri())->withPath([]); } /** * @expectedException \InvalidArgumentException */ public function testQueryMustHaveCorrectType() { (new Uri())->withQuery([]); } /** * @expectedException \InvalidArgumentException */ public function testFragmentMustHaveCorrectType() { (new Uri())->withFragment([]); } public function testCanParseFalseyUriParts() { $uri = new Uri('0://0:0@0/0?0#0'); $this->assertSame('0', $uri->getScheme()); $this->assertSame('0:0@0', $uri->getAuthority()); $this->assertSame('0:0', $uri->getUserInfo()); $this->assertSame('0', $uri->getHost()); $this->assertSame('/0', $uri->getPath()); $this->assertSame('0', $uri->getQuery()); $this->assertSame('0', $uri->getFragment()); $this->assertSame('0://0:0@0/0?0#0', (string) $uri); } public function testCanConstructFalseyUriParts() { $uri = (new Uri()) ->withScheme('0') ->withUserInfo('0', '0') ->withHost('0') ->withPath('/0') ->withQuery('0') ->withFragment('0'); $this->assertSame('0', $uri->getScheme()); $this->assertSame('0:0@0', $uri->getAuthority()); $this->assertSame('0:0', $uri->getUserInfo()); $this->assertSame('0', $uri->getHost()); $this->assertSame('/0', $uri->getPath()); $this->assertSame('0', $uri->getQuery()); $this->assertSame('0', $uri->getFragment()); $this->assertSame('0://0:0@0/0?0#0', (string) $uri); } /** * @dataProvider getResolveTestCases */ public function testResolvesUris($base, $rel, $expected) { $uri = new Uri($base); $actual = Uri::resolve($uri, $rel); $this->assertSame($expected, (string) $actual); } public function getResolveTestCases() { return [ [self::RFC3986_BASE, 'g:h', 'g:h'], [self::RFC3986_BASE, 'g', 'http://a/b/c/g'], [self::RFC3986_BASE, './g', 'http://a/b/c/g'], [self::RFC3986_BASE, 'g/', 'http://a/b/c/g/'], [self::RFC3986_BASE, '/g', 'http://a/g'], [self::RFC3986_BASE, '//g', 'http://g'], [self::RFC3986_BASE, '?y', 'http://a/b/c/d;p?y'], [self::RFC3986_BASE, 'g?y', 'http://a/b/c/g?y'], [self::RFC3986_BASE, '#s', 'http://a/b/c/d;p?q#s'], [self::RFC3986_BASE, 'g#s', 'http://a/b/c/g#s'], [self::RFC3986_BASE, 'g?y#s', 'http://a/b/c/g?y#s'], [self::RFC3986_BASE, ';x', 'http://a/b/c/;x'], [self::RFC3986_BASE, 'g;x', 'http://a/b/c/g;x'], [self::RFC3986_BASE, 'g;x?y#s', 'http://a/b/c/g;x?y#s'], [self::RFC3986_BASE, '', self::RFC3986_BASE], [self::RFC3986_BASE, '.', 'http://a/b/c/'], [self::RFC3986_BASE, './', 'http://a/b/c/'], [self::RFC3986_BASE, '..', 'http://a/b/'], [self::RFC3986_BASE, '../', 'http://a/b/'], [self::RFC3986_BASE, '../g', 'http://a/b/g'], [self::RFC3986_BASE, '../..', 'http://a/'], [self::RFC3986_BASE, '../../', 'http://a/'], [self::RFC3986_BASE, '../../g', 'http://a/g'], [self::RFC3986_BASE, '../../../g', 'http://a/g'], [self::RFC3986_BASE, '../../../../g', 'http://a/g'], [self::RFC3986_BASE, '/./g', 'http://a/g'], [self::RFC3986_BASE, '/../g', 'http://a/g'], [self::RFC3986_BASE, 'g.', 'http://a/b/c/g.'], [self::RFC3986_BASE, '.g', 'http://a/b/c/.g'], [self::RFC3986_BASE, 'g..', 'http://a/b/c/g..'], [self::RFC3986_BASE, '..g', 'http://a/b/c/..g'], [self::RFC3986_BASE, './../g', 'http://a/b/g'], [self::RFC3986_BASE, 'foo////g', 'http://a/b/c/foo////g'], [self::RFC3986_BASE, './g/.', 'http://a/b/c/g/'], [self::RFC3986_BASE, 'g/./h', 'http://a/b/c/g/h'], [self::RFC3986_BASE, 'g/../h', 'http://a/b/c/h'], [self::RFC3986_BASE, 'g;x=1/./y', 'http://a/b/c/g;x=1/y'], [self::RFC3986_BASE, 'g;x=1/../y', 'http://a/b/c/y'], // dot-segments in the query or fragment [self::RFC3986_BASE, 'g?y/./x', 'http://a/b/c/g?y/./x'], [self::RFC3986_BASE, 'g?y/../x', 'http://a/b/c/g?y/../x'], [self::RFC3986_BASE, 'g#s/./x', 'http://a/b/c/g#s/./x'], [self::RFC3986_BASE, 'g#s/../x', 'http://a/b/c/g#s/../x'], [self::RFC3986_BASE, 'g#s/../x', 'http://a/b/c/g#s/../x'], [self::RFC3986_BASE, '?y#s', 'http://a/b/c/d;p?y#s'], ['http://a/b/c/d;p?q#s', '?y', 'http://a/b/c/d;p?y'], ['http://u@a/b/c/d;p?q', '.', 'http://u@a/b/c/'], ['http://u:p@a/b/c/d;p?q', '.', 'http://u:p@a/b/c/'], ['http://a/b/c/d/', 'e', 'http://a/b/c/d/e'], ['urn:no-slash', 'e', 'urn:e'], // falsey relative parts [self::RFC3986_BASE, '//0', 'http://0'], [self::RFC3986_BASE, '0', 'http://a/b/c/0'], [self::RFC3986_BASE, '?0', 'http://a/b/c/d;p?0'], [self::RFC3986_BASE, '#0', 'http://a/b/c/d;p?q#0'], ]; } public function testAddAndRemoveQueryValues() { $uri = new Uri(); $uri = Uri::withQueryValue($uri, 'a', 'b'); $uri = Uri::withQueryValue($uri, 'c', 'd'); $uri = Uri::withQueryValue($uri, 'e', null); $this->assertSame('a=b&c=d&e', $uri->getQuery()); $uri = Uri::withoutQueryValue($uri, 'c'); $this->assertSame('a=b&e', $uri->getQuery()); $uri = Uri::withoutQueryValue($uri, 'e'); $this->assertSame('a=b', $uri->getQuery()); $uri = Uri::withoutQueryValue($uri, 'a'); $this->assertSame('', $uri->getQuery()); } public function testWithQueryValueReplacesSameKeys() { $uri = new Uri(); $uri = Uri::withQueryValue($uri, 'a', 'b'); $uri = Uri::withQueryValue($uri, 'c', 'd'); $uri = Uri::withQueryValue($uri, 'a', 'e'); $this->assertSame('c=d&a=e', $uri->getQuery()); } public function testWithoutQueryValueRemovesAllSameKeys() { $uri = (new Uri())->withQuery('a=b&c=d&a=e'); $uri = Uri::withoutQueryValue($uri, 'a'); $this->assertSame('c=d', $uri->getQuery()); } public function testRemoveNonExistingQueryValue() { $uri = new Uri(); $uri = Uri::withQueryValue($uri, 'a', 'b'); $uri = Uri::withoutQueryValue($uri, 'c'); $this->assertSame('a=b', $uri->getQuery()); } public function testWithQueryValueHandlesEncoding() { $uri = new Uri(); $uri = Uri::withQueryValue($uri, 'E=mc^2', 'ein&stein'); $this->assertSame('E%3Dmc%5E2=ein%26stein', $uri->getQuery(), 'Decoded key/value get encoded'); $uri = new Uri(); $uri = Uri::withQueryValue($uri, 'E%3Dmc%5e2', 'ein%26stein'); $this->assertSame('E%3Dmc%5e2=ein%26stein', $uri->getQuery(), 'Encoded key/value do not get double-encoded'); } public function testWithoutQueryValueHandlesEncoding() { // It also tests that the case of the percent-encoding does not matter, // i.e. both lowercase "%3d" and uppercase "%5E" can be removed. $uri = (new Uri())->withQuery('E%3dmc%5E2=einstein&foo=bar'); $uri = Uri::withoutQueryValue($uri, 'E=mc^2'); $this->assertSame('foo=bar', $uri->getQuery(), 'Handles key in decoded form'); $uri = (new Uri())->withQuery('E%3dmc%5E2=einstein&foo=bar'); $uri = Uri::withoutQueryValue($uri, 'E%3Dmc%5e2'); $this->assertSame('foo=bar', $uri->getQuery(), 'Handles key in encoded form'); } public function testSchemeIsNormalizedToLowercase() { $uri = new Uri('HTTP://example.com'); $this->assertSame('http', $uri->getScheme()); $this->assertSame('http://example.com', (string) $uri); $uri = (new Uri('//example.com'))->withScheme('HTTP'); $this->assertSame('http', $uri->getScheme()); $this->assertSame('http://example.com', (string) $uri); } public function testHostIsNormalizedToLowercase() { $uri = new Uri('//eXaMpLe.CoM'); $this->assertSame('example.com', $uri->getHost()); $this->assertSame('//example.com', (string) $uri); $uri = (new Uri())->withHost('eXaMpLe.CoM'); $this->assertSame('example.com', $uri->getHost()); $this->assertSame('//example.com', (string) $uri); } public function testPortIsNullIfStandardPortForScheme() { // HTTPS standard port $uri = new Uri('https://example.com:443'); $this->assertNull($uri->getPort()); $this->assertSame('example.com', $uri->getAuthority()); $uri = (new Uri('https://example.com'))->withPort(443); $this->assertNull($uri->getPort()); $this->assertSame('example.com', $uri->getAuthority()); // HTTP standard port $uri = new Uri('http://example.com:80'); $this->assertNull($uri->getPort()); $this->assertSame('example.com', $uri->getAuthority()); $uri = (new Uri('http://example.com'))->withPort(80); $this->assertNull($uri->getPort()); $this->assertSame('example.com', $uri->getAuthority()); } public function testPortIsReturnedIfSchemeUnknown() { $uri = (new Uri('//example.com'))->withPort(80); $this->assertSame(80, $uri->getPort()); $this->assertSame('example.com:80', $uri->getAuthority()); } public function testStandardPortIsNullIfSchemeChanges() { $uri = new Uri('http://example.com:443'); $this->assertSame('http', $uri->getScheme()); $this->assertSame(443, $uri->getPort()); $uri = $uri->withScheme('https'); $this->assertNull($uri->getPort()); } public function testPortPassedAsStringIsCastedToInt() { $uri = (new Uri('//example.com'))->withPort('8080'); $this->assertSame(8080, $uri->getPort(), 'Port is returned as integer'); $this->assertSame('example.com:8080', $uri->getAuthority()); } public function testPortCanBeRemoved() { $uri = (new Uri('http://example.com:8080'))->withPort(null); $this->assertNull($uri->getPort()); $this->assertSame('http://example.com', (string) $uri); } public function testAuthorityWithUserInfoButWithoutHost() { $uri = (new Uri())->withUserInfo('user', 'pass'); $this->assertSame('user:pass', $uri->getUserInfo()); $this->assertSame('', $uri->getAuthority()); } public function uriComponentsEncodingProvider() { $unreserved = 'a-zA-Z0-9.-_~!$&\'()*+,;=:@'; return [ // Percent encode spaces ['/pa th?q=va lue#frag ment', '/pa%20th', 'q=va%20lue', 'frag%20ment', '/pa%20th?q=va%20lue#frag%20ment'], // Percent encode multibyte ['/€?€#€', '/%E2%82%AC', '%E2%82%AC', '%E2%82%AC', '/%E2%82%AC?%E2%82%AC#%E2%82%AC'], // Don't encode something that's already encoded ['/pa%20th?q=va%20lue#frag%20ment', '/pa%20th', 'q=va%20lue', 'frag%20ment', '/pa%20th?q=va%20lue#frag%20ment'], // Percent encode invalid percent encodings ['/pa%2-th?q=va%2-lue#frag%2-ment', '/pa%252-th', 'q=va%252-lue', 'frag%252-ment', '/pa%252-th?q=va%252-lue#frag%252-ment'], // Don't encode path segments ['/pa/th//two?q=va/lue#frag/ment', '/pa/th//two', 'q=va/lue', 'frag/ment', '/pa/th//two?q=va/lue#frag/ment'], // Don't encode unreserved chars or sub-delimiters ["/$unreserved?$unreserved#$unreserved", "/$unreserved", $unreserved, $unreserved, "/$unreserved?$unreserved#$unreserved"], // Encoded unreserved chars are not decoded ['/p%61th?q=v%61lue#fr%61gment', '/p%61th', 'q=v%61lue', 'fr%61gment', '/p%61th?q=v%61lue#fr%61gment'], ]; } /** * @dataProvider uriComponentsEncodingProvider */ public function testUriComponentsGetEncodedProperly($input, $path, $query, $fragment, $output) { $uri = new Uri($input); $this->assertSame($path, $uri->getPath()); $this->assertSame($query, $uri->getQuery()); $this->assertSame($fragment, $uri->getFragment()); $this->assertSame($output, (string) $uri); } public function testWithPathEncodesProperly() { $uri = (new Uri())->withPath('/baz?#€/b%61r'); // Query and fragment delimiters and multibyte chars are encoded. $this->assertSame('/baz%3F%23%E2%82%AC/b%61r', $uri->getPath()); $this->assertSame('/baz%3F%23%E2%82%AC/b%61r', (string) $uri); } public function testWithQueryEncodesProperly() { $uri = (new Uri())->withQuery('?=#&€=/&b%61r'); // A query starting with a "?" is valid and must not be magically removed. Otherwise it would be impossible to // construct such an URI. Also the "?" and "/" does not need to be encoded in the query. $this->assertSame('?=%23&%E2%82%AC=/&b%61r', $uri->getQuery()); $this->assertSame('??=%23&%E2%82%AC=/&b%61r', (string) $uri); } public function testWithFragmentEncodesProperly() { $uri = (new Uri())->withFragment('#€?/b%61r'); // A fragment starting with a "#" is valid and must not be magically removed. Otherwise it would be impossible to // construct such an URI. Also the "?" and "/" does not need to be encoded in the fragment. $this->assertSame('%23%E2%82%AC?/b%61r', $uri->getFragment()); $this->assertSame('#%23%E2%82%AC?/b%61r', (string) $uri); } public function testAllowsForRelativeUri() { $uri = (new Uri)->withPath('foo'); $this->assertSame('foo', $uri->getPath()); $this->assertSame('foo', (string) $uri); } public function testAddsSlashForRelativeUriStringWithHost() { // If the path is rootless and an authority is present, the path MUST // be prefixed by "/". $uri = (new Uri)->withPath('foo')->withHost('example.com'); $this->assertSame('foo', $uri->getPath()); // concatenating a relative path with a host doesn't work: "//example.comfoo" would be wrong $this->assertSame('//example.com/foo', (string) $uri); } public function testRemoveExtraSlashesWihoutHost() { // If the path is starting with more than one "/" and no authority is // present, the starting slashes MUST be reduced to one. $uri = (new Uri)->withPath('//foo'); $this->assertSame('//foo', $uri->getPath()); // URI "//foo" would be interpreted as network reference and thus change the original path to the host $this->assertSame('/foo', (string) $uri); } public function testDefaultReturnValuesOfGetters() { $uri = new Uri(); $this->assertSame('', $uri->getScheme()); $this->assertSame('', $uri->getAuthority()); $this->assertSame('', $uri->getUserInfo()); $this->assertSame('', $uri->getHost()); $this->assertNull($uri->getPort()); $this->assertSame('', $uri->getPath()); $this->assertSame('', $uri->getQuery()); $this->assertSame('', $uri->getFragment()); } public function testImmutability() { $uri = new Uri(); $this->assertNotSame($uri, $uri->withScheme('https')); $this->assertNotSame($uri, $uri->withUserInfo('user', 'pass')); $this->assertNotSame($uri, $uri->withHost('example.com')); $this->assertNotSame($uri, $uri->withPort(8080)); $this->assertNotSame($uri, $uri->withPath('/path/123')); $this->assertNotSame($uri, $uri->withQuery('q=abc')); $this->assertNotSame($uri, $uri->withFragment('test')); } public function testExtendingClassesInstantiates() { // The non-standard port triggers a cascade of private methods which // should not use late static binding to access private static members. // If they do, this will fatal. $this->assertInstanceOf( '\GuzzleHttp\Tests\Psr7\ExtendingClassTest', new ExtendingClassTest('http://h:9/') ); } } class ExtendingClassTest extends \GuzzleHttp\Psr7\Uri { } tests/bootstrap.php000064400000000253144760126270010445 0ustar00