added a RequestStack class

symfony · fabpot · Sep 8, 2013 · Apr 18, 2013 · Aug 31, 2013 · Aug 31, 2013
commit c55f1ea8af80cf5c96b27d57b7bf97843ec73aef
diff --git a/src/Symfony/Bridge/Twig/Tests/Extension/HttpKernelExtensionTest.php b/src/Symfony/Bridge/Twig/Tests/Extension/HttpKernelExtensionTest.php
@@ -14,7 +14,9 @@
 use Symfony\Bridge\Twig\Extension\HttpKernelExtension;
 use Symfony\Bridge\Twig\Tests\TestCase;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Fragment\FragmentHandler;
+use Symfony\Component\HttpKernel\RequestContext;

 class HttpKernelExtensionTest extends TestCase
 {
@@ -23,13 +25,30 @@ class HttpKernelExtensionTest extends TestCase
     */
    public function testFragmentWithError()
    {
-        $kernel = $this->getFragmentHandler($this->throwException(new \Exception('foo')));
+        $renderer = $this->getFragmentHandler($this->throwException(new \Exception('foo')));

-        $loader = new \Twig_Loader_Array(array('index' => '{{ fragment("foo") }}'));
-        $twig = new \Twig_Environment($loader, array('debug' => true, 'cache' => false));
-        $twig->addExtension(new HttpKernelExtension($kernel));
+        $this->renderTemplate($renderer);
+    }
+
+    public function testRenderFragment()
+    {
+        $renderer = $this->getFragmentHandler($this->returnValue(new Response('html')));
+
+        $response = $this->renderTemplate($renderer);

-        $this->renderTemplate($kernel);
+        $this->assertEquals('html', $response);
+    }
+
+    public function testUnknownFragmentRenderer()
+    {
+        $context = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\RequestContext')
+            ->disableOriginalConstructor()
+            ->getMock()
+        ;
+        $renderer = new FragmentHandler($context, array());
+
+        $this->setExpectedException('InvalidArgumentException', 'The "inline" renderer does not exist.');
+        $renderer->render('/foo');
    }

    protected function getFragmentHandler($return)
@@ -38,8 +57,14 @@ protected function getFragmentHandler($return)
        $strategy->expects($this->once())->method('getName')->will($this->returnValue('inline'));
        $strategy->expects($this->once())->method('render')->will($return);

-        $renderer = new FragmentHandler(array($strategy));
-        $renderer->setRequest(Request::create('/'));
+        $context = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\RequestContext')
+            ->disableOriginalConstructor()
+            ->getMock()
+        ;
+
+        $context->expects($this->any())->method('getCurrentRequest')->will($this->returnValue(Request::create('/')));
+
+        $renderer = new FragmentHandler($context, array($strategy));

        return $renderer;
    }

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/fragment_renderer.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/fragment_renderer.xml
@@ -15,9 +15,9 @@

    <services>
        <service id="fragment.handler" class="%fragment.handler.class%">
+            <argument type="service" id="request_context" />
            <argument type="collection" />
            <argument>%kernel.debug%</argument>
-            <call method="setRequest"><argument type="service" id="request" on-invalid="null" strict="false" /></call>
        </service>

        <service id="fragment.renderer.inline" class="%fragment.renderer.inline.class%">

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/routing.xml
@@ -92,9 +92,9 @@
            <tag name="kernel.event_subscriber" />
            <tag name="monolog.logger" channel="request" />
            <argument type="service" id="router" />
+            <argument type="service" id="request_context" />
            <argument type="service" id="router.request_context" on-invalid="ignore" />
            <argument type="service" id="logger" on-invalid="ignore" />
-            <call method="setRequest"><argument type="service" id="request" on-invalid="null" strict="false" /></call>
        </service>
    </services>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/services.xml
@@ -12,6 +12,8 @@
        <parameter key="cache_clearer.class">Symfony\Component\HttpKernel\CacheClearer\ChainCacheClearer</parameter>
        <parameter key="file_locator.class">Symfony\Component\HttpKernel\Config\FileLocator</parameter>
        <parameter key="uri_signer.class">Symfony\Component\HttpKernel\UriSigner</parameter>
+        <parameter key="request_stack.class">Symfony\Component\HttpKernel\RequestStack</parameter>
+        <parameter key="request_context.class">Symfony\Component\HttpKernel\RequestContext</parameter>
    </parameters>

    <services>
@@ -23,6 +25,14 @@
            <argument type="service" id="event_dispatcher" />
            <argument type="service" id="service_container" />
            <argument type="service" id="controller_resolver" />
