EZP-31825: Fixed user with user:password unable to change password

eZ/Publish/API/Repository/Events/User/BeforeUpdateUserPasswordEvent.php

@@ -0,0 +1,60 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace eZ\Publish\API\Repository\Events\User;
+
+use eZ\Publish\API\Repository\Values\User\User;
+use eZ\Publish\SPI\Repository\Event\BeforeEvent;
+use UnexpectedValueException;
+
+final class BeforeUpdateUserPasswordEvent extends BeforeEvent
+{
+    /** @var \eZ\Publish\API\Repository\Values\User\User */
+    private $user;
+
+    /** @var string */
+    private $newPassword;
+
+    /** @var \eZ\Publish\API\Repository\Values\User\User|null */
+    private $updatedUser;
+
+    public function __construct(User $user, string $newPassword)
+    {
+        $this->user = $user;
+        $this->newPassword = $newPassword;
+    }
+
+    public function getUser(): User
+    {
+        return $this->user;
+    }
+
+    public function getNewPassword(): string
+    {
+        return $this->newPassword;
+    }
+
+    public function getUpdatedUser(): User
+    {
+        if (!$this->hasUpdatedUser()) {
+            throw new UnexpectedValueException(sprintf('Return value is not set or not of type %s. Check hasUpdatedUser() or set it using setUpdatedUser() before you call the getter.', User::class));
+        }
+
+        return $this->updatedUser;
+    }
+
+    public function setUpdatedUser(?User $updatedUser): void
+    {
+        $this->updatedUser = $updatedUser;
+    }
+
+    public function hasUpdatedUser(): bool
+    {
+        return $this->updatedUser instanceof User;
+    }
+}

eZ/Publish/API/Repository/Events/User/UpdateUserPasswordEvent.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace eZ\Publish\API\Repository\Events\User;
+
+use eZ\Publish\API\Repository\Values\User\User;
+use eZ\Publish\SPI\Repository\Event\AfterEvent;
+
+final class UpdateUserPasswordEvent extends AfterEvent
+{
+    /** @var \eZ\Publish\API\Repository\Values\User\User */
+    private $user;
+
+    /** @var string */
+    private $newPassword;
+
+    /** @var \eZ\Publish\API\Repository\Values\User\User */
+    private $updatedUser;
+
+    public function __construct(
+        User $updatedUser,
+        User $user,
+        string $newPassword
+    ) {
+        $this->user = $user;
+        $this->newPassword = $newPassword;
+        $this->updatedUser = $updatedUser;
+    }
+
+    public function getUser(): User
+    {
+        return $this->user;
+    }
+
+    public function getNewPassword(): string
+    {
+        return $this->newPassword;
+    }
+
+    public function getUpdatedUser(): User
+    {
+        return $this->updatedUser;
+    }
+}

eZ/Publish/API/Repository/Tests/UserServiceAuthorizationTest.php

@@ -297,6 +297,70 @@ public function testUpdateUserThrowsUnauthorizedException()
         /* END: Use Case */
     }
 
