AzineTwigSwiftMailer::sendSingleEmail() - Code Metrics - Inspection of "update phpunit to ~4.0" - azine/email-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update-phpunit ( 383ba3 )

by Dominik

created 2017-05-06 20:36 UTC

AzineTwigSwiftMailer::sendSingleEmail() A

↳ Parent: AzineTwigSwiftMailer

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	9
crap	1

How to fix Many Parameters

<?php
namespace Azine\EmailBundle\Services;

use Doctrine\Common\Persistence\ManagerRegistry;
use Symfony\Component\Routing\RequestContext;
use Symfony\Component\HttpFoundation\File\Exception\FileException;
use Azine\EmailBundle\Entity\SentEmail;
use Azine\EmailBundle\DependencyInjection\AzineEmailExtension;
use Symfony\Bundle\FrameworkBundle\Translation\Translator;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use FOS\UserBundle\Mailer\TwigSwiftMailer;
use Azine\EmailBundle\Entity\RecipientInterface;

/**
 * This Service is used to send html-emails with embedded images
 * @author Dominik Businger
 */
class AzineTwigSwiftMailer extends TwigSwiftMailer implements TemplateTwigSwiftMailerInterface
{
    /**
     * @var Translator
     */
    protected $translator;

    /**
     * @var TemplateProviderInterface
     */
    protected $templateProvider;

    /**
     * @var ManagerRegistry
     */
    protected $managerRegistry;

    /**
     *
     * @var RequestContext
     */
    protected $routerContext;

    /**
     * @var string email to use for "no-reply"
     */
    protected $noReplyEmail;

    /**
     * @var string name to use for "no-reply"
     */
    protected $noReplyName;

    /**
     * The Swift_Mailer to be used for sending emails immediately
     * @var \Swift_Mailer
     */
    private $immediateMailer;

    /**
     * @var EmailOpenTrackingCodeBuilderInterface
     */
    private $emailOpenTrackingCodeBuilder;

    /**
     * @var AzineEmailTwigExtension
     */
    private $emailTwigExtension;

    private $encodedItemIdPattern;
    private $templateCache = array();
    private $imageCache = array();


    /**
     *
     * @param \Swift_Mailer $mailer
     * @param UrlGeneratorInterface $router
     * @param \Twig_Environment $twig
     * @param Translator $translator
     * @param TemplateProviderInterface $templateProvider
     * @param ManagerRegistry $managerRegistry
     * @param EmailOpenTrackingCodeBuilderInterface $emailOpenTrackingCodeBuilder
     * @param AzineEmailTwigExtension $emailTwigExtension
     * @param array $parameters
     * @param \Swift_Mailer $immediateMailer
     */
    public function __construct(    \Swift_Mailer $mailer,
                                    UrlGeneratorInterface $router,
                                    \Twig_Environment $twig,
                                    Translator $translator,
                                    TemplateProviderInterface $templateProvider,
                                    ManagerRegistry $managerRegistry,
                                    EmailOpenTrackingCodeBuilderInterface $emailOpenTrackingCodeBuilder,
                                    AzineEmailTwigExtension $emailTwigExtension,
                                    array $parameters,
                                    \Swift_Mailer $immediateMailer = null)
    {
        parent::__construct($mailer, $router, $twig, $parameters);
        $this->immediateMailer = $immediateMailer;
        $this->translator = $translator;
        $this->templateProvider = $templateProvider;
        $this->managerRegistry = $managerRegistry;
        $this->noReplyEmail = $parameters[AzineEmailExtension::NO_REPLY][AzineEmailExtension::NO_REPLY_EMAIL_ADDRESS];
        $this->noReplyName = $parameters[AzineEmailExtension::NO_REPLY][AzineEmailExtension::NO_REPLY_EMAIL_NAME];
        $this->emailOpenTrackingCodeBuilder = $emailOpenTrackingCodeBuilder;
        $this->routerContext = $router->getContext();
        $this->encodedItemIdPattern = "/^cid:.*@/";
        $this->emailTwigExtension = $emailTwigExtension;
    }

