SparkPostSwiftTransport::getHeaderValue() - Code Metrics - Inspection of "support silverstripe 4.9 and swift mailer 6.0" - lekoala/silverstripe-sparkpost - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 4707af...d36b17 )

by Thomas
created 2021-10-05 11:33 UTC
SparkPostSwiftTransport::getHeaderValue() A

↳ Parent: SparkPostSwiftTransport
Complexity

Conditions	3
Paths	3
Size

Total Lines	9
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	5
nc	3
nop	1
dl	0
loc	9
rs	10
c	0
b	0
f	0
<?php

namespace LeKoala\SparkPost;

use Exception;
use \Swift_MimePart;
use \Swift_Transport;
use \Swift_Attachment;
use \Swift_Mime_SimpleMessage;
use \Swift_Mime_Headers_UnstructuredHeader;
use \Swift_Events_SendEvent;
use \Swift_Mime_Header;
use Psr\Log\LoggerInterface;
use \Swift_Events_EventListener;
use SilverStripe\Control\Director;
use SilverStripe\Assets\FileNameFilter;
use SilverStripe\Core\Injector\Injector;
use LeKoala\SparkPost\Api\SparkPostApiClient;

/**
 * A SparkPost transport for Swift Mailer using our custom client
 *
 * Heavily inspired by slowprog/SparkPostSwiftMailer
 *
 * @link https://github.com/slowprog/SparkPostSwiftMailer
 * @link https://www.sparkpost.com/api#/reference/introduction
 * @author LeKoala <[email protected]>
 */
class SparkPostSwiftTransport implements Swift_Transport
{

    /**
     * @var Swift_Transport_SimpleMailInvoker

     */
    protected $invoker;

    /**
     * @var Swift_Events_SimpleEventDispatcher

     */
    protected $eventDispatcher;

    /**
     * @var LeKoala\SparkPost\Api\SparkPostApiClient

     */
    protected $client;

    /**
     * @var array
     */
    protected $resultApi;

    /**
     * @var string
     */
    protected $fromEmail;

    /**
     * @var boolean
     */
    protected $isStarted = false;

    public function __construct(SparkPostApiClient $client)
    {
        $this->client = $client;


        $this->invoker = new \Swift_Transport_SimpleMailInvoker();

        $this->eventDispatcher = new \Swift_Events_SimpleEventDispatcher();

    }

    /**
     * Not used
     */
    public function isStarted()
    {
        return $this->isStarted;
    }

    /**
     * Not used
     */
    public function start()
    {
        $this->isStarted = true;
    }

    /**
     * Not used
     */
    public function stop()
    {
        $this->isStarted = false;
    }

    public function ping()
    {
        return true;
    }

