GH-7007: Synchronized Service alternative, backwards compatible.

symfony · beberlei · Apr 18, 2013 · Apr 18, 2013 · Apr 30, 2013 · Apr 30, 2013
commit db4d9348c07e006617f92ede98ea749e47c8d996
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
@@ -15,6 +15,7 @@
 use Symfony\Component\HttpFoundation\Response;
 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;
@@ -29,19 +30,23 @@
 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);

+        $this->requestStack = $requestStack;
        $this->container = $container;
+
        $container->addScope(new Scope('request'));
    }

@@ -50,6 +55,8 @@ public function __construct(EventDispatcherInterface $dispatcher, ContainerInter
     */
    public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
    {
+        $this->requestStack->push($request);
+
        $request->headers->set('X-Php-Ob-Level', ob_get_level());

        $this->container->enterScope('request');
@@ -67,6 +74,8 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
        $this->container->set('request', null, 'request');
        $this->container->leaveScope('request');

+        $this->requestStack->pop();
+
        return $response;
    }
 }
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\FilterResponseEvent;
 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,65 @@ 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 onKernelResponse(FilterResponseEvent $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)),
+            // should be registered very late
+            KernelEvents::RESPONSE => array(array('onKernelResponse', -255)),
        );
    }
 }
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\FilterResponseEvent;
 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;
@@ -35,6 +37,7 @@ class RouterListener implements EventSubscriberInterface
    private $matcher;
    private $context;
    private $logger;
+    private $kernelContext;

    /**
     * Constructor.
@@ -45,7 +48,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.');
@@ -57,6 +60,7 @@ public function __construct($matcher, RequestContext $context = null, LoggerInte

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

@@ -77,6 +81,11 @@ public function setRequest(Request $request = null)
        }
    }

+    public function onKernelResponse(FilterResponseEvent $event)
+    {
+        $this->setRequest($this->kernelContext->getParentRequest());
+    }
+
    public function onKernelRequest(GetResponseEvent $event)
    {
        $request = $event->getRequest();
@@ -133,6 +142,7 @@ public static function getSubscribedEvents()
    {
        return array(
            KernelEvents::REQUEST => array(array('onKernelRequest', 32)),
+            KernelEvents::RESPONSE => array(array('onKernelResponse', -255)),
        );
    }
 }
diff --git a/src/Symfony/Component/HttpKernel/RequestContext.php b/src/Symfony/Component/HttpKernel/RequestContext.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace Symfony\Component\HttpKernel;
+
+/**
+ * Registry for Requests.
+ *
+ * Facade for RequestStack that prevents modification of the stack,
+ * so that users don't accidentily push()/pop() from the stack and
+ * mess up the request cycle.
+ */
+class RequestContext
+{
+    private $stack;
+
+    public function __construct(RequestStack $stack)
+    {
+        $this->stack = $stack;
+    }
+
+    /**
+     * @return Request
+     */
+    public function getCurrentRequest()
+    {
+        return $this->stack->getCurrentRequest();
+    }
+
+    /**
+     * @return Request
+     */
+    public function getMasterRequest()
+    {
+        return $this->stack->getMasterRequest();
+    }
+
+    /**
+     * @return Request|null
+     */
+    public function getParentRequest()
+    {
+        return $this->stack->getParentRequest();
+    }
+}
diff --git a/src/Symfony/Component/HttpKernel/RequestStack.php b/src/Symfony/Component/HttpKernel/RequestStack.php
@@ -0,0 +1,69 @@
+<?php
+
+namespace Symfony\Component\HttpKernel;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Request stack that controls the lifecycle of requests.
+ *
+ * Notifies services of changes in the stack.
+ */
+class RequestStack
+{
+    /**
+     * @var Request[]
+     */
+    private $requests = array();
+
+    public function push(Request $request)
+    {
+        $this->requests[] = $request;
+    }
+
+    /**
+     * Pop the current request from the stack.
+     *
+     * This operation lets the current request go out of scope.
+     *
+     * @return Request
+     */
+    public function pop()
+    {
+        return array_pop($this->requests);
+    }
+
+    /**
+     * @return Request
+     */
+    public function getCurrentRequest()
+    {
+        return end($this->requests);
+    }
+
+    /**
+     * @return Request
+     */
+    public function getMasterRequest()
+    {
+        return $this->requests[0];
+    }
+
+    /**
+     * Return the parent request of the current.
+     *
+     * If current Request ist the master request, method returns null.
+     *
+     * @return Request
+     */
+    public function getParentRequest()
+    {
+        $pos = count($this->requests) - 2;
+
+        if (!isset($this->requests[$pos])) {
+            return null;
+        }
+
+        return $this->requests[$pos];
+    }
+}
-Original file line number
+Diff line change
@@ -0,0 +1,44 @@
+    <?php
+    namespace Symfony\Component\HttpKernel;
+    /**
+     * Registry for Requests.
+     *
+     * Facade for RequestStack that prevents modification of the stack,
+     * so that users don't accidentily push()/pop() from the stack and
             Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            pborreli
  

      

      

      


        Apr 30, 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.
    

    
      
      


  


  
    
      accidently
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

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


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            jameshalsall
  

      

      

      


        Apr 30, 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.
    

    
      
      


  


  
    
      accidentally
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

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


  
  


          
      
  
    
    
      
        
            
    All reactions
+     * mess up the request cycle.
+     */
+    class RequestContext
+    {
+        private $stack;
+        public function __construct(RequestStack $stack)
+        {
+            $this->stack = $stack;
+        }
+        /**
+         * @return Request
+         */
+        public function getCurrentRequest()
+        {
+            return $this->stack->getCurrentRequest();
+        }
+        /**
+         * @return Request
+         */
+        public function getMasterRequest()
+        {
+            return $this->stack->getMasterRequest();
+        }
+        /**
+         * @return Request|null
+         */
+        public function getParentRequest()
+        {
+            return $this->stack->getParentRequest();
+        }
+    }