+            <argument type="service" id="request_stack" />
+        </service>
+
+        <service id="request_stack" class="%request_stack.class%">
+        </service>
+
+        <service id="request_context" class="%request_context.class%">
+            <argument type="service" id="request_stack" />
        </service>

        <service id="cache_warmer" class="%cache_warmer.class%">

diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml
@@ -37,8 +37,8 @@
        <service id="locale_listener" class="%locale_listener.class%">
            <tag name="kernel.event_subscriber" />
            <argument>%kernel.default_locale%</argument>
+            <argument type="service" id="request_context" />
            <argument type="service" id="router" on-invalid="ignore" />
-            <call method="setRequest"><argument type="service" id="request" on-invalid="null" strict="false" /></call>
        </service>
    </services>
 </container>
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/ContainerAwareHttpKernel.php b/src/Symfony/Component/HttpKernel/DependencyInjection/ContainerAwareHttpKernel.php
@@ -14,6 +14,7 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\HttpKernel\HttpKernel;
+use Symfony\Component\HttpKernel\RequestStack;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -28,17 +29,19 @@
 class ContainerAwareHttpKernel extends HttpKernel
 {
    protected $container;
+    protected $requestStack;

    /**
     * Constructor.
     *
     * @param EventDispatcherInterface    $dispatcher         An EventDispatcherInterface instance
     * @param ContainerInterface          $container          A ContainerInterface instance
     * @param ControllerResolverInterface $controllerResolver A ControllerResolverInterface instance
+      * @param RequestStack               $requestStack       A stack for master/sub requests
     */
-    public function __construct(EventDispatcherInterface $dispatcher, ContainerInterface $container, ControllerResolverInterface $controllerResolver)
+    public function __construct(EventDispatcherInterface $dispatcher, ContainerInterface $container, ControllerResolverInterface $controllerResolver, RequestStack $requestStack)
    {
-        parent::__construct($dispatcher, $controllerResolver);
+        parent::__construct($dispatcher, $controllerResolver, $requestStack);

        $this->container = $container;


diff --git a/src/Symfony/Component/HttpKernel/Event/RequestFinishedEvent.php b/src/Symfony/Component/HttpKernel/Event/RequestFinishedEvent.php
@@ -0,0 +1,21 @@
+<?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\HttpKernel\Event;
+
+/**
+ * Triggered whenever a request is fully processed.
+ *
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
+ */
+class RequestFinishedEvent extends KernelEvent
+{
+}
diff --git a/src/Symfony/Component/HttpKernel/EventListener/LocaleListener.php b/src/Symfony/Component/HttpKernel/EventListener/LocaleListener.php
@@ -12,7 +12,9 @@
 namespace Symfony\Component\HttpKernel\EventListener;

 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\Event\RequestFinishedEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
+use Symfony\Component\HttpKernel\RequestContext;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\RequestContextAwareInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -26,41 +28,64 @@ class LocaleListener implements EventSubscriberInterface
 {
    private $router;
    private $defaultLocale;
+    private $requestContext;

-    public function __construct($defaultLocale = 'en', RequestContextAwareInterface $router = null)
+    public function __construct($defaultLocale = 'en', RequestContext $requestContext, RequestContextAwareInterface $router = null)
    {
        $this->defaultLocale = $defaultLocale;
+        $this->requestContext = $requestContext;
        $this->router = $router;
    }

-    public function setRequest(Request $request = null)
+    public function onKernelRequest(GetResponseEvent $event)
+    {
+        $request = $event->getRequest();
+        $request->setDefaultLocale($this->defaultLocale);
+
+        $this->setLocale($request);
+        $this->setRouterContext($request);
+    }
+
+    public function onKernelRequestFinished(RequestFinishedEvent $event)
    {
-        if (null === $request) {
+        $this->resetRouterContext();
+    }
+
+    private function resetRouterContext()
+    {
+        if ($this->requestContext === null) {
+            return;
+        }
+
+        $parentRequest = $this->requestContext->getParentRequest();
+
+        if ($parentRequest === null) {
            return;
        }

+        $this->setRouterContext($parentRequest);
+    }
+
+    private function setLocale(Request $request)
+    {
        if ($locale = $request->attributes->get('_locale')) {
            $request->setLocale($locale);
        }
+    }

+    private function setRouterContext(Request $request)
+    {
        if (null !== $this->router) {
            $this->router->getContext()->setParameter('_locale', $request->getLocale());
        }
    }

-    public function onKernelRequest(GetResponseEvent $event)
-    {
-        $request = $event->getRequest();
-        $request->setDefaultLocale($this->defaultLocale);
-
-        $this->setRequest($request);
-    }
-
    public static function getSubscribedEvents()
    {
        return array(
            // must be registered after the Router to have access to the _locale
            KernelEvents::REQUEST => array(array('onKernelRequest', 16)),
+            KernelEvents::REQUEST_FINISHED => array(array('onKernelRequestFinished', 0)),
        );
    }
 }
diff --git a/src/Symfony/Component/HttpKernel/EventListener/RouterListener.php b/src/Symfony/Component/HttpKernel/EventListener/RouterListener.php
@@ -13,9 +13,11 @@

 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\Event\RequestFinishedEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Symfony\Component\HttpKernel\RequestContext as KernelRequestContext;
 use Symfony\Component\Routing\Exception\MethodNotAllowedException;
 use Symfony\Component\Routing\Exception\ResourceNotFoundException;
 use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
@@ -36,6 +38,7 @@ class RouterListener implements EventSubscriberInterface
    private $context;
    private $logger;
    private $request;
+    private $kernelContext;

    /**
     * Constructor.
@@ -46,7 +49,7 @@ class RouterListener implements EventSubscriberInterface
     *
     * @throws \InvalidArgumentException
     */
-    public function __construct($matcher, RequestContext $context = null, LoggerInterface $logger = null)
+    public function __construct($matcher, KernelRequestContext $kernelContext, RequestContext $context = null, LoggerInterface $logger = null)
    {
        if (!$matcher instanceof UrlMatcherInterface && !$matcher instanceof RequestMatcherInterface) {
            throw new \InvalidArgumentException('Matcher must either implement UrlMatcherInterface or RequestMatcherInterface.');
@@ -58,6 +61,7 @@ public function __construct($matcher, RequestContext $context = null, LoggerInte

        $this->matcher = $matcher;
        $this->context = $context ?: $matcher->getContext();
+        $this->kernelContext = $kernelContext;
        $this->logger = $logger;
    }

@@ -71,22 +75,27 @@ public function __construct($matcher, RequestContext $context = null, LoggerInte
     *
     * @param Request|null $request A Request instance
     */
-    public function setRequest(Request $request = null)
+    private function populateRoutingContext(Request $request = null)
    {
        if (null !== $request && $this->request !== $request) {
            $this->context->fromRequest($request);
        }
        $this->request = $request;
    }

+     public function onKernelRequestFinished(RequestFinishedEvent $event)
+     {
+         $this->populateRoutingContext($this->kernelContext->getParentRequest());
+     }
+
    public function onKernelRequest(GetResponseEvent $event)
    {
        $request = $event->getRequest();

        // initialize the context that is also used by the generator (assuming matcher and generator share the same context instance)
        // we call setRequest even if most of the time, it has already been done to keep compatibility
        // with frameworks which do not use the Symfony service container
-        $this->setRequest($request);
+        $this->populateRoutingContext($request);

        if ($request->attributes->has('_controller')) {
            // routing is already done
@@ -139,6 +148,7 @@ public static function getSubscribedEvents()
    {
        return array(
            KernelEvents::REQUEST => array(array('onKernelRequest', 32)),
+            KernelEvents::REQUEST_FINISHED => array(array('onKernelRequestFinished', 0)),
        );
    }
 }
diff --git a/src/Symfony/Component/HttpKernel/Fragment/FragmentHandler.php b/src/Symfony/Component/HttpKernel/Fragment/FragmentHandler.php
@@ -15,6 +15,7 @@
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 use Symfony\Component\HttpKernel\Controller\ControllerReference;
+use Symfony\Component\HttpKernel\RequestContext;

 /**
 * Renders a URI that represents a resource fragment.
@@ -30,16 +31,17 @@ class FragmentHandler
 {
    private $debug;
    private $renderers;
-    private $request;
+    private $context;

    /**
     * Constructor.
     *
     * @param FragmentRendererInterface[] $renderers An array of FragmentRendererInterface instances
     * @param Boolean                     $debug     Whether the debug mode is enabled or not
     */
-    public function __construct(array $renderers = array(), $debug = false)
+    public function __construct(RequestContext $context, array $renderers = array(), $debug = false)
    {
+        $this->context = $context;
        $this->renderers = array();
        foreach ($renderers as $renderer) {
            $this->addRenderer($renderer);
@@ -57,16 +59,6 @@ public function addRenderer(FragmentRendererInterface $renderer)
        $this->renderers[$renderer->getName()] = $renderer;
    }

-    /**
-     * Sets the current Request.
-     *
-     * @param Request $request The current Request
-     */
-    public function setRequest(Request $request = null)
-    {
-        $this->request = $request;
-    }
-
    /**
     * Renders a URI and returns the Response content.
     *
@@ -93,11 +85,7 @@ public function render($uri, $renderer = 'inline', array $options = array())
            throw new \InvalidArgumentException(sprintf('The "%s" renderer does not exist.', $renderer));
        }

-        if (null === $this->request) {
-            throw new \LogicException('Rendering a fragment can only be done when handling a master Request.');
-        }
-
-        return $this->deliver($this->renderers[$renderer]->render($uri, $this->request, $options));
+        return $this->deliver($this->renderers[$renderer]->render($uri, $this->context->getCurrentRequest(), $options));
    }

    /**
@@ -115,7 +103,8 @@ public function render($uri, $renderer = 'inline', array $options = array())
    protected function deliver(Response $response)
    {
        if (!$response->isSuccessful()) {
-            throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %s).', $this->request->getUri(), $response->getStatusCode()));
+            $request = $this->context->getCurrentRequest();
+            throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %s).', $request->getUri(), $response->getStatusCode()));
        }

        if (!$response instanceof StreamedResponse) {
-Original file line number
+Diff line change
@@ -12,7 +12,9 @@
     namespace Symfony\Component\HttpKernel\EventListener;
     use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+    use Symfony\Component\HttpKernel\Event\RequestFinishedEvent;
     use Symfony\Component\HttpKernel\KernelEvents;
+    use Symfony\Component\HttpKernel\RequestContext;
     use Symfony\Component\HttpFoundation\Request;
     use Symfony\Component\Routing\RequestContextAwareInterface;
     use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -26,41 +28,64 @@ class LocaleListener implements EventSubscriberInterface
     {
         private $router;
         private $defaultLocale;
+        private $requestContext;
-        public function __construct($defaultLocale = 'en', RequestContextAwareInterface $router = null)
+        public function __construct($defaultLocale = 'en', RequestContext $requestContext, RequestContextAwareInterface $router = null)
             Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            stof
  

      

      

      


        Sep 2, 2013


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      This BC break still need to be handled (it affects Silex for instance)
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            beberlei
  

      

      

      


        Sep 2, 2013


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      this class is not @api and constructors are not part of the interface of an class in terms of API Backwards compatiblitiy in my opinion, because their construction is another concern and handled by a factory of sorts.
Same for the other constructor change below.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            stof
  

      

      

      


        Sep 2, 2013


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      @beberlei This is valid only if the factories are themselves part of the component and so updated at the same time. It is not the case here. Merging this as is will break Silex code while the component was marked as stable and so Silex is already using ~2.3 as requirement based on this expectation.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            beberlei
  

      

      

      


        Sep 2, 2013


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      While i see the validity of this argument, this would mean that Symfonys path using DIC without factories has a flaw.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
  Member


      

  Author


  

  
    
      

      
            fabpot
  

      

      

      


        Sep 7, 2013


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      This class should now work in 2.3 or 2.4+ without any change.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
         {
             $this->defaultLocale = $defaultLocale;
+            $this->requestContext = $requestContext;
             $this->router = $router;
         }
-        public function setRequest(Request $request = null)
+        public function onKernelRequest(GetResponseEvent $event)
+        {
+            $request = $event->getRequest();
+            $request->setDefaultLocale($this->defaultLocale);
+            $this->setLocale($request);
+            $this->setRouterContext($request);
+        }
+        public function onKernelRequestFinished(RequestFinishedEvent $event)
         {
-            if (null === $request) {
+            $this->resetRouterContext();
+        }
+        private function resetRouterContext()
+        {
+            if ($this->requestContext === null) {
+                return;
+            }
+            $parentRequest = $this->requestContext->getParentRequest();
+            if ($parentRequest === null) {
                 return;
             }
+            $this->setRouterContext($parentRequest);
+        }
+        private function setLocale(Request $request)
+        {
             if ($locale = $request->attributes->get('_locale')) {
                 $request->setLocale($locale);
             }
+        }
+        private function setRouterContext(Request $request)
+        {
             if (null !== $this->router) {
                 $this->router->getContext()->setParameter('_locale', $request->getLocale());
             }
         }
-        public function onKernelRequest(GetResponseEvent $event)
-        {
-            $request = $event->getRequest();
-            $request->setDefaultLocale($this->defaultLocale);
-            $this->setRequest($request);
-        }
         public static function getSubscribedEvents()
         {
             return array(
                 // must be registered after the Router to have access to the _locale
                 KernelEvents::REQUEST => array(array('onKernelRequest', 16)),
+                KernelEvents::REQUEST_FINISHED => array(array('onKernelRequestFinished', 0)),
             );
         }
     }