SecondFactorMailService::findEmailTemplate() - Code Metrics - Inspection of "Warn on missing email template" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#119)

by Boy

created 2016-06-16 11:30 UTC

SecondFactorMailService::findEmailTemplate() A

↳ Parent: SecondFactorMailService

Complexity

Conditions	3
Paths	3

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	19
rs	9.4285
cc	3
eloc	10
nc	3
nop	3

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Service;

use Psr\Log\LoggerInterface;
use Surfnet\Stepup\Identity\Value\CommonName;
use Surfnet\Stepup\Identity\Value\Email;
use Surfnet\Stepup\Identity\Value\Locale;
use Surfnet\StepupMiddleware\ApiBundle\Identity\Value\RegistrationAuthorityCredentials;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Service\EmailTemplateService;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Exception\InvalidArgumentException;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Value\Sender;
use Swift_Mailer as Mailer;
use Swift_Message as Message;
use Symfony\Component\Templating\EngineInterface;
use Symfony\Component\Translation\TranslatorInterface;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
final class SecondFactorMailService
{
    /**
     * @var Mailer
     */
    private $mailer;

    /**
     * @var Sender
     */
    private $sender;

    /**
     * @var TranslatorInterface
     */
    private $translator;

    /**
     * @var EngineInterface
     */
    private $templateEngine;

    /**
     * @var string
     */
    private $emailVerificationUrlTemplate;

    /**
     * @var \Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Service\EmailTemplateService
     */
    private $emailTemplateService;

    /**
     * @var string
     */
    private $fallbackLocale;

    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * @var bool
     */
    private $warnOnMissingTemplateConfiguration;

    /**
     * @param Mailer $mailer
     * @param Sender $sender
     * @param TranslatorInterface $translator
     * @param EngineInterface $templateEngine
     * @param string $emailVerificationUrlTemplate
     * @param EmailTemplateService $emailTemplateService
     * @param string $fallbackLocale
     * @param LoggerInterface $logger
     * @param bool $warnOnMissingTemplateConfiguration
     */
    public function __construct(
        Mailer $mailer,
        Sender $sender,
        TranslatorInterface $translator,
        EngineInterface $templateEngine,
        $emailVerificationUrlTemplate,
        EmailTemplateService $emailTemplateService,
        $fallbackLocale,
        LoggerInterface $logger,
        $warnOnMissingTemplateConfiguration = true

    ) {
        $this->mailer = $mailer;
        $this->sender = $sender;
        $this->translator = $translator;
        $this->templateEngine = $templateEngine;
        $this->emailVerificationUrlTemplate = $emailVerificationUrlTemplate;
        $this->emailTemplateService = $emailTemplateService;
        $this->fallbackLocale = $fallbackLocale;
        $this->logger = $logger;

        if (!is_bool($warnOnMissingTemplateConfiguration)) {
            throw new InvalidArgumentException('warnOnMissingTemplateConfiguration for SecondFactorMailService is not a boolean');

        }

        $this->warnOnMissingTemplateConfiguration = $warnOnMissingTemplateConfiguration;
    }

    /**
     * @param string $locale
     * @param string $commonName
     * @param string $email
     * @param string $verificationNonce
     */
    public function sendEmailVerificationEmail(
        $locale,
        $commonName,
        $email,
        $verificationNonce
    ) {
        $subject = $this->translator->trans(
            'ss.mail.email_verification_email.subject',
            ['%commonName%' => $commonName],
            null,
            $locale
        );

        $verificationUrl = str_replace(
            '{nonce}',
            urlencode($verificationNonce),
            $this->emailVerificationUrlTemplate
        );

        $emailTemplate = $this->findEmailTemplate('confirm_email', $locale, $this->fallbackLocale);
        if (!$emailTemplate) {
            return;
        }

        $parameters = [
            'templateString'   => $emailTemplate->htmlContent,
            'locale'           => $locale,
            'commonName'       => $commonName,
            'email'            => $email,
            'verificationUrl'  => $verificationUrl
        ];

        // Rendering file template instead of string
        // (https://github.com/symfony/symfony/issues/10865#issuecomment-42438248)
        $body = $this->templateEngine->render(
            'SurfnetStepupMiddlewareCommandHandlingBundle:SecondFactorMailService:email.html.twig',
            $parameters
        );

        /** @var Message $message */
        $message = $this->mailer->createMessage();
        $message
            ->setFrom($this->sender->getEmail(), $this->sender->getName())
            ->addTo($email, $commonName)
            ->setSubject($subject)
            ->setBody($body, 'text/html', 'utf-8');

        $this->mailer->send($message);
    }

