AmazonSES::setSignatureVersion() - Code Metrics - Inspection of "Merge pull request #40 from stevecoug/master" - omnimail/omnimail - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 071646...5588b7 )

unknown

created 2020-08-12 03:02 UTC

AmazonSES::setSignatureVersion() A

↳ Parent: AmazonSES

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	3
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

namespace Omnimail;

use Omnimail\Common\AbstractMailer;
use Omnimail\Exception\Exception;
use Psr\Log\LoggerInterface;
use SimpleEmailServiceMessage;
use SimpleEmailService;

class AmazonSES extends AbstractMailer implements MailerInterface
{
    const AWS_US_EAST_1 = 'email.us-east-1.amazonaws.com';
    const AWS_US_WEST_2 = 'email.us-west-2.amazonaws.com';
    const AWS_EU_WEST1 = 'email.eu-west-1.amazonaws.com';

    protected $accessKey;
    protected $secretKey;
    protected $host;
    protected $logger;
    protected $verifyPeer;
    protected $verifyHost;
    protected $signatureVersion;

    /**
     * @return null|string
     */
    public function getAccessKey()
    {
        return $this->accessKey;
    }

    /**
     * @param null|string $accessKey
     */
    public function setAccessKey($accessKey)
    {
        $this->accessKey = $accessKey;
    }

    /**
     * @return null|string
     */
    public function getSecretKey()
    {
        return $this->secretKey;
    }

    /**
     * @param null|string $secretKey
     */
    public function setSecretKey($secretKey)
    {
        $this->secretKey = $secretKey;
    }

    /**
     * @return string
     */
    public function getHost()
    {
        return $this->host;
    }

    /**
     * @param string $host
     */
    public function setHost($host)
    {
        $this->host = $host;
    }

    /**
     * @return null|\Psr\Log\LoggerInterface
     */
    public function getLogger()
    {
        return $this->logger;
    }

    /**
     * @param null|\Psr\Log\LoggerInterface $logger
     */
    public function setLogger($logger)
    {
        $this->logger = $logger;
    }

    /**
     * @return boolean
     */
    public function isVerifyPeer()
    {
        return $this->verifyPeer;
    }

    /**
     * @param boolean $verifyPeer
     */
    public function setVerifyPeer($verifyPeer)
    {
        $this->verifyPeer = $verifyPeer;
    }

    /**
     * @return boolean
     */
    public function isVerifyHost()
    {
        return $this->verifyHost;
    }

    /**
     * @param boolean $verifyHost
     */
    public function setVerifyHost($verifyHost)
    {
        $this->verifyHost = $verifyHost;
    }

    /**
     * @param boolean $signatureVersion
     */
    public function setSignatureVersion($signatureVersion)
    {
        $this->signatureVersion = $signatureVersion;
    }

    /**
     * @param string $accessKey
     * @param string $secretKey
     * @param string $host
     * @param bool $verifyPeer
     * @param bool $verifyHost
     * @param LoggerInterface|null $logger
     */
    public function __construct($accessKey = null, $secretKey = null, $host = self::AWS_US_EAST_1, $verifyPeer = true, $verifyHost = true, LoggerInterface $logger = null, string $signatureVersion = SimpleEmailService::REQUEST_SIGNATURE_V4)
    {
        $this->verifyPeer = $verifyPeer;
        $this->verifyHost = $verifyHost;
        $this->accessKey = $accessKey;
        $this->secretKey = $secretKey;
        $this->host = $host;
        $this->logger = $logger;
        $this->signatureVersion = $signatureVersion;
    }

    public function send(EmailInterface $email)
    {
        $m = new SimpleEmailServiceMessage();
        $m->addTo($this->mapEmails($email->getTos()));
        $m->setFrom($this->mapEmail($email->getFrom()));

        if ($email->getReplyTos()) {
            $m->addReplyTo($this->mapEmails($email->getReplyTos()));
        }

        if ($email->getCcs()) {
            $m->addCC($this->mapEmails($email->getCcs()));
        }

        if ($email->getBccs()) {
            $m->addBCC($this->mapEmails($email->getBccs()));
        }

        $m->setSubject($email->getSubject());
        $m->setMessageFromString($email->getTextBody(), $email->getHtmlBody());

        if ($email->getAttachments()) {
            foreach ($email->getAttachments() as $attachment) {
                if (!$attachment->getPath() && $attachment->getContent()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    $m->addAttachmentFromData(
                        $attachment->getName(),
                        $attachment->getContent(),
                        $attachment->getMimeType(),
                        $attachment->getContentId(),
                        $attachment->getContentId() ? 'inline' : 'attachment'
                    );
                } elseif ($attachment->getPath()) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                    $m->addAttachmentFromFile(
                        $attachment->getName(),
                        $attachment->getPath(),
                        $attachment->getMimeType(),
                        $attachment->getContentId(),
                        $attachment->getContentId() ? 'inline' : 'attachment'
                    );
                }
            }
        }

