namespace GuzzleHttp\Psr7;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UriInterface;
* Remove the items given by the keys, case insensitively from the data.
* @param iterable<string> $keys
public static function caselessRemove($keys, array $data)
foreach ($keys as &$key) {
foreach ($data as $k => $v) {
if (!in_array(strtolower($k), $keys)) {
* 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.
public static function copyToStream(StreamInterface $source, StreamInterface $dest, $maxLen = -1)
while (!$source->eof()) {
if (!$dest->write($source->read($bufferSize))) {
while ($remaining > 0 && !$source->eof()) {
$buf = $source->read(min($bufferSize, $remaining));
* Copy the contents of a stream into a string until the given number of
* @param StreamInterface $stream Stream to read
* @param int $maxLen Maximum number of bytes to read. Pass -1
* to read the entire stream.
* @throws \RuntimeException on error.
public static function copyToString(StreamInterface $stream, $maxLen = -1)
while (!$stream->eof()) {
$buf = $stream->read(1048576);
// Using a loose equality here to match on '' and false.
while (!$stream->eof() && $len < $maxLen) {
$buf = $stream->read($maxLen - $len);
// Using a loose equality here to match on '' and 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.
* @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.
public static function hash(StreamInterface $stream, $algo, $rawOutput = false)
while (!$stream->eof()) {
hash_update($ctx, $stream->read(1048576));
$out = hash_final($ctx, (bool) $rawOutput);
* Clone and modify a request with the given changes.
* This method is useful for reducing the number of clones needed to mutate
* 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
public static function modifyRequest(RequestInterface $request, array $changes)
$headers = $request->getHeaders();
if (!isset($changes['uri'])) {
$uri = $request->getUri();
// 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;
if (!empty($changes['remove_headers'])) {
$headers = self::caselessRemove($changes['remove_headers'], $headers);
if (!empty($changes['set_headers'])) {
$headers = self::caselessRemove(array_keys($changes['set_headers']), $headers);
$headers = $changes['set_headers'] + $headers;
if (isset($changes['query'])) {
$uri = $uri->withQuery($changes['query']);
if ($request instanceof ServerRequestInterface) {
$new = (new ServerRequest(
isset($changes['method']) ? $changes['method'] : $request->getMethod(),
isset($changes['body']) ? $changes['body'] : $request->getBody(),
isset($changes['version'])
: $request->getProtocolVersion(),
$request->getServerParams()
->withParsedBody($request->getParsedBody())
->withQueryParams($request->getQueryParams())
->withCookieParams($request->getCookieParams())
->withUploadedFiles($request->getUploadedFiles());
foreach ($request->getAttributes() as $key => $value) {
$new = $new->withAttribute($key, $value);
isset($changes['method']) ? $changes['method'] : $request->getMethod(),
isset($changes['body']) ? $changes['body'] : $request->getBody(),
isset($changes['version'])
: $request->getProtocolVersion()
* Read a line from the stream up to the maximum allowed buffer length.
* @param StreamInterface $stream Stream to read from
* @param int|null $maxLength Maximum buffer length
public static function readLine(StreamInterface $stream, $maxLength = null)
while (!$stream->eof()) {
// Using a loose equality here to match on '' and false.
if (null == ($byte = $stream->read(1))) {
// Break when a new line is found or the max length - 1 is reached
if ($byte === "\n" || ++$size === $maxLength - 1) {
* 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
* - `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.
* @param resource|string|int|float|bool|StreamInterface|callable|\Iterator|null $resource Entity body data
* @param array $options Additional options
* @return StreamInterface
* @throws \InvalidArgumentException if the $resource arg is not valid.
public static function streamFor($resource = '', array $options = [])
if (is_scalar($resource)) {
$stream = self::tryFopen('php://temp', 'r+');
fwrite($stream, $resource);
return new Stream($stream, $options);
switch (gettype($resource)) {
* The 'php://input' is a special stream with quirks and inconsistencies.
* We avoid using that stream by reading it into php://temp
$metaData = \stream_get_meta_data($resource);
if (isset($metaData['uri']) && $metaData['uri'] === 'php://input') {
$stream = self::tryFopen('php://temp', 'w+');
fwrite($stream, stream_get_contents($resource));
return new Stream($resource, $options);
if ($resource instanceof StreamInterface) {
} elseif ($resource instanceof \Iterator) {
return new PumpStream(function () use ($resource) {
if (!$resource->valid()) {
$result = $resource->current();
} elseif (method_exists($resource, '__toString')) {
return Utils::streamFor((string) $resource, $options);
return new Stream(self::tryFopen('php://temp', 'r+'), $options);
if (is_callable($resource)) {
return new PumpStream($resource, $options);
throw new \InvalidArgumentException('Invalid resource type: ' . gettype($resource));
* 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
* @throws \RuntimeException if the file cannot be opened
public static function tryFopen($filename, $mode)
set_error_handler(function () use ($filename, $mode, &$ex) {
$ex = new \RuntimeException(sprintf(
'Unable to open "%s" using mode "%s": %s',
$handle = fopen($filename, $mode);
} catch (\Throwable $e) {
$ex = new \RuntimeException(sprintf(
'Unable to open "%s" using mode "%s": %s',
/** @var $ex \RuntimeException */
* Returns a UriInterface for the given value.
* This function accepts a string or 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
* @throws \InvalidArgumentException
public static function uriFor($uri)
if ($uri instanceof UriInterface) {
throw new \InvalidArgumentException('URI must be a string or UriInterface');