From 1f37275a72f974a11ca73157cf8f78398cf84c76 Mon Sep 17 00:00:00 2001
From: Robin Chalas <robin.chalas@elao.com>
Date: Thu, 30 May 2019 17:17:31 +0200
Subject: [PATCH] [FrameworkBundle] Add missing BC layer for deprecated
 ControllerNameParser injections

---
 UPGRADE-4.4.md                                |  8 +++++++
 UPGRADE-5.0.md                                |  5 ++++
 .../Bundle/FrameworkBundle/CHANGELOG.md       |  7 ++++++
 .../Controller/ControllerNameParser.php       |  6 ++++-
 .../Controller/ControllerResolver.php         | 22 +++++++++++++++---
 .../ResolveControllerNameSubscriber.php       |  6 ++++-
 .../Resources/config/routing.xml              |  2 +-
 .../FrameworkBundle/Resources/config/web.xml  | 18 +++++++++++----
 .../Routing/DelegatingLoader.php              | 23 +++++++++++++++----
 .../Controller/ControllerResolverTest.php     | 17 ++++++++++----
 .../ResolveControllerNameSubscriberTest.php   |  3 +++
 .../Tests/Routing/DelegatingLoaderTest.php    | 10 ++++----
 12 files changed, 103 insertions(+), 24 deletions(-)

diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
index 0e044861bd3c2..763e73a51ed07 100644
--- a/UPGRADE-4.4.md
+++ b/UPGRADE-4.4.md
@@ -25,6 +25,14 @@ DependencyInjection
        factory: ['@factory_service', method]
    ```
 
+FrameworkBundle
+---------------
+
+* The `$parser` argument of `ControllerResolver::__construct()` and `DelegatingLoader::__construct()`
+  has been deprecated.
+* The `ControllerResolver` and `DelegatingLoader` classes have been marked as `final`.
+* The `controller_name_converter` and `resolve_controller_name_subscriber` services have been deprecated.
+
 Messenger
 ---------
 
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
index 289910e8c2daa..5d8b699e43e65 100644
--- a/UPGRADE-5.0.md
+++ b/UPGRADE-5.0.md
@@ -219,6 +219,11 @@ FrameworkBundle
  * Removed support for legacy translations directories `src/Resources/translations/` and `src/Resources/<BundleName>/translations/`, use `translations/` instead.
  * Support for the legacy directory structure in `translation:update` and `debug:translation` commands has been removed.
  * Removed the "Psr\SimpleCache\CacheInterface" / "cache.app.simple" service, use "Symfony\Contracts\Cache\CacheInterface" / "cache.app" instead.
+ * The `$parser` argument of `ControllerResolver::__construct()` and `DelegatingLoader::__construct()`
+   has been removed.
+ * The `ControllerResolver` and `DelegatingLoader` classes have been made `final`.
+ * The `controller_name_converter` and `resolve_controller_name_subscriber` services have been removed.
+
 
 HttpFoundation
 --------------
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
index d32da9541ac5b..74b74c35ee7d5 100644
--- a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
+++ b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+* Deprecated the `$parser` argument of `ControllerResolver::__construct()` and `DelegatingLoader::__construct()`
+* Deprecated the `controller_name_converter` and `resolve_controller_name_subscriber` services
+* The `ControllerResolver` and `DelegatingLoader` classes have been marked as `final`
+
 4.3.0
 -----
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerNameParser.php b/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerNameParser.php
index d02a9824ce2b7..1a1112dbaeb23 100644
--- a/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerNameParser.php
+++ b/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerNameParser.php
@@ -27,9 +27,13 @@ class ControllerNameParser
 {
     protected $kernel;
 
-    public function __construct(KernelInterface $kernel)
+    public function __construct(KernelInterface $kernel, bool $triggerDeprecation = true)
     {
         $this->kernel = $kernel;
+
+        if ($triggerDeprecation) {
+            @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.1.', __CLASS__), E_USER_DEPRECATED);
+        }
     }
 
     /**
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerResolver.php b/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerResolver.php
index 552704f20d42d..e4f5e5dfa54a3 100644
--- a/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerResolver.php
+++ b/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerResolver.php
@@ -18,14 +18,30 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class ControllerResolver extends ContainerControllerResolver
 {
+    /**
+     * @deprecated since Symfony 4.4
+     */
     protected $parser;
 
-    public function __construct(ContainerInterface $container, ControllerNameParser $parser, LoggerInterface $logger = null)
+    /**
+     * @param LoggerInterface|null $logger
+     */
+    public function __construct(ContainerInterface $container, $logger = null)
     {
-        $this->parser = $parser;
+        if ($logger instanceof ControllerNameParser) {
+            @trigger_error(sprintf('Passing a "%s" instance as 2nd argument to "%s()" is deprecated since Symfony 4.4, pass a "%s" instance or null instead.', ControllerNameParser::class, __METHOD__, LoggerInterface::class), E_USER_DEPRECATED);
+            $this->parser = $logger;
+            $logger = 2 < \func_num_args() ? func_get_arg(2) : null;
+        } elseif (2 < \func_num_args() && func_get_arg(2) instanceof ControllerNameParser) {
+            $this->parser = func_get_arg(2);
+        } elseif ($logger && !$logger instanceof LoggerInterface) {
+            throw new \TypeError(sprintf('Argument 2 of "%s()" must be an instance of "%s" or null, "%s" given.', __METHOD__, LoggerInterface::class, \is_object($logger) ? \get_class($logger) : \gettype($logger)), E_USER_DEPRECATED);
+        }
 
         parent::__construct($container, $logger);
     }
@@ -35,7 +51,7 @@ public function __construct(ContainerInterface $container, ControllerNameParser
      */
     protected function createController($controller)
     {
-        if (false === strpos($controller, '::') && 2 === substr_count($controller, ':')) {
+        if ($this->parser && false === strpos($controller, '::') && 2 === substr_count($controller, ':')) {
             // controller in the a:b:c notation then
             $deprecatedNotation = $controller;
             $controller = $this->parser->parse($deprecatedNotation, false);
diff --git a/src/Symfony/Bundle/FrameworkBundle/EventListener/ResolveControllerNameSubscriber.php b/src/Symfony/Bundle/FrameworkBundle/EventListener/ResolveControllerNameSubscriber.php
index 709df23075a54..1964be1b4bd09 100644
--- a/src/Symfony/Bundle/FrameworkBundle/EventListener/ResolveControllerNameSubscriber.php
+++ b/src/Symfony/Bundle/FrameworkBundle/EventListener/ResolveControllerNameSubscriber.php
@@ -27,8 +27,12 @@ class ResolveControllerNameSubscriber implements EventSubscriberInterface
 {
     private $parser;
 
-    public function __construct(ControllerNameParser $parser)
+    public function __construct(ControllerNameParser $parser, bool $triggerDeprecation = true)
     {
+        if ($triggerDeprecation) {
+            @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.1.', __CLASS__), E_USER_DEPRECATED);
+        }
+
         $this->parser = $parser;
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing.xml
index 8c293ebefc390..54e16f5b4bbbf 100644
--- a/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing.xml
+++ b/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing.xml
@@ -46,9 +46,9 @@
         </service>
 
         <service id="routing.loader" class="Symfony\Bundle\FrameworkBundle\Routing\DelegatingLoader" public="true">
-            <argument type="service" id="controller_name_converter" />
             <argument type="service" id="routing.resolver" />
             <argument type="collection" />
+            <argument type="service" id=".legacy_controller_name_converter" /> <!-- deprecated since Symfony 4.4 -->
         </service>
 
         <service id="router.default" class="Symfony\Bundle\FrameworkBundle\Routing\Router">
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml
index 07aa84c9cc033..8fc28054d71e2 100644
--- a/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml
+++ b/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml
@@ -7,16 +7,21 @@
     <services>
         <defaults public="false" />
 
-        <service id="controller_name_converter" class="Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser">
+        <service id=".legacy_controller_name_converter" class="Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser">
             <tag name="monolog.logger" channel="request" />
             <argument type="service" id="kernel" />
+            <argument>false</argument>
+        </service>
+
+        <service id="controller_name_converter" alias=".legacy_controller_name_converter">
+            <deprecated>The "%alias_id%" service is deprecated since Symfony 4.3.</deprecated>
         </service>
 
         <service id="controller_resolver" class="Symfony\Bundle\FrameworkBundle\Controller\ControllerResolver">
             <tag name="monolog.logger" channel="request" />
             <argument type="service" id="service_container" />
-            <argument type="service" id="controller_name_converter" />
             <argument type="service" id="logger" on-invalid="ignore" />
+            <argument type="service" id=".legacy_controller_name_converter" />
         </service>
 
         <service id="argument_metadata_factory" class="Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory" />
@@ -81,10 +86,15 @@
             <tag name="kernel.event_subscriber" />
         </service>
 
-        <service id="resolve_controller_name_subscriber" class="Symfony\Bundle\FrameworkBundle\EventListener\ResolveControllerNameSubscriber">
-            <argument type="service" id="controller_name_converter" />
+        <service id=".legacy_resolve_controller_name_subscriber" class="Symfony\Bundle\FrameworkBundle\EventListener\ResolveControllerNameSubscriber">
+            <argument type="service" id=".legacy_controller_name_converter" />
+            <argument>false</argument>
             <tag name="kernel.event_subscriber" />
         </service>
+        <service id="resolve_controller_name_subscriber" alias=".legacy_resolve_controller_name_subscriber">
+            <deprecated>The "%alias_id%" service is deprecated since Symfony 4.3.</deprecated>
+        </service>
+
         <service id="disallow_search_engine_index_response_listener" class="Symfony\Component\HttpKernel\EventListener\DisallowRobotsIndexingListener">
             <tag name="kernel.event_subscriber" />
         </service>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Routing/DelegatingLoader.php b/src/Symfony/Bundle/FrameworkBundle/Routing/DelegatingLoader.php
index 1e6b90a9bf107..63e6af0be3832 100644
--- a/src/Symfony/Bundle/FrameworkBundle/Routing/DelegatingLoader.php
+++ b/src/Symfony/Bundle/FrameworkBundle/Routing/DelegatingLoader.php
@@ -23,20 +23,33 @@
  * to the fully-qualified form (from a:b:c to class::method).
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class DelegatingLoader extends BaseDelegatingLoader
 {
+    /**
+     * @deprecated since Symfony 4.4
+     */
     protected $parser;
     private $loading = false;
     private $defaultOptions;
 
     /**
-     * @param ControllerNameParser    $parser   A ControllerNameParser instance
-     * @param LoaderResolverInterface $resolver A LoaderResolverInterface instance
+     * @param LoaderResolverInterface $resolver
+     * @param array                   $defaultOptions
      */
-    public function __construct(ControllerNameParser $parser, LoaderResolverInterface $resolver, array $defaultOptions = [])
+    public function __construct($resolver, $defaultOptions = [])
     {
-        $this->parser = $parser;
+        if ($resolver instanceof ControllerNameParser) {
+            @trigger_error(sprintf('Passing a "%s" instance as first argument to "%s()" is deprecated since Symfony 4.4, pass a "%s" instance instead.', ControllerNameParser::class, __METHOD__, LoaderResolverInterface::class), E_USER_DEPRECATED);
+            $this->parser = $resolver;
+            $resolver = $defaultOptions;
+            $defaultOptions = 2 < \func_num_args() ? func_get_arg(2) : [];
+        } elseif (2 < \func_num_args() && func_get_arg(2) instanceof ControllerNameParser) {
+            $this->parser = func_get_arg(2);
+        }
+
         $this->defaultOptions = $defaultOptions;
 
         parent::__construct($resolver);
@@ -86,7 +99,7 @@ public function load($resource, $type = null)
                 continue;
             }
 
-            if (2 === substr_count($controller, ':')) {
+            if ($this->parser && 2 === substr_count($controller, ':')) {
                 $deprecatedNotation = $controller;
 
                 try {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerResolverTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerResolverTest.php
index d73f5765689f7..3eea42c24ec45 100644
--- a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerResolverTest.php
+++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerResolverTest.php
@@ -63,7 +63,7 @@ public function testGetControllerWithBundleNotation()
             ->willReturn('Symfony\Bundle\FrameworkBundle\Tests\Controller\ContainerAwareController::testAction')
         ;
 
-        $resolver = $this->createControllerResolver(null, null, $parser);
+        $resolver = $this->createLegacyControllerResolver(null, null, $parser);
         $request = Request::create('/');
         $request->attributes->set('_controller', $shortName);
 
@@ -105,7 +105,7 @@ class_exists(AbstractControllerTest::class);
         $container = new Container();
         $container->set(TestAbstractController::class, $controller);
 
-        $resolver = $this->createControllerResolver(null, $container);
+        $resolver = $this->createLegacyControllerResolver(null, $container);
 
         $request = Request::create('/');
         $request->attributes->set('_controller', TestAbstractController::class.'::fooAction');
@@ -127,7 +127,7 @@ class_exists(AbstractControllerTest::class);
         $container = new Container();
         $container->set(DummyController::class, $controller);
 
-        $resolver = $this->createControllerResolver(null, $container);
+        $resolver = $this->createLegacyControllerResolver(null, $container);
 
         $request = Request::create('/');
         $request->attributes->set('_controller', DummyController::class.'::fooAction');
@@ -176,7 +176,7 @@ class_exists(AbstractControllerTest::class);
         $this->assertSame($controllerContainer, $controller->getContainer());
     }
 
-    protected function createControllerResolver(LoggerInterface $logger = null, Psr11ContainerInterface $container = null, ControllerNameParser $parser = null)
+    protected function createLegacyControllerResolver(LoggerInterface $logger = null, Psr11ContainerInterface $container = null, ControllerNameParser $parser = null)
     {
         if (!$parser) {
             $parser = $this->createMockParser();
@@ -189,6 +189,15 @@ protected function createControllerResolver(LoggerInterface $logger = null, Psr1
         return new ControllerResolver($container, $parser, $logger);
     }
 
+    protected function createControllerResolver(LoggerInterface $logger = null, Psr11ContainerInterface $container = null)
+    {
+        if (!$container) {
+            $container = $this->createMockContainer();
+        }
+
+        return new ControllerResolver($container, $logger);
+    }
+
     protected function createMockParser()
     {
         return $this->getMockBuilder('Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser')->disableOriginalConstructor()->getMock();
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/EventListener/ResolveControllerNameSubscriberTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/EventListener/ResolveControllerNameSubscriberTest.php
index c8bc4f8a854c5..4d9acb9911a87 100644
--- a/src/Symfony/Bundle/FrameworkBundle/Tests/EventListener/ResolveControllerNameSubscriberTest.php
+++ b/src/Symfony/Bundle/FrameworkBundle/Tests/EventListener/ResolveControllerNameSubscriberTest.php
@@ -18,6 +18,9 @@
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 
+/**
+ * @group legacy
+ */
 class ResolveControllerNameSubscriberTest extends TestCase
 {
     /**
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Routing/DelegatingLoaderTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Routing/DelegatingLoaderTest.php
index 1d576056ebf8b..daed030f721a2 100644
--- a/src/Symfony/Bundle/FrameworkBundle/Tests/Routing/DelegatingLoaderTest.php
+++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Routing/DelegatingLoaderTest.php
@@ -13,6 +13,10 @@
 
 class DelegatingLoaderTest extends TestCase
 {
+    /**
+     * @group legacy
+     * @expectedDeprecation Passing a "Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser" instance as first argument to "Symfony\Bundle\FrameworkBundle\Routing\DelegatingLoader::__construct()" is deprecated since Symfony 4.4, pass a "Symfony\Component\Config\Loader\LoaderResolverInterface" instance instead.
+     */
     public function testConstructorApi()
     {
         $controllerNameParser = $this->getMockBuilder(ControllerNameParser::class)
@@ -24,10 +28,6 @@ public function testConstructorApi()
 
     public function testLoadDefaultOptions()
     {
-        $controllerNameParser = $this->getMockBuilder(ControllerNameParser::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
         $loaderResolver = $this->getMockBuilder(LoaderResolverInterface::class)
             ->disableOriginalConstructor()
             ->getMock();
@@ -46,7 +46,7 @@ public function testLoadDefaultOptions()
             ->method('load')
             ->willReturn($routeCollection);
 
-        $delegatingLoader = new DelegatingLoader($controllerNameParser, $loaderResolver, ['utf8' => true]);
+        $delegatingLoader = new DelegatingLoader($loaderResolver, ['utf8' => true]);
 
         $loadedRouteCollection = $delegatingLoader->load('foo');
         $this->assertCount(2, $loadedRouteCollection);

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/31739.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/31739.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/31739.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony/pull/31739.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>