AbstractUserEmailFactory::getContextKeys() - Code Metrics - Inspection of "Issue/69" - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#72)

by Daniel

created 2020-05-09 18:47 UTC

AbstractUserEmailFactory::getContextKeys() A

↳ Parent: AbstractUserEmailFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	5
rs	10
c	0
b	0
f	0

<?php

/*
 * This file is part of the Silverback API Components Bundle Project
 *
 * (c) Daniel West <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Silverback\ApiComponentsBundle\Factory\User\Mailer;

use Psr\Container\ContainerInterface;
use Silverback\ApiComponentsBundle\Entity\User\AbstractUser;
use Silverback\ApiComponentsBundle\Event\UserEmailMessageEvent;
use Silverback\ApiComponentsBundle\Exception\BadMethodCallException;
use Silverback\ApiComponentsBundle\Exception\InvalidArgumentException;
use Silverback\ApiComponentsBundle\Exception\RfcComplianceException;
use Silverback\ApiComponentsBundle\Exception\UnexpectedValueException;
use Silverback\ApiComponentsBundle\Helper\RefererUrlResolver;
use Silverback\ApiComponentsBundle\Security\TokenGenerator;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Exception\RfcComplianceException as SymfonyRfcComplianceException;
use Symfony\Component\Mime\RawMessage;
use Symfony\Contracts\Service\ServiceSubscriberInterface;
use Twig\Environment;

/**
 * @author Daniel West <[email protected]>
 */
abstract class AbstractUserEmailFactory implements ServiceSubscriberInterface
{
    public const MESSAGE_ID_PREFIX = 'xx';

    protected ContainerInterface $container;
    private EventDispatcherInterface $eventDispatcher;
    protected string $subject;
    protected bool $enabled;
    protected ?string $defaultRedirectPath;
    protected ?string $redirectPathQueryKey;
    protected array $emailContext;
    protected ?RawMessage $message;
    private AbstractUser $user;

    public function __construct(ContainerInterface $container, EventDispatcherInterface $eventDispatcher, string $subject, bool $enabled = true, ?string $defaultRedirectPath = null, ?string $redirectPathQueryKey = null, array $emailContext = [])
    {
        $this->container = $container;
        $this->eventDispatcher = $eventDispatcher;
        $this->subject = $subject;
        $this->enabled = $enabled;
        $this->emailContext = $emailContext;
        $this->defaultRedirectPath = $defaultRedirectPath;
        $this->redirectPathQueryKey = $redirectPathQueryKey;
    }

    public static function getSubscribedServices(): array
    {
        return [
            RequestStack::class,
            RefererUrlResolver::class,
            Environment::class,
        ];
    }

    protected static function getContextKeys(): ?array
    {
        return [
            'website_name',
            'user',
        ];
    }

    protected function initUser(AbstractUser $user): void
    {
        if (!$user->getUsername()) {
            throw new InvalidArgumentException('The user must have a username set to send them any email');
        }

        if (!$user->getEmailAddress()) {
            throw new InvalidArgumentException('The user must have an email address set to send them any email');
        }

        $this->user = $user;
    }

    protected function createEmailMessage(array $context = []): ?TemplatedEmail
    {
        if (!$this->enabled) {
            return null;
        }

        if (!isset($this->user)) {
            throw new BadMethodCallException('You must call the method `initUser` before `createEmailMessage`');
        }

        try {
            $toEmailAddress = Address::fromString((string) $this->user->getEmailAddress());
        } catch (SymfonyRfcComplianceException $exception) {
            $exception = new RfcComplianceException($exception->getMessage());
            throw $exception;
        }

        $context = array_replace_recursive([
            'user' => $this->user,
        ], $this->emailContext, $context);
        $this->validateContext($context);

        $twig = $this->container->get(Environment::class);
        $template = $twig->createTemplate($this->subject);
        $subject = $template->render($context);

        $email = (new TemplatedEmail())
            ->to($toEmailAddress)
            ->subject($subject)
            ->htmlTemplate('@SilverbackApiComponents/emails/' . $this->getTemplate())
            ->context($context);

        $event = new UserEmailMessageEvent(static::class, $email);
        $this->eventDispatcher->dispatch($event);

        $email->getHeaders()->addTextHeader('X-Message-ID', sprintf('%s-%s', static::MESSAGE_ID_PREFIX, TokenGenerator::generateToken()));

        return $event->getEmail();
    }

