Merge branch '3.4' into 4.1

fabpot · fabpot · commit 46fff8b4d71d · 2018-09-30T05:38:13.000+02:00
* 3.4:
  [Console] simplified code
  removed useless phpdoc
  improve docblocks around group sequences
  [Cache] prevent getting older entries when the version key is evicted
  [WebProfilerBundle] added a note in the README
  [Yaml] Skip parser test with root user
  [Filesystem] Skip tests on readable file when run with root user
  [FWBundle] Fix an error in WebTestCase::createClient's PHPDoc
  [HttpFoundation][Security] forward locale and format to subrequests
  [Console] Send the right exit code to console.terminate listeners
  [HttpFoundation] fix hidding warnings from session handlers
  Caching missed templates on cache warmup
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php
@@ -23,7 +23,7 @@ abstract class WebTestCase extends KernelTestCase
     /**
      * Creates a Client.
      *
-     * @param array $options An array of options to pass to the createKernel class
+     * @param array $options An array of options to pass to the createKernel method
      * @param array $server  An array of server parameters
      *
      * @return Client A Client instance
diff --git a/src/Symfony/Bundle/TwigBundle/TemplateIterator.php b/src/Symfony/Bundle/TwigBundle/TemplateIterator.php
@@ -63,7 +63,7 @@ public function getIterator()
             $this->templates = array_merge(
                 $this->templates,
                 $this->findTemplatesInDirectory($bundle->getPath().'/Resources/views', $name),
-                $this->findTemplatesInDirectory($this->rootDir.'/'.$bundle->getName().'/views', $name),
+                $this->findTemplatesInDirectory($this->rootDir.'/Resources/'.$bundle->getName().'/views', $name),
                 $this->findTemplatesInDirectory($this->defaultPath.'/bundles/'.$bundle->getName(), $name)
             );
         }
diff --git a/src/Symfony/Bundle/TwigBundle/Tests/Fixtures/templates/Resources/BarBundle/views/base.html.twig b/src/Symfony/Bundle/TwigBundle/Tests/Fixtures/templates/Resources/BarBundle/views/base.html.twig
diff --git a/src/Symfony/Bundle/TwigBundle/Tests/TemplateIteratorTest.php b/src/Symfony/Bundle/TwigBundle/Tests/TemplateIteratorTest.php
@@ -31,6 +31,7 @@ public function testGetIterator()
         sort($sorted);
         $this->assertEquals(
             array(
+                '@Bar/base.html.twig',
                 '@Bar/index.html.twig',
                 '@Bar/layout.html.twig',
                 '@Foo/index.html.twig',
diff --git a/src/Symfony/Bundle/WebProfilerBundle/README.md b/src/Symfony/Bundle/WebProfilerBundle/README.md
@@ -1,6 +1,12 @@
 WebProfilerBundle
 =================
 
+The Web profiler bundle is a **development tool** that gives detailed
+information about the execution of any request.
+
+**Never** enable it on production servers as it will lead to major security
+vulnerabilities in your project.
+
 Resources
 ---------
 
diff --git a/src/Symfony/Component/Cache/Traits/AbstractTrait.php b/src/Symfony/Component/Cache/Traits/AbstractTrait.php
@@ -106,14 +106,7 @@ public function clear()
     {
         $this->deferred = array();
         if ($cleared = $this->versioningIsEnabled) {
-            $namespaceVersion = 2;
-            try {
-                foreach ($this->doFetch(array('@'.$this->namespace)) as $v) {
-                    $namespaceVersion = 1 + (int) $v;
-                }
-            } catch (\Exception $e) {
-            }
-            $namespaceVersion .= ':';
+            $namespaceVersion = substr_replace(base64_encode(pack('V', mt_rand())), ':', 5);
             try {
                 $cleared = $this->doSave(array('@'.$this->namespace => $namespaceVersion), 0);
             } catch (\Exception $e) {
@@ -247,6 +240,10 @@ private function getId($key)
                 foreach ($this->doFetch(array('@'.$this->namespace)) as $v) {
                     $this->namespaceVersion = $v;
                 }
+                if ('1:' === $this->namespaceVersion) {
+                    $this->namespaceVersion = substr_replace(base64_encode(pack('V', time())), ':', 5);
+                    $this->doSave(array('@'.$this->namespace => $this->namespaceVersion), 0);
+                }
             } catch (\Exception $e) {
             }
         }
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -159,6 +159,8 @@ public function run(InputInterface $input = null, OutputInterface $output = null
             } else {
                 $exitCode = 1;
             }
+
+            return $exitCode;
         } finally {
             // if the exception handler changed, keep it
             // otherwise, unregister $renderException
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -960,6 +960,31 @@ public function testRunReturnsIntegerExitCode()
         $this->assertSame(4, $exitCode, '->run() returns integer exit code extracted from raised exception');
     }
 
+    public function testRunDispatchesIntegerExitCode()
+    {
+        $passedRightValue = false;
+
+        // We can assume here that some other test asserts that the event is dispatched at all
+        $dispatcher = new EventDispatcher();
+        $self = $this;
+        $dispatcher->addListener('console.terminate', function (ConsoleTerminateEvent $event) use ($self, &$passedRightValue) {
+            $passedRightValue = (4 === $event->getExitCode());
+        });
+
+        $application = new Application();
+        $application->setDispatcher($dispatcher);
+        $application->setAutoExit(false);
+
+        $application->register('test')->setCode(function (InputInterface $input, OutputInterface $output) {
+            throw new \Exception('', 4);
+        });
+
+        $tester = new ApplicationTester($application);
+        $tester->run(array('command' => 'test'));
+
+        $this->assertTrue($passedRightValue, '-> exit code 4 was passed in the console.terminate event');
+    }
+
     public function testRunReturnsExitCodeOneForExceptionCodeZero()
     {
         $exception = new \Exception('', 0);
@@ -975,6 +1000,31 @@ public function testRunReturnsExitCodeOneForExceptionCodeZero()
         $this->assertSame(1, $exitCode, '->run() returns exit code 1 when exception code is 0');
     }
 
+    public function testRunDispatchesExitCodeOneForExceptionCodeZero()
+    {
+        $passedRightValue = false;
+
+        // We can assume here that some other test asserts that the event is dispatched at all
+        $dispatcher = new EventDispatcher();
+        $self = $this;
+        $dispatcher->addListener('console.terminate', function (ConsoleTerminateEvent $event) use ($self, &$passedRightValue) {
+            $passedRightValue = (1 === $event->getExitCode());
+        });
+
+        $application = new Application();
+        $application->setDispatcher($dispatcher);
+        $application->setAutoExit(false);
+
+        $application->register('test')->setCode(function (InputInterface $input, OutputInterface $output) {
+            throw new \Exception();
+        });
+
+        $tester = new ApplicationTester($application);
+        $tester->run(array('command' => 'test'));
+
+        $this->assertTrue($passedRightValue, '-> exit code 1 was passed in the console.terminate event');
+    }
+
     /**
      * @expectedException \LogicException
      * @expectedExceptionMessage An option with shortcut "e" already exists.
diff --git a/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php b/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php
@@ -50,6 +50,10 @@ public function testCopyUnreadableFileFails()
             $this->markTestSkipped('This test cannot run on Windows.');
         }
 
+        if (!getenv('USER') || 'root' === getenv('USER')) {
+            $this->markTestSkipped('This test will fail if run under superuser');
+        }
+
         $sourceFilePath = $this->workspace.\DIRECTORY_SEPARATOR.'copy_source_file';
         $targetFilePath = $this->workspace.\DIRECTORY_SEPARATOR.'copy_target_file';
 
@@ -124,6 +128,10 @@ public function testCopyWithOverrideWithReadOnlyTargetFails()
             $this->markTestSkipped('This test cannot run on Windows.');
         }
 
+        if (!getenv('USER') || 'root' === getenv('USER')) {
+            $this->markTestSkipped('This test will fail if run under superuser');
+        }
+
         $sourceFilePath = $this->workspace.\DIRECTORY_SEPARATOR.'copy_source_file';
         $targetFilePath = $this->workspace.\DIRECTORY_SEPARATOR.'copy_target_file';
 
diff --git a/src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php b/src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php
@@ -137,7 +137,7 @@ public function validate($form, Constraint $constraint)
     /**
      * Returns the validation groups of the given form.
      *
-     * @return array The validation groups
+     * @return string|GroupSequence|(string|GroupSequence)[] The validation groups
      */
     private static function getValidationGroups(FormInterface $form)
     {
@@ -172,10 +172,10 @@ private static function getValidationGroups(FormInterface $form)
     /**
      * Post-processes the validation groups option for a given form.
      *
-     * @param array|callable $groups The validation groups
-     * @param FormInterface  $form   The validated form
+     * @param string|GroupSequence|(string|GroupSequence)[]|callable $groups The validation groups
+     * @param FormInterface                                          $form   The validated form
      *
-     * @return array The validation groups
+     * @return (string|GroupSequence)[] The validation groups
      */
     private static function resolveValidationGroups($groups, FormInterface $form)
     {
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -1325,7 +1325,7 @@ public function setFormat($format, $mimeTypes)
      *  * _format request attribute
      *  * $default
      *
-     * @param string $default The default format
+     * @param string|null $default The default format
      *
      * @return string The request format
      */
diff --git a/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php b/src/Symfony/Component/HttpFoundation/Session/Storage/NativeSessionStorage.php
@@ -227,29 +227,22 @@ public function save()
             unset($_SESSION[$key]);
         }
 
-        // Register custom error handler to catch a possible failure warning during session write
-        set_error_handler(function ($errno, $errstr, $errfile, $errline) {
-            throw new \ErrorException($errstr, $errno, E_WARNING, $errfile, $errline);
-        }, E_WARNING);
+        // Register error handler to add information about the current save handler
+        $previousHandler = set_error_handler(function ($type, $msg, $file, $line) use (&$previousHandler) {
+            if (E_WARNING === $type && 0 === strpos($msg, 'session_write_close():')) {
+                $handler = $this->saveHandler instanceof SessionHandlerProxy ? $this->saveHandler->getHandler() : $this->saveHandler;
+                $msg = sprintf('session_write_close(): Failed to write session data with "%s" handler', \get_class($handler));
+            }
+
+            return $previousHandler ? $previousHandler($type, $msg, $file, $line) : false;
+        });
 
         try {
-            $e = null;
             session_write_close();
-        } catch (\ErrorException $e) {
         } finally {
             restore_error_handler();
             $_SESSION = $session;
         }
-        if (null !== $e) {
-            // The default PHP error message is not very helpful, as it does not give any information on the current save handler.
-            // Therefore, we catch this error and trigger a warning with a better error message
-            $handler = $this->getSaveHandler();
-            if ($handler instanceof SessionHandlerProxy) {
-                $handler = $handler->getHandler();
-            }
-
-            trigger_error(sprintf('session_write_close(): Failed to write session data with %s handler', \get_class($handler)), E_USER_WARNING);
-        }
 
         $this->closed = true;
         $this->started = false;
diff --git a/src/Symfony/Component/HttpKernel/Fragment/InlineFragmentRenderer.php b/src/Symfony/Component/HttpKernel/Fragment/InlineFragmentRenderer.php
@@ -125,6 +125,13 @@ protected function createSubRequest($uri, Request $request)
         }
         $setSession($subRequest, $request);
 
