123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\HttpClient;
- use Psr\Log\LoggerAwareInterface;
- use Psr\Log\LoggerAwareTrait;
- use Symfony\Component\HttpClient\Exception\InvalidArgumentException;
- use Symfony\Component\HttpClient\Exception\TransportException;
- use Symfony\Component\HttpClient\Internal\NativeClientState;
- use Symfony\Component\HttpClient\Response\NativeResponse;
- use Symfony\Component\HttpClient\Response\ResponseStream;
- use Symfony\Contracts\HttpClient\HttpClientInterface;
- use Symfony\Contracts\HttpClient\ResponseInterface;
- use Symfony\Contracts\HttpClient\ResponseStreamInterface;
- /**
- * A portable implementation of the HttpClientInterface contracts based on PHP stream wrappers.
- *
- * PHP stream wrappers are able to fetch response bodies concurrently,
- * but each request is opened synchronously.
- *
- * @author Nicolas Grekas <p@tchwork.com>
- */
- final class NativeHttpClient implements HttpClientInterface, LoggerAwareInterface
- {
- use HttpClientTrait;
- use LoggerAwareTrait;
- private $defaultOptions = self::OPTIONS_DEFAULTS;
- /** @var NativeClientState */
- private $multi;
- /**
- * @param array $defaultOptions Default request's options
- * @param int $maxHostConnections The maximum number of connections to open
- *
- * @see HttpClientInterface::OPTIONS_DEFAULTS for available options
- */
- public function __construct(array $defaultOptions = [], int $maxHostConnections = 6)
- {
- $this->defaultOptions['buffer'] = $this->defaultOptions['buffer'] ?? \Closure::fromCallable([__CLASS__, 'shouldBuffer']);
- if ($defaultOptions) {
- [, $this->defaultOptions] = self::prepareRequest(null, null, $defaultOptions, $this->defaultOptions);
- }
- $this->multi = new NativeClientState();
- $this->multi->maxHostConnections = 0 < $maxHostConnections ? $maxHostConnections : \PHP_INT_MAX;
- }
- /**
- * @see HttpClientInterface::OPTIONS_DEFAULTS for available options
- *
- * {@inheritdoc}
- */
- public function request(string $method, string $url, array $options = []): ResponseInterface
- {
- [$url, $options] = self::prepareRequest($method, $url, $options, $this->defaultOptions);
- if ($options['bindto']) {
- if (file_exists($options['bindto'])) {
- throw new TransportException(__CLASS__.' cannot bind to local Unix sockets, use e.g. CurlHttpClient instead.');
- }
- if (0 === strpos($options['bindto'], 'if!')) {
- throw new TransportException(__CLASS__.' cannot bind to network interfaces, use e.g. CurlHttpClient instead.');
- }
- if (0 === strpos($options['bindto'], 'host!')) {
- $options['bindto'] = substr($options['bindto'], 5);
- }
- }
- $options['body'] = self::getBodyAsString($options['body']);
- if ('' !== $options['body'] && 'POST' === $method && !isset($options['normalized_headers']['content-type'])) {
- $options['headers'][] = 'Content-Type: application/x-www-form-urlencoded';
- }
- if (\extension_loaded('zlib') && !isset($options['normalized_headers']['accept-encoding'])) {
- // gzip is the most widely available algo, no need to deal with deflate
- $options['headers'][] = 'Accept-Encoding: gzip';
- }
- if ($options['peer_fingerprint']) {
- if (isset($options['peer_fingerprint']['pin-sha256']) && 1 === \count($options['peer_fingerprint'])) {
- throw new TransportException(__CLASS__.' cannot verify "pin-sha256" fingerprints, please provide a "sha256" one.');
- }
- unset($options['peer_fingerprint']['pin-sha256']);
- }
- $info = [
- 'response_headers' => [],
- 'url' => $url,
- 'error' => null,
- 'canceled' => false,
- 'http_method' => $method,
- 'http_code' => 0,
- 'redirect_count' => 0,
- 'start_time' => 0.0,
- 'connect_time' => 0.0,
- 'redirect_time' => 0.0,
- 'pretransfer_time' => 0.0,
- 'starttransfer_time' => 0.0,
- 'total_time' => 0.0,
- 'namelookup_time' => 0.0,
- 'size_upload' => 0,
- 'size_download' => 0,
- 'size_body' => \strlen($options['body']),
- 'primary_ip' => '',
- 'primary_port' => 'http:' === $url['scheme'] ? 80 : 443,
- 'debug' => \extension_loaded('curl') ? '' : "* Enable the curl extension for better performance\n",
- ];
- if ($onProgress = $options['on_progress']) {
- // Memoize the last progress to ease calling the callback periodically when no network transfer happens
- $lastProgress = [0, 0];
- $maxDuration = 0 < $options['max_duration'] ? $options['max_duration'] : \INF;
- $onProgress = static function (...$progress) use ($onProgress, &$lastProgress, &$info, $maxDuration) {
- if ($info['total_time'] >= $maxDuration) {
- throw new TransportException(sprintf('Max duration was reached for "%s".', implode('', $info['url'])));
- }
- $progressInfo = $info;
- $progressInfo['url'] = implode('', $info['url']);
- unset($progressInfo['size_body']);
- if ($progress && -1 === $progress[0]) {
- // Response completed
- $lastProgress[0] = max($lastProgress);
- } else {
- $lastProgress = $progress ?: $lastProgress;
- }
- $onProgress($lastProgress[0], $lastProgress[1], $progressInfo);
- };
- } elseif (0 < $options['max_duration']) {
- $maxDuration = $options['max_duration'];
- $onProgress = static function () use (&$info, $maxDuration): void {
- if ($info['total_time'] >= $maxDuration) {
- throw new TransportException(sprintf('Max duration was reached for "%s".', implode('', $info['url'])));
- }
- };
- }
- // Always register a notification callback to compute live stats about the response
- $notification = static function (int $code, int $severity, ?string $msg, int $msgCode, int $dlNow, int $dlSize) use ($onProgress, &$info) {
- $info['total_time'] = microtime(true) - $info['start_time'];
- if (\STREAM_NOTIFY_PROGRESS === $code) {
- $info['starttransfer_time'] = $info['starttransfer_time'] ?: $info['total_time'];
- $info['size_upload'] += $dlNow ? 0 : $info['size_body'];
- $info['size_download'] = $dlNow;
- } elseif (\STREAM_NOTIFY_CONNECT === $code) {
- $info['connect_time'] = $info['total_time'];
- $info['debug'] .= $info['request_header'];
- unset($info['request_header']);
- } else {
- return;
- }
- if ($onProgress) {
- $onProgress($dlNow, $dlSize);
- }
- };
- if ($options['resolve']) {
- $this->multi->dnsCache = $options['resolve'] + $this->multi->dnsCache;
- }
- $this->logger && $this->logger->info(sprintf('Request: "%s %s"', $method, implode('', $url)));
- if (!isset($options['normalized_headers']['user-agent'])) {
- $options['headers'][] = 'User-Agent: Symfony HttpClient/Native';
- }
- if (0 < $options['max_duration']) {
- $options['timeout'] = min($options['max_duration'], $options['timeout']);
- }
- $context = [
- 'http' => [
- 'protocol_version' => min($options['http_version'] ?: '1.1', '1.1'),
- 'method' => $method,
- 'content' => $options['body'],
- 'ignore_errors' => true,
- 'curl_verify_ssl_peer' => $options['verify_peer'],
- 'curl_verify_ssl_host' => $options['verify_host'],
- 'auto_decode' => false, // Disable dechunk filter, it's incompatible with stream_select()
- 'timeout' => $options['timeout'],
- 'follow_location' => false, // We follow redirects ourselves - the native logic is too limited
- ],
- 'ssl' => array_filter([
- 'verify_peer' => $options['verify_peer'],
- 'verify_peer_name' => $options['verify_host'],
- 'cafile' => $options['cafile'],
- 'capath' => $options['capath'],
- 'local_cert' => $options['local_cert'],
- 'local_pk' => $options['local_pk'],
- 'passphrase' => $options['passphrase'],
- 'ciphers' => $options['ciphers'],
- 'peer_fingerprint' => $options['peer_fingerprint'],
- 'capture_peer_cert_chain' => $options['capture_peer_cert_chain'],
- 'allow_self_signed' => (bool) $options['peer_fingerprint'],
- 'SNI_enabled' => true,
- 'disable_compression' => true,
- ], static function ($v) { return null !== $v; }),
- 'socket' => [
- 'bindto' => $options['bindto'] ?: '0:0',
- 'tcp_nodelay' => true,
- ],
- ];
- $context = stream_context_create($context, ['notification' => $notification]);
- $resolver = static function ($multi) use ($context, $options, $url, &$info, $onProgress) {
- [$host, $port] = self::parseHostPort($url, $info);
- if (!isset($options['normalized_headers']['host'])) {
- $options['headers'][] = 'Host: '.$host.$port;
- }
- $proxy = self::getProxy($options['proxy'], $url, $options['no_proxy']);
- if (!self::configureHeadersAndProxy($context, $host, $options['headers'], $proxy, 'https:' === $url['scheme'])) {
- $ip = self::dnsResolve($host, $multi, $info, $onProgress);
- $url['authority'] = substr_replace($url['authority'], $ip, -\strlen($host) - \strlen($port), \strlen($host));
- }
- return [self::createRedirectResolver($options, $host, $proxy, $info, $onProgress), implode('', $url)];
- };
- return new NativeResponse($this->multi, $context, implode('', $url), $options, $info, $resolver, $onProgress, $this->logger);
- }
- /**
- * {@inheritdoc}
- */
- public function stream($responses, float $timeout = null): ResponseStreamInterface
- {
- if ($responses instanceof NativeResponse) {
- $responses = [$responses];
- } elseif (!is_iterable($responses)) {
- throw new \TypeError(sprintf('"%s()" expects parameter 1 to be an iterable of NativeResponse objects, "%s" given.', __METHOD__, get_debug_type($responses)));
- }
- return new ResponseStream(NativeResponse::stream($responses, $timeout));
- }
- private static function getBodyAsString($body): string
- {
- if (\is_resource($body)) {
- return stream_get_contents($body);
- }
- if (!$body instanceof \Closure) {
- return $body;
- }
- $result = '';
- while ('' !== $data = $body(self::$CHUNK_SIZE)) {
- if (!\is_string($data)) {
- throw new TransportException(sprintf('Return value of the "body" option callback must be string, "%s" returned.', get_debug_type($data)));
- }
- $result .= $data;
- }
- return $result;
- }
- /**
- * Extracts the host and the port from the URL.
- */
- private static function parseHostPort(array $url, array &$info): array
- {
- if ($port = parse_url($url['authority'], \PHP_URL_PORT) ?: '') {
- $info['primary_port'] = $port;
- $port = ':'.$port;
- } else {
- $info['primary_port'] = 'http:' === $url['scheme'] ? 80 : 443;
- }
- return [parse_url($url['authority'], \PHP_URL_HOST), $port];
- }
- /**
- * Resolves the IP of the host using the local DNS cache if possible.
- */
- private static function dnsResolve($host, NativeClientState $multi, array &$info, ?\Closure $onProgress): string
- {
- if (null === $ip = $multi->dnsCache[$host] ?? null) {
- $info['debug'] .= "* Hostname was NOT found in DNS cache\n";
- $now = microtime(true);
- if (!$ip = gethostbynamel($host)) {
- throw new TransportException(sprintf('Could not resolve host "%s".', $host));
- }
- $info['namelookup_time'] = microtime(true) - ($info['start_time'] ?: $now);
- $multi->dnsCache[$host] = $ip = $ip[0];
- $info['debug'] .= "* Added {$host}:0:{$ip} to DNS cache\n";
- } else {
- $info['debug'] .= "* Hostname was found in DNS cache\n";
- }
- $info['primary_ip'] = $ip;
- if ($onProgress) {
- // Notify DNS resolution
- $onProgress();
- }
- return $ip;
- }
- /**
- * Handles redirects - the native logic is too buggy to be used.
- */
- private static function createRedirectResolver(array $options, string $host, ?array $proxy, array &$info, ?\Closure $onProgress): \Closure
- {
- $redirectHeaders = [];
- if (0 < $maxRedirects = $options['max_redirects']) {
- $redirectHeaders = ['host' => $host];
- $redirectHeaders['with_auth'] = $redirectHeaders['no_auth'] = array_filter($options['headers'], static function ($h) {
- return 0 !== stripos($h, 'Host:');
- });
- if (isset($options['normalized_headers']['authorization']) || isset($options['normalized_headers']['cookie'])) {
- $redirectHeaders['no_auth'] = array_filter($redirectHeaders['no_auth'], static function ($h) {
- return 0 !== stripos($h, 'Authorization:') && 0 !== stripos($h, 'Cookie:');
- });
- }
- }
- return static function (NativeClientState $multi, ?string $location, $context) use ($redirectHeaders, $proxy, &$info, $maxRedirects, $onProgress): ?string {
- if (null === $location || $info['http_code'] < 300 || 400 <= $info['http_code']) {
- $info['redirect_url'] = null;
- return null;
- }
- try {
- $url = self::parseUrl($location);
- } catch (InvalidArgumentException $e) {
- $info['redirect_url'] = null;
- return null;
- }
- $url = self::resolveUrl($url, $info['url']);
- $info['redirect_url'] = implode('', $url);
- if ($info['redirect_count'] >= $maxRedirects) {
- return null;
- }
- $info['url'] = $url;
- ++$info['redirect_count'];
- $info['redirect_time'] = microtime(true) - $info['start_time'];
- // Do like curl and browsers: turn POST to GET on 301, 302 and 303
- if (\in_array($info['http_code'], [301, 302, 303], true)) {
- $options = stream_context_get_options($context)['http'];
- if ('POST' === $options['method'] || 303 === $info['http_code']) {
- $info['http_method'] = $options['method'] = 'HEAD' === $options['method'] ? 'HEAD' : 'GET';
- $options['content'] = '';
- $options['header'] = array_filter($options['header'], static function ($h) {
- return 0 !== stripos($h, 'Content-Length:') && 0 !== stripos($h, 'Content-Type:');
- });
- stream_context_set_option($context, ['http' => $options]);
- }
- }
- [$host, $port] = self::parseHostPort($url, $info);
- if (false !== (parse_url($location, \PHP_URL_HOST) ?? false)) {
- // Authorization and Cookie headers MUST NOT follow except for the initial host name
- $requestHeaders = $redirectHeaders['host'] === $host ? $redirectHeaders['with_auth'] : $redirectHeaders['no_auth'];
- $requestHeaders[] = 'Host: '.$host.$port;
- $dnsResolve = !self::configureHeadersAndProxy($context, $host, $requestHeaders, $proxy, 'https:' === $url['scheme']);
- } else {
- $dnsResolve = isset(stream_context_get_options($context)['ssl']['peer_name']);
- }
- if ($dnsResolve) {
- $ip = self::dnsResolve($host, $multi, $info, $onProgress);
- $url['authority'] = substr_replace($url['authority'], $ip, -\strlen($host) - \strlen($port), \strlen($host));
- }
- return implode('', $url);
- };
- }
- private static function configureHeadersAndProxy($context, string $host, array $requestHeaders, ?array $proxy, bool $isSsl): bool
- {
- if (null === $proxy) {
- stream_context_set_option($context, 'http', 'header', $requestHeaders);
- stream_context_set_option($context, 'ssl', 'peer_name', $host);
- return false;
- }
- // Matching "no_proxy" should follow the behavior of curl
- foreach ($proxy['no_proxy'] as $rule) {
- $dotRule = '.'.ltrim($rule, '.');
- if ('*' === $rule || $host === $rule || substr($host, -\strlen($dotRule)) === $dotRule) {
- stream_context_set_option($context, 'http', 'proxy', null);
- stream_context_set_option($context, 'http', 'request_fulluri', false);
- stream_context_set_option($context, 'http', 'header', $requestHeaders);
- stream_context_set_option($context, 'ssl', 'peer_name', $host);
- return false;
- }
- }
- if (null !== $proxy['auth']) {
- $requestHeaders[] = 'Proxy-Authorization: '.$proxy['auth'];
- }
- stream_context_set_option($context, 'http', 'proxy', $proxy['url']);
- stream_context_set_option($context, 'http', 'request_fulluri', !$isSsl);
- stream_context_set_option($context, 'http', 'header', $requestHeaders);
- stream_context_set_option($context, 'ssl', 'peer_name', null);
- return true;
- }
- }
|