Remembered username

Author: riasvdv

resources/templates/_special/login.twig

@@ -5,7 +5,7 @@
 {% set staticEmail = staticEmail ?? null %}
 
 {% set generalConfig = app.config.craft.general %}
-{% set username = staticEmail ?? (generalConfig.rememberUsernameDuration ? craft.app.user.getRememberedUsername(): '') %}
+{% set username = staticEmail ?? (generalConfig.rememberUsernameDuration ? rememberedUsername : '') %}
 
 {% if generalConfig.useEmailAsUsername %}
   {% set usernameLabel = 'Email'|t('app') %}

src/Auth/AuthServiceProvider.php

@@ -30,6 +30,14 @@ final class AuthServiceProvider extends ServiceProvider
 {
     #[Override]
     public function register(): void
+    {
+        $this->registerRedirects();
+        $this->registerGuard();
+        $this->registerPermissions();
+        $this->registerEvents();
+    }
+
+    private function registerRedirects(): void
     {
         Authenticate::redirectUsing(function (Request $request) {
             if ($request->isCpRequest()) {
@@ -40,7 +48,10 @@ public function register(): void
         });
 
         RedirectIfAuthenticated::redirectUsing(fn (Request $request) => $request->user()->getDefaultReturnUrl());
+    }
 
+    private function registerGuard(): void
+    {
         Auth::provider('craft', fn (Application $app) => new UserProvider($app->make(Hasher::class)));
 
         if (! Config::has('auth.guards.craft')) {
@@ -57,7 +68,10 @@ public function register(): void
                 'model' => User::class,
             ]);
         }
+    }
 
