vendor/symfony/http-client/Response/CurlResponse.php line 109

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpClient\Response;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\HttpClient\Chunk\FirstChunk;
  16. use Symfony\Component\HttpClient\Chunk\InformationalChunk;
  17. use Symfony\Component\HttpClient\Exception\TransportException;
  18. use Symfony\Component\HttpClient\Internal\Canary;
  19. use Symfony\Component\HttpClient\Internal\ClientState;
  20. use Symfony\Component\HttpClient\Internal\CurlClientState;
  21. use Symfony\Contracts\HttpClient\ResponseInterface;
  23. /**
  24.  * @author Nicolas Grekas <p@tchwork.com>
  25.  *
  26.  * @internal
  27.  */
  28. final class CurlResponse implements ResponseInterface, StreamableInterface
  29. {
  30.     use CommonResponseTrait {
  31.         getContent as private doGetContent;
  32.     }
  33.     use TransportResponseTrait;
  35.     private static bool $performing = false;
  36.     private CurlClientState $multi;
  38.     /**
  39.      * @var resource
  40.      */
  41.     private $debugBuffer;
  43.     /**
  44.      * @internal
  45.      */
  46.     public function __construct(CurlClientState $multi, \CurlHandle|string $ch, array $options = null, LoggerInterface $logger = null, string $method = 'GET', callable $resolveRedirect = null, int $curlVersion = null, string $originalUrl = null)
  47.     {
  48.         $this->multi = $multi;
  50.         if ($ch instanceof \CurlHandle) {
  51.             $this->handle = $ch;
  52.             $this->debugBuffer = fopen('php://temp', 'w+');
  53.             if (0x074000 === $curlVersion) {
  54.                 fwrite($this->debugBuffer, 'Due to a bug in curl 7.64.0, the debug log is disabled; use another version to work around the issue.');
  55.             } else {
  56.                 curl_setopt($ch, \CURLOPT_VERBOSE, true);
  57.                 curl_setopt($ch, \CURLOPT_STDERR, $this->debugBuffer);
  58.             }
  59.         } else {
  60.             $this->info['url'] = $ch;
  61.             $ch = $this->handle;
  62.         }
  64.         $this->id = $id = (int) $ch;
  65.         $this->logger = $logger;
  66.         $this->shouldBuffer = $options['buffer'] ?? true;
  67.         $this->timeout = $options['timeout'] ?? null;
  68.         $this->info['http_method'] = $method;
  69.         $this->info['user_data'] = $options['user_data'] ?? null;
  70.         $this->info['max_duration'] = $options['max_duration'] ?? null;
  71.         $this->info['start_time'] ??= microtime(true);
  72.         $this->info['original_url'] = $originalUrl ?? $this->info['url'] ?? curl_getinfo($ch, \CURLINFO_EFFECTIVE_URL);
  73.         $info = &$this->info;
  74.         $headers = &$this->headers;
  75.         $debugBuffer = $this->debugBuffer;
  77.         if (!$info['response_headers']) {
  78.             // Used to keep track of what we're waiting for
  79.             curl_setopt($ch, \CURLOPT_PRIVATE, \in_array($method, ['GET', 'HEAD', 'OPTIONS', 'TRACE'], true) && 1.0 < (float) ($options['http_version'] ?? 1.1) ? 'H2' : 'H0'); // H = headers + retry counter
  80.         }
  82.         curl_setopt($ch, \CURLOPT_HEADERFUNCTION, static function ($ch, string $data) use (&$info, &$headers, $options, $multi, $id, &$location, $resolveRedirect, $logger): int {
  83.             if (0 !== substr_compare($data, "\r\n", -2)) {
  84.                 return 0;
  85.             }
  87.             $len = 0;
  89.             foreach (explode("\r\n", substr($data, 0, -2)) as $data) {
  90.                 $len += 2 + self::parseHeaderLine($ch, $data, $info, $headers, $options, $multi, $id, $location, $resolveRedirect, $logger);
  91.             }
  93.             return $len;
  94.         });
  96.         if (null === $options) {
  97.             // Pushed response: buffer until requested
  98.             curl_setopt($ch, \CURLOPT_WRITEFUNCTION, static function ($ch, string $data) use ($multi, $id): int {
  99.                 $multi->handlesActivity[$id][] = $data;
  100.                 curl_pause($ch, \CURLPAUSE_RECV);
  102.                 return \strlen($data);
  103.             });
  105.             return;
  106.         }
  108.         $execCounter = $multi->execCounter;
  109.         $this->info['pause_handler'] = static function (float $duration) use ($ch, $multi, $execCounter) {
  110.             if (0 < $duration) {
  111.                 if ($execCounter === $multi->execCounter) {
  112.                     $multi->execCounter = !\is_float($execCounter) ? 1 + $execCounter : \PHP_INT_MIN;
  113.                     curl_multi_remove_handle($multi->handle, $ch);
  114.                 }
  116.                 $lastExpiry = end($multi->pauseExpiries);
  117.                 $multi->pauseExpiries[(int) $ch] = $duration += microtime(true);
  118.                 if (false !== $lastExpiry && $lastExpiry > $duration) {
  119.                     asort($multi->pauseExpiries);
  120.                 }
  121.                 curl_pause($ch, \CURLPAUSE_ALL);
  122.             } else {
  123.                 unset($multi->pauseExpiries[(int) $ch]);
  124.                 curl_pause($ch, \CURLPAUSE_CONT);
  125.                 curl_multi_add_handle($multi->handle, $ch);
  126.             }
  127.         };
  129.         $this->inflate = !isset($options['normalized_headers']['accept-encoding']);
  130.         curl_pause($ch, \CURLPAUSE_CONT);
  132.         if ($onProgress = $options['on_progress']) {
  133.             $url = isset($info['url']) ? ['url' => $info['url']] : [];
  134.             curl_setopt($ch, \CURLOPT_NOPROGRESS, false);
  135.             curl_setopt($ch, \CURLOPT_PROGRESSFUNCTION, static function ($ch, $dlSize, $dlNow) use ($onProgress, &$info, $url, $multi, $debugBuffer) {
  136.                 try {
  137.                     rewind($debugBuffer);
  138.                     $debug = ['debug' => stream_get_contents($debugBuffer)];
  139.                     $onProgress($dlNow, $dlSize, $url + curl_getinfo($ch) + $info + $debug);
  140.                 } catch (\Throwable $e) {
  141.                     $multi->handlesActivity[(int) $ch][] = null;
  142.                     $multi->handlesActivity[(int) $ch][] = $e;
  144.                     return 1; // Abort the request
  145.                 }
  147.                 return null;
  148.             });
  149.         }
  151.         curl_setopt($ch, \CURLOPT_WRITEFUNCTION, static function ($ch, string $data) use ($multi, $id): int {
  152.             if ('H' === (curl_getinfo($ch, \CURLINFO_PRIVATE)[0] ?? null)) {
  153.                 $multi->handlesActivity[$id][] = null;
  154.                 $multi->handlesActivity[$id][] = new TransportException(sprintf('Unsupported protocol for "%s"', curl_getinfo($ch, \CURLINFO_EFFECTIVE_URL)));
  156.                 return 0;
  157.             }
  159.             curl_setopt($ch, \CURLOPT_WRITEFUNCTION, static function ($ch, string $data) use ($multi, $id): int {
  160.                 $multi->handlesActivity[$id][] = $data;
  162.                 return \strlen($data);
  163.             });
  165.             $multi->handlesActivity[$id][] = $data;
  167.             return \strlen($data);
  168.         });
  170.         $this->initializer = static function (self $response) {
  171.             $waitFor = curl_getinfo($ch = $response->handle, \CURLINFO_PRIVATE);
  173.             return 'H' === $waitFor[0];
  174.         };
  176.         // Schedule the request in a non-blocking way
  177.         $multi->lastTimeout = null;
  178.         $multi->openHandles[$id] = [$ch, $options];
  179.         curl_multi_add_handle($multi->handle, $ch);
  181.         $this->canary = new Canary(static function () use ($ch, $multi, $id) {
  182.             unset($multi->pauseExpiries[$id], $multi->openHandles[$id], $multi->handlesActivity[$id]);
  183.             curl_setopt($ch, \CURLOPT_PRIVATE, '_0');
  185.             if (self::$performing) {
  186.                 return;
  187.             }
  189.             curl_multi_remove_handle($multi->handle, $ch);
  190.             curl_setopt_array($ch, [
  191.                 \CURLOPT_NOPROGRESS => true,
  192.                 \CURLOPT_PROGRESSFUNCTION => null,
  193.                 \CURLOPT_HEADERFUNCTION => null,
  194.                 \CURLOPT_WRITEFUNCTION => null,
  195.                 \CURLOPT_READFUNCTION => null,
  196.                 \CURLOPT_INFILE => null,
  197.             ]);
  199.             if (!$multi->openHandles) {
  200.                 // Schedule DNS cache eviction for the next request
  201.                 $multi->dnsCache->evictions = $multi->dnsCache->evictions ?: $multi->dnsCache->removals;
  202.                 $multi->dnsCache->removals = $multi->dnsCache->hostnames = [];
  203.             }
  204.         });
  205.     }
  207.     public function getInfo(string $type = null): mixed
  208.     {
  209.         if (!$info = $this->finalInfo) {
  210.             $info = array_merge($this->info, curl_getinfo($this->handle));
  211.             $info['url'] = $this->info['url'] ?? $info['url'];
  212.             $info['redirect_url'] = $this->info['redirect_url'] ?? null;
  214.             // workaround curl not subtracting the time offset for pushed responses
  215.             if (isset($this->info['url']) && $info['start_time'] / 1000 < $info['total_time']) {
  216.                 $info['total_time'] -= $info['starttransfer_time'] ?: $info['total_time'];
  217.                 $info['starttransfer_time'] = 0.0;
  218.             }
  220.             rewind($this->debugBuffer);
  221.             $info['debug'] = stream_get_contents($this->debugBuffer);
  222.             $waitFor = curl_getinfo($this->handle, \CURLINFO_PRIVATE);
  224.             if ('H' !== $waitFor[0] && 'C' !== $waitFor[0]) {
  225.                 curl_setopt($this->handle, \CURLOPT_VERBOSE, false);
  226.                 rewind($this->debugBuffer);
  227.                 ftruncate($this->debugBuffer, 0);
  228.                 $this->finalInfo = $info;
  229.             }
  230.         }
  232.         return null !== $type ? $info[$type] ?? null : $info;
  233.     }
  235.     public function getContent(bool $throw = true): string
  236.     {
  237.         $performing = self::$performing;
  238.         self::$performing = $performing || '_0' === curl_getinfo($this->handle, \CURLINFO_PRIVATE);
  240.         try {
  241.             return $this->doGetContent($throw);
  242.         } finally {
  243.             self::$performing = $performing;
  244.         }
  245.     }
  247.     public function __destruct()
  248.     {
  249.         try {
  250.             if (null === $this->timeout) {
  251.                 return; // Unused pushed response
  252.             }
  254.             $this->doDestruct();
  255.         } finally {
  256.             if (\is_resource($this->handle) || $this->handle instanceof \CurlHandle) {
  257.                 curl_setopt($this->handle, \CURLOPT_VERBOSE, false);
  258.             }
  259.         }
  260.     }
  262.     private static function schedule(self $response, array &$runningResponses): void
  263.     {
  264.         if (isset($runningResponses[$i = (int) $response->multi->handle])) {
  265.             $runningResponses[$i][1][$response->id] = $response;
  266.         } else {
  267.             $runningResponses[$i] = [$response->multi, [$response->id => $response]];
  268.         }
  270.         if ('_0' === curl_getinfo($ch = $response->handle, \CURLINFO_PRIVATE)) {
  271.             // Response already completed
  272.             $response->multi->handlesActivity[$response->id][] = null;
  273.             $response->multi->handlesActivity[$response->id][] = null !== $response->info['error'] ? new TransportException($response->info['error']) : null;
  274.         }
  275.     }
  277.     /**
  278.      * @param CurlClientState $multi
  279.      */
  280.     private static function perform(ClientState $multi, array &$responses = null): void
  281.     {
  282.         if (self::$performing) {
  283.             if ($responses) {
  284.                 $response = current($responses);
  285.                 $multi->handlesActivity[(int) $response->handle][] = null;
  286.                 $multi->handlesActivity[(int) $response->handle][] = new TransportException(sprintf('Userland callback cannot use the client nor the response while processing "%s".', curl_getinfo($response->handle, \CURLINFO_EFFECTIVE_URL)));
  287.             }
  289.             return;
  290.         }
  292.         try {
  293.             self::$performing = true;
  294.             ++$multi->execCounter;
  295.             $active = 0;
  296.             while (\CURLM_CALL_MULTI_PERFORM === ($err = curl_multi_exec($multi->handle, $active))) {
  297.             }
  299.             if (\CURLM_OK !== $err) {
  300.                 throw new TransportException(curl_multi_strerror($err));
  301.             }
  303.             while ($info = curl_multi_info_read($multi->handle)) {
  304.                 if (\CURLMSG_DONE !== $info['msg']) {
  305.                     continue;
  306.                 }
  307.                 $result = $info['result'];
  308.                 $id = (int) $ch = $info['handle'];
  309.                 $waitFor = @curl_getinfo($ch, \CURLINFO_PRIVATE) ?: '_0';
  311.                 if (\in_array($result, [\CURLE_SEND_ERROR, \CURLE_RECV_ERROR, /* CURLE_HTTP2 */ 16, /* CURLE_HTTP2_STREAM */ 92], true) && $waitFor[1] && 'C' !== $waitFor[0]) {
  312.                     curl_multi_remove_handle($multi->handle, $ch);
  313.                     $waitFor[1] = (string) ((int) $waitFor[1] - 1); // decrement the retry counter
  314.                     curl_setopt($ch, \CURLOPT_PRIVATE, $waitFor);
  315.                     curl_setopt($ch, \CURLOPT_FORBID_REUSE, true);
  317.                     if (0 === curl_multi_add_handle($multi->handle, $ch)) {
  318.                         continue;
  319.                     }
  320.                 }
  322.                 if (\CURLE_RECV_ERROR === $result && 'H' === $waitFor[0] && 400 <= ($responses[(int) $ch]->info['http_code'] ?? 0)) {
  323.                     $multi->handlesActivity[$id][] = new FirstChunk();
  324.                 }
  326.                 $multi->handlesActivity[$id][] = null;
  327.                 $multi->handlesActivity[$id][] = \in_array($result, [\CURLE_OK, \CURLE_TOO_MANY_REDIRECTS], true) || '_0' === $waitFor || curl_getinfo($ch, \CURLINFO_SIZE_DOWNLOAD) === curl_getinfo($ch, \CURLINFO_CONTENT_LENGTH_DOWNLOAD) ? null : new TransportException(ucfirst(curl_error($ch) ?: curl_strerror($result)).sprintf(' for "%s".', curl_getinfo($ch, \CURLINFO_EFFECTIVE_URL)));
  328.             }
  329.         } finally {
  330.             self::$performing = false;
  331.         }
  332.     }
  334.     /**
  335.      * @param CurlClientState $multi
  336.      */
  337.     private static function select(ClientState $multi, float $timeout): int
  338.     {
  339.         if ($multi->pauseExpiries) {
  340.             $now = microtime(true);
  342.             foreach ($multi->pauseExpiries as $id => $pauseExpiry) {
  343.                 if ($now < $pauseExpiry) {
  344.                     $timeout = min($timeout, $pauseExpiry - $now);
  345.                     break;
  346.                 }
  348.                 unset($multi->pauseExpiries[$id]);
  349.                 curl_pause($multi->openHandles[$id][0], \CURLPAUSE_CONT);
  350.                 curl_multi_add_handle($multi->handle, $multi->openHandles[$id][0]);
  351.             }
  352.         }
  354.         if (0 !== $selected = curl_multi_select($multi->handle, $timeout)) {
  355.             return $selected;
  356.         }
  358.         if ($multi->pauseExpiries && 0 < $timeout -= microtime(true) - $now) {
  359.             usleep((int) (1E6 * $timeout));
  360.         }
  362.         return 0;
  363.     }
  365.     /**
  366.      * Parses header lines as curl yields them to us.
  367.      */
  368.     private static function parseHeaderLine($ch, string $data, array &$info, array &$headers, ?array $options, CurlClientState $multi, int $id, ?string &$location, ?callable $resolveRedirect, ?LoggerInterface $logger): int
  369.     {
  370.         $waitFor = @curl_getinfo($ch, \CURLINFO_PRIVATE) ?: '_0';
  372.         if ('H' !== $waitFor[0]) {
  373.             return \strlen($data); // Ignore HTTP trailers
  374.         }
  376.         if ('' !== $data) {
  377.             // Regular header line: add it to the list
  378.             self::addResponseHeaders([$data], $info, $headers);
  380.             if (!str_starts_with($data, 'HTTP/')) {
  381.                 if (0 === stripos($data, 'Location:')) {
  382.                     $location = trim(substr($data, 9));
  383.                 }
  385.                 return \strlen($data);
  386.             }
  388.             if (\function_exists('openssl_x509_read') && $certinfo = curl_getinfo($ch, \CURLINFO_CERTINFO)) {
  389.                 $info['peer_certificate_chain'] = array_map('openssl_x509_read', array_column($certinfo, 'Cert'));
  390.             }
  392.             if (300 <= $info['http_code'] && $info['http_code'] < 400) {
  393.                 if (curl_getinfo($ch, \CURLINFO_REDIRECT_COUNT) === $options['max_redirects']) {
  394.                     curl_setopt($ch, \CURLOPT_FOLLOWLOCATION, false);
  395.                 } elseif (303 === $info['http_code'] || ('POST' === $info['http_method'] && \in_array($info['http_code'], [301, 302], true))) {
  396.                     curl_setopt($ch, \CURLOPT_POSTFIELDS, '');
  397.                 }
  398.             }
  400.             return \strlen($data);
  401.         }
  403.         // End of headers: handle informational responses, redirects, etc.
  405.         if (200 > $statusCode = curl_getinfo($ch, \CURLINFO_RESPONSE_CODE)) {
  406.             $multi->handlesActivity[$id][] = new InformationalChunk($statusCode, $headers);
  407.             $location = null;
  409.             return \strlen($data);
  410.         }
  412.         $info['redirect_url'] = null;
  414.         if (300 <= $statusCode && $statusCode < 400 && null !== $location) {
  415.             if ($noContent = 303 === $statusCode || ('POST' === $info['http_method'] && \in_array($statusCode, [301, 302], true))) {
  416.                 $info['http_method'] = 'HEAD' === $info['http_method'] ? 'HEAD' : 'GET';
  417.                 curl_setopt($ch, \CURLOPT_CUSTOMREQUEST, $info['http_method']);
  418.             }
  420.             if (null === $info['redirect_url'] = $resolveRedirect($ch, $location, $noContent)) {
  421.                 $options['max_redirects'] = curl_getinfo($ch, \CURLINFO_REDIRECT_COUNT);
  422.                 curl_setopt($ch, \CURLOPT_FOLLOWLOCATION, false);
  423.                 curl_setopt($ch, \CURLOPT_MAXREDIRS, $options['max_redirects']);
  424.             } else {
  425.                 $url = parse_url($location ?? ':');
  427.                 if (isset($url['host']) && null !== $ip = $multi->dnsCache->hostnames[$url['host'] = strtolower($url['host'])] ?? null) {
  428.                     // Populate DNS cache for redirects if needed
  429.                     $port = $url['port'] ?? ('http' === ($url['scheme'] ?? parse_url(curl_getinfo($ch, \CURLINFO_EFFECTIVE_URL), \PHP_URL_SCHEME)) ? 80 : 443);
  430.                     curl_setopt($ch, \CURLOPT_RESOLVE, ["{$url['host']}:$port:$ip"]);
  431.                     $multi->dnsCache->removals["-{$url['host']}:$port"] = "-{$url['host']}:$port";
  432.                 }
  433.             }
  434.         }
  436.         if (401 === $statusCode && isset($options['auth_ntlm']) && 0 === strncasecmp($headers['www-authenticate'][0] ?? '', 'NTLM ', 5)) {
  437.             // Continue with NTLM auth
  438.         } elseif ($statusCode < 300 || 400 <= $statusCode || null === $location || curl_getinfo($ch, \CURLINFO_REDIRECT_COUNT) === $options['max_redirects']) {
  439.             // Headers and redirects completed, time to get the response's content
  440.             $multi->handlesActivity[$id][] = new FirstChunk();
  442.             if ('HEAD' === $info['http_method'] || \in_array($statusCode, [204, 304], true)) {
  443.                 $waitFor = '_0'; // no content expected
  444.                 $multi->handlesActivity[$id][] = null;
  445.                 $multi->handlesActivity[$id][] = null;
  446.             } else {
  447.                 $waitFor[0] = 'C'; // C = content
  448.             }
  450.             curl_setopt($ch, \CURLOPT_PRIVATE, $waitFor);
  451.         } elseif (null !== $info['redirect_url'] && $logger) {
  452.             $logger->info(sprintf('Redirecting: "%s %s"', $info['http_code'], $info['redirect_url']));
  453.         }
  455.         $location = null;
  457.         return \strlen($data);
  458.     }
  459. }