+        if ($request->get('_format')) {
+            $subRequest->attributes->set('_format', $request->get('_format'));
+        }
+        if ($request->getDefaultLocale() !== $request->getLocale()) {
+            $subRequest->setLocale($request->getLocale());
+        }
+
         return $subRequest;
     }
 
diff --git a/src/Symfony/Component/HttpKernel/Tests/Fragment/InlineFragmentRendererTest.php b/src/Symfony/Component/HttpKernel/Tests/Fragment/InlineFragmentRendererTest.php
@@ -145,6 +145,26 @@ public function testExceptionInSubRequestsDoesNotMangleOutputBuffers()
         $this->assertEquals('Foo', ob_get_clean());
     }
 
+    public function testLocaleAndFormatAreIsKeptInSubrequest()
+    {
+        $expectedSubRequest = Request::create('/');
+        $expectedSubRequest->attributes->set('_format', 'foo');
+        $expectedSubRequest->setLocale('fr');
+        if (Request::getTrustedHeaderName(Request::HEADER_CLIENT_IP)) {
+            $expectedSubRequest->headers->set('x-forwarded-for', array('127.0.0.1'));
+            $expectedSubRequest->server->set('HTTP_X_FORWARDED_FOR', '127.0.0.1');
+        }
+        $expectedSubRequest->headers->set('forwarded', array('for="127.0.0.1";host="localhost";proto=http'));
+        $expectedSubRequest->server->set('HTTP_FORWARDED', 'for="127.0.0.1";host="localhost";proto=http');
+
+        $strategy = new InlineFragmentRenderer($this->getKernelExpectingRequest($expectedSubRequest));
+
+        $request = Request::create('/');
+        $request->attributes->set('_format', 'foo');
+        $request->setLocale('fr');
+        $strategy->render('/', $request);
+    }
+
     public function testESIHeaderIsKeptInSubrequest()
     {
         $expectedSubRequest = Request::create('/');
diff --git a/src/Symfony/Component/Security/Http/HttpUtils.php b/src/Symfony/Component/Security/Http/HttpUtils.php
@@ -95,6 +95,13 @@ public function createRequest(Request $request, $path)
             $newRequest->attributes->set(Security::LAST_USERNAME, $request->attributes->get(Security::LAST_USERNAME));
         }
 