    /**
     * (non-PHPdoc)
     * @see Azine\EmailBundle\Services.TemplateTwigSwiftMailerInterface::sendEmail()
     * @param array $failedRecipients
     * @param string $subject
     * @param String $from
     * @param String $fromName
     * @param array|String $to
     * @param String $toName
     * @param array|String $cc
     * @param String $ccName
     * @param array|String $bcc
     * @param String $bccName
     * @param $replyTo
     * @param $replyToName
     * @param array $params
     * @param $template
     * @param array $attachments
     * @param null $emailLocale
     * @param \Swift_Message $message
     * @return int
     */
    public function sendEmail(&$failedRecipients, $subject, $from, $fromName, $to, $toName, $cc, $ccName, $bcc, $bccName, $replyTo, $replyToName, array $params, $template, $attachments = array(), $emailLocale = null, \Swift_Message &$message = null)
    {
        // create the message
        if ($message === null) {
            $message = \Swift_Message::newInstance();
        }

        $message->setSubject($subject);

        // set the from-Name & -Email to the default ones if not given
        if ($from === null) {
            $from = $this->noReplyEmail;
            if ($fromName === null) {
                $fromName = $this->noReplyName;
            }
        }

        // add the from-email for the footer-text
        if (!array_key_exists('fromEmail', $params)) {
            $params['sendMailAccountName'] = $this->noReplyName;
            $params['sendMailAccountAddress'] = $this->noReplyEmail;
        }

        // get the baseTemplate. => templateId without the ending.
        $templateBaseId = substr($template, 0, strrpos($template, ".", -6));

        // check if this email should be stored for web-view
        if ($this->templateProvider->saveWebViewFor($templateBaseId)) {
            // keep a copy of the vars for the web-view
            $webViewParams = $params;

            // add the web-view token
            $params[$this->templateProvider->getWebViewTokenId()] = SentEmail::getNewToken();
        } else {
            $webViewParams = array();
        }

        // recursively add all template-variables for the wrapper-templates and contentItems
        $params = $this->templateProvider->addTemplateVariablesFor($templateBaseId, $params);

        // recursively attach all messages in the array
        $this->embedImages($message, $params);

        // change the locale for the email-recipients
        if ($emailLocale !== null && strlen($emailLocale) > 0) {
            $currentUserLocale = $this->translator->getLocale();

            // change the router-context locale
            $this->routerContext->setParameter("_locale", $emailLocale);

            // change the translator locale
            $this->translator->setLocale($emailLocale);
        } else {
            $emailLocale = $this->translator->getLocale();
        }

        // recursively add snippets for the wrapper-templates and contentItems
        $params = $this->templateProvider->addTemplateSnippetsWithImagesFor($templateBaseId, $params, $emailLocale);

        // add the emailLocale (used for web-view)
        $params['emailLocale'] = $emailLocale;

        // render the email parts
        $twigTemplate = $this->loadTemplate($template);
        $textBody = $twigTemplate->renderBlock('body_text', $params);
        $message->addPart($textBody, 'text/plain');

        $htmlBody = $twigTemplate->renderBlock('body_html', $params);

        $campaignParams = $this->templateProvider->getCampaignParamsFor($templateBaseId, $params);

        if (sizeof($campaignParams) > 0) {
            $htmlBody = $this->emailTwigExtension->addCampaignParamsToAllUrls($htmlBody, $campaignParams);
        }

        // if email-tracking is enabled
        if($this->emailOpenTrackingCodeBuilder){
            // add an image at the end of the html tag with the tracking-params to track email-opens
            $imgTrackingCode = $this->emailOpenTrackingCodeBuilder->getTrackingImgCode($templateBaseId, $campaignParams, $params, $message->getId(), $to, $cc, $bcc);
            if($imgTrackingCode && strlen($imgTrackingCode) > 0) {
                $htmlCloseTagPosition = strpos($htmlBody, "</body>");
                $htmlBody = substr_replace($htmlBody, $imgTrackingCode, $htmlCloseTagPosition, 0);
            }
        }

        $message->setBody($htmlBody, 'text/html');

        // remove unused/unreferenced embeded items from the message
        $message = $this->removeUnreferecedEmbededItemsFromMessage($message, $params, $htmlBody);

        // change the locale back to the users locale
        if (isset($currentUserLocale) && $currentUserLocale !== null) {
            $this->routerContext->setParameter("_locale", $currentUserLocale);
            $this->translator->setLocale($currentUserLocale);
        }

        // add attachments
        foreach ($attachments as $fileName => $file) {

            // add attachment from existing file
            if (is_string($file)) {

                // check that the file really exists!
                if (file_exists($file)) {
                    $attachment = \Swift_Attachment::fromPath($file);
                    if (strlen($fileName) >= 5 ) {
                        $attachment->setFilename($fileName);
                    }
                } else {
                    throw new FileException("File not found: ".$file);
                }

                // add attachment from generated data
            } else {
                $attachment = \Swift_Attachment::newInstance($file, $fileName);
            }

            $message->attach($attachment);
        }

        // set the addresses
        if ($from) {
            $message->setFrom($from, $fromName);
        }
        if ($replyTo) {
            $message->setReplyTo($replyTo, $replyToName);
        } elseif ($from) {
            $message->setReplyTo($from, $fromName);
        }
        if ($to) {
            $message->setTo($to, $toName);
        }
        if ($cc) {
            $message->setCc($cc, $ccName);
        }
        if ($bcc) {
            $message->setBcc($bcc, $bccName);
        }

        // add custom headers
        $this->templateProvider->addCustomHeaders($templateBaseId, $message, $params);

        // send the message
        $mailer = $this->getMailer($params);
        $messagesSent = $mailer->send($message, $failedRecipients);

        // if the message was successfully sent,
        // and it should be made available in web-view
        if ($messagesSent && array_key_exists($this->templateProvider->getWebViewTokenId(), $params)) {

            // store the email
            $sentEmail = new SentEmail();
            $sentEmail->setToken($params[$this->templateProvider->getWebViewTokenId()]);
            $sentEmail->setTemplate($templateBaseId);
            $sentEmail->setSent(new \DateTime());

            // recursively add all template-variables for the wrapper-templates and contentItems
            $webViewParams = $this->templateProvider->addTemplateVariablesFor($template, $webViewParams);

            // replace absolute image-paths with relative ones.
            $webViewParams = $this->templateProvider->makeImagePathsWebRelative($webViewParams, $emailLocale);

            // recursively add snippets for the wrapper-templates and contentItems
            $webViewParams = $this->templateProvider->addTemplateSnippetsWithImagesFor($template, $webViewParams, $emailLocale, true);

            $sentEmail->setVariables($webViewParams);

            // save only successfull recipients
            if (!is_array($to)) {
                $to = array($to);
            }
            $successfulRecipients = array_diff($to, $failedRecipients);
            $sentEmail->setRecipients($successfulRecipients);

            // write to db
            $em = $this->managerRegistry->getManager();
            $em->persist($sentEmail);
            $em->flush($sentEmail);
            $em->clear();
            gc_collect_cycles();
        }

        return $messagesSent;
    }

