UserRecoveryService::getSalesChannel() - Code Metrics - Inspection of "Merge branch 'next-29959/fix-recovery-user-request..." - shopware/platform - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — trunk ( e136f9...a572a3 )

by Christian

created 2023-09-07 08:30 UTC

UserRecoveryService::getSalesChannel() A

↳ Parent: UserRecoveryService

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	1
dl	0
loc	9
rs	10
c	0
b	0
f	0

<?php declare(strict_types=1);

namespace Shopware\Core\System\User\Recovery;

use Shopware\Core\DevOps\Environment\EnvironmentHelper;
use Shopware\Core\Framework\Context;
use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
use Shopware\Core\Framework\Log\Package;
use Shopware\Core\Framework\Util\Random;
use Shopware\Core\Framework\Uuid\Uuid;
use Shopware\Core\System\SalesChannel\Context\SalesChannelContextService;
use Shopware\Core\System\SalesChannel\Context\SalesChannelContextServiceParameters;
use Shopware\Core\System\SalesChannel\SalesChannelCollection;
use Shopware\Core\System\SalesChannel\SalesChannelEntity;
use Shopware\Core\System\User\Aggregate\UserRecovery\UserRecoveryCollection;
use Shopware\Core\System\User\Aggregate\UserRecovery\UserRecoveryEntity;
use Shopware\Core\System\User\UserCollection;
use Shopware\Core\System\User\UserEntity;
use Shopware\Core\System\User\UserException;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Routing\Exception\RouteNotFoundException;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Routing\RouterInterface;

#[Package('system-settings')]
class UserRecoveryService
{
    /**
     * @param EntityRepository<UserRecoveryCollection> $userRecoveryRepo
     * @param EntityRepository<UserCollection> $userRepo
     * @param EntityRepository<SalesChannelCollection> $salesChannelRepository
     *
     * @internal
     */
    public function __construct(
        private readonly EntityRepository $userRecoveryRepo,
        private readonly EntityRepository $userRepo,
        private readonly RouterInterface $router,
        private readonly EventDispatcherInterface $dispatcher,
        private readonly SalesChannelContextService $salesChannelContextService,
        private readonly EntityRepository $salesChannelRepository,
    ) {
    }

    public function generateUserRecovery(string $userEmail, Context $context): void
    {
        $user = $this->getUserByEmail($userEmail, $context);

        if (!$user) {
            return;
        }

        $userId = $user->getId();

        $userIdCriteria = new Criteria();
        $userIdCriteria->addFilter(new EqualsFilter('userId', $userId));
        $userIdCriteria->addAssociation('user');

        if ($existingRecovery = $this->getUserRecovery($userIdCriteria, $context)) {
            $this->deleteRecoveryForUser($existingRecovery, $context);
        }

        $recoveryData = [
            'userId' => $userId,
            'hash' => Random::getAlphanumericString(32),
        ];

        $this->userRecoveryRepo->create([$recoveryData], $context);

        $recovery = $this->getUserRecovery($userIdCriteria, $context);

        if (!$recovery) {
            return;
        }

        $hash = $recovery->getHash();

        try {
            $url = $this->router->generate('administration.index', [], UrlGeneratorInterface::ABSOLUTE_URL);
        } catch (RouteNotFoundException) {
            // fallback if admin bundle is not installed, the url should work once the bundle is installed
            $url = EnvironmentHelper::getVariable('APP_URL') . '/admin';
        }

        $recoveryUrl = $url . '#/login/user-recovery/' . $hash;

        $salesChannel = $this->getSalesChannel($context);

        $salesChannelContext = $this->salesChannelContextService->get(
            new SalesChannelContextServiceParameters(
                $salesChannel->getId(),
                Uuid::randomHex(),
                $salesChannel->getLanguageId(),
                $salesChannel->getCurrencyId(),
                null,
                $context,
                null,
            )
        );

        $this->dispatcher->dispatch(
            new UserRecoveryRequestEvent($recovery, $recoveryUrl, $salesChannelContext->getContext()),
            UserRecoveryRequestEvent::EVENT_NAME
        );
    }

    public function checkHash(string $hash, Context $context): bool
    {
        $criteria = new Criteria();
        $criteria->addFilter(
            new EqualsFilter('hash', $hash)
        );

        $recovery = $this->getUserRecovery($criteria, $context);

        $validDateTime = (new \DateTime())->sub(new \DateInterval('PT2H'));

        return $recovery && $validDateTime < $recovery->getCreatedAt();
    }