    /**
     * @param string $locale
     * @param string $commonName
     * @param string $email
     * @param string $registrationCode
     * @param RegistrationAuthorityCredentials[] $ras
     */
    public function sendRegistrationEmail(
        $locale,
        $commonName,
        $email,
        $registrationCode,
        array $ras
    ) {
        $subject = $this->translator->trans(
            'ss.mail.registration_email.subject',
            ['%commonName%' => $commonName],
            null,
            $locale
        );

        $emailTemplate = $this->findEmailTemplate('registration_code', $locale, $this->fallbackLocale);
        if (!$emailTemplate) {
            return;
        }

        $parameters = [
            'templateString'   => $emailTemplate->htmlContent,
            'locale'           => $locale,
            'commonName'       => $commonName,
            'email'            => $email,
            'registrationCode' => $registrationCode,
            'ras'              => $ras,
        ];

        // Rendering file template instead of string
        // (https://github.com/symfony/symfony/issues/10865#issuecomment-42438248)
        $body = $this->templateEngine->render(
            'SurfnetStepupMiddlewareCommandHandlingBundle:SecondFactorMailService:email.html.twig',
            $parameters
        );

        /** @var Message $message */
        $message = $this->mailer->createMessage();
        $message
            ->setFrom($this->sender->getEmail(), $this->sender->getName())
            ->addTo($email, $commonName)
            ->setSubject($subject)
            ->setBody($body, 'text/html', 'utf-8');

        $this->mailer->send($message);
    }

    /**
     * @param Locale     $locale
     * @param CommonName $commonName
     * @param Email      $email
     */
    public function sendVettedEmail(
        Locale $locale,
        CommonName $commonName,
        Email $email
    ) {
        $subject = $this->translator->trans(
            'ss.mail.vetted_email.subject',
            ['%commonName%' => $commonName->getCommonName(), '%email%' => $email->getEmail()],
            null,
            $locale->getLocale()
        );

        $emailTemplate = $this->findEmailTemplate('vetted', $locale->getLocale(), $this->fallbackLocale);
        if (!$emailTemplate) {
            return;
        }

        $parameters = [
            'templateString'   => $emailTemplate->htmlContent,
            'locale'           => $locale->getLocale(),
            'commonName'       => $commonName->getCommonName(),
            'email'            => $email->getEmail(),
        ];

        // Rendering file template instead of string
        // (https://github.com/symfony/symfony/issues/10865#issuecomment-42438248)
        $body = $this->templateEngine->render(
            'SurfnetStepupMiddlewareCommandHandlingBundle:SecondFactorMailService:email.html.twig',
            $parameters
        );

        /** @var Message $message */
        $message = $this->mailer->createMessage();
        $message
            ->setFrom($this->sender->getEmail(), $this->sender->getName())
            ->addTo($email->getEmail(), $commonName->getCommonName())
            ->setSubject($subject)
            ->setBody($body, 'text/html', 'utf-8');

        $this->mailer->send($message);
    }

    /**
     * @param string $name
     * @param string $locale
     * @param string $fallbackLocale
     * @return null|\Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Dto\EmailTemplate
     */
    private function findEmailTemplate($name, $locale, $fallbackLocale)
    {
        $emailTemplate = $this->emailTemplateService->findByName($name, $locale, $this->fallbackLocale);

        if ($emailTemplate) {
            return $emailTemplate;
        }

        if ($this->warnOnMissingTemplateConfiguration) {
            $this->logger->warning(
                sprintf(
                    'Skipping sending mail because template configuration for "%s" in locale "%s" or "%s" is missing',
                    [$name, $locale, $fallbackLocale]
                )
            );
        }

        return null;
    }
}


