Merge branch '4.4' into 5.0

* 4.4: (26 commits)
  [HttpClient] NativeHttpClient should not send >1.1 protocol version
  [HttpClient] fix support for non-blocking resource streams
  [Mailer] Make sure you can pass custom headers to Mailgun
  [Mailer] Remove line breaks in email attachment content
  Update links to documentation
  [Validator] Add the missing translations for the Arabic (ar) locale
  ensure to expect no validation for the right reasons
  [Security-Guard] fixed 35203 missing name tag in param docblock
  [HttpClient] fix casting responses to PHP streams
  [PhpUnitBridge] Add test case for @expectedDeprecation annotation
  [PhpUnitBridge][SymfonyTestsListenerTrait] Remove $testsWithWarnings stack
  [Mailer] Fix addresses management in Sendgrid API payload
  [Mailer][MailchimpBridge] Fix missing attachments when sending via Mandrill API
  [Mailer][MailchimpBridge] Fix incorrect sender address when sender has name
  [HttpClient] fix capturing SSL certificates with NativeHttpClient
  Update year in license files
  [TwigBridge][Form] Added missing help messages in form themes
  Update year in license files
  Update year in license files
  fix version when "anonymous: lazy" was introduced
  ...

Author: nicolas-grekas

CurlHttpClient.php

@@ -288,7 +288,7 @@ public function request(string $method, string $url, array $options = []): Respo
                 $pushedResponse = $pushedResponse->response;
                 $pushedResponse->__construct($this->multi, $url, $options, $this->logger);
             } else {
-                $this->logger && $this->logger->debug(sprintf('Rejecting pushed response: "%s".', $url));
+                $this->logger && $this->logger->debug(sprintf('Rejecting pushed response: "%s"', $url));
                 $pushedResponse = null;
             }
         }
@@ -412,7 +412,7 @@ private static function acceptPushForRequest(string $method, array $options, Pus
             return false;
         }
 
