bug #20474 [Routing] Fail properly when a route parameter name cannot be used as a PCRE subpattern name (fancyweb)

nicolas-grekas · nicolas-grekas · commit 8c2a77bbcaab · 2016-11-25T13:07:11.000+01:00
This PR was squashed before being merged into the 2.7 branch (closes #20474). Discussion ---------- [Routing] Fail properly when a route parameter name cannot be used as a PCRE subpattern name | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#7139 This is a follow up PR to #20327. I also decided to improve the current `is_numeric()` check that is done by a truer one. The current limitation is that a PCRE subpattern name must not start with a digit which is different. Commits ------- 73fbd08 [Routing] Fail properly when a route parameter name cannot be used as a PCRE subpattern name
diff --git a/src/Symfony/Component/Routing/RouteCompiler.php b/src/Symfony/Component/Routing/RouteCompiler.php
@@ -28,12 +28,20 @@ class RouteCompiler implements RouteCompilerInterface
      */
     const SEPARATORS = '/,;.:-_~+*=@|';
 
+    /**
+     * The maximum supported length of a PCRE subpattern name
+     * http://pcre.org/current/doc/html/pcre2pattern.html#SEC16.
+     *
+     * @internal
+     */
+    const VARIABLE_MAXIMUM_LENGTH = 32;
+
     /**
      * {@inheritdoc}
      *
      * @throws \LogicException  If a variable is referenced more than once
-     * @throws \DomainException If a variable name is numeric because PHP raises an error for such
-     *                          subpatterns in PCRE and thus would break matching, e.g. "(?P<123>.+)".
+     * @throws \DomainException If a variable name starts with a digit or if it is too long to be successfully used as
+     *                          a PCRE subpattern.
      */
     public static function compile(Route $route)
     {
@@ -95,13 +103,19 @@ private static function compilePattern(Route $route, $pattern, $isHost)
             $precedingChar = strlen($precedingText) > 0 ? substr($precedingText, -1) : '';
             $isSeparator = '' !== $precedingChar && false !== strpos(static::SEPARATORS, $precedingChar);
 
-            if (is_numeric($varName)) {
-                throw new \DomainException(sprintf('Variable name "%s" cannot be numeric in route pattern "%s". Please use a different name.', $varName, $pattern));
+            // A PCRE subpattern name must start with a non-digit. Also a PHP variable cannot start with a digit so the
+            // variable would not be usable as a Controller action argument.
+            if (preg_match('/^\d/', $varName)) {
+                throw new \DomainException(sprintf('Variable name "%s" cannot start with a digit in route pattern "%s". Please use a different name.', $varName, $pattern));
             }
             if (in_array($varName, $variables)) {
                 throw new \LogicException(sprintf('Route pattern "%s" cannot reference variable name "%s" more than once.', $pattern, $varName));
             }
 
+            if (strlen($varName) > self::VARIABLE_MAXIMUM_LENGTH) {
+                throw new \DomainException(sprintf('Variable name "%s" cannot be longer than %s characters in route pattern "%s". Please use a shorter name.', $varName, self::VARIABLE_MAXIMUM_LENGTH, $pattern));
+            }
+
             if ($isSeparator && strlen($precedingText) > 1) {
                 $tokens[] = array('text', substr($precedingText, 0, -1));
             } elseif (!$isSeparator && strlen($precedingText) > 0) {
diff --git a/src/Symfony/Component/Routing/Tests/RouteCompilerTest.php b/src/Symfony/Component/Routing/Tests/RouteCompilerTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Routing\Tests;
 
 use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCompiler;
 
 class RouteCompilerTest extends \PHPUnit_Framework_TestCase
 {
@@ -176,16 +177,16 @@ public function testRouteWithSameVariableTwice()
     }
 
     /**
-     * @dataProvider getNumericVariableNames
+     * @dataProvider getVariableNamesStartingWithADigit
      * @expectedException \DomainException
      */
-    public function testRouteWithNumericVariableName($name)
+    public function testRouteWithVariableNameStartingWithADigit($name)
     {
         $route = new Route('/{'.$name.'}');
         $route->compile();
     }
 
-    public function getNumericVariableNames()
+    public function getVariableNamesStartingWithADigit()
     {
         return array(
            array('09'),
@@ -264,4 +265,13 @@ public function provideCompileWithHostData()
             ),
         );
     }
+
+    /**
+     * @expectedException \DomainException
+     */
+    public function testRouteWithTooLongVariableName()
+    {
+        $route = new Route(sprintf('/{%s}', str_repeat('a', RouteCompiler::VARIABLE_MAXIMUM_LENGTH + 1)));
+        $route->compile();
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`namespace Symfony\Component\Routing\Tests;`
`13`	`13`
`14`	`14`	`use Symfony\Component\Routing\Route;`
	`15`	`+use Symfony\Component\Routing\RouteCompiler;`
`15`	`16`
`16`	`17`	`class RouteCompilerTest extends \PHPUnit_Framework_TestCase`
`17`	`18`	`{`
`@@ -176,16 +177,16 @@ public function testRouteWithSameVariableTwice()`
`176`	`177`	`}`
`177`	`178`
`178`	`179`	`/**`
`179`		`- * @dataProvider getNumericVariableNames`
	`180`	`+ * @dataProvider getVariableNamesStartingWithADigit`
`180`	`181`	`* @expectedException \DomainException`
`181`	`182`	`*/`
`182`		`- public function testRouteWithNumericVariableName($name)`
	`183`	`+ public function testRouteWithVariableNameStartingWithADigit($name)`
`183`	`184`	`{`
`184`	`185`	`$route = new Route('/{'.$name.'}');`
`185`	`186`	`$route->compile();`
`186`	`187`	`}`
`187`	`188`
`188`		`- public function getNumericVariableNames()`
	`189`	`+ public function getVariableNamesStartingWithADigit()`
`189`	`190`	`{`
`190`	`191`	`return array(`
`191`	`192`	`array('09'),`
`@@ -264,4 +265,13 @@ public function provideCompileWithHostData()`
`264`	`265`	`),`
`265`	`266`	`);`
`266`	`267`	`}`
	`268`	`+`
	`269`	`+ /**`
	`270`	`+ * @expectedException \DomainException`
	`271`	`+ */`
	`272`	`+ public function testRouteWithTooLongVariableName()`
	`273`	`+ {`
	`274`	`+ $route = new Route(sprintf('/{%s}', str_repeat('a', RouteCompiler::VARIABLE_MAXIMUM_LENGTH + 1)));`
	`275`	`+ $route->compile();`
	`276`	`+ }`
`267`	`277`	`}`