+        if ($request->get('_format')) {
+            $newRequest->attributes->set('_format', $request->get('_format'));
+        }
+        if ($request->getDefaultLocale() !== $request->getLocale()) {
+            $newRequest->setLocale($request->getLocale());
+        }
+
         return $newRequest;
     }
 
diff --git a/src/Symfony/Component/Validator/GroupSequenceProviderInterface.php b/src/Symfony/Component/Validator/GroupSequenceProviderInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Component\Validator;
 
+use Symfony\Component\Validator\Constraints\GroupSequence;
+
 /**
  * Defines the interface for a group sequence provider.
  */
@@ -20,7 +22,7 @@ interface GroupSequenceProviderInterface
      * Returns which validation groups should be used for a certain state
      * of the object.
      *
-     * @return array An array of validation groups
+     * @return string[]|GroupSequence An array of validation groups
      */
     public function getGroupSequence();
 }
diff --git a/src/Symfony/Component/Validator/Mapping/ClassMetadata.php b/src/Symfony/Component/Validator/Mapping/ClassMetadata.php
@@ -392,7 +392,7 @@ public function getConstrainedProperties()
     /**
      * Sets the default group sequence for this class.
      *
-     * @param array $groupSequence An array of group names
+     * @param string[]|GroupSequence $groupSequence An array of group names
      *
      * @return $this
      *
diff --git a/src/Symfony/Component/Validator/Validator/ContextualValidatorInterface.php b/src/Symfony/Component/Validator/Validator/ContextualValidatorInterface.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Validator\Validator;
 
 use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Constraints\GroupSequence;
 use Symfony\Component\Validator\ConstraintViolationListInterface;
 
 /**
@@ -39,12 +40,9 @@ public function atPath($path);
      * If no constraint is passed, the constraint
      * {@link \Symfony\Component\Validator\Constraints\Valid} is assumed.
      *
-     * @param mixed                   $value       The value to validate
-     * @param Constraint|Constraint[] $constraints The constraint(s) to validate
-     *                                             against
-     * @param array|null              $groups      The validation groups to
-     *                                             validate. If none is given,
-     *                                             "Default" is assumed
+     * @param mixed                                              $value       The value to validate
+     * @param Constraint|Constraint[]                            $constraints The constraint(s) to validate against
+     * @param string|GroupSequence|(string|GroupSequence)[]|null $groups      The validation groups to validate. If none is given, "Default" is assumed
      *
      * @return $this
      */
