New redirect strategy

config/module.config.php

@@ -16,14 +16,17 @@
         ),
     ),
     'controllers' => array(
-        'invokables' => array(
-            'zfcuser' => 'ZfcUser\Controller\UserController',
+        'factories' => array(
+            'zfcuser' => 'ZfcUser\Factory\Controller\UserControllerFactory',
         ),
     ),
     'service_manager' => array(
         'aliases' => array(
             'zfcuser_zend_db_adapter' => 'Zend\Db\Adapter\Adapter',
         ),
+        'factories' => array(
+            'zfcuser_redirect_callback' => 'ZfcUser\Factory\Controller\RedirectCallbackFactory'
+        )
     ),
     'router' => array(
         'routes' => array(

src/ZfcUser/Controller/RedirectCallback.php

@@ -0,0 +1,122 @@
+<?php
+
+namespace ZfcUser\Controller;
+
+use Zend\Mvc\Router\RouteInterface;
+use Zend\Mvc\Router\RouteMatch;
+use Zend\Mvc\Router\Exception;
+use Zend\Http\PhpEnvironment\Request;
+use Zend\Http\PhpEnvironment\Response;
+use ZfcUser\Options\ModuleOptions;
+
+class RedirectCallback
+{
+    /** @var RouteMatch */
+    protected $routeMatch;
+
+    /** @var RouteInterface  */
+    protected $router;
+
+    /** @var Response */
+    protected $response;
+
+    /** @var Request */
+    protected $request;
+
+    /** @var ModuleOptions */
+    protected $options;
+
+    /**
+     * @param RouteMatch $routeMatch
+     * @param RouteInterface $router
+     * @param Response $response
+     * @param Request $request
+     * @param ModuleOptions $options
+     */
+    public function __construct(RouteMatch $routeMatch, RouteInterface $router, Response $response, Request $request, ModuleOptions $options)
+    {
+        $this->routeMatch = $routeMatch;
+        $this->router = $router;
+        $this->request = $request;
+        $this->response = $response;
+        $this->options = $options;
+    }
+
+    /**
+     * @return Response
+     */
+    public function __invoke()
+    {
+        $redirect = $this->getRedirect($this->routeMatch->getMatchedRouteName(), $this->getRedirectRouteFromRequest());
+
+        $response = $this->response;
+        $response->getHeaders()->addHeaderLine('Location', $redirect);
+        $response->setStatusCode(302);
+        return $response;
+    }
+
+    /**
+     * Return the redirect from param.
+     * First checks GET then POST
+     * @return string
+     */
+    protected function getRedirectRouteFromRequest()
+    {
+        $request  = $this->request;
+        $redirect = $request->getQuery('redirect');
+        if ($redirect && $this->routeExists($redirect)) {
+            return $redirect;
+        }
+
+        $redirect = $request->getPost('redirect');
+        if ($redirect && $this->routeExists($redirect)) {
+            return $redirect;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param $route
+     * @return bool
+     */
+    protected function routeExists($route)
+    {
+        try {
+            $this->router->assemble($route);
+        } catch (Exception\RuntimeException $e) {
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Returns the url to redirect to based on current route.
+     * If $redirect is set and the option to use redirect is set to true, it will return the $redirect url.
+     *
+     * @param string $currentRoute
+     * @param bool $redirect
+     * @return mixed
+     */
+    protected function getRedirect($currentRoute, $redirect = false)
+    {
+        $useRedirect = $this->options->getUseRedirectParameterIfPresent();
+        $routeExists = ($redirect && $this->routeExists($redirect));
+        if (!$useRedirect || !$routeExists) {
+            $redirect = false;
+        }
+
+        switch ($currentRoute) {
+            case 'zfcuser/login':
+                $route = ($redirect) ?: $this->options->getLoginRedirectRoute();
+                return $this->router->assemble([], ['name' => $route]);
+                break;
+            case 'zfcuser/logout':
+                $route = ($redirect) ?: $this->options->getLogoutRedirectRoute();
+                return $this->router->assemble([], ['name' => $route]);
+                break;
+            default:
+                return $this->router->assemble([], ['name' => 'zfcuser']);
+        }
+    }
+}

src/ZfcUser/Controller/UserController.php

@@ -55,6 +55,16 @@ class UserController extends AbstractActionController
      */
     protected $options;
 
+    /**
+     * @var Callable $redirectCallback
+     */
+    protected $redirectCallback;
+
+    public function __construct($redirectCallback)
+    {
+        $this->redirectCallback = $redirectCallback;
+    }
+
     /**
      * User page
      */
@@ -116,13 +126,8 @@ public function logoutAction()
         $this->zfcUserAuthentication()->getAuthAdapter()->logoutAdapters();
         $this->zfcUserAuthentication()->getAuthService()->clearIdentity();
 
-        $redirect = $this->params()->fromPost('redirect', $this->params()->fromQuery('redirect', false));
-
-        if ($this->getOptions()->getUseRedirectParameterIfPresent() && $redirect) {
-            return $this->redirect()->toRoute($redirect);
-        }
-
-        return $this->redirect()->toRoute($this->getOptions()->getLogoutRedirectRoute());
+        $redirect = $this->redirectCallback;
+        return $redirect();
     }
 
     /**
@@ -155,17 +160,15 @@ public function authenticateAction()
             );
         }
 
-        if ($this->getOptions()->getUseRedirectParameterIfPresent() && $redirect) {
-            return $this->redirect()->toRoute($redirect);
-        }
-
         $route = $this->getOptions()->getLoginRedirectRoute();
 
         if (is_callable($route)) {
             $route = $route($this->zfcUserAuthentication()->getIdentity());
+            return $this->redirect()->toRoute($route);
         }
 
-        return $this->redirect()->toRoute($route);
+        $redirect = $this->redirectCallback;
+        return $redirect();
     }
 
     /**

src/ZfcUser/Factory/Controller/RedirectCallbackFactory.php

@@ -0,0 +1,26 @@
+<?php
+namespace ZfcUser\Factory\Controller;
+
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use ZfcUser\Controller\RedirectCallback;
+
+class RedirectCallbackFactory implements FactoryInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        $router = $serviceLocator->get('Router');
+        $response = $serviceLocator->get('Response');
+        $request = $serviceLocator->get('Request');
+        $options = $serviceLocator->get('zfcuser_module_options');
+
+        /** @var MvcEvent $mvcEvent */
+        $mvcEvent   = $serviceLocator->get('Application')->getMvcEvent();
+        $routeMatch = $mvcEvent->getRouteMatch();
+
+        return new RedirectCallback($routeMatch, $router, $response, $request, $options);
+    }
+}

src/ZfcUser/Factory/Controller/UserControllerFactory.php

@@ -0,0 +1,25 @@
+<?php
+namespace ZfcUser\Factory\Controller;
+
+use Zend\Mvc\Controller\ControllerManager;
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use ZfcUser\Authentication\Adapter;
+use ZfcUser\Controller\UserController;
+
+class UserControllerFactory implements FactoryInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function createService(ServiceLocatorInterface $controllerManager)
+    {
+        /** @var ControllerManager $controllerManager*/
+        $serviceManager = $controllerManager->getServiceLocator();
+
+        $redirectCallback = $serviceManager->get('zfcuser_redirect_callback');
+        $controller = new UserController($redirectCallback);
+
+        return $controller;
+    }
+}

tests/ZfcUserTest/Controller/UserControllerTest.php

@@ -26,9 +26,15 @@ class UserControllerTest extends \PHPUnit_Framework_TestCase
 
     protected $options;
 
+    protected $redirectCallback;
+
     public function setUp()
     {
-        $controller = new Controller;
+        $this->redirectCallback = $this->getMockBuilder('ZfcUser\Controller\RedirectCallback')
+                                 ->disableOriginalConstructor()
+                                 ->getMock();
+
+        $controller = new Controller($this->redirectCallback);
         $this->controller = $controller;
 
         $this->zfcUserAuthenticationPlugin = $this->getMock('ZfcUser\Controller\Plugin\ZfcUserAuthentication');
@@ -362,50 +368,11 @@ public function testLogoutAction($withRedirect, $post, $query)
         ));
 
 
-        $params = $this->getMock('Zend\Mvc\Controller\Plugin\Params');
-        $params->expects($this->any())
-               ->method('__invoke')
-               ->will($this->returnSelf());
-        $params->expects($this->once())
-               ->method('fromPost')
-               ->will($this->returnCallback(function ($key, $default) use ($post) {
-                   return $post ?: $default;
-               }));
-        $params->expects($this->once())
-               ->method('fromQuery')
-               ->will($this->returnCallback(function ($key, $default) use ($query) {
-                   return $query ?: $default;
-               }));
-        $this->pluginManagerPlugins['params'] = $params;
-
         $response = new Response();
 
-        $redirect = $this->getMock('Zend\Mvc\Controller\Plugin\Redirect');
-        $redirect->expects($this->any())
-                 ->method('toRoute')
-                 ->will($this->returnValue($response));
-
-        if ($withRedirect) {
-            $expectedLocation = $post ?: $query ?: false;
-            $this->options->expects($this->once())
-                          ->method('getUseRedirectParameterIfPresent')
-                          ->will($this->returnValue((bool) $withRedirect));
-            $redirect->expects($this->any())
-                     ->method('toRoute')
-                     ->with($expectedLocation)
-                     ->will($this->returnValue($response));
-        } else {
-            $expectedLocation = "/user/logout";
-            $this->options->expects($this->once())
-                          ->method('getLogoutRedirectRoute')
-                          ->will($this->returnValue($expectedLocation));
-            $redirect->expects($this->any())
-                     ->method('toRoute')
-                     ->with($expectedLocation)
-                     ->will($this->returnValue($response));
-        }
-
-        $this->pluginManagerPlugins['redirect']= $redirect;
+        $this->redirectCallback->expects($this->once())
+            ->method('__invoke')
+            ->will($this->returnValue($response));
 
         $result = $controller->logoutAction();
 
@@ -513,21 +480,9 @@ public function testAuthenticateAction($wantRedirect, $post, $query, $prepareRes
                     ->will($this->returnValue('user/login'));
                 $this->pluginManagerPlugins['url'] = $url;
 
-            } elseif ($wantRedirect && $hasRedirect) {
-                $redirect->expects($this->once())
-                         ->method('toRoute')
-                         ->with(($post ?: $query ?: false))
-                         ->will($this->returnValue($response));
             } else {
-
-                $redirect->expects($this->once())
-                         ->method('toRoute')
-                         ->with('zfcuser')
-                         ->will($this->returnValue($response));
-
-                $this->options->expects($this->once())
-                              ->method('getLoginRedirectRoute')
-                              ->will($this->returnValue('zfcuser'));
+                $this->redirectCallback->expects($this->once())
+                    ->method('__invoke');
             }
 
             $this->options->expects($this->any())
@@ -1010,7 +965,7 @@ public function testSetterGetterServices(
         $serviceName,
         $callback = null
     ) {
-        $controller = new Controller;
+        $controller = new Controller($this->redirectCallback);
 
         $controller->setPluginManager($this->pluginManager);