Merge pull request #726 from cakephp/3.3-default-login-redirect

Add default URL to AuthenticationComponent::getLoginRedirect()

Author: markstory

src/Controller/Component/AuthenticationComponent.php

@@ -360,13 +360,16 @@ public function logout(): ?string
      * Leverages the `unauthenticatedRedirect` and `queryParam` options in
      * the AuthenticationService.
      *
+     * @param array|string|null $default Default URL to use if no redirect URL is available.
      * @return string|null
      */
-    public function getLoginRedirect(): ?string
+    public function getLoginRedirect(array|string|null $default = null): ?string
     {
-        $controller = $this->getController();
+        if (is_array($default)) {
+            $default = Router::url(['_base' => false] + $default);
+        }
 
-        return $this->getAuthenticationService()->getLoginRedirect($controller->getRequest());
+        return $this->getAuthenticationService()->getLoginRedirect($this->getController()->getRequest()) ?? $default;
     }
 
     /**

tests/TestCase/Controller/Component/AuthenticationComponentTest.php

@@ -27,10 +27,12 @@
 use Authentication\Test\TestCase\AuthenticationTestCase as TestCase;
 use Cake\Controller\ComponentRegistry;
 use Cake\Controller\Controller;
+use Cake\Core\Configure;
 use Cake\Event\Event;
 use Cake\Event\EventManager;
 use Cake\Http\ServerRequestFactory;
 use Cake\ORM\Entity;
+use Cake\Routing\Router;
 use InvalidArgumentException;
 use TestApp\Authentication\InvalidAuthenticationService;
 use UnexpectedValueException;
@@ -357,18 +359,33 @@ public function testLogout()
      */
     public function testGetLoginRedirect()
     {
+        Configure::write('App.base', '/cakephp');
+        $url = ['controller' => 'Users', 'action' => 'dashboard'];
+        Router::createRouteBuilder('/')
+            ->connect('/dashboard', $url);
+
         $this->service->setConfig('queryParam', 'redirect');
         $request = $this->request
             ->withAttribute('identity', $this->identity)
-            ->withAttribute('authentication', $this->service)
-            ->withQueryParams(['redirect' => 'ok/path?value=key']);
+            ->withAttribute('authentication', $this->service);
+
+        $controller = new Controller($request);
+        $registry = new ComponentRegistry($controller);
+        $component = new AuthenticationComponent($registry);
+
+        $result = $component->getLoginRedirect($url);
+        $this->assertSame('/dashboard', $result);
+
+        $request = $request->withQueryParams(['redirect' => 'ok/path?value=key']);
 
         $controller = new Controller($request);
         $registry = new ComponentRegistry($controller);
         $component = new AuthenticationComponent($registry);
 
-        $result = $component->getLoginRedirect();
+        $result = $component->getLoginRedirect($url);
         $this->assertSame('/ok/path?value=key', $result);
+
+        Configure::delete('App.base');
     }
 
     /**