Merge pull request #18153 from craftcms/feature/users-service

[6.x] Users service

Author: brandonkelly

composer.json

@@ -38,7 +38,7 @@
     "commerceguys/addressing": "^2.1.1",
     "composer/semver": "^3.3.2",
     "craftcms/laravel-aliases": "^2.0",
-    "craftcms/laravel-dependency-aware-cache": "^1.0",
+    "craftcms/laravel-dependency-aware-cache": "^1.1",
     "craftcms/plugin-installer": "~1.6.0",
     "craftcms/server-check": "~5.0.1",
     "craftcms/yii2-adapter": "self.version",

database/Factories/UserFactory.php

@@ -7,17 +7,49 @@
 use CraftCms\Cms\Element\Models\Element;
 use CraftCms\Cms\User\Models\User;
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Override;
 
 final class UserFactory extends Factory
 {
     protected $model = User::class;
 
-    #[\Override]
-    public function definition()
+    #[Override]
+    public function definition(): array
     {
         return [
             'id' => Element::factory(),
             'username' => $this->faker->userName(),
+            'email' => $this->faker->email(),
         ];
     }
+
+    public function pending(): self
+    {
+        return $this->state(fn () => [
+            'pending' => true,
+        ]);
+    }
+
+    public function locked(): self
+    {
+        return $this->state(fn () => [
+            'locked' => true,
+            'invalidLoginCount' => 2,
+            'lockoutDate' => now(),
+        ]);
+    }
+
+    public function active(): self
+    {
+        return $this->state(fn () => [
+            'active' => true,
+        ]);
+    }
+
+    public function suspended(): self
+    {
+        return $this->state(fn () => [
+            'suspended' => true,
+        ]);
+    }
 }

routes/actions.php

@@ -33,8 +33,15 @@
 use CraftCms\Cms\Http\Controllers\StructuresController;
 use CraftCms\Cms\Http\Controllers\Updates\UpdaterController;
 use CraftCms\Cms\Http\Controllers\Updates\UpdatesController;
+use CraftCms\Cms\Http\Controllers\Users\ActivateController;
+use CraftCms\Cms\Http\Controllers\Users\EnableController;
 use CraftCms\Cms\Http\Controllers\Users\ImpersonationController;
 use CraftCms\Cms\Http\Controllers\Users\PermissionsController;
+use CraftCms\Cms\Http\Controllers\Users\PhotoController;
+use CraftCms\Cms\Http\Controllers\Users\PreferencesController;
+use CraftCms\Cms\Http\Controllers\Users\SuspendController;
+use CraftCms\Cms\Http\Controllers\Users\UnlockController;
+use CraftCms\Cms\Http\Controllers\Users\UsersController;
 use CraftCms\Cms\Http\Controllers\Utilities\ClearCachesController;
 use CraftCms\Cms\Http\Controllers\Utilities\DbBackupController;
 use CraftCms\Cms\Http\Controllers\Utilities\DeprecationErrorsController;
@@ -72,6 +79,8 @@
 
     Route::middleware(['auth:craft'])->group(function () {
         Route::post('entries/save-entry', StoreEntryController::class);
+        Route::post('users/save-address', [\CraftCms\Cms\Http\Controllers\Users\AddressesController::class, 'store']);
+        Route::post('users/delete-address', [\CraftCms\Cms\Http\Controllers\Users\AddressesController::class, 'destroy']);
     });
 
     Route::middleware([RequireToken::class])->group(function () {
@@ -270,6 +279,17 @@
         });
 
         Route::post('users/save-permissions', [PermissionsController::class, 'store']);