    public function updatePassword(string $hash, string $password, Context $context): bool
    {
        if (!$this->checkHash($hash, $context)) {
            return false;
        }

        $criteria = new Criteria();
        $criteria->addFilter(new EqualsFilter('hash', $hash));

        /** @var UserRecoveryEntity $recovery It can't be null as we checked the hash before */
        $recovery = $this->getUserRecovery($criteria, $context);

        $updateData = [
            'id' => $recovery->getUserId(),
            'password' => $password,
        ];

        $this->userRepo->update([$updateData], $context);

        $this->deleteRecoveryForUser($recovery, $context);

        return true;
    }

    public function getUserByHash(string $hash, Context $context): ?UserEntity
    {
        $criteria = new Criteria();
        $criteria->addFilter(new EqualsFilter('hash', $hash));
        $criteria->addAssociation('user');

        $user = $this->getUserRecovery($criteria, $context);

        if ($user === null) {
            return null;
        }

        return $user->getUser();
    }

    private function getUserByEmail(string $userEmail, Context $context): ?UserEntity
    {
        $criteria = new Criteria();

        $criteria->addFilter(
            new EqualsFilter('email', $userEmail)
        );

        $user = $this->userRepo->search($criteria, $context)->first();

        if (!$user instanceof UserEntity) {
            return null;
        }

        return $user;
    }

    private function getUserRecovery(Criteria $criteria, Context $context): ?UserRecoveryEntity
    {
        $recovery = $this->userRecoveryRepo->search($criteria, $context)->first();

        if (!$recovery instanceof UserRecoveryEntity) {
            return null;
        }

        return $recovery;
    }

    private function deleteRecoveryForUser(UserRecoveryEntity $userRecoveryEntity, Context $context): void
    {
        $recoveryData = [
            'id' => $userRecoveryEntity->getId(),
        ];

        $this->userRecoveryRepo->delete([$recoveryData], $context);
    }