@@ -54,10 +52,9 @@ public function validate($value, $constraints = null, $groups = null);
      * Validates a property of an object against the constraints specified
      * for this property.
      *
-     * @param object     $object       The object
-     * @param string     $propertyName The name of the validated property
-     * @param array|null $groups       The validation groups to validate. If
-     *                                 none is given, "Default" is assumed
+     * @param object                                             $object       The object
+     * @param string                                             $propertyName The name of the validated property
+     * @param string|GroupSequence|(string|GroupSequence)[]|null $groups       The validation groups to validate. If none is given, "Default" is assumed
      *
      * @return $this
      */
@@ -67,12 +64,10 @@ public function validateProperty($object, $propertyName, $groups = null);
      * Validates a value against the constraints specified for an object's
      * property.
      *
-     * @param object|string $objectOrClass The object or its class name
-     * @param string        $propertyName  The name of the property
-     * @param mixed         $value         The value to validate against the
-     *                                     property's constraints
-     * @param array|null    $groups        The validation groups to validate. If
-     *                                     none is given, "Default" is assumed
+     * @param object|string                                      $objectOrClass The object or its class name
+     * @param string                                             $propertyName  The name of the property
+     * @param mixed                                              $value         The value to validate against the property's constraints
+     * @param string|GroupSequence|(string|GroupSequence)[]|null $groups        The validation groups to validate. If none is given, "Default" is assumed
      *
      * @return $this
      */