    /**
     * Remove all Embeded Attachments that are not referenced in the html-body from the message
     * to avoid using unneccary bandwidth.
     *
     * @param \Swift_Message $message
     * @param array $params the parameters used to render the html
     * @param string $htmlBody
     * @return \Swift_Message
     */
    private function removeUnreferecedEmbededItemsFromMessage(\Swift_Message $message, $params, $htmlBody)
    {
        foreach ($params as $key => $value) {
            // remove unreferenced attachments from contentItems too.
            if ($key === 'contentItems') {
                foreach ($value as $contentItemParams) {
                    $message = $this->removeUnreferecedEmbededItemsFromMessage($message, $contentItemParams, $htmlBody);
                }
            } else {

                // check if the embeded items are referenced in the templates
                $isEmbededItem = is_string($value) && preg_match($this->encodedItemIdPattern, $value) == 1;

                if ($isEmbededItem && stripos($htmlBody, $value) === false) {
                    // remove unreferenced items
                    $children = array();

                    foreach ($message->getChildren() as $attachment) {
                        if ("cid:".$attachment->getId() != $value) {
                            $children[] = $attachment;
                        }
                    }

                    $message->setChildren($children);
                }
            }
        }

        return $message;
    }

    /**
     * Get the template from the cache if it was loaded already
     * @param  string         $template
     * @return \Twig_Template
     */
    private function loadTemplate($template)
    {
        if (!array_key_exists($template, $this->templateCache)) {
            $this->templateCache[$template] = $this->twig->loadTemplate($template);
        }

        return $this->templateCache[$template];
    }

    /**
     * Recursively embed all images in the array into the message
     * @param  \Swift_Message $message
     * @param  array $params
     * @return array $params
     */
    private function embedImages(&$message, &$params)
    {
        // loop through the array
        foreach ($params as $key => $value) {

            // if the current value is an array
            if (is_array($value)) {
                // search for more images deeper in the arrays
                $value = $this->embedImages($message, $value);
                $params[$key] = $value;

            // if the current value is an existing file from the image-folder, embed it
            } elseif (is_string($value)) {
                if (is_file($value)) {

                    // check if the file is from an allowed folder
                    if ($this->templateProvider->isFileAllowed($value) !== false) {
                        $encodedImage = $this->cachedEmbedImage($value);
                        if ($encodedImage !== null) {
                            $id = $message->embed($encodedImage);
                            $params[$key] = $id;
                        }
                    }

                // the $filePath isn't a regular file
                } else {
                    // add a null-value to the cache for this path, so we don't try again.
                    $this->imageCache[$value] = null;
                }

                //if the current value is a generated image
            } elseif (is_resource($value) && stripos(get_resource_type($value), "gd") == 0) {
                // get the image-data as string
                ob_start();
                imagepng($value);
                $imageData = ob_get_clean();

                // encode the image
                $encodedImage = \Swift_Image::newInstance($imageData, "generatedImage".md5($imageData));
                $id = $message->embed($encodedImage);
                $params[$key] = $id;
            } else {
                // don't do anything
            }
        }

        // remove duplicate-attachments
        $message->setChildren(array_unique($message->getChildren()));

        return $params;
    }