+    /**
+     * Test for the updateUserPassword() method.
+     *
+     * @see \eZ\Publish\API\Repository\UserService::updateUserPassword()
+     */
+    public function testUpdateUserPasswordThrowsUnauthorizedException()
+    {
+        $this->expectException(\eZ\Publish\API\Repository\Exceptions\UnauthorizedException::class);
+
+        $repository = $this->getRepository();
+        $userService = $repository->getUserService();
+        $permissionResolver = $repository->getPermissionResolver();
+
+        /* BEGIN: Use Case */
+        $this->createRoleWithPolicies('CannotChangePassword', []);
+
+        $user = $this->createCustomUserWithLogin(
+            'without_role_password',
+            'without_role_password@example.com',
+            'Anons',
+            'CannotChangePassword'
+        );
+
+        // Now set the currently created "Editor" as current user
+        $permissionResolver->setCurrentUserReference($user);
+
+        // This call will fail with an "UnauthorizedException"
+        $userService->updateUserPassword($user, 'new password');
+        /* END: Use Case */
+    }
+
+    /**
+     * Test for the updateUserPassword() method.
+     *
+     * @see \eZ\Publish\API\Repository\UserService::updateUserPassword()
+     */
+    public function testUpdateUserPasswordWorksWithUserPasswordRole()
+    {
+        $repository = $this->getRepository();
+        $userService = $repository->getUserService();
+        $permissionResolver = $repository->getPermissionResolver();
+
+        /* BEGIN: Use Case */
+        $this->createRoleWithPolicies('CanChangePassword', [
+            ['module' => 'user', 'function' => 'password'],
+        ]);
+
+        $user = $this->createCustomUserWithLogin(
+            'with_role_password',
+            'with_role_password@example.com',
+            'Anons',
+            'CanChangePassword'
+        );
+        $previousHash = $user->passwordHash;
+
+        $permissionResolver->setCurrentUserReference($user);
+
+        $userService->updateUserPassword($user, 'new password');
+
+        $user = $userService->loadUserByLogin('with_role_password');
+        $this->assertNotEquals($previousHash, $user->passwordHash);
+        /* END: Use Case */
+    }
+
     /**
      * Test for the assignUserToUserGroup() method.
      *

eZ/Publish/API/Repository/UserService.php

@@ -218,21 +218,39 @@ public function deleteUser(User $user): iterable;
     /**
      * Updates a user.
      *
-     * 4.x: If the versionUpdateStruct is set in the user update structure, this method internally creates a content draft, updates ts with the provided data
+     * 4.x: If the versionUpdateStruct is set in the user update structure, this method internally creates a content draft, updates it with the provided data
      * and publishes the draft. If a draft is explicitly required, the user group can be updated via the content service methods.
      *
      * @param \eZ\Publish\API\Repository\Values\User\User $user
      * @param \eZ\Publish\API\Repository\Values\User\UserUpdateStruct $userUpdateStruct
      *
      * @return \eZ\Publish\API\Repository\Values\User\User
      *
-     *@throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $userUpdateStruct is not valid
+     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $userUpdateStruct is not valid
      * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is set empty
      * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if a field value is not accepted by the field type
      * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to update the user
      */
     public function updateUser(User $user, UserUpdateStruct $userUpdateStruct): User;
 