    /**
     * @param Swift_Mime_SimpleMessage $message
     * @param string[] $failedRecipients
     * @return int Number of messages sent
     */
    public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null)
    {
        $this->resultApi = null;
        if ($event = $this->eventDispatcher->createSendEvent($this, $message)) {
            $this->eventDispatcher->dispatchEvent($event, 'beforeSendPerformed');
            if ($event->bubbleCancelled()) {
                return 0;
            }
        }

        $sendCount = 0;

        $disableSending = $message->getHeaders()->has('X-SendingDisabled') || SparkPostHelper::config()->disable_sending;

        $transmissionData = $this->getTransmissionFromMessage($message);

        /* @var $client LeKoala\SparkPost\Api\SparkPostApiClient */
        $client = $this->client;

        if ($disableSending) {
            $result = [
                'total_rejected_recipients' => 0,
                'total_accepted_recipients' => 1,
                'id' => uniqid(),
                'disabled' => true,
            ];
        } else {
            $result = $client->createTransmission($transmissionData);
        }
        $this->resultApi = $result;

        if (SparkPostHelper::config()->enable_logging) {
            $this->logMessageContent($message, $result);
        }

        $sendCount = $this->resultApi['total_accepted_recipients'];

        // We don't know which recipients failed, so simply add fromEmail since it's the only one we know
        if ($this->resultApi['total_rejected_recipients'] > 0) {
            $failedRecipients[] = $this->fromEmail;
        }

        if ($event) {
            if ($sendCount > 0) {
                $event->setResult(Swift_Events_SendEvent::RESULT_SUCCESS);
            } else {
                $event->setResult(Swift_Events_SendEvent::RESULT_FAILED);
            }

            $this->eventDispatcher->dispatchEvent($event, 'sendPerformed');
        }

        return $sendCount;
    }

    /**
     * Log message content
     *
     * @param Swift_Mime_SimpleMessage $message
     * @param array $results Results from the api
     * @return void
     */
    protected function logMessageContent(Swift_Mime_SimpleMessage $message, $results = [])
    {
        $subject = $message->getSubject();
        $body = $message->getBody();
        $contentType = $this->getMessagePrimaryContentType($message);

        $logContent = $body;

        // Append some extra information at the end
        $logContent .= '<hr><pre>Debug infos:' . "\n\n";
        $logContent .= 'To : ' . print_r($message->getTo(), true) . "\n";
        $logContent .= 'To : ' . /** @scrutinizer ignore-type */ print_r($message->getTo(), true) . "\n";
        $logContent .= 'Subject : ' . $subject . "\n";
        $logContent .= 'From : ' . print_r($message->getFrom(), true) . "\n";
        $logContent .= 'From : ' . /** @scrutinizer ignore-type */ print_r($message->getFrom(), true) . "\n";
        $logContent .= 'Headers:' . "\n";
        foreach ($message->getHeaders()->getAll() as $header) {
            $logContent .= '  ' . $header->getFieldName() . ': ' . $header->getFieldBody() . "\n";
        }
        if (!empty($params['recipients'])) {

            $logContent .= 'Recipients : ' . print_r($message->getTo(), true) . "\n";
        }
        $logContent .= 'Results:' . "\n";
        foreach ($results as $resultKey => $resultValue) {
            $logContent .= '  ' . $resultKey . ': ' . $resultValue . "\n";
        }
        $logContent .= '</pre>';

        $logFolder = SparkPostHelper::getLogFolder();

        // Generate filename
        $filter = new FileNameFilter();
        $title = substr($filter->filter($subject), 0, 35);
        $logName = date('Ymd_His') . '_' . $title;

        // Store attachments if any
        $attachments = $message->getChildren();
        if (!empty($attachments)) {
            $logContent .= '<hr />';
            foreach ($attachments as $attachment) {
                if ($attachment instanceof Swift_Attachment) {
                    $attachmentDestination = $logFolder . '/' . $logName . '_' . $attachment->getFilename();
                    file_put_contents($attachmentDestination, $attachment->getBody());
                    $logContent .= 'File : <a href="' . $attachmentDestination . '">' . $attachment->getFilename() . '</a><br/>';
                }
            }
        }

        // Store it
        $ext = ($contentType == 'text/html') ? 'html' : 'txt';
        $r = file_put_contents($logFolder . '/' . $logName . '.' . $ext, $logContent);

        if (!$r && Director::isDev()) {
            throw new Exception('Failed to store email in ' . $logFolder);
        }
    }

    /**
     * @return LoggerInterface
     */
    public function getLogger()
    {
        return Injector::inst()->get(LoggerInterface::class)->withName('SparkPost');
    }

    /**
     * @param Swift_Events_EventListener $plugin
     */
    public function registerPlugin(Swift_Events_EventListener $plugin)
    {
        $this->eventDispatcher->bindEventListener($plugin);
    }

    /**
     * @return array
     */
    protected function getSupportedContentTypes()
    {
        return array(
            'text/plain',
            'text/html'
        );
    }

    /**
     * @param string $contentType
     * @return bool
     */
    protected function supportsContentType($contentType)
    {
        return in_array($contentType, $this->getSupportedContentTypes());
    }

    /**
     * @param Swift_Mime_SimpleMessage $message
     * @return string
     */
    protected function getMessagePrimaryContentType(Swift_Mime_SimpleMessage $message)
    {
        $contentType = $message->getContentType();

        if ($this->supportsContentType($contentType)) {
            return $contentType;
        }

        // SwiftMailer hides the content type set in the constructor of Swift_Mime_SimpleMessage as soon
        // as you add another part to the message. We need to access the protected property
        // _userContentType to get the original type.
        $messageRef = new \ReflectionClass($message);
        if ($messageRef->hasProperty('_userContentType')) {
            $propRef = $messageRef->getProperty('_userContentType');
            $propRef->setAccessible(true);
            $contentType = $propRef->getValue($message);
        }

        return $contentType;
    }

    /**
     * @param Swift_Mime_Headers_UnstructuredHeader|null $header
     * @return string
     */
    protected static function getHeaderValue(Swift_Mime_Header $header = null)
    {
        if (!$header) {
            return '';
        }
        if (method_exists($header, 'getValue')) {
            return $header->getValue();
        }
        return $header->getFieldBody();
    }

    /**
     * Convert a Swift Message to a transmission
     *
     * @param Swift_Mime_SimpleMessage $message
     * @return array SparkPost Send Message
     * @throws \Swift_SwiftException
     */
    public function getTransmissionFromMessage(Swift_Mime_SimpleMessage $message)
    {
        $contentType = $this->getMessagePrimaryContentType($message);

        $fromAddresses = $message->getFrom();

        $fromFirstEmail = key($fromAddresses);
        $fromFirstEmail = key(/** @scrutinizer ignore-type */ $fromAddresses);
        $fromFirstName = current($fromAddresses);
        $fromFirstName = current(/** @scrutinizer ignore-type */ $fromAddresses);
        if (SparkPostHelper::config()->override_admin_email && SparkPostHelper::isAdminEmail($fromFirstEmail)) {
            $fromFirstEmail = SparkPostHelper::resolveDefaultFromEmail();
        }
        if (SparkPostHelper::getEnvForceSender()) {
            $fromFirstEmail = SparkPostHelper::getEnvForceSender();
        }
        if (!$fromFirstName) {
            $fromFirstName = EmailUtils::get_displayname_from_rfc_email($fromFirstEmail);
        }
        $this->fromEmail = $fromFirstEmail;

        $toAddresses = $message->getTo();
        $ccAddresses = $message->getCc() ? $message->getCc() : [];
        $bccAddresses = $message->getBcc() ? $message->getBcc() : [];
        $replyToAddresses = $message->getReplyTo() ? $message->getReplyTo() : [];

        $recipients = array();
        $cc = array();
        $bcc = array();
        $attachments = array();
        $headers = array();
        $tags = array();
        $metadata = array();
        $inlineCss = null;

        // Mandrill compatibility
        // Data is merge with transmission and removed from headers
        // @link https://mailchimp.com/developer/transactional/docs/tags-metadata/#tags
        if ($message->getHeaders()->has('X-MC-Tags')) {
            $tagsHeader = $message->getHeaders()->get('X-MC-Tags');
            $tags = explode(',', self::getHeaderValue($tagsHeader));
            $message->getHeaders()->remove('X-MC-Tags');
        }
        if ($message->getHeaders()->has('X-MC-Metadata')) {
            $metadataHeader = $message->getHeaders()->get('X-MC-Metadata');
            $metadata = json_decode(self::getHeaderValue($metadataHeader), JSON_OBJECT_AS_ARRAY);
            $metadata = json_decode(self::getHeaderValue($metadataHeader), /** @scrutinizer ignore-type */ JSON_OBJECT_AS_ARRAY);
            $message->getHeaders()->remove('X-MC-Metadata');
        }
        if ($message->getHeaders()->has('X-MC-InlineCSS')) {
            $inlineHeader = $message->getHeaders()->get('X-MC-InlineCSS');
            $inlineCss = self::getHeaderValue($inlineHeader);
            $message->getHeaders()->remove('X-MC-InlineCSS');
        }

        // Handle MSYS headers
        // Data is merge with transmission and removed from headers
        // @link https://developers.sparkpost.com/api/smtp-api.html
        $msysHeader = [];
        if ($message->getHeaders()->has('X-MSYS-API')) {
            $msysHeaderObj = $message->getHeaders()->get('X-MSYS-API');
            $msysHeader = json_decode(self::getHeaderValue($msysHeaderObj), JSON_OBJECT_AS_ARRAY);
            if (!empty($msysHeader['tags'])) {
                $tags = array_merge($tags, $msysHeader['tags']);
            }
            if (!empty($msysHeader['metadata'])) {
                $metadata = array_merge($metadata, $msysHeader['metadata']);
            }
            $message->getHeaders()->remove('X-MSYS-API');
        }

        // Build recipients list
        // @link https://developers.sparkpost.com/api/recipient-lists.html
        $primaryEmail = null;
        foreach ($toAddresses as $toEmail => $toName) {
            if ($primaryEmail === null) {
                $primaryEmail = $toEmail;
            }
            if (!$toName) {
                $toName = $toEmail;
            }
            $recipient = array(
                'address' => array(
                    'email' => $toEmail,
                    'name' => $toName,
                )
            );
            if (!empty($tags)) {
                $recipient['tags'] = $tags;
            }
            // TODO: metadata are not valid?
            if (!empty($metadata)) {
                $recipient['metadata'] = $metadata;
            }
            $recipients[] = $recipient;
        }

        $reply_to = null;
        foreach ($replyToAddresses as $replyToEmail => $replyToName) {
            if ($replyToName) {
                $reply_to = sprintf('%s <%s>', $replyToName, $replyToEmail);
            } else {
                $reply_to = $replyToEmail;
            }
        }

        // @link https://www.sparkpost.com/docs/faq/cc-bcc-with-rest-api/
        foreach ($ccAddresses as $ccEmail => $ccName) {
            $cc[] = array(
                'email' => $ccEmail,
                'name' => $ccName,
                'header_to' => $primaryEmail ? $primaryEmail : $ccEmail,
            );
        }

        foreach ($bccAddresses as $bccEmail => $bccName) {
            $bcc[] = array(
                'email' => $bccEmail,
                'name' => $bccName,
                'header_to' => $primaryEmail ? $primaryEmail : $ccEmail,

            );
        }

        $bodyHtml = $bodyText = null;

        if ($contentType === 'text/plain') {
            $bodyText = $message->getBody();
        } elseif ($contentType === 'text/html') {
            $bodyHtml = $message->getBody();
        } else {
            $bodyHtml = $message->getBody();
        }

        foreach ($message->getChildren() as $child) {
            if ($child instanceof Swift_Attachment) {
                $attachments[] = array(
                    'type' => $child->getContentType(),
                    'name' => $child->getFilename(),
                    'data' => base64_encode($child->getBody())
                );
            } elseif ($child instanceof Swift_MimePart && $this->supportsContentType($child->getContentType())) {
                if ($child->getContentType() == "text/html") {
                    $bodyHtml = $child->getBody();
                } elseif ($child->getContentType() == "text/plain") {
                    $bodyText = $child->getBody();
                }
            }
        }

        // If we ask to provide plain, use our custom method instead of the provided one
        if ($bodyHtml && SparkPostHelper::config()->provide_plain) {
            $bodyText = EmailUtils::convert_html_to_text($bodyHtml);
        }

        // Should we inline css
        if (!$inlineCss && SparkPostHelper::config()->inline_styles) {
            $bodyHtml = EmailUtils::inline_styles($bodyHtml);
        }

        // Custom unsubscribe list
        if ($message->getHeaders()->has('List-Unsubscribe')) {
            $unsubHeader = $message->getHeaders()->get('List-Unsubscribe');
            $headers['List-Unsubscribe'] = self::getHeaderValue($unsubHeader);
        }

        $defaultParams = SparkPostHelper::config()->default_params;
        if ($inlineCss !== null) {
            $defaultParams['inline_css'] = $inlineCss;
        }

        // Build base transmission
        $sparkPostMessage = array(
            'recipients' => $recipients,
            'content' => array(
                'from' => array(
                    'name' => $fromFirstName,
                    'email' => $fromFirstEmail,
                ),
                'subject' => $message->getSubject(),
                'html' => $bodyHtml,
                'text' => $bodyText,
            ),
        );
        if ($reply_to) {
            $sparkPostMessage['reply_to'] = $reply_to;
        }

        // Add default params
        $sparkPostMessage = array_merge($defaultParams, $sparkPostMessage);
        if ($msysHeader) {
            $sparkPostMessage = array_merge($sparkPostMessage, $msysHeader);
        }

        // Add remaining elements
        if (!empty($cc)) {
            $sparkPostMessage['headers.CC'] = $cc;
        }
        if (!empty($headers)) {
            $sparkPostMessage['customHeaders'] = $headers;
        }
        if (count($attachments) > 0) {
            $sparkPostMessage['attachments'] = $attachments;
        }

        return $sparkPostMessage;
    }

    /**
     * @return null|array
     */
    public function getResultApi()
    {
        return $this->resultApi;
    }
}

lekoala / silverstripe-sparkpost

Push — master ( 4707af...d36b17 )

SparkPostSwiftTransport::getHeaderValue() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