    protected function getTokenUrl(string $token, string $username, ?string $newEmail = null): string
    {
        $path = $this->populatePathVariables($this->getTokenPath(), [
            'token' => $token,
            'username' => $username,
            'new_email' => $newEmail,
        ]);

        $refererUrlResolver = $this->container->get(RefererUrlResolver::class);

        return $refererUrlResolver->getAbsoluteUrl($path);
    }

    private function getTokenPath(): string
    {
        if (null === $this->defaultRedirectPath && null === $this->redirectPathQueryKey) {
            throw new InvalidArgumentException('The `defaultRedirectPath` or `redirectPathQueryKey` must be set');
        }

        $requestStack = $this->container->get(RequestStack::class);
        $request = $requestStack->getMasterRequest();

        $path = ($request && $this->redirectPathQueryKey) ?
            $request->query->get($this->redirectPathQueryKey, $this->defaultRedirectPath) :
            $this->defaultRedirectPath;

        if (null === $path) {
            throw new UnexpectedValueException(sprintf('The querystring key `%s` could not be found in the request to generate a token URL', $this->redirectPathQueryKey));
        }

        return $path;
    }

    private function populatePathVariables(string $path, array $variables): string
    {
        preg_match_all('/{{[\s]*(\w+)[\s]*}}/', $path, $matches);
        foreach ($matches[0] as $matchIndex => $fullMatch) {
            if (\array_key_exists($varKey = $matches[1][$matchIndex], $variables) && null !== $variables[$varKey]) {
                $path = str_replace($fullMatch, rawurlencode($variables[$varKey]), $path);
            }
        }

        return $path;
    }

    private function validateContext(array $context): void
    {
        $contextKeys = static::getContextKeys();
        $keys = array_keys($context);
        if (\count($differences = array_diff($contextKeys, $keys))) {
            throw new InvalidArgumentException(sprintf('You have not specified required context key(s) for the user email factory factory `%s` (expected: `%s`)', static::class, implode('`, `', $differences)));
        }
    }

    abstract public function create(AbstractUser $user, array $context = []): ?RawMessage;

    abstract protected function getTemplate(): string;
}


