Use a compiler pass to inject the Container only when necessary

Author: GuilhemN

Controller/AuthorizeController.php

@@ -56,7 +56,7 @@ public function setContainer(ContainerInterface $container = null)
      */
     public function authorizeAction(Request $request)
     {
-        $user = $this->container->get('security.context')->getToken()->getUser();
+        $user = $this->getTokenStorage()->getToken()->getUser();
 
         if (!$user instanceof UserInterface) {
             throw new AccessDeniedException('This user does not have access to this section.');
@@ -106,7 +106,7 @@ public function authorizeAction(Request $request)
     protected function processSuccess(UserInterface $user, AuthorizeFormHandler $formHandler, Request $request)
     {
         if (true === $this->container->get('session')->get('_fos_oauth_server.ensure_logout')) {
-            $this->container->get('security.context')->setToken(null);
+            $this->getTokenStorage()->setToken(null);
             $this->container->get('session')->invalidate();
         }
 
@@ -146,11 +146,7 @@ protected function getRedirectionUrl(UserInterface $user)
     protected function getClient()
     {
         if (null === $this->client) {
-            try {
-                $request = $this->container->get('request_stack')->getCurrentRequest();
-            } catch (ServiceNotFoundException $e) {
-                $request = $this->container->get('request');
-            }
+            $request = $this->getCurrentRequest();
 
             $client = null;
             if (null !== $request) {
@@ -173,4 +169,26 @@ protected function getClient()
 
         return $this->client;
     }
+
+    private function getCurrentRequest() {
+        if($this->container->has('request_stack')) {
+            $request = $this->container->get('request_stack')->getCurrentRequest();
+            if(null === $request) {
+                throw new \RuntimeException('No current request.');
+            }
+
+            return $request;
+        } else {
+            return $this->container->get('request');
+        }
+    }
+
+    private function getTokenStorage()
+    {
+        if($this->container->has('security.token_storage')) {
+            return $this->container->get('security.token_storage');
+        }
+
+        return $this->container->get('security.context');
+    }
 }

DependencyInjection/Compiler/RequestStackCompilerPass.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the FOSOAuthServerBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\OAuthServerBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * @author Ener-Getick <[email protected]>
+ *
+ * @internal
+ */
+final class RequestStackCompilerPass implements CompilerPassInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+        if($container->has('request_stack')) {
+            return;
+        }
+
+        $definition = $container->getDefinition('fos_oauth_server.authorize.form.handler.default');
+        $definition->addMethodCall('setContainer', array(new Reference('service_container')));
+    }
+}

FOSOAuthServerBundle.php

@@ -12,6 +12,7 @@
 namespace FOS\OAuthServerBundle;
 
 use FOS\OAuthServerBundle\DependencyInjection\Compiler\TokenStorageCompilerPass;
+use FOS\OAuthServerBundle\DependencyInjection\Compiler\RequestStackCompilerPass;
 use FOS\OAuthServerBundle\DependencyInjection\FOSOAuthServerExtension;
 use FOS\OAuthServerBundle\DependencyInjection\Security\Factory\OAuthFactory;
 use FOS\OAuthServerBundle\DependencyInjection\Compiler\GrantExtensionsCompilerPass;
@@ -37,5 +38,6 @@ public function build(ContainerBuilder $container)
 
         $container->addCompilerPass(new GrantExtensionsCompilerPass());
         $container->addCompilerPass(new TokenStorageCompilerPass());
+        $container->addCompilerPass(new RequestStackCompilerPass());
     }
 }

Form/Handler/AuthorizeFormHandler.php

@@ -11,16 +11,17 @@
 
 namespace FOS\OAuthServerBundle\Form\Handler;
 
-use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\Form\FormInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 use FOS\OAuthServerBundle\Form\Model\Authorize;
 
 /**
  * @author Chris Jones <[email protected]>
  */