        $ses = new SimpleEmailService($this->accessKey, $this->secretKey, $this->host, false, $this->signatureVersion);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $ses->setVerifyPeer($this->verifyPeer);
        $ses->setVerifyHost($this->verifyHost);
        $response = $ses->sendEmail($m, false, false);

        if (is_object($response) && isset($response->error)) {
            $message = isset($response->error['Error']['Message']) ?
                $response->error['Error']['Message'] : $response->error['message'];

            if ($this->logger) {
                $this->logger->error("Error: ", $message);
            }
            throw new Exception("Error: ".$message, 603);
        } elseif (empty($response['MessageId'])) {
            if ($this->logger) {
                $this->logger->error("Email error: Unknown error", $email->toArray());
            }
            throw new Exception('Unknown error', 603);
        } else {
            if ($this->logger) {
                $this->logger->info("Email sent: '{$email->getSubject()}'", $email->toArray());
            }
        }
    }

    /**
     * @param array $emails
     * @return string
     */
    private function mapEmails(array $emails)
    {
        $returnValue = [];
        foreach ($emails as $email) {
            $returnValue[] = $this->mapEmail($email);
        }
        return $returnValue;
    }

    /**
     * @param array $email
     * @return string
     */
    private function mapEmail(array $email)
    {
        return !empty($email['name']) ? "'{$email['name']}' <{$email['email']}>" : $email['email'];
    }
}