+    /**
+     * Updates user's password.
+     *
+     * 4.x: If the versionUpdateStruct is set in the user update structure, this method internally creates a content draft, updates it with the provided data
+     * and publishes the draft. If a draft is explicitly required, the user group can be updated via the content service methods.
+     *
+     * @param \eZ\Publish\API\Repository\Values\User\User $user
+     * @param string $newPassword
+     *
+     * @return \eZ\Publish\API\Repository\Values\User\User
+     *
+     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $userUpdateStruct is not valid
+     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is set empty
+     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if a field value is not accepted by the field type
+     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the authenticated user is not allowed to update the user
+     */
+    public function updateUserPassword(User $user, string $newPassword): User;
+
     /**
      * Update the user token information specified by the user token struct.
      *

eZ/Publish/Core/Base/Exceptions/MissingUserFieldTypeException.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+namespace eZ\Publish\Core\Base\Exceptions;
+
+use eZ\Publish\API\Repository\Values\ContentType\ContentType;
+
+class MissingUserFieldTypeException extends ContentValidationException
+{
+    public function __construct(ContentType $contentType)
+    {
+        parent::__construct(
+            'The provided Content Type "%contentType%" does not contain the ezuser Field Type',
+            [
+                'contentType' => $contentType->identifier,
+            ]
+        );
+    }
+}

eZ/Publish/Core/Event/UserService.php

@@ -8,6 +8,8 @@
 
 namespace eZ\Publish\Core\Event;
 
+use eZ\Publish\API\Repository\Events\User\BeforeUpdateUserPasswordEvent;
+use eZ\Publish\API\Repository\Events\User\UpdateUserPasswordEvent;
 use eZ\Publish\API\Repository\UserService as UserServiceInterface;
 use eZ\Publish\API\Repository\Values\User\User;
 use eZ\Publish\API\Repository\Values\User\UserCreateStruct;
@@ -228,6 +230,58 @@ public function updateUser(
         return $updatedUser;
     }
 
+    public function updateUserPassword(
+        User $user,
+        string $newPassword
+    ): User {
+        $eventData = [
+            $user,
+            new UserUpdateStruct([
+                'password' => $newPassword,
+            ]),
+        ];
+
+        /**
+         * @deprecated listening on BeforeUpdateUserEvent when updating password has been deprecated. Use BeforeUpdateUserPasswordEvent instead.
+         */
+        $beforeEvent = new BeforeUpdateUserEvent(...$eventData);
+
+        $this->eventDispatcher->dispatch($beforeEvent);
+        if ($beforeEvent->isPropagationStopped()) {
+            return $beforeEvent->getUpdatedUser();
+        }
+
+        $beforePasswordEvent = new BeforeUpdateUserPasswordEvent($user, $newPassword);
+
+        $this->eventDispatcher->dispatch($beforePasswordEvent);
+        if ($beforePasswordEvent->isPropagationStopped()) {
+            return $beforePasswordEvent->getUpdatedUser();
+        }
+
+        if ($beforeEvent->hasUpdatedUser()) {
+            $updatedUser = $beforeEvent->getUpdatedUser();
+        } elseif ($beforePasswordEvent->hasUpdatedUser()) {
+            $updatedUser = $beforePasswordEvent->getUpdatedUser();
+        } else {
+            $updatedUser = $this->innerService->updateUserPassword($user, $newPassword);
+        }
+
+        /**
+         * @deprecated listening on UpdateUserEvent when updating password has been deprecated. Use UpdateUserPasswordEvent instead.
+         */
+        $afterEvent = new UpdateUserEvent($updatedUser, ...$eventData);
+        $this->eventDispatcher->dispatch(
+            $afterEvent
+        );
+
+        $afterPasswordEvent = new UpdateUserPasswordEvent($updatedUser, $user, $newPassword);
+        $this->eventDispatcher->dispatch(
+            $afterPasswordEvent
+        );
+
+        return $updatedUser;
+    }
+
     public function updateUserToken(
         User $user,
         UserTokenUpdateStruct $userTokenUpdateStruct

eZ/Publish/Core/Persistence/Cache/UserHandler.php

@@ -215,6 +215,23 @@ public function update(User $user)
         return $user;
     }
 
+    public function updatePassword(User $user)
+    {
+        $this->logger->logCall(__METHOD__, ['struct' => $user]);
+
+        $return = $this->persistenceHandler->userHandler()->updatePassword($user);
+
+        // Clear corresponding content cache as update of the User changes it's external data
+        $this->cache->invalidateTags(['content-' . $user->id, 'user-' . $user->id]);
+        // Clear especially by email key as it might already be cached and this might represent change to email
+        $this->cache->deleteItems([
+            'ez-user-' . $this->escapeForCacheKey($user->email) . '-by-email',
+            'ez-users-' . $this->escapeForCacheKey($user->email) . '-by-email',
+        ]);
+
+        return $return;
+    }
+
     /**
      * {@inheritdoc}
      */

eZ/Publish/Core/Persistence/Legacy/User/Gateway.php

@@ -8,6 +8,7 @@
 
 namespace eZ\Publish\Core\Persistence\Legacy\User;
 
+use eZ\Publish\SPI\Persistence\User;
 use eZ\Publish\SPI\Persistence\User\UserTokenUpdateStruct;
 
 /**
@@ -39,6 +40,13 @@ abstract public function loadByEmail(string $email): array;
      */
     abstract public function loadUserByToken(string $hash): array;
 
+    /**
+     * Update the user password as specified by the user struct.
+     *
+     * @param \eZ\Publish\SPI\Persistence\User $user
+     */
+    abstract public function updateUserPassword(User $user): void;
+
     /**
      * Update a User token specified by UserTokenUpdateStruct.
      *