    /**
     * pick a random sales channel to form sales channel context as flow builder requires it
     */
    private function getSalesChannel(Context $context): SalesChannelEntity
    {
        $salesChannel = $this->salesChannelRepository->search((new Criteria())->setLimit(1), $context)->first();

        if (!$salesChannel instanceof SalesChannelEntity) {
            throw UserException::salesChannelNotFound();
        }

        return $salesChannel;
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Shopware\Core\System\User\Recovery;
4
5			use Shopware\Core\DevOps\Environment\EnvironmentHelper;
6			use Shopware\Core\Framework\Context;
7			use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
8			use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
9			use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
10			use Shopware\Core\Framework\Log\Package;
11			use Shopware\Core\Framework\Util\Random;
12			use Shopware\Core\Framework\Uuid\Uuid;
13			use Shopware\Core\System\SalesChannel\Context\SalesChannelContextService;
14			use Shopware\Core\System\SalesChannel\Context\SalesChannelContextServiceParameters;
15			use Shopware\Core\System\SalesChannel\SalesChannelCollection;
16			use Shopware\Core\System\SalesChannel\SalesChannelEntity;
17			use Shopware\Core\System\User\Aggregate\UserRecovery\UserRecoveryCollection;
18			use Shopware\Core\System\User\Aggregate\UserRecovery\UserRecoveryEntity;
19			use Shopware\Core\System\User\UserCollection;
20			use Shopware\Core\System\User\UserEntity;
21			use Shopware\Core\System\User\UserException;
22			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
23			use Symfony\Component\Routing\Exception\RouteNotFoundException;
24			use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
25			use Symfony\Component\Routing\RouterInterface;
26
27			#[Package('system-settings')]
28			class UserRecoveryService
29			{
30			/**
31			* @param EntityRepository<UserRecoveryCollection> $userRecoveryRepo
32			* @param EntityRepository<UserCollection> $userRepo
33			* @param EntityRepository<SalesChannelCollection> $salesChannelRepository
34			*
35			* @internal
36			*/
37			public function __construct(
38			private readonly EntityRepository $userRecoveryRepo,
39			private readonly EntityRepository $userRepo,
40			private readonly RouterInterface $router,
41			private readonly EventDispatcherInterface $dispatcher,
42			private readonly SalesChannelContextService $salesChannelContextService,
43			private readonly EntityRepository $salesChannelRepository,
44			) {
45			}
46
47			public function generateUserRecovery(string $userEmail, Context $context): void
48			{
49			$user = $this->getUserByEmail($userEmail, $context);
50
51			if (!$user) {
52			return;
53			}
54
55			$userId = $user->getId();
56
57			$userIdCriteria = new Criteria();
58			$userIdCriteria->addFilter(new EqualsFilter('userId', $userId));
59			$userIdCriteria->addAssociation('user');
60
61			if ($existingRecovery = $this->getUserRecovery($userIdCriteria, $context)) {
62			$this->deleteRecoveryForUser($existingRecovery, $context);
63			}
64
65			$recoveryData = [
66			'userId' => $userId,
67			'hash' => Random::getAlphanumericString(32),
68			];
69
70			$this->userRecoveryRepo->create([$recoveryData], $context);
71
72			$recovery = $this->getUserRecovery($userIdCriteria, $context);
73
74			if (!$recovery) {
75			return;
76			}
77
78			$hash = $recovery->getHash();
79
80			try {
81			$url = $this->router->generate('administration.index', [], UrlGeneratorInterface::ABSOLUTE_URL);
82			} catch (RouteNotFoundException) {
83			// fallback if admin bundle is not installed, the url should work once the bundle is installed
84			$url = EnvironmentHelper::getVariable('APP_URL') . '/admin';
85			}
86
87			$recoveryUrl = $url . '#/login/user-recovery/' . $hash;
88
89			$salesChannel = $this->getSalesChannel($context);
90
91			$salesChannelContext = $this->salesChannelContextService->get(
92			new SalesChannelContextServiceParameters(
93			$salesChannel->getId(),
94			Uuid::randomHex(),
95			$salesChannel->getLanguageId(),
96			$salesChannel->getCurrencyId(),
97			null,
98			$context,
99			null,
100			)
101			);
102
103			$this->dispatcher->dispatch(
104			new UserRecoveryRequestEvent($recovery, $recoveryUrl, $salesChannelContext->getContext()),
105			UserRecoveryRequestEvent::EVENT_NAME
106			);
107			}
108
109			public function checkHash(string $hash, Context $context): bool
110			{
111			$criteria = new Criteria();
112			$criteria->addFilter(
113			new EqualsFilter('hash', $hash)
114			);
115
116			$recovery = $this->getUserRecovery($criteria, $context);
117
118			$validDateTime = (new \DateTime())->sub(new \DateInterval('PT2H'));
119
120			return $recovery && $validDateTime < $recovery->getCreatedAt();
121			}
122
123			public function updatePassword(string $hash, string $password, Context $context): bool
124			{
125			if (!$this->checkHash($hash, $context)) {
126			return false;
127			}
128
129			$criteria = new Criteria();
130			$criteria->addFilter(new EqualsFilter('hash', $hash));
131
132			/** @var UserRecoveryEntity $recovery It can't be null as we checked the hash before */
133			$recovery = $this->getUserRecovery($criteria, $context);
134
135			$updateData = [
136			'id' => $recovery->getUserId(),
137			'password' => $password,
138			];
139
140			$this->userRepo->update([$updateData], $context);
141
142			$this->deleteRecoveryForUser($recovery, $context);
143
144			return true;
145			}
146
147			public function getUserByHash(string $hash, Context $context): ?UserEntity
148			{
149			$criteria = new Criteria();
150			$criteria->addFilter(new EqualsFilter('hash', $hash));
151			$criteria->addAssociation('user');
152
153			$user = $this->getUserRecovery($criteria, $context);
154
155			if ($user === null) {
156			return null;
157			}
158
159			return $user->getUser();
160			}
161
162			private function getUserByEmail(string $userEmail, Context $context): ?UserEntity
163			{
164			$criteria = new Criteria();
165
166			$criteria->addFilter(
167			new EqualsFilter('email', $userEmail)
168			);
169
170			$user = $this->userRepo->search($criteria, $context)->first();
171
172			if (!$user instanceof UserEntity) {
173			return null;
174			}
175
176			return $user;
177			}
178
179			private function getUserRecovery(Criteria $criteria, Context $context): ?UserRecoveryEntity
180			{
181			$recovery = $this->userRecoveryRepo->search($criteria, $context)->first();
182
183			if (!$recovery instanceof UserRecoveryEntity) {
184			return null;
185			}
186
187			return $recovery;
188			}
189
190			private function deleteRecoveryForUser(UserRecoveryEntity $userRecoveryEntity, Context $context): void
191			{
192			$recoveryData = [
193			'id' => $userRecoveryEntity->getId(),
194			];
195
196			$this->userRecoveryRepo->delete([$recoveryData], $context);
197			}
198
199			/**
200			* pick a random sales channel to form sales channel context as flow builder requires it
201			*/
202			private function getSalesChannel(Context $context): SalesChannelEntity
203			{
204			$salesChannel = $this->salesChannelRepository->search((new Criteria())->setLimit(1), $context)->first();
205
206			if (!$salesChannel instanceof SalesChannelEntity) {
207			throw UserException::salesChannelNotFound();
208			}
209
210			return $salesChannel;
211			}
212			}
213

shopware / platform

Push — trunk ( e136f9...a572a3 )

UserRecoveryService::getSalesChannel() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like