1			<?php
2
3			/**
4			* Copyright 2014 SURFnet bv
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Service;
20
21			use Psr\Log\LoggerInterface;
22			use Surfnet\Stepup\Identity\Value\CommonName;
23			use Surfnet\Stepup\Identity\Value\Email;
24			use Surfnet\Stepup\Identity\Value\Locale;
25			use Surfnet\StepupMiddleware\ApiBundle\Identity\Value\RegistrationAuthorityCredentials;
26			use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Service\EmailTemplateService;
27			use Surfnet\StepupMiddleware\CommandHandlingBundle\Exception\InvalidArgumentException;
28			use Surfnet\StepupMiddleware\CommandHandlingBundle\Value\Sender;
29			use Swift_Mailer as Mailer;
30			use Swift_Message as Message;
31			use Symfony\Component\Templating\EngineInterface;
32			use Symfony\Component\Translation\TranslatorInterface;
33
34			/**
35			* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
36			*/
37			final class SecondFactorMailService
38			{
39			/**
40			* @var Mailer
41			*/
42			private $mailer;
43
44			/**
45			* @var Sender
46			*/
47			private $sender;
48
49			/**
50			* @var TranslatorInterface
51			*/
52			private $translator;
53
54			/**
55			* @var EngineInterface
56			*/
57			private $templateEngine;
58
59			/**
60			* @var string
61			*/
62			private $emailVerificationUrlTemplate;
63
64			/**
65			* @var \Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Service\EmailTemplateService
66			*/
67			private $emailTemplateService;
68
69			/**
70			* @var string
71			*/
72			private $fallbackLocale;
73
74			/**
75			* @var LoggerInterface
76			*/
77			private $logger;
78
79			/**
80			* @var bool
81			*/
82			private $warnOnMissingTemplateConfiguration;
83
84			/**
85			* @param Mailer $mailer
86			* @param Sender $sender
87			* @param TranslatorInterface $translator
88			* @param EngineInterface $templateEngine
89			* @param string $emailVerificationUrlTemplate
90			* @param EmailTemplateService $emailTemplateService
91			* @param string $fallbackLocale
92			* @param LoggerInterface $logger
93			* @param bool $warnOnMissingTemplateConfiguration
94			*/
95			public function __construct(
96			Mailer $mailer,
97			Sender $sender,
98			TranslatorInterface $translator,
99			EngineInterface $templateEngine,
100			$emailVerificationUrlTemplate,
101			EmailTemplateService $emailTemplateService,
102			$fallbackLocale,
103			LoggerInterface $logger,
104			$warnOnMissingTemplateConfiguration = true
			0 ignored issues – show Comprehensibility Naming introduced 2016-06-14 08:21 UTC by Report Bug Copy Issue Report The variable name `$warnOnMissingTemplateConfiguration` exceeds the maximum configured length of `30`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
105			) {
106			$this->mailer = $mailer;
107			$this->sender = $sender;
108			$this->translator = $translator;
109			$this->templateEngine = $templateEngine;
110			$this->emailVerificationUrlTemplate = $emailVerificationUrlTemplate;
111			$this->emailTemplateService = $emailTemplateService;
112			$this->fallbackLocale = $fallbackLocale;
113			$this->logger = $logger;
114
115			if (!is_bool($warnOnMissingTemplateConfiguration)) {
116			throw new InvalidArgumentException('warnOnMissingTemplateConfiguration for SecondFactorMailService is not a boolean');
			0 ignored issues – show Coding Style introduced 2016-06-15 09:43 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 130 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
117			}
118
119			$this->warnOnMissingTemplateConfiguration = $warnOnMissingTemplateConfiguration;
120			}
121
122			/**
123			* @param string $locale
124			* @param string $commonName
125			* @param string $email
126			* @param string $verificationNonce
127			*/
128			public function sendEmailVerificationEmail(
129			$locale,
130			$commonName,
131			$email,
132			$verificationNonce
133			) {
134			$subject = $this->translator->trans(
135			'ss.mail.email_verification_email.subject',
136			['%commonName%' => $commonName],
137			null,
138			$locale
139			);
140
141			$verificationUrl = str_replace(
142			'{nonce}',
143			urlencode($verificationNonce),
144			$this->emailVerificationUrlTemplate
145			);
146
147			$emailTemplate = $this->findEmailTemplate('confirm_email', $locale, $this->fallbackLocale);
148			if (!$emailTemplate) {
149			return;
150			}
151
152			$parameters = [
153			'templateString' => $emailTemplate->htmlContent,
154			'locale' => $locale,
155			'commonName' => $commonName,
156			'email' => $email,
157			'verificationUrl' => $verificationUrl
158			];
159
160			// Rendering file template instead of string
161			// (https://github.com/symfony/symfony/issues/10865#issuecomment-42438248)
162			$body = $this->templateEngine->render(
163			'SurfnetStepupMiddlewareCommandHandlingBundle:SecondFactorMailService:email.html.twig',
164			$parameters
165			);
166
167			/** @var Message $message */
168			$message = $this->mailer->createMessage();
169			$message
170			->setFrom($this->sender->getEmail(), $this->sender->getName())
171			->addTo($email, $commonName)
172			->setSubject($subject)
173			->setBody($body, 'text/html', 'utf-8');
174
175			$this->mailer->send($message);
176			}
177
178			/**
179			* @param string $locale
180			* @param string $commonName
181			* @param string $email
182			* @param string $registrationCode
183			* @param RegistrationAuthorityCredentials[] $ras
184			*/
185			public function sendRegistrationEmail(
186			$locale,
187			$commonName,
188			$email,
189			$registrationCode,
190			array $ras
191			) {
192			$subject = $this->translator->trans(
193			'ss.mail.registration_email.subject',
194			['%commonName%' => $commonName],
195			null,
196			$locale
197			);
198
199			$emailTemplate = $this->findEmailTemplate('registration_code', $locale, $this->fallbackLocale);
200			if (!$emailTemplate) {
201			return;
202			}
203
204			$parameters = [
205			'templateString' => $emailTemplate->htmlContent,
206			'locale' => $locale,
207			'commonName' => $commonName,
208			'email' => $email,
209			'registrationCode' => $registrationCode,
210			'ras' => $ras,
211			];
212
213			// Rendering file template instead of string
214			// (https://github.com/symfony/symfony/issues/10865#issuecomment-42438248)
215			$body = $this->templateEngine->render(
216			'SurfnetStepupMiddlewareCommandHandlingBundle:SecondFactorMailService:email.html.twig',
217			$parameters
218			);
219
220			/** @var Message $message */
221			$message = $this->mailer->createMessage();
222			$message
223			->setFrom($this->sender->getEmail(), $this->sender->getName())
224			->addTo($email, $commonName)
225			->setSubject($subject)
226			->setBody($body, 'text/html', 'utf-8');
227
228			$this->mailer->send($message);
229			}
230
231			/**
232			* @param Locale $locale
233			* @param CommonName $commonName
234			* @param Email $email
235			*/
236			public function sendVettedEmail(
237			Locale $locale,
238			CommonName $commonName,
239			Email $email
240			) {
241			$subject = $this->translator->trans(
242			'ss.mail.vetted_email.subject',
243			['%commonName%' => $commonName->getCommonName(), '%email%' => $email->getEmail()],
244			null,
245			$locale->getLocale()
246			);
247
248			$emailTemplate = $this->findEmailTemplate('vetted', $locale->getLocale(), $this->fallbackLocale);
249			if (!$emailTemplate) {
250			return;
251			}
252
253			$parameters = [
254			'templateString' => $emailTemplate->htmlContent,
255			'locale' => $locale->getLocale(),
256			'commonName' => $commonName->getCommonName(),
257			'email' => $email->getEmail(),
258			];
259
260			// Rendering file template instead of string
261			// (https://github.com/symfony/symfony/issues/10865#issuecomment-42438248)
262			$body = $this->templateEngine->render(
263			'SurfnetStepupMiddlewareCommandHandlingBundle:SecondFactorMailService:email.html.twig',
264			$parameters
265			);
266
267			/** @var Message $message */
268			$message = $this->mailer->createMessage();
269			$message
270			->setFrom($this->sender->getEmail(), $this->sender->getName())
271			->addTo($email->getEmail(), $commonName->getCommonName())
272			->setSubject($subject)
273			->setBody($body, 'text/html', 'utf-8');
274
275			$this->mailer->send($message);
276			}
277
278			/**
279			* @param string $name
280			* @param string $locale
281			* @param string $fallbackLocale
282			* @return null\|\Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Dto\EmailTemplate
283			*/
284			private function findEmailTemplate($name, $locale, $fallbackLocale)
285			{
286			$emailTemplate = $this->emailTemplateService->findByName($name, $locale, $this->fallbackLocale);
287
288			if ($emailTemplate) {
289			return $emailTemplate;
290			}
291
292			if ($this->warnOnMissingTemplateConfiguration) {
293			$this->logger->warning(
294			sprintf(
295			'Skipping sending mail because template configuration for "%s" in locale "%s" or "%s" is missing',
296			[$name, $locale, $fallbackLocale]
297			)
298			);
299			}
300
301			return null;
302			}
303			}
304

OpenConext / Stepup-Middleware

Pull Request — develop (#119)

SecondFactorMailService::findEmailTemplate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like