+        Route::post('users/save-preferences', [PreferencesController::class, 'store']);
+        Route::post('users/activate-user', [ActivateController::class, 'activate']);
+        Route::post('users/deactivate-user', [ActivateController::class, 'deactivate']);
+        Route::post('users/suspend-user', [SuspendController::class, 'suspend']);
+        Route::post('users/unsuspend-user', [SuspendController::class, 'unsuspend']);
+        Route::post('users/enable-user', EnableController::class);
+        Route::post('users/unlock-user', UnlockController::class);
+        Route::post('users/delete-user', [UsersController::class, 'destroy']);
+        Route::post('users/render-photo-input', [PhotoController::class, 'renderInput']);
+        Route::post('users/upload-user-photo', [PhotoController::class, 'upload']);
+        Route::post('users/delete-user-photo', [PhotoController::class, 'destroy']);
 
         // User groups
         Route::middleware([

routes/cp.php

@@ -19,7 +19,12 @@
 use CraftCms\Cms\Http\Controllers\Settings\UserGroupsController;
 use CraftCms\Cms\Http\Controllers\Settings\UserSettingsController;
 use CraftCms\Cms\Http\Controllers\Updates\UpdaterController;
+use CraftCms\Cms\Http\Controllers\Users\AddressesController;
+use CraftCms\Cms\Http\Controllers\Users\PasskeysController;
+use CraftCms\Cms\Http\Controllers\Users\PasswordController;
 use CraftCms\Cms\Http\Controllers\Users\PermissionsController;
+use CraftCms\Cms\Http\Controllers\Users\PreferencesController;
+use CraftCms\Cms\Http\Controllers\Users\UsersController;
 use CraftCms\Cms\Http\Controllers\Utilities\UtilitiesController;
 use CraftCms\Cms\Http\Middleware\HandleInertiaRequests;
 use CraftCms\Cms\Http\Middleware\RequireAdmin;
@@ -62,8 +67,23 @@
     /**
      * Users
      */
-    Route::get('users/{user}/permissions', [PermissionsController::class, 'index']);
+    Route::get('myaccount', [UsersController::class, 'edit']);
+    Route::get('myaccount/addresses', [AddressesController::class, 'index']);
     Route::get('myaccount/permissions', [PermissionsController::class, 'index']);
+    Route::get('myaccount/passkeys', [PasskeysController::class, 'index']);
+    Route::get('myaccount/password', [PasswordController::class, 'index']);
+    Route::get('myaccount/preferences', [PreferencesController::class, 'index']);
+
+    Route::middleware([
+        RequireEdition::class.':'.Edition::Team->value,
+    ])->group(function () {
+        Route::get('users/new', [UsersController::class, 'create']);
+        Route::get('users/{userId}', [UsersController::class, 'edit'])->whereNumber('userId');
+        Route::get('users/{userId}/addresses', [AddressesController::class, 'index'])->whereNumber('userId');
+        Route::get('users/{userId}/permissions', [PermissionsController::class, 'index']);
+    });
+
+    Route::get('users/{slug?}', [UsersController::class, 'index']);
 
     /**
      * Routes that require admin, but do not require admin changes

src/Auth/Events/LoginUserRetrieved.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Auth\Events;
+
+use CraftCms\Cms\User\Elements\User;
+
+final class LoginUserRetrieved
+{
+    public function __construct(
+        public string $loginName,
+        public User $user,
+    ) {}
+}

src/Auth/Events/RetrievingLoginUser.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CraftCms\Cms\Auth\Events;
+
+use CraftCms\Cms\User\Elements\User;
+
+final class RetrievingLoginUser
+{
+    public function __construct(
+        public string $loginName,
+        public ?User $user = null,
+    ) {}
+}

src/User/UserProvider.php src/Auth/UserProvider.phpsrc/User/UserProvider.php renamed to src/Auth/UserProvider.php

@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace CraftCms\Cms\User;
+namespace CraftCms\Cms\Auth;
 
-use Closure;
-use craft\elements\User;
+use CraftCms\Cms\Auth\Events\LoginUserRetrieved;
+use CraftCms\Cms\Auth\Events\RetrievingLoginUser;
 use CraftCms\Cms\Database\Table;
+use CraftCms\Cms\Support\Facades\Users;
+use CraftCms\Cms\User\Elements\User;
 use Illuminate\Contracts\Auth\Authenticatable;
 use Illuminate\Contracts\Hashing\Hasher as HasherContract;
-use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Event;
 use SensitiveParameter;
 
 final readonly class UserProvider implements \Illuminate\Contracts\Auth\UserProvider
@@ -55,7 +57,7 @@ public function updateRememberToken(Authenticatable $user, #[SensitiveParameter]
     {
         DB::table(Table::USERS)
             ->where('id', $user->getAuthIdentifier())
-            ->update([$user->getRememberTokenName() => $token]);
+            ->update(['rememberToken' => $token]);
     }
 
     /**
@@ -73,19 +75,23 @@ public function retrieveByCredentials(#[SensitiveParameter] array $credentials):
             return null;
         }
 
-        $query = User::find();
+        $loginName = $credentials['loginName'];
 
-        foreach ($credentials as $key => $value) {
-            if (is_array($value) || $value instanceof Arrayable) {
-                $query->whereIn($key, $value);
-            } elseif ($value instanceof Closure) {
-                $value($query);
-            } else {
-                $query->where($key, $value);
-            }
+        $user = null;
+        if (Event::hasListeners(RetrievingLoginUser::class)) {
+            Event::dispatch($event = new RetrievingLoginUser($loginName));
+            $user = $event->user;
         }
 
-        return $query->first();
+        $user ??= Users::getUserByUsernameOrEmail($loginName);
+
+        if (Event::hasListeners(LoginUserRetrieved::class)) {
+            Event::dispatch($event = new LoginUserRetrieved($loginName, $user));
+
+            return $event->user;
+        }
+
+        return $user;
     }
 
     /**

src/Console/Commands/Utils/AsciiFilenamesCommand.php

@@ -5,11 +5,11 @@
 namespace CraftCms\Cms\Console\Commands\Utils;
 
 use Craft;
-use craft\errors\InvalidElementException;
 use craft\helpers\FileHelper;
 use CraftCms\Cms\Asset\Elements\Asset;
 use CraftCms\Cms\Config\GeneralConfig;
 use CraftCms\Cms\Console\CraftCommand;
+use CraftCms\Cms\Element\Exceptions\InvalidElementException;
 use Exception;
 use Illuminate\Console\Command;
 use Illuminate\Support\Facades\DB;

src/Dashboard/Dashboard.php

@@ -296,7 +296,6 @@ public function changeWidgetColspan(int $widgetId, int $colspan): bool
      */
     private function addDefaultUserWidgets(): void
     {
-        /** @var ?\craft\elements\User $user */
         $user = Auth::user();
 
         // Recent Entries widget

src/Dashboard/Widgets/CraftSupport.php

@@ -12,6 +12,7 @@
 use CraftCms\Cms\Plugin\Plugins;
 use CraftCms\Cms\Support\PHP;
 use Illuminate\Support\Facades\Auth;
+use Override;
 
 use function CraftCms\Cms\normalizeVersion;
 use function CraftCms\Cms\t;
@@ -29,7 +30,7 @@ public function __construct(
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public static function displayName(): string
     {
         return t('Craft Support');
@@ -38,17 +39,17 @@ public static function displayName(): string
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public static function isSelectable(): bool
     {
         // Only admins get the Craft Support widget.
-        return parent::isSelectable() && Auth::user()->isAdmin();
+        return parent::isSelectable() && Auth::user()?->isAdmin();
     }
 
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     protected static function allowMultipleInstances(): bool
     {
         return false;
@@ -57,7 +58,7 @@ protected static function allowMultipleInstances(): bool
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public static function icon(): string
     {
         return 'life-ring';
@@ -66,7 +67,7 @@ public static function icon(): string
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public function getTitle(): ?string
     {
         return null;
@@ -75,11 +76,11 @@ public function getTitle(): ?string
     /**
      * {@inheritdoc}
      */
-    #[\Override]
+    #[Override]
     public function getBodyHtml(): ?string
     {
         // Only admins get the Craft Support widget.
-        if (! Auth::user()->isAdmin()) {
+        if (! Auth::user()?->isAdmin()) {
             return null;
         }
 
@@ -126,7 +127,7 @@ public function getBodyHtml(): ?string
 EOD;
 
         $view->registerJsWithVars(fn ($id, $settings) => <<<JS
-new Craft.CraftSupportWidget($id, $settings);
+new Craft.CraftSupportWidget($id, $settings)
 JS, [
             $this->id,
             [