1			<?php
2
3			/*
4			* This file is part of the Silverback API Components Bundle Project
5			*
6			* (c) Daniel West <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			declare(strict_types=1);
13
14			namespace Silverback\ApiComponentsBundle\Factory\User\Mailer;
15
16			use Psr\Container\ContainerInterface;
17			use Silverback\ApiComponentsBundle\Entity\User\AbstractUser;
18			use Silverback\ApiComponentsBundle\Event\UserEmailMessageEvent;
19			use Silverback\ApiComponentsBundle\Exception\BadMethodCallException;
20			use Silverback\ApiComponentsBundle\Exception\InvalidArgumentException;
21			use Silverback\ApiComponentsBundle\Exception\RfcComplianceException;
22			use Silverback\ApiComponentsBundle\Exception\UnexpectedValueException;
23			use Silverback\ApiComponentsBundle\Helper\RefererUrlResolver;
24			use Silverback\ApiComponentsBundle\Security\TokenGenerator;
25			use Symfony\Bridge\Twig\Mime\TemplatedEmail;
26			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
27			use Symfony\Component\HttpFoundation\RequestStack;
28			use Symfony\Component\Mime\Address;
29			use Symfony\Component\Mime\Exception\RfcComplianceException as SymfonyRfcComplianceException;
30			use Symfony\Component\Mime\RawMessage;
31			use Symfony\Contracts\Service\ServiceSubscriberInterface;
32			use Twig\Environment;
33
34			/**
35			* @author Daniel West <[email protected]>
36			*/
37			abstract class AbstractUserEmailFactory implements ServiceSubscriberInterface
38			{
39			public const MESSAGE_ID_PREFIX = 'xx';
40
41			protected ContainerInterface $container;
42			private EventDispatcherInterface $eventDispatcher;
43			protected string $subject;
44			protected bool $enabled;
45			protected ?string $defaultRedirectPath;
46			protected ?string $redirectPathQueryKey;
47			protected array $emailContext;
48			protected ?RawMessage $message;
49			private AbstractUser $user;
50
51			public function __construct(ContainerInterface $container, EventDispatcherInterface $eventDispatcher, string $subject, bool $enabled = true, ?string $defaultRedirectPath = null, ?string $redirectPathQueryKey = null, array $emailContext = [])
52			{
53			$this->container = $container;
54			$this->eventDispatcher = $eventDispatcher;
55			$this->subject = $subject;
56			$this->enabled = $enabled;
57			$this->emailContext = $emailContext;
58			$this->defaultRedirectPath = $defaultRedirectPath;
59			$this->redirectPathQueryKey = $redirectPathQueryKey;
60			}
61
62			public static function getSubscribedServices(): array
63			{
64			return [
65			RequestStack::class,
66			RefererUrlResolver::class,
67			Environment::class,
68			];
69			}
70
71			protected static function getContextKeys(): ?array
72			{
73			return [
74			'website_name',
75			'user',
76			];
77			}
78
79			protected function initUser(AbstractUser $user): void
80			{
81			if (!$user->getUsername()) {
82			throw new InvalidArgumentException('The user must have a username set to send them any email');
83			}
84
85			if (!$user->getEmailAddress()) {
86			throw new InvalidArgumentException('The user must have an email address set to send them any email');
87			}
88
89			$this->user = $user;
90			}
91
92			protected function createEmailMessage(array $context = []): ?TemplatedEmail
93			{
94			if (!$this->enabled) {
95			return null;
96			}
97
98			if (!isset($this->user)) {
99			throw new BadMethodCallException('You must call the method `initUser` before `createEmailMessage`');
100			}
101
102			try {
103			$toEmailAddress = Address::fromString((string) $this->user->getEmailAddress());
104			} catch (SymfonyRfcComplianceException $exception) {
105			$exception = new RfcComplianceException($exception->getMessage());
106			throw $exception;
107			}
108
109			$context = array_replace_recursive([
110			'user' => $this->user,
111			], $this->emailContext, $context);
112			$this->validateContext($context);
113
114			$twig = $this->container->get(Environment::class);
115			$template = $twig->createTemplate($this->subject);
116			$subject = $template->render($context);
117
118			$email = (new TemplatedEmail())
119			->to($toEmailAddress)
120			->subject($subject)
121			->htmlTemplate('@SilverbackApiComponents/emails/' . $this->getTemplate())
122			->context($context);
123
124			$event = new UserEmailMessageEvent(static::class, $email);
125			$this->eventDispatcher->dispatch($event);
126
127			$email->getHeaders()->addTextHeader('X-Message-ID', sprintf('%s-%s', static::MESSAGE_ID_PREFIX, TokenGenerator::generateToken()));
128
129			return $event->getEmail();
130			}
131
132			protected function getTokenUrl(string $token, string $username, ?string $newEmail = null): string
133			{
134			$path = $this->populatePathVariables($this->getTokenPath(), [
135			'token' => $token,
136			'username' => $username,
137			'new_email' => $newEmail,
138			]);
139
140			$refererUrlResolver = $this->container->get(RefererUrlResolver::class);
141
142			return $refererUrlResolver->getAbsoluteUrl($path);
143			}
144
145			private function getTokenPath(): string
146			{
147			if (null === $this->defaultRedirectPath && null === $this->redirectPathQueryKey) {
148			throw new InvalidArgumentException('The `defaultRedirectPath` or `redirectPathQueryKey` must be set');
149			}
150
151			$requestStack = $this->container->get(RequestStack::class);
152			$request = $requestStack->getMasterRequest();
153
154			$path = ($request && $this->redirectPathQueryKey) ?
155			$request->query->get($this->redirectPathQueryKey, $this->defaultRedirectPath) :
156			$this->defaultRedirectPath;
157
158			if (null === $path) {
159			throw new UnexpectedValueException(sprintf('The querystring key `%s` could not be found in the request to generate a token URL', $this->redirectPathQueryKey));
160			}
161
162			return $path;
163			}
164
165			private function populatePathVariables(string $path, array $variables): string
166			{
167			preg_match_all('/{{[\s](\w+)[\s]}}/', $path, $matches);
168			foreach ($matches[0] as $matchIndex => $fullMatch) {
169			if (\array_key_exists($varKey = $matches[1][$matchIndex], $variables) && null !== $variables[$varKey]) {
170			$path = str_replace($fullMatch, rawurlencode($variables[$varKey]), $path);
171			}
172			}
173
174			return $path;
175			}
176
177			private function validateContext(array $context): void
178			{
179			$contextKeys = static::getContextKeys();
180			$keys = array_keys($context);
181			if (\count($differences = array_diff($contextKeys, $keys))) {
182			throw new InvalidArgumentException(sprintf('You have not specified required context key(s) for the user email factory factory `%s` (expected: `%s`)', static::class, implode('`, `', $differences)));
183			}
184			}
185
186			abstract public function create(AbstractUser $user, array $context = []): ?RawMessage;
187
188			abstract protected function getTemplate(): string;
189			}
190

components-web-app / api-components-bundle

Pull Request — master (#72)

AbstractUserEmailFactory::getContextKeys() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like