TestMailer::send() - Code Metrics - Inspection of "SS3 has customHeaders before with Cc/Bcc addresses" - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 4 (#10172)

by Marco

created 2021-12-10 00:16 UTC

TestMailer::send() C

↳ Parent: TestMailer

Complexity

Conditions	11
Paths	144

Size

Total Lines	56
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	11
eloc	37
c	1
b	0
f	0
nc	144
nop	1
dl	0
loc	56
rs	6.95

How to fix Long Method Complexity

<?php

namespace SilverStripe\Dev;

use SilverStripe\Control\Email\Mailer;
use Swift_Attachment;

class TestMailer implements Mailer
{
    /**
     * @var array
     */
    protected $emailsSent = [];

    public function send($email)
    {
        // Detect body type
        $htmlContent = null;
        $plainContent = null;
        if ($email->getSwiftMessage()->getContentType() === 'text/plain') {
            $type = 'plain';
            $plainContent = $email->getBody();
        } else {
            $type = 'html';
            $htmlContent = $email->getBody();
            $plainPart = $email->findPlainPart();
            if ($plainPart) {
                $plainContent = $plainPart->getBody();
            }
        }

        // Get attachments
        $attachedFiles = [];
        foreach ($email->getSwiftMessage()->getChildren() as $child) {
            if ($child instanceof Swift_Attachment) {
                $attachedFiles[] = [
                    'contents' => $child->getBody(),
                    'filename' => $child->getFilename(),
                    'mimetype' => $child->getContentType(),
                ];
            }
        }
        
        $headers = $email->getSwiftMessage()->getHeaders();
        $cc = $headers->get('CC') ? $headers->get('CC')->getFieldBody() : '';
        $bcc = $headers->get('BCC') ? $headers->get('BCC')->getFieldBody() : '';

        // Serialise email
        $serialised = [
            'Type' => $type,
            'To' => implode(';', array_keys($email->getTo() ?: [])),
            'From' => implode(';', array_keys($email->getFrom() ?: [])),
            'Subject' => $email->getSubject(),
            'Content' => $email->getBody(),
            'AttachedFiles' => $attachedFiles,
            'Headers' => [
                'Cc' => $cc,
                'Bcc' => $bcc,
            ],
        ];
        if ($plainContent) {
            $serialised['PlainContent'] = $plainContent;
        }
        if ($htmlContent) {
            $serialised['HtmlContent'] = $htmlContent;
        }

        $this->saveEmail($serialised);

        return true;
    }

    /**
     * Save a single email to the log
     *
     * @param array $data A map of information about the email
     */
    protected function saveEmail($data)
    {
        $this->emailsSent[] = $data;
    }

    /**
     * Clear the log of emails sent
     */
    public function clearEmails()
    {
        $this->emailsSent = [];
    }

    /**
     * Search for an email that was sent.
     * All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
     *
     * @param string $to
     * @param string $from
     * @param string $subject
     * @param string $content
     * @return array|null Contains keys: 'Type', 'To', 'From', 'Subject', 'Content', 'PlainContent', 'AttachedFiles',
     *               'HtmlContent'
     */
    public function findEmail($to, $from = null, $subject = null, $content = null)
    {
        $compare = [
            'To' => $to,
            'From' => $from,
            'Subject' => $subject,
            'Content' => $content,
        ];

        foreach ($this->emailsSent as $email) {
            $matched = true;

            // Loop all our Email fields
            foreach ($compare as $field => $value) {
                $emailValue = $email[$field];
                if ($value) {
                    if (in_array($field, ['To', 'From'])) {
                        $emailValue = $this->normaliseSpaces($emailValue);
                        $value = $this->normaliseSpaces($value);
                    }
                    if ($value[0] === '/') {
                        $matched = preg_match($value, $emailValue);
                    } else {
                        $matched = ($value === $emailValue);
                    }
                    if (!$matched) {
                        break;
                    }
                }
            }

            if ($matched) {
                return $email;
            }
        }
        return null;
    }

    /**
     * @param string $value
     */
    private function normaliseSpaces(string $value)
    {
        return str_replace([', ', '; '], [',', ';'], $value);
    }
}


1			<?php
2
3			namespace SilverStripe\Dev;
4
5			use SilverStripe\Control\Email\Mailer;
6			use Swift_Attachment;
7
8			class TestMailer implements Mailer
9			{
10			/**
11			* @var array
12			*/
13			protected $emailsSent = [];
14
15			public function send($email)
16			{
17			// Detect body type
18			$htmlContent = null;
19			$plainContent = null;
20			if ($email->getSwiftMessage()->getContentType() === 'text/plain') {
21			$type = 'plain';
22			$plainContent = $email->getBody();
23			} else {
24			$type = 'html';
25			$htmlContent = $email->getBody();
26			$plainPart = $email->findPlainPart();
27			if ($plainPart) {
28			$plainContent = $plainPart->getBody();
29			}
30			}
31
32			// Get attachments
33			$attachedFiles = [];
34			foreach ($email->getSwiftMessage()->getChildren() as $child) {
35			if ($child instanceof Swift_Attachment) {
36			$attachedFiles[] = [
37			'contents' => $child->getBody(),
38			'filename' => $child->getFilename(),
39			'mimetype' => $child->getContentType(),
40			];
41			}
42			}
43
44			$headers = $email->getSwiftMessage()->getHeaders();
45			$cc = $headers->get('CC') ? $headers->get('CC')->getFieldBody() : '';
46			$bcc = $headers->get('BCC') ? $headers->get('BCC')->getFieldBody() : '';
47
48			// Serialise email
49			$serialised = [
50			'Type' => $type,
51			'To' => implode(';', array_keys($email->getTo() ?: [])),
52			'From' => implode(';', array_keys($email->getFrom() ?: [])),
53			'Subject' => $email->getSubject(),
54			'Content' => $email->getBody(),
55			'AttachedFiles' => $attachedFiles,
56			'Headers' => [
57			'Cc' => $cc,
58			'Bcc' => $bcc,
59			],
60			];
61			if ($plainContent) {
62			$serialised['PlainContent'] = $plainContent;
63			}
64			if ($htmlContent) {
65			$serialised['HtmlContent'] = $htmlContent;
66			}
67
68			$this->saveEmail($serialised);
69
70			return true;
71			}
72
73			/**
74			* Save a single email to the log
75			*
76			* @param array $data A map of information about the email
77			*/
78			protected function saveEmail($data)
79			{
80			$this->emailsSent[] = $data;
81			}
82
83			/**
84			* Clear the log of emails sent
85			*/
86			public function clearEmails()
87			{
88			$this->emailsSent = [];
89			}
90
91			/**
92			* Search for an email that was sent.
93			* All of the parameters can either be a string, or, if they start with "/", a PREG-compatible regular expression.
94			*
95			* @param string $to
96			* @param string $from
97			* @param string $subject
98			* @param string $content
99			* @return array\|null Contains keys: 'Type', 'To', 'From', 'Subject', 'Content', 'PlainContent', 'AttachedFiles',
100			* 'HtmlContent'
101			*/
102			public function findEmail($to, $from = null, $subject = null, $content = null)
103			{
104			$compare = [
105			'To' => $to,
106			'From' => $from,
107			'Subject' => $subject,
108			'Content' => $content,
109			];
110
111			foreach ($this->emailsSent as $email) {
112			$matched = true;
113
114			// Loop all our Email fields
115			foreach ($compare as $field => $value) {
116			$emailValue = $email[$field];
117			if ($value) {
118			if (in_array($field, ['To', 'From'])) {
119			$emailValue = $this->normaliseSpaces($emailValue);
120			$value = $this->normaliseSpaces($value);
121			}
122			if ($value[0] === '/') {
123			$matched = preg_match($value, $emailValue);
124			} else {
125			$matched = ($value === $emailValue);
126			}
127			if (!$matched) {
128			break;
129			}
130			}
131			}
132
133			if ($matched) {
134			return $email;
135			}
136			}
137			return null;
138			}
139
140			/**
141			* @param string $value
142			*/
143			private function normaliseSpaces(string $value)
144			{
145			return str_replace([', ', '; '], [',', ';'], $value);
146			}
147			}
148

silverstripe / silverstripe-framework

Pull Request — 4 (#10172)

TestMailer::send() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like