vendor/php-http/client-common/src/Plugin/DecoderPlugin.php line 69

  1. <?php
  3. declare(strict_types=1);
  5. namespace Http\Client\Common\Plugin;
  7. use Http\Client\Common\Plugin;
  8. use Http\Message\Encoding;
  9. use Http\Promise\Promise;
  10. use Psr\Http\Message\RequestInterface;
  11. use Psr\Http\Message\ResponseInterface;
  12. use Psr\Http\Message\StreamInterface;
  13. use Symfony\Component\OptionsResolver\OptionsResolver;
  15. /**
  16.  * Allow to decode response body with a chunk, deflate, compress or gzip encoding.
  17.  *
  18.  * If zlib is not installed, only chunked encoding can be handled.
  19.  *
  20.  * If Content-Encoding is not disabled, the plugin will add an Accept-Encoding header for the encoding methods it supports.
  21.  *
  22.  * @author Joel Wurtz <joel.wurtz@gmail.com>
  23.  */
  24. final class DecoderPlugin implements Plugin
  25. {
  26.     /**
  27.      * @var bool Whether this plugin decode stream with value in the Content-Encoding header (default to true).
  28.      *
  29.      * If set to false only the Transfer-Encoding header will be used
  30.      */
  31.     private $useContentEncoding;
  33.     /**
  34.      * @param array{'use_content_encoding'?: bool} $config
  35.      *
  36.      * Configuration options:
  37.      *   - use_content_encoding: Whether this plugin should look at the Content-Encoding header first or only at the Transfer-Encoding (defaults to true)
  38.      */
  39.     public function __construct(array $config = [])
  40.     {
  41.         $resolver = new OptionsResolver();
  42.         $resolver->setDefaults([
  43.             'use_content_encoding' => true,
  44.         ]);
  45.         $resolver->setAllowedTypes('use_content_encoding', 'bool');
  46.         $options = $resolver->resolve($config);
  48.         $this->useContentEncoding = $options['use_content_encoding'];
  49.     }
  51.     public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
  52.     {
  53.         $encodings = extension_loaded('zlib') ? ['gzip', 'deflate'] : ['identity'];
  55.         if ($this->useContentEncoding) {
  56.             $request = $request->withHeader('Accept-Encoding', $encodings);
  57.         }
  58.         $encodings[] = 'chunked';
  59.         $request = $request->withHeader('TE', $encodings);
  61.         return $next($request)->then(function (ResponseInterface $response) {
  62.             return $this->decodeResponse($response);
  63.         });
  64.     }
  66.     /**
  67.      * Decode a response body given its Transfer-Encoding or Content-Encoding value.
  68.      */
  69.     private function decodeResponse(ResponseInterface $response): ResponseInterface
  70.     {
  71.         $response = $this->decodeOnEncodingHeader('Transfer-Encoding', $response);
  73.         if ($this->useContentEncoding) {
  74.             $response = $this->decodeOnEncodingHeader('Content-Encoding', $response);
  75.         }
  77.         return $response;
  78.     }
  80.     /**
  81.      * Decode a response on a specific header (content encoding or transfer encoding mainly).
  82.      */
  83.     private function decodeOnEncodingHeader(string $headerName, ResponseInterface $response): ResponseInterface
  84.     {
  85.         if ($response->hasHeader($headerName)) {
  86.             $encodings = $response->getHeader($headerName);
  87.             $newEncodings = [];
  89.             while ($encoding = array_pop($encodings)) {
  90.                 $stream = $this->decorateStream($encoding, $response->getBody());
  92.                 if (false === $stream) {
  93.                     array_unshift($newEncodings, $encoding);
  95.                     continue;
  96.                 }
  98.                 $response = $response->withBody($stream);
  99.             }
  101.             if (\count($newEncodings) > 0) {
  102.                 $response = $response->withHeader($headerName, $newEncodings);
  103.             } else {
  104.                 $response = $response->withoutHeader($headerName);
  105.             }
  106.         }
  108.         return $response;
  109.     }
  111.     /**
  112.      * Decorate a stream given an encoding.
  113.      *
  114.      * @return StreamInterface|false A new stream interface or false if encoding is not supported
  115.      */
  116.     private function decorateStream(string $encoding, StreamInterface $stream)
  117.     {
  118.         if ('chunked' === strtolower($encoding)) {
  119.             return new Encoding\DechunkStream($stream);
  120.         }
  122.         if ('deflate' === strtolower($encoding)) {
  123.             return new Encoding\DecompressStream($stream);
  124.         }
  126.         if ('gzip' === strtolower($encoding)) {
  127.             return new Encoding\GzipDecodeStream($stream);
  128.         }
  130.         return false;
  131.     }
  132. }