-        foreach (['proxy', 'no_proxy', 'bindto'] as $k) {
+        foreach (['proxy', 'no_proxy', 'bindto', 'local_cert', 'local_pk'] as $k) {
             if ($options[$k] !== $pushedResponse->parentOptions[$k]) {
                 return false;
             }

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018-2019 Fabien Potencier
+Copyright (c) 2018-2020 Fabien Potencier
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

NativeHttpClient.php

@@ -169,7 +169,7 @@ public function request(string $method, string $url, array $options = []): Respo
             $this->multi->dnsCache = $options['resolve'] + $this->multi->dnsCache;
         }
 
-        $this->logger && $this->logger->info(sprintf('Request: %s %s', $method, implode('', $url)));
+        $this->logger && $this->logger->info(sprintf('Request: "%s %s"', $method, implode('', $url)));
 
         [$host, $port, $url['authority']] = self::dnsResolve($url, $this->multi, $info, $onProgress);
 
@@ -187,7 +187,7 @@ public function request(string $method, string $url, array $options = []): Respo
 
         $context = [
             'http' => [
-                'protocol_version' => $options['http_version'] ?: '1.1',
+                'protocol_version' => min($options['http_version'] ?: '1.1', '1.1'),
                 'method' => $method,
                 'content' => $options['body'],
                 'ignore_errors' => true,
@@ -357,7 +357,7 @@ private static function createRedirectResolver(array $options, string $host, ?ar
             });
 
             if (isset($options['normalized_headers']['authorization']) || isset($options['normalized_headers']['cookie'])) {
-                $redirectHeaders['no_auth'] = array_filter($options['headers'], static function ($h) {
+                $redirectHeaders['no_auth'] = array_filter($redirectHeaders['no_auth'], static function ($h) {
                     return 0 !== stripos($h, 'Authorization:') && 0 !== stripos($h, 'Cookie:');
                 });
             }

Response/NativeResponse.php

@@ -162,13 +162,13 @@ private function open(): void
             restore_error_handler();
         }
 
-        stream_set_blocking($h, false);
-        $this->context = $this->resolveRedirect = null;
-
-        if (isset($context['ssl']['peer_certificate_chain'])) {
+        if (isset($context['ssl']['capture_peer_cert_chain']) && isset(($context = stream_context_get_options($this->context))['ssl']['peer_certificate_chain'])) {
             $this->info['peer_certificate_chain'] = $context['ssl']['peer_certificate_chain'];
         }
 
+        stream_set_blocking($h, false);
+        $this->context = $this->resolveRedirect = null;
+
         // Create dechunk and inflate buffers
         if (isset($this->headers['content-length'])) {
             $this->remaining = (int) $this->headers['content-length'][0];

Response/ResponseTrait.php

@@ -204,7 +204,11 @@ public function toStream(bool $throw = true)
             $this->getHeaders($throw);
         }
 
-        return StreamWrapper::createResource($this, null, $this->content, $this->handle && 'stream' === get_resource_type($this->handle) ? $this->handle : null);
+        $stream = StreamWrapper::createResource($this);
+        stream_get_meta_data($stream)['wrapper_data']
+            ->bindHandles($this->handle, $this->content);
+
+        return $stream;
     }
 
     /**

Response/StreamWrapper.php

@@ -37,19 +37,17 @@ class StreamWrapper
     /** @var resource|null */
     private $handle;
 
+    private $blocking = true;
+    private $timeout;
     private $eof = false;
     private $offset = 0;
 
     /**
      * Creates a PHP stream resource from a ResponseInterface.
      *
-     * @param resource|null $contentBuffer The seekable resource where the response body is buffered
-     * @param resource|null $selectHandle  The resource handle that should be monitored when
-     *                                     stream_select() is used on the created stream
-     *
      * @return resource
      */
-    public static function createResource(ResponseInterface $response, HttpClientInterface $client = null, $contentBuffer = null, $selectHandle = null)
+    public static function createResource(ResponseInterface $response, HttpClientInterface $client = null)
     {
         if (null === $client && !method_exists($response, 'stream')) {
             throw new \InvalidArgumentException(sprintf('Providing a client to "%s()" is required when the response doesn\'t have any "stream()" method.', __CLASS__));
@@ -63,8 +61,6 @@ public static function createResource(ResponseInterface $response, HttpClientInt
             $context = [
                 'client' => $client ?? $response,
                 'response' => $response,
-                'content' => $contentBuffer,
-                'handle' => $selectHandle,
             ];
 
             return fopen('symfony://'.$response->getInfo('url'), 'r', false, stream_context_create(['symfony' => $context])) ?: null;
@@ -78,6 +74,17 @@ public function getResponse(): ResponseInterface
         return $this->response;
     }
 
+    /**
+     * @param resource|null $handle  The resource handle that should be monitored when
+     *                               stream_select() is used on the created stream
+     * @param resource|null $content The seekable resource where the response body is buffered
+     */
+    public function bindHandles(&$handle, &$content): void
+    {
+        $this->handle = &$handle;
+        $this->content = &$content;
+    }
+
     public function stream_open(string $path, string $mode, int $options): bool
     {
         if ('r' !== $mode) {
@@ -91,8 +98,6 @@ public function stream_open(string $path, string $mode, int $options): bool
         $context = stream_context_get_options($this->context)['symfony'] ?? null;
         $this->client = $context['client'] ?? null;
         $this->response = $context['response'] ?? null;
-        $this->content = $context['content'] ?? null;
-        $this->handle = $context['handle'] ?? null;
         $this->context = null;
 
         if (null !== $this->client && null !== $this->response) {
@@ -147,7 +152,7 @@ public function stream_read(int $count)
             return $data;
         }
 
-        foreach ($this->client->stream([$this->response]) as $chunk) {
+        foreach ($this->client->stream([$this->response], $this->blocking ? $this->timeout : 0) as $chunk) {
             try {
                 $this->eof = true;
                 $this->eof = !$chunk->isTimeout();
@@ -178,6 +183,19 @@ public function stream_read(int $count)
         return '';
     }
 
+    public function stream_set_option(int $option, int $arg1, ?int $arg2): bool
+    {
+        if (STREAM_OPTION_BLOCKING === $option) {
+            $this->blocking = (bool) $arg1;
+        } elseif (STREAM_OPTION_READ_TIMEOUT === $option) {
+            $this->timeout = $arg1 + $arg2 / 1e6;
+        } else {
+            return false;
+        }
+
+        return true;
+    }
+
     public function stream_tell(): int
     {
         return $this->offset;
@@ -238,6 +256,8 @@ public function stream_seek(int $offset, int $whence = SEEK_SET): bool
     public function stream_cast(int $castAs)
     {
         if (STREAM_CAST_FOR_SELECT === $castAs) {
+            $this->response->getHeaders(false);
+
             return $this->handle ?? false;
         }
 

Tests/HttpClientTestCase.php

@@ -75,4 +75,20 @@ public function testToStream404()
         $response = $client->request('GET', 'http://localhost:8057/404');
         $stream = $response->toStream();
     }
+
+    public function testNonBlockingStream()
+    {
+        $client = $this->getHttpClient(__FUNCTION__);
+        $response = $client->request('GET', 'http://localhost:8057/timeout-body');
+        $stream = $response->toStream();
+
+        $this->assertTrue(stream_set_blocking($stream, false));
+        $this->assertSame('<1>', fread($stream, 8192));
+        $this->assertFalse(feof($stream));
+
+        $this->assertTrue(stream_set_blocking($stream, true));
+        $this->assertSame('<2>', fread($stream, 8192));
+        $this->assertSame('', fread($stream, 8192));
+        $this->assertTrue(feof($stream));
+    }
 }

Tests/MockHttpClientTest.php

@@ -171,6 +171,10 @@ protected function getHttpClient(string $testCase): HttpClientInterface
 
                 return $client;
 
+            case 'testNonBlockingStream':
+                $responses[] = new MockResponse((function () { yield '<1>'; yield ''; yield '<2>'; })(), ['response_headers' => $headers]);
+                break;
+
             case 'testMaxDuration':
                 $mock = $this->getMockBuilder(ResponseInterface::class)->getMock();
                 $mock->expects($this->any())