-class AuthorizeFormHandler implements ContainerAwareInterface
+class AuthorizeFormHandler
 {
     /**
      * @var FormInterface
@@ -32,6 +33,25 @@ class AuthorizeFormHandler implements ContainerAwareInterface
      */
     protected $container;
 
+    /**
+     * @var RequestStack|Request|null
+     */
+    private $requestStack;
+
+    /**
+     * @param FormInterface        $form
+     * @param Request|RequestStack $requestStack
+     */
+    public function __construct(FormInterface $form, $requestStack = null)
+    {
+        if(null !== $requestStack && !$requestStack instanceof RequestStack && !$requestStack instanceof Request) {
+            throw new \InvalidArgumentException(sprintf('Argument 2 of %s must be an instanceof RequestStack or Request', __CLASS__));
+        }
+
+        $this->form = $form;
+        $this->requestStack = $requestStack;
+    }
+
     /**
      * Sets the container.
      *
@@ -42,11 +62,6 @@ public function setContainer(ContainerInterface $container = null)
         $this->container = $container;
     }
 
-    public function __construct(FormInterface $form)
-    {
-        $this->form = $form;
-    }
-
     public function isAccepted()
     {
         return $this->form->getData()->accepted;
@@ -59,12 +74,7 @@ public function isRejected()
 
     public function process()
     {
-        try {
-            $request = $this->container->get('request_stack')->getCurrentRequest();
-        } catch (ServiceNotFoundException $e) {
-            $request = $this->container->get('request');
-        }
-
+        $request = $this->getCurrentRequest();
         if (null !== $request) {
             $this->form->setData(new Authorize(
                 $request->request->has('accepted'),
@@ -89,6 +99,15 @@ public function getScope()
         return $this->form->getData()->scope;
     }
 
+    public function __get($name)
+    {
+        if ($name === 'request') {
+            @trigger_error(sprintf('%s::$request is deprecated since 1.4 and will be removed in 2.0.', __CLASS__), E_USER_DEPRECATED);
+
+            return $this->getCurrentRequest();
+        }
+    }
+
     /**
      * Put form data in $_GET so that OAuth2 library will call Request::createFromGlobals()
      *
@@ -105,4 +124,17 @@ protected function onSuccess()
             'scope'         => $this->form->getData()->scope,
         );
     }
+
+    private function getCurrentRequest()
+    {
+        if (null !== $this->requestStack) {
+            if ($this->requestStack instanceof Request) {
+                return $this->requestStack;
+            } else {
+                return $this->requestStack->getCurrentRequest();
+            }
+        }
+
+        return $this->container->get('request');
+    }
 }

Resources/config/authorize.xml

@@ -20,6 +20,7 @@
 
         <service id="fos_oauth_server.authorize.form.handler.default" class="FOS\OAuthServerBundle\Form\Handler\AuthorizeFormHandler">
             <argument type="service" id="fos_oauth_server.authorize.form" />
+            <argument type="service" id="request_stack" on-invalid="ignore" />
         </service>
     </services>
 

Security/Firewall/OAuthListener.php

@@ -30,24 +30,24 @@
 class OAuthListener implements ListenerInterface
 {
     /**
-     * @var \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface|\Symfony\Component\Security\Core\SecurityContextInterface
+     * @var TokenStorageInterface|SecurityContextInterface
      */
     protected $securityContext;
 
     /**
-     * @var \Symfony\Component\Security\Core\Authentication\AuthenticationManagerInterface
+     * @var AuthenticationManagerInterface
      */
     protected $authenticationManager;
 
     /**
-     * @var \OAuth2\OAuth2
+     * @var OAuth2
      */
     protected $serverService;
 
     /**
-     * @param \Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface|\Symfony\Component\Security\Core\SecurityContextInterface   $tokenStorage          The token storage.
-     * @param \Symfony\Component\Security\Core\Authentication\AuthenticationManagerInterface        $authenticationManager The authentication manager.
-     * @param \OAuth2\OAuth2                                                                        $serverService
+     * @param TokenStorageInterface|SecurityContextInterface $tokenStorage          The token storage.
+     * @param AuthenticationManagerInterface                 $authenticationManager The authentication manager.
+     * @param OAuth2                                         $serverService
      */
     public function __construct($securityContext, AuthenticationManagerInterface $authenticationManager, OAuth2 $serverService)
     {
@@ -60,7 +60,7 @@ public function __construct($securityContext, AuthenticationManagerInterface $au
     }
 
     /**
-     * @param \Symfony\Component\HttpKernel\Event\GetResponseEvent $event The event.
+     * @param GetResponseEvent $event The event.
      */
     public function handle(GetResponseEvent $event)
     {