1		<?php
2
3		namespace Omnimail;
4
5		use Omnimail\Common\AbstractMailer;
6		use Omnimail\Exception\Exception;
7		use Psr\Log\LoggerInterface;
8		use SimpleEmailServiceMessage;
9		use SimpleEmailService;
10
11		class AmazonSES extends AbstractMailer implements MailerInterface
12		{
13		const AWS_US_EAST_1 = 'email.us-east-1.amazonaws.com';
14		const AWS_US_WEST_2 = 'email.us-west-2.amazonaws.com';
15		const AWS_EU_WEST1 = 'email.eu-west-1.amazonaws.com';
16
17		protected $accessKey;
18		protected $secretKey;
19		protected $host;
20		protected $logger;
21		protected $verifyPeer;
22		protected $verifyHost;
23		protected $signatureVersion;
24
25		/**
26		* @return null\|string
27		*/
28		public function getAccessKey()
29		{
30		return $this->accessKey;
31		}
32
33		/**
34		* @param null\|string $accessKey
35		*/
36	1	public function setAccessKey($accessKey)
37		{
38	1	$this->accessKey = $accessKey;
39	1	}
40
41		/**
42		* @return null\|string
43		*/
44		public function getSecretKey()
45		{
46		return $this->secretKey;
47		}
48
49		/**
50		* @param null\|string $secretKey
51		*/
52	1	public function setSecretKey($secretKey)
53		{
54	1	$this->secretKey = $secretKey;
55	1	}
56
57		/**
58		* @return string
59		*/
60		public function getHost()
61		{
62		return $this->host;
63		}
64
65		/**
66		* @param string $host
67		*/
68		public function setHost($host)
69		{
70		$this->host = $host;
71		}
72
73		/**
74		* @return null\|\Psr\Log\LoggerInterface
75		*/
76		public function getLogger()
77		{
78		return $this->logger;
79		}
80
81		/**
82		* @param null\|\Psr\Log\LoggerInterface $logger
83		*/
84		public function setLogger($logger)
85		{
86		$this->logger = $logger;
87		}
88
89		/**
90		* @return boolean
91		*/
92		public function isVerifyPeer()
93		{
94		return $this->verifyPeer;
95		}
96
97		/**
98		* @param boolean $verifyPeer
99		*/
100		public function setVerifyPeer($verifyPeer)
101		{
102		$this->verifyPeer = $verifyPeer;
103		}
104
105		/**
106		* @return boolean
107		*/
108		public function isVerifyHost()
109		{
110		return $this->verifyHost;
111		}
112
113		/**
114		* @param boolean $verifyHost
115		*/
116		public function setVerifyHost($verifyHost)
117		{
118		$this->verifyHost = $verifyHost;
119		}
120
121		/**
122		* @param boolean $signatureVersion
123		*/
124		public function setSignatureVersion($signatureVersion)
125		{
126		$this->signatureVersion = $signatureVersion;
127		}
128
129		/**
130		* @param string $accessKey
131		* @param string $secretKey
132		* @param string $host
133		* @param bool $verifyPeer
134		* @param bool $verifyHost
135		* @param LoggerInterface\|null $logger
136		*/
137	1	public function __construct($accessKey = null, $secretKey = null, $host = self::AWS_US_EAST_1, $verifyPeer = true, $verifyHost = true, LoggerInterface $logger = null, string $signatureVersion = SimpleEmailService::REQUEST_SIGNATURE_V4)
138		{
139	1	$this->verifyPeer = $verifyPeer;
140	1	$this->verifyHost = $verifyHost;
141	1	$this->accessKey = $accessKey;
142	1	$this->secretKey = $secretKey;
143	1	$this->host = $host;
144	1	$this->logger = $logger;
145	1	$this->signatureVersion = $signatureVersion;
146	1	}
147
148	1	public function send(EmailInterface $email)
149		{
150	1	$m = new SimpleEmailServiceMessage();
151	1	$m->addTo($this->mapEmails($email->getTos()));
152	1	$m->setFrom($this->mapEmail($email->getFrom()));
153
154	1	if ($email->getReplyTos()) {
155		$m->addReplyTo($this->mapEmails($email->getReplyTos()));
156		}
157
158	1	if ($email->getCcs()) {
159		$m->addCC($this->mapEmails($email->getCcs()));
160		}
161
162	1	if ($email->getBccs()) {
163		$m->addBCC($this->mapEmails($email->getBccs()));
164		}
165
166	1	$m->setSubject($email->getSubject());
167	1	$m->setMessageFromString($email->getTextBody(), $email->getHtmlBody());
168
169	1	if ($email->getAttachments()) {
170		foreach ($email->getAttachments() as $attachment) {
171		if (!$attachment->getPath() && $attachment->getContent()) {
		0 ignored issues – show Bug Best Practice introduced 2016-07-12 03:39 UTC by Report Bug Copy Issue Report The expression `$attachment->getPath()` of type `string\|null` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
172		$m->addAttachmentFromData(
173		$attachment->getName(),
174		$attachment->getContent(),
175		$attachment->getMimeType(),
176		$attachment->getContentId(),
177		$attachment->getContentId() ? 'inline' : 'attachment'
178		);
179		} elseif ($attachment->getPath()) {
		0 ignored issues – show Bug Best Practice introduced 2016-07-12 03:39 UTC by Report Bug Copy Issue Report The expression `$attachment->getPath()` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
180		$m->addAttachmentFromFile(
181		$attachment->getName(),
182		$attachment->getPath(),
183		$attachment->getMimeType(),
184		$attachment->getContentId(),
185		$attachment->getContentId() ? 'inline' : 'attachment'
186		);
187		}
188		}
189		}
190
191	1	$ses = new SimpleEmailService($this->accessKey, $this->secretKey, $this->host, false, $this->signatureVersion);
		0 ignored issues – show Bug introduced 2020-08-04 17:56 UTC by Report Bug Copy Issue Report It seems like `$this->signatureVersion` can also be of type `boolean`; however, `SimpleEmailService::__construct()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
192	1	$ses->setVerifyPeer($this->verifyPeer);
193	1	$ses->setVerifyHost($this->verifyHost);
194	1	$response = $ses->sendEmail($m, false, false);
195
196	1	if (is_object($response) && isset($response->error)) {
197	1	$message = isset($response->error['Error']['Message']) ?
198	1	$response->error['Error']['Message'] : $response->error['message'];
199
200	1	if ($this->logger) {
201		$this->logger->error("Error: ", $message);
202		}
203	1	throw new Exception("Error: ".$message, 603);
204		} elseif (empty($response['MessageId'])) {
205		if ($this->logger) {
206		$this->logger->error("Email error: Unknown error", $email->toArray());
207		}
208		throw new Exception('Unknown error', 603);
209		} else {
210		if ($this->logger) {
211		$this->logger->info("Email sent: '{$email->getSubject()}'", $email->toArray());
212		}
213		}
214		}
215
216		/**
217		* @param array $emails
218		* @return string
219		*/
220	1	private function mapEmails(array $emails)
221		{
222	1	$returnValue = [];
223	1	foreach ($emails as $email) {
224	1	$returnValue[] = $this->mapEmail($email);
225		}
226	1	return $returnValue;
227		}
228
229		/**
230		* @param array $email
231		* @return string
232		*/
233	1	private function mapEmail(array $email)
234		{
235	1	return !empty($email['name']) ? "'{$email['name']}' <{$email['email']}>" : $email['email'];
236		}
237		}
238

omnimail / omnimail

Push — master ( 071646...5588b7 )

AmazonSES::setSignatureVersion() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like