+    private function registerPermissions(): void
+    {
         /**
          * This hooks our permission system into
          * Laravel's Gate authorization system
@@ -92,14 +106,19 @@ public function register(): void
 
             return true;
         });
+    }
 
+    private function registerEvents(): void
+    {
         Event::listen(Login::class, function (Login $event) {
             if (! $event->user instanceof User) {
                 return;
             }
 
             Users::handleValidLogin($event->user);
 
+            RememberedUsername::set($event->user);
+
             Session::passwordConfirmed();
         });
 
@@ -111,7 +130,7 @@ public function register(): void
             Users::handleInvalidLogin($event->user);
         });
 
-        Event::listen(Logout::class, function (Logout $event) {
+        Event::listen(Logout::class, function () {
             app(Impersonation::class)->setImpersonatorId(null);
         });
     }

src/Auth/RememberedUsername.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Auth;
+
+use CraftCms\Cms\Cms;
+use CraftCms\Cms\User\Elements\User;
+use Illuminate\Support\Facades\Cookie;
+
+final readonly class RememberedUsername
+{
+    public static function get(): ?string
+    {
+        return Cookie::get(Cookie::craftPrefix().'_username');
+    }
+
+    public static function set(User $user): void
+    {
+        $prefix = Cookie::craftPrefix();
+
+        if (Cms::config()->rememberUsernameDuration === 0) {
+            Cookie::forget("{$prefix}_username");
+
+            return;
+        }
+
+        Cookie::queue(
+            name: "{$prefix}_username",
+            value: $user->username,
+            minutes: floor(Cms::config()->rememberUsernameDuration / 60),
+        );
+    }
+}

src/Auth/SessionAuth.php

@@ -4,8 +4,8 @@
 
 namespace CraftCms\Cms\Auth;
 
-use CraftCms\Cms\Cms;
 use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Cookie;
 use Illuminate\Support\Facades\Session;
 
 final class SessionAuth
@@ -70,8 +70,6 @@ public static function checkAuthorization(string $action): bool
 
     private static function authAccessParam(): string
     {
-        $prefix = md5('CraftSession'.Cms::envId());
-
-        return $prefix.self::$authAccessParam;
+        return Cookie::craftPrefix().self::$authAccessParam;
     }
 }

src/Providers/AppServiceProvider.php

@@ -16,6 +16,7 @@
 use CraftCms\Cms\Support\Facades\Updates;
 use GuzzleHttp\Utils;
 use Illuminate\Contracts\Config\Repository as ConfigRepository;
+use Illuminate\Cookie\CookieJar;
 use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Console\AboutCommand;
 use Illuminate\Foundation\Events\LocaleUpdated;
@@ -131,6 +132,8 @@ private function registerMacros(): void
             return $this;
         });
 
+        CookieJar::macro('craftPrefix', fn (): string => md5('CraftSession'.Cms::envId()));
+
         Request::macro('isCpRequest', fn (): bool => $this->is(
             Cms::config()->cpTrigger, // /admin
             Cms::config()->cpTrigger.'/*' // /admin/foo

yii2-adapter/legacy/controllers/UsersController.php

@@ -35,6 +35,7 @@
 use CraftCms\Cms\Auth\Events\LoginUserRetrieved;
 use CraftCms\Cms\Auth\Events\RetrievingLoginUser;
 use CraftCms\Cms\Auth\Impersonation;
+use CraftCms\Cms\Auth\RememberedUsername;
 use CraftCms\Cms\Cms;
 use CraftCms\Cms\Edition;
 use CraftCms\Cms\Element\Exceptions\InvalidElementException;
@@ -420,7 +421,7 @@ public function actionSetPassword(): Response
             /** @var string $code */
             [$user, $uid, $code] = $info;
 
-            Craft::$app->getUser()->sendUsernameCookie($user);
+            RememberedUsername::set($user);
 
             // Send them to the set password template.
             return $this->_renderSetPasswordTemplate([
@@ -521,7 +522,7 @@ public function actionVerifyEmail(): Response
             /** @var string $code */
             [$user, $uid, $code] = $info;
 
-            Craft::$app->getUser()->sendUsernameCookie($user);
+            RememberedUsername::set($user);
 
             // Send them to the set verify-email template
             return $this->_rerouteWithFallbackTemplate('verify-email.twig', [
@@ -891,7 +892,7 @@ public function actionSaveUser(): ?Response
         /** @noinspection PhpUndefinedVariableInspection */
         if ($isCurrentUser && $user->username !== $oldUsername) {
             // Update the username cookie
-            $userSession->sendUsernameCookie($user);
+            RememberedUsername::set($user);
         }
 
         // Save the user’s photo, if it was submitted

yii2-adapter/legacy/helpers/App.php

@@ -37,6 +37,7 @@
 use CraftCms\Cms\Translation\Locale;
 use CraftCms\Cms\User\Elements\User;
 use CraftCms\Yii2Adapter\Cache;
+use Illuminate\Support\Facades\Cookie;
 use yii\base\Event;
 use yii\base\Exception;
 use yii\base\InvalidArgumentException;
@@ -817,16 +818,14 @@ public static function userConfig(): array
             $loginUrl = UrlHelper::cpUrl(Request::CP_PATH_LOGIN);
         }
 
-        $stateKeyPrefix = md5('Craft.' . WebUser::class . '.' . Craft::$app->getEnvId());
-
         return [
             'class' => WebUser::class,
             'identityClass' => User::class,
             'enableAutoLogin' => true,
             'autoRenewCookie' => true,
             'loginUrl' => $loginUrl,
             'authTimeout' => $generalConfig->userSessionDuration ?: null,
-            'usernameCookie' => Craft::cookieConfig(['name' => $stateKeyPrefix . '_username']),
+            'usernameCookie' => Craft::cookieConfig(['name' => Cookie::craftPrefix() . '_username']),
         ];
     }
 

yii2-adapter/legacy/web/Controller.php

@@ -473,6 +473,7 @@ public function requireLogin(): void
      * Redirects the user to the account template if they are logged in.
      *
      * @since 3.4.0
+     * @deprecated 6.0.0 use the "guest" middleware instead.
      */
     public function requireGuest(): void
     {

yii2-adapter/legacy/web/User.php

@@ -13,6 +13,7 @@
 use craft\helpers\UrlHelper;
 use CraftCms\Cms\Auth\Concerns\ConfirmsPasswords;
 use CraftCms\Cms\Auth\Impersonation;
+use CraftCms\Cms\Auth\RememberedUsername;
 use CraftCms\Cms\Cms;
 use CraftCms\Cms\Support\Config;
 use CraftCms\Cms\Support\Facades\Users;
@@ -85,17 +86,7 @@ public function loginByUserId(int $userId, int $duration = 0): bool
      */
     public function sendUsernameCookie(UserElement $user): void
     {
-        $generalConfig = Cms::config();
-
-        if ($generalConfig->rememberUsernameDuration !== 0) {
-            $cookie = new Cookie($this->usernameCookie);
-            $cookie->value = $user->username;
-            $seconds = Config::durationInSeconds($generalConfig->rememberUsernameDuration);
-            $cookie->expire = DateTimeHelper::currentTimeStamp() + $seconds;
-            Craft::$app->getResponse()->getCookies()->add($cookie);
-        } else {
-            Craft::$app->getResponse()->getCookies()->remove(new Cookie($this->usernameCookie));
-        }
+        RememberedUsername::set($user);
     }
 
     /**
@@ -180,10 +171,11 @@ public function getToken(): ?string
      * ```
      *
      * @return string|null
+     * @deprecated 6.0.0 use {@see \Illuminate\Support\Facades\Cookie::getRememberedUsername()} instead.
      */
     public function getRememberedUsername(): ?string
     {
-        return Craft::$app->getRequest()->getCookies()->getValue($this->usernameCookie['name']);
+        return RememberedUsername::get();
     }
 
     /**
@@ -219,6 +211,7 @@ public function getIsGuest(): bool
      * @return Response the redirection response
      * @throws ForbiddenHttpException if the request doesn’t accept a redirect response
      * @since 3.4.0
+     * @deprecated 6.0.0 use the "guest" middleware instead.
      */
     public function guestRequired(): Response
     {
@@ -382,7 +375,7 @@ protected function afterLogin($identity, $cookieBased, $duration): void
         // Save the username cookie if they're not being impersonated
         $impersonator = app(Impersonation::class)->getImpersonator();
         if (!$impersonator) {
-            $this->sendUsernameCookie(UserElement::find()->id($identity->getId())->firstOrFail());
+            RememberedUsername::set(UserElement::find()->id($identity->getId())->firstOrFail());
         }
 
         // Update the user record

yii2-adapter/legacy/web/twig/Extension.php

@@ -54,6 +54,7 @@
 use craft\web\twig\variables\CraftVariable;
 use craft\web\View;
 use CraftCms\Cms\Address\Addresses;
+use CraftCms\Cms\Auth\RememberedUsername;
 use CraftCms\Cms\Cms;
 use CraftCms\Cms\Database\Queries\AddressQuery;
 use CraftCms\Cms\Database\Queries\AssetQuery;
@@ -1845,6 +1846,7 @@ public function getGlobals(): array
             'pluginAssets' => app(Plugins::class)->getAssetsHtml(),
             'currentSite' => $currentSite,
             'currentUser' => $currentUser,
+            'rememberedUsername' => RememberedUsername::get(),
             'primarySite' => $primarySite,
             'siteName' => $siteName,
             'siteUrl' => $siteUrl,