diff --git a/src/Symfony/Component/Validator/Validator/RecursiveContextualValidator.php b/src/Symfony/Component/Validator/Validator/RecursiveContextualValidator.php
diff --git a/src/Symfony/Component/Validator/Validator/ValidatorInterface.php b/src/Symfony/Component/Validator/Validator/ValidatorInterface.php
diff --git a/src/Symfony/Component/Yaml/Tests/ParserTest.php b/src/Symfony/Component/Yaml/Tests/ParserTest.php

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ abstract class WebTestCase extends KernelTestCase`
`23`	`23`	`/**`
`24`	`24`	`* Creates a Client.`
`25`	`25`	`*`
`26`		`- * @param array $options An array of options to pass to the createKernel class`
	`26`	`+ * @param array $options An array of options to pass to the createKernel method`
`27`	`27`	`* @param array $server An array of server parameters`
`28`	`28`	`*`
`29`	`29`	`* @return Client A Client instance`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public function getIterator()`
`63`	`63`	`$this->templates = array_merge(`
`64`	`64`	`$this->templates,`
`65`	`65`	`$this->findTemplatesInDirectory($bundle->getPath().'/Resources/views', $name),`
`66`		`- $this->findTemplatesInDirectory($this->rootDir.'/'.$bundle->getName().'/views', $name),`
	`66`	`+ $this->findTemplatesInDirectory($this->rootDir.'/Resources/'.$bundle->getName().'/views', $name),`
`67`	`67`	`$this->findTemplatesInDirectory($this->defaultPath.'/bundles/'.$bundle->getName(), $name)`
`68`	`68`	`);`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -159,6 +159,8 @@ public function run(InputInterface $input = null, OutputInterface $output = null`
`159`	`159`	`} else {`
`160`	`160`	`$exitCode = 1;`
`161`	`161`	`}`
	`162`	`+`
	`163`	`+ return $exitCode;`
`162`	`164`	`} finally {`
`163`	`165`	`// if the exception handler changed, keep it`
`164`	`166`	`// otherwise, unregister $renderException`
Original file line number	Diff line number	Diff line change
`@@ -137,7 +137,7 @@ public function validate($form, Constraint $constraint)`
`137`	`137`	`/**`
`138`	`138`	`* Returns the validation groups of the given form.`
`139`	`139`	`*`
`140`		`- * @return array The validation groups`
	`140`	`+ * @return string\|GroupSequence\|(string\|GroupSequence)[] The validation groups`
`141`	`141`	`*/`
`142`	`142`	`private static function getValidationGroups(FormInterface $form)`
`143`	`143`	`{`
`@@ -172,10 +172,10 @@ private static function getValidationGroups(FormInterface $form)`
`172`	`172`	`/**`
`173`	`173`	`* Post-processes the validation groups option for a given form.`
`174`	`174`	`*`
`175`		`- * @param array\|callable $groups The validation groups`
`176`		`- * @param FormInterface $form The validated form`
	`175`	`+ * @param string\|GroupSequence\|(string\|GroupSequence)[]\|callable $groups The validation groups`
	`176`	`+ * @param FormInterface $form The validated form`
`177`	`177`	`*`
`178`		`- * @return array The validation groups`
	`178`	`+ * @return (string\|GroupSequence)[] The validation groups`
`179`	`179`	`*/`
`180`	`180`	`private static function resolveValidationGroups($groups, FormInterface $form)`
`181`	`181`	`{`