    /**
     * Get the Swift_Image for the file.
     * @param  string            $filePath
     * @return \Swift_Image|null
     */
    private function cachedEmbedImage($filePath)
    {
        $filePath = realpath($filePath);
        if (!array_key_exists($filePath, $this->imageCache)) {
            if (is_file($filePath)) {

                $image = \Swift_Image::fromPath($filePath);
                $id = $image->getId();

                // $id and $value must not be the same => this happens if the file cannot be found/read
                if ($id == $filePath) {
                    // @codeCoverageIgnoreStart
                    // add a null-value to the cache for this path, so we don't try again.
                    $this->imageCache[$filePath] = null;

                } else {
                    // @codeCoverageIgnoreEnd
                    // add the image to the cache
                    $this->imageCache[$filePath] = $image;
                }

            }

        }

        return $this->imageCache[$filePath];
    }

    /**
     * (non-PHPdoc)
     * @see Azine\EmailBundle\Services.TemplateTwigSwiftMailerInterface::sendSingleEmail()
     * @param string $to
     * @param string $toName
     * @param string $subject
     * @param array $params
     * @param string $template
     * @param string $emailLocale
     * @param null $from
     * @param null $fromName
     * @param \Swift_Message $message
     * @return bool
     */
    public function sendSingleEmail($to, $toName, $subject, array $params, $template, $emailLocale, $from = null, $fromName = null, \Swift_Message &$message = null)
    {
        $failedRecipients = array();
        $this->sendEmail($failedRecipients, $subject, $from, $fromName, $to, $toName, null, null, null, null, null, null, $params, $template, array(), $emailLocale, $message);

        return sizeof($failedRecipients) == 0;
    }

    /**
     * Override the fosuserbundles original sendMessage, to embed template variables etc. into html-emails.
     * @param  string  $templateName
     * @param  array   $context
     * @param  string  $fromEmail
     * @param  string  $toEmail
     * @return boolean true if the mail was sent successfully, else false
     */
    protected function sendMessage($templateName, $context, $fromEmail, $toEmail)
    {
        // get the subject from the template
        // => make sure the subject block exists in your fos-templates (FOSUserBundle:Registration:email.txt.twig & FOSUserBundle:Resetting:email.txt.twig)
        $twigTemplate = $this->loadTemplate($templateName);
        $subject = $twigTemplate->renderBlock('subject', $context);

        return $this->sendSingleEmail($toEmail, null, $subject, $context, $templateName, $this->translator->getLocale(), $fromEmail);
    }

    /**
     * Return the Swift_Mailer to be used for sending mails immediately (e.g. instead of spooling them) if it is configured
     * @param $params
     * @return \Swift_Mailer
     */
    private function getMailer($params){
        // if the second mailer for immediate mail-delivery has been configured
        if($this->immediateMailer !== null){
            // check if this template has been configured to be sent immediately
            if(array_key_exists(AzineTemplateProvider::SEND_IMMEDIATELY_FLAG, $params) && $params[AzineTemplateProvider::SEND_IMMEDIATELY_FLAG]) {
                return $this->immediateMailer;
            }
        }
        return $this->mailer;
    }

    /**
     * Send confirmation link to specified new user email.
     * @param RecipientInterface $user
     * @param $confirmationUrl
     * @param $templateName
     * @param $toEmail
     * @return bool
     * @deprecated As soon as the "confirm changed email"-feature is merged into the FosUserBundle, this function will be removed again. See https://github.com/azine/FOSUserBundle
     */
    public function sendUpdateEmailConfirmation(RecipientInterface $user, $confirmationUrl, $templateName, $toEmail)
    {
        $emailTemplateParams = array(
            'user'            => $user,
            'confirmationUrl' => $confirmationUrl
        );

        $sendResult = $this->sendMessage(
            $templateName,
            $emailTemplateParams,
            null,
            $toEmail
        );

        if (!$sendResult) {
            throw new \LogicException(
                'Unable to send an email to confirm your new email'
            );
        }

        return true;
    }
}


1		<?php
2		namespace Azine\EmailBundle\Services;
3
4		use Doctrine\Common\Persistence\ManagerRegistry;
5		use Symfony\Component\Routing\RequestContext;
6		use Symfony\Component\HttpFoundation\File\Exception\FileException;
7		use Azine\EmailBundle\Entity\SentEmail;
8		use Azine\EmailBundle\DependencyInjection\AzineEmailExtension;
9		use Symfony\Bundle\FrameworkBundle\Translation\Translator;
10		use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
11		use FOS\UserBundle\Mailer\TwigSwiftMailer;
12		use Azine\EmailBundle\Entity\RecipientInterface;
13
14		/**
15		* This Service is used to send html-emails with embedded images
16		* @author Dominik Businger
17		*/
18		class AzineTwigSwiftMailer extends TwigSwiftMailer implements TemplateTwigSwiftMailerInterface
19		{
20		/**
21		* @var Translator
22		*/
23		protected $translator;
24
25		/**
26		* @var TemplateProviderInterface
27		*/
28		protected $templateProvider;
29
30		/**
31		* @var ManagerRegistry
32		*/
33		protected $managerRegistry;
34
35		/**
36		*
37		* @var RequestContext
38		*/
39		protected $routerContext;
40
41		/**
42		* @var string email to use for "no-reply"
43		*/
44		protected $noReplyEmail;
45
46		/**
47		* @var string name to use for "no-reply"
48		*/
49		protected $noReplyName;
50
51		/**
52		* The Swift_Mailer to be used for sending emails immediately
53		* @var \Swift_Mailer
54		*/
55		private $immediateMailer;
56
57		/**
58		* @var EmailOpenTrackingCodeBuilderInterface
59		*/
60		private $emailOpenTrackingCodeBuilder;
61
62		/**
63		* @var AzineEmailTwigExtension
64		*/
65		private $emailTwigExtension;
66
67		private $encodedItemIdPattern;
68		private $templateCache = array();
69		private $imageCache = array();
70
71
72		/**
73		*
74		* @param \Swift_Mailer $mailer
75		* @param UrlGeneratorInterface $router
76		* @param \Twig_Environment $twig
77		* @param Translator $translator
78		* @param TemplateProviderInterface $templateProvider
79		* @param ManagerRegistry $managerRegistry
80		* @param EmailOpenTrackingCodeBuilderInterface $emailOpenTrackingCodeBuilder
81		* @param AzineEmailTwigExtension $emailTwigExtension
82		* @param array $parameters
83		* @param \Swift_Mailer $immediateMailer
84		*/
85	7	public function __construct( \Swift_Mailer $mailer,
86		UrlGeneratorInterface $router,
87		\Twig_Environment $twig,
88		Translator $translator,
89		TemplateProviderInterface $templateProvider,
90		ManagerRegistry $managerRegistry,
91		EmailOpenTrackingCodeBuilderInterface $emailOpenTrackingCodeBuilder,
92		AzineEmailTwigExtension $emailTwigExtension,
93		array $parameters,
94		\Swift_Mailer $immediateMailer = null)
95		{
96	7	parent::__construct($mailer, $router, $twig, $parameters);
97	7	$this->immediateMailer = $immediateMailer;
98	7	$this->translator = $translator;
99	7	$this->templateProvider = $templateProvider;
100	7	$this->managerRegistry = $managerRegistry;
101	7	$this->noReplyEmail = $parameters[AzineEmailExtension::NO_REPLY][AzineEmailExtension::NO_REPLY_EMAIL_ADDRESS];
102	7	$this->noReplyName = $parameters[AzineEmailExtension::NO_REPLY][AzineEmailExtension::NO_REPLY_EMAIL_NAME];
103	7	$this->emailOpenTrackingCodeBuilder = $emailOpenTrackingCodeBuilder;
104	7	$this->routerContext = $router->getContext();
105	7	$this->encodedItemIdPattern = "/^cid:.*@/";
106	7	$this->emailTwigExtension = $emailTwigExtension;
107	7	}
108
109		/**
110		* (non-PHPdoc)
111		* @see Azine\EmailBundle\Services.TemplateTwigSwiftMailerInterface::sendEmail()
112		* @param array $failedRecipients
113		* @param string $subject
114		* @param String $from
115		* @param String $fromName
116		* @param array\|String $to
117		* @param String $toName
118		* @param array\|String $cc
119		* @param String $ccName
120		* @param array\|String $bcc
121		* @param String $bccName
122		* @param $replyTo
123		* @param $replyToName
124		* @param array $params
125		* @param $template
126		* @param array $attachments
127		* @param null $emailLocale
128		* @param \Swift_Message $message
129		* @return int
130		*/
131	7	public function sendEmail(&$failedRecipients, $subject, $from, $fromName, $to, $toName, $cc, $ccName, $bcc, $bccName, $replyTo, $replyToName, array $params, $template, $attachments = array(), $emailLocale = null, \Swift_Message &$message = null)
132		{
133		// create the message
134	7	if ($message === null) {
135	7	$message = \Swift_Message::newInstance();
136	7	}
137
138	7	$message->setSubject($subject);
139
140		// set the from-Name & -Email to the default ones if not given
141	7	if ($from === null) {
142	2	$from = $this->noReplyEmail;
143	2	if ($fromName === null) {
144	2	$fromName = $this->noReplyName;
145	2	}
146	2	}
147
148		// add the from-email for the footer-text
149	7	if (!array_key_exists('fromEmail', $params)) {
150	7	$params['sendMailAccountName'] = $this->noReplyName;
151	7	$params['sendMailAccountAddress'] = $this->noReplyEmail;
152	7	}
153
154		// get the baseTemplate. => templateId without the ending.
155	7	$templateBaseId = substr($template, 0, strrpos($template, ".", -6));
156
157		// check if this email should be stored for web-view
158	7	if ($this->templateProvider->saveWebViewFor($templateBaseId)) {
159		// keep a copy of the vars for the web-view
160	4	$webViewParams = $params;
161
162		// add the web-view token
163	4	$params[$this->templateProvider->getWebViewTokenId()] = SentEmail::getNewToken();
164	4	} else {
165	3	$webViewParams = array();
166		}
167
168		// recursively add all template-variables for the wrapper-templates and contentItems
169	7	$params = $this->templateProvider->addTemplateVariablesFor($templateBaseId, $params);
170
171		// recursively attach all messages in the array
172	7	$this->embedImages($message, $params);
173
174		// change the locale for the email-recipients
175	7	if ($emailLocale !== null && strlen($emailLocale) > 0) {
176	6	$currentUserLocale = $this->translator->getLocale();
177
178		// change the router-context locale
179	6	$this->routerContext->setParameter("_locale", $emailLocale);
180
181		// change the translator locale
182	6	$this->translator->setLocale($emailLocale);
183	6	} else {
184	1	$emailLocale = $this->translator->getLocale();
185		}
186
187		// recursively add snippets for the wrapper-templates and contentItems
188	7	$params = $this->templateProvider->addTemplateSnippetsWithImagesFor($templateBaseId, $params, $emailLocale);
189
190		// add the emailLocale (used for web-view)
191	7	$params['emailLocale'] = $emailLocale;
192
193		// render the email parts
194	7	$twigTemplate = $this->loadTemplate($template);
195	7	$textBody = $twigTemplate->renderBlock('body_text', $params);
196	7	$message->addPart($textBody, 'text/plain');
197
198	7	$htmlBody = $twigTemplate->renderBlock('body_html', $params);
199
200	7	$campaignParams = $this->templateProvider->getCampaignParamsFor($templateBaseId, $params);
201
202	7	if (sizeof($campaignParams) > 0) {
203	5	$htmlBody = $this->emailTwigExtension->addCampaignParamsToAllUrls($htmlBody, $campaignParams);
204	5	}
205
206		// if email-tracking is enabled
207	7	if($this->emailOpenTrackingCodeBuilder){
208		// add an image at the end of the html tag with the tracking-params to track email-opens
209	7	$imgTrackingCode = $this->emailOpenTrackingCodeBuilder->getTrackingImgCode($templateBaseId, $campaignParams, $params, $message->getId(), $to, $cc, $bcc);
210	7	if($imgTrackingCode && strlen($imgTrackingCode) > 0) {
211	5	$htmlCloseTagPosition = strpos($htmlBody, "</body>");
212	5	$htmlBody = substr_replace($htmlBody, $imgTrackingCode, $htmlCloseTagPosition, 0);
213	5	}
214	7	}
215
216	7	$message->setBody($htmlBody, 'text/html');
217
218		// remove unused/unreferenced embeded items from the message
219	7	$message = $this->removeUnreferecedEmbededItemsFromMessage($message, $params, $htmlBody);
220
221		// change the locale back to the users locale
222	7	if (isset($currentUserLocale) && $currentUserLocale !== null) {
223	6	$this->routerContext->setParameter("_locale", $currentUserLocale);
224	6	$this->translator->setLocale($currentUserLocale);
225	6	}
226
227		// add attachments
228	7	foreach ($attachments as $fileName => $file) {
229
230		// add attachment from existing file
231	2	if (is_string($file)) {
232
233		// check that the file really exists!
234	2	if (file_exists($file)) {
235	1	$attachment = \Swift_Attachment::fromPath($file);
236	1	if (strlen($fileName) >= 5 ) {
237	1	$attachment->setFilename($fileName);
238	1	}
239	1	} else {
240	1	throw new FileException("File not found: ".$file);
241		}
242
243		// add attachment from generated data
244	1	} else {
245	1	$attachment = \Swift_Attachment::newInstance($file, $fileName);
246		}
247
248	1	$message->attach($attachment);
249	6	}
250
251		// set the addresses
252	6	if ($from) {
253	6	$message->setFrom($from, $fromName);
254	6	}
255	6	if ($replyTo) {
256	2	$message->setReplyTo($replyTo, $replyToName);
257	6	} elseif ($from) {
258	4	$message->setReplyTo($from, $fromName);
259	4	}
260	6	if ($to) {
261	6	$message->setTo($to, $toName);
262	6	}
263	6	if ($cc) {
264	2	$message->setCc($cc, $ccName);
265	2	}
266	6	if ($bcc) {
267	2	$message->setBcc($bcc, $bccName);
268	2	}
269
270		// add custom headers
271	6	$this->templateProvider->addCustomHeaders($templateBaseId, $message, $params);
272
273		// send the message
274	6	$mailer = $this->getMailer($params);
275	6	$messagesSent = $mailer->send($message, $failedRecipients);
276
277		// if the message was successfully sent,
278		// and it should be made available in web-view
279	6	if ($messagesSent && array_key_exists($this->templateProvider->getWebViewTokenId(), $params)) {
280
281		// store the email
282	2	$sentEmail = new SentEmail();
283	2	$sentEmail->setToken($params[$this->templateProvider->getWebViewTokenId()]);
284	2	$sentEmail->setTemplate($templateBaseId);
285	2	$sentEmail->setSent(new \DateTime());
286
287		// recursively add all template-variables for the wrapper-templates and contentItems
288	2	$webViewParams = $this->templateProvider->addTemplateVariablesFor($template, $webViewParams);
289
290		// replace absolute image-paths with relative ones.
291	2	$webViewParams = $this->templateProvider->makeImagePathsWebRelative($webViewParams, $emailLocale);
292
293		// recursively add snippets for the wrapper-templates and contentItems
294	2	$webViewParams = $this->templateProvider->addTemplateSnippetsWithImagesFor($template, $webViewParams, $emailLocale, true);
295
296	2	$sentEmail->setVariables($webViewParams);
297
298		// save only successfull recipients
299	2	if (!is_array($to)) {
300	2	$to = array($to);
301	2	}
302	2	$successfulRecipients = array_diff($to, $failedRecipients);
303	2	$sentEmail->setRecipients($successfulRecipients);
304
305		// write to db
306	2	$em = $this->managerRegistry->getManager();
307	2	$em->persist($sentEmail);
308	2	$em->flush($sentEmail);
309	2	$em->clear();
310	2	gc_collect_cycles();
311	2	}
312
313	6	return $messagesSent;
314		}
315
316		/**
317		* Remove all Embeded Attachments that are not referenced in the html-body from the message
318		* to avoid using unneccary bandwidth.
319		*
320		* @param \Swift_Message $message
321		* @param array $params the parameters used to render the html
322		* @param string $htmlBody
323		* @return \Swift_Message
324		*/
325	7	private function removeUnreferecedEmbededItemsFromMessage(\Swift_Message $message, $params, $htmlBody)
326		{
327	7	foreach ($params as $key => $value) {
328		// remove unreferenced attachments from contentItems too.
329	7	if ($key === 'contentItems') {
330	2	foreach ($value as $contentItemParams) {
331	2	$message = $this->removeUnreferecedEmbededItemsFromMessage($message, $contentItemParams, $htmlBody);
332	7	}
333	3	} else {
334
335		// check if the embeded items are referenced in the templates
336	7	$isEmbededItem = is_string($value) && preg_match($this->encodedItemIdPattern, $value) == 1;
337
338	7	if ($isEmbededItem && stripos($htmlBody, $value) === false) {
339		// remove unreferenced items
340	7	$children = array();
341
342	7	foreach ($message->getChildren() as $attachment) {
343	7	if ("cid:".$attachment->getId() != $value) {
344	7	$children[] = $attachment;
345	7	}
346	7	}
347
348	7	$message->setChildren($children);
349	7	}
350		}
351	7	}
352
353	7	return $message;
354		}
355
356		/**
357		* Get the template from the cache if it was loaded already
358		* @param string $template
359		* @return \Twig_Template
360		*/
361	7	private function loadTemplate($template)
362		{
363	7	if (!array_key_exists($template, $this->templateCache)) {
364	7	$this->templateCache[$template] = $this->twig->loadTemplate($template);
365	7	}
366
367	7	return $this->templateCache[$template];
368		}
369
370		/**
371		* Recursively embed all images in the array into the message
372		* @param \Swift_Message $message
373		* @param array $params
374		* @return array $params
375		*/
376	7	private function embedImages(&$message, &$params)
377		{
378		// loop through the array
379	7	foreach ($params as $key => $value) {
380
381		// if the current value is an array
382	7	if (is_array($value)) {
383		// search for more images deeper in the arrays
384	2	$value = $this->embedImages($message, $value);
385	2	$params[$key] = $value;
386
387		// if the current value is an existing file from the image-folder, embed it
388	7	} elseif (is_string($value)) {
389	7	if (is_file($value)) {
390
391		// check if the file is from an allowed folder
392	7	if ($this->templateProvider->isFileAllowed($value) !== false) {
393	7	$encodedImage = $this->cachedEmbedImage($value);
394	7	if ($encodedImage !== null) {
395	7	$id = $message->embed($encodedImage);
396	7	$params[$key] = $id;
397	7	}
398	7	}
399
400		// the $filePath isn't a regular file
401	7	} else {
402		// add a null-value to the cache for this path, so we don't try again.
403	7	$this->imageCache[$value] = null;
404		}
405
406		//if the current value is a generated image
407	7	} elseif (is_resource($value) && stripos(get_resource_type($value), "gd") == 0) {
408		// get the image-data as string
409	1	ob_start();
410	1	imagepng($value);
411	1	$imageData = ob_get_clean();
412
413		// encode the image
414	1	$encodedImage = \Swift_Image::newInstance($imageData, "generatedImage".md5($imageData));
415	1	$id = $message->embed($encodedImage);
416	1	$params[$key] = $id;
417	1	} else {
418		// don't do anything
419		}
420	7	}
421
422		// remove duplicate-attachments
423	7	$message->setChildren(array_unique($message->getChildren()));
424
425	7	return $params;
426		}
427
428		/**
429		* Get the Swift_Image for the file.
430		* @param string $filePath
431		* @return \Swift_Image\|null
432		*/
433	7	private function cachedEmbedImage($filePath)
434		{
435	7	$filePath = realpath($filePath);
436	7	if (!array_key_exists($filePath, $this->imageCache)) {
437	7	if (is_file($filePath)) {
438
439	7	$image = \Swift_Image::fromPath($filePath);
440	7	$id = $image->getId();
441
442		// $id and $value must not be the same => this happens if the file cannot be found/read
443	7	if ($id == $filePath) {
444		// @codeCoverageIgnoreStart
445		// add a null-value to the cache for this path, so we don't try again.
446		$this->imageCache[$filePath] = null;
447
448		} else {
449		// @codeCoverageIgnoreEnd
450		// add the image to the cache
451	7	$this->imageCache[$filePath] = $image;
452		}
453
454	7	}
455
456	7	}
457
458	7	return $this->imageCache[$filePath];
459		}
460
461		/**
462		* (non-PHPdoc)
463		* @see Azine\EmailBundle\Services.TemplateTwigSwiftMailerInterface::sendSingleEmail()
464		* @param string $to
465		* @param string $toName
466		* @param string $subject
467		* @param array $params
468		* @param string $template
469		* @param string $emailLocale
470		* @param null $from
471		* @param null $fromName
472		* @param \Swift_Message $message
473		* @return bool
474		*/
475	4	public function sendSingleEmail($to, $toName, $subject, array $params, $template, $emailLocale, $from = null, $fromName = null, \Swift_Message &$message = null)
476		{
477	4	$failedRecipients = array();
478	4	$this->sendEmail($failedRecipients, $subject, $from, $fromName, $to, $toName, null, null, null, null, null, null, $params, $template, array(), $emailLocale, $message);
479
480	4	return sizeof($failedRecipients) == 0;
481		}
482
483		/**
484		* Override the fosuserbundles original sendMessage, to embed template variables etc. into html-emails.
485		* @param string $templateName
486		* @param array $context
487		* @param string $fromEmail
488		* @param string $toEmail
489		* @return boolean true if the mail was sent successfully, else false
490		*/
491	2	protected function sendMessage($templateName, $context, $fromEmail, $toEmail)
492		{
493		// get the subject from the template
494		// => make sure the subject block exists in your fos-templates (FOSUserBundle:Registration:email.txt.twig & FOSUserBundle:Resetting:email.txt.twig)
495	2	$twigTemplate = $this->loadTemplate($templateName);
496	2	$subject = $twigTemplate->renderBlock('subject', $context);
497
498	2	return $this->sendSingleEmail($toEmail, null, $subject, $context, $templateName, $this->translator->getLocale(), $fromEmail);
499		}
500
501		/**
502		* Return the Swift_Mailer to be used for sending mails immediately (e.g. instead of spooling them) if it is configured
503		* @param $params
504		* @return \Swift_Mailer
505		*/
506	6	private function getMailer($params){
507		// if the second mailer for immediate mail-delivery has been configured
508	6	if($this->immediateMailer !== null){
509		// check if this template has been configured to be sent immediately
510		if(array_key_exists(AzineTemplateProvider::SEND_IMMEDIATELY_FLAG, $params) && $params[AzineTemplateProvider::SEND_IMMEDIATELY_FLAG]) {
511		return $this->immediateMailer;
512		}
513		}
514	6	return $this->mailer;
515		}
516
517		/**
518		* Send confirmation link to specified new user email.
519		* @param RecipientInterface $user
520		* @param $confirmationUrl
521		* @param $templateName
522		* @param $toEmail
523		* @return bool
524		* @deprecated As soon as the "confirm changed email"-feature is merged into the FosUserBundle, this function will be removed again. See https://github.com/azine/FOSUserBundle
525		*/
526		public function sendUpdateEmailConfirmation(RecipientInterface $user, $confirmationUrl, $templateName, $toEmail)
527		{
528		$emailTemplateParams = array(
529		'user' => $user,
530		'confirmationUrl' => $confirmationUrl
531		);
532
533		$sendResult = $this->sendMessage(
534		$templateName,
535		$emailTemplateParams,
536		null,
537		$toEmail
538		);
539
540		if (!$sendResult) {
541		throw new \LogicException(
542		'Unable to send an email to confirm your new email'
543		);
544		}
545
546		return true;
547		}
548		}
549

azine / email-bundle

Push — update-phpunit ( 383ba3 )

AzineTwigSwiftMailer::sendSingleEmail() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like