Mailer::prepareAttachments() - Code Metrics - Inspection of "Initial commit" - kinglozzer/silverstripe-mailgunner - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1ff499...32025a )

by Loz

created 2016-02-27 19:51 UTC

Mailer::prepareAttachments() A

↳ Parent: Mailer

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	15
rs	9.4285
cc	2
eloc	8
nc	2
nop	1

<?php

namespace Kinglozzer\SilverStripeMailgunner;

use Mailer as SilverstripeMailer;
use Mailgun\Mailgun;
use Mailgun\Messages\MessageBuilder;

class Mailer extends SilverstripeMailer
{
    /**
     * @var string
     * @config
     */
    private static $api_domain = '';

    /**
     * @var string
     * @config
     */
    private static $api_endpoint = 'api.mailgun.net';

    /**
     * @var string
     * @config
     */
    private static $api_key = '';

    /**
     * @var boolean
     * @config
     */
    private static $api_ssl = true;

    /**
     * @var string
     * @config
     */
    private static $api_version = 'v3';

    /**
     * An array of temporary file handles opened to store attachments
     * @var array
     */
    protected $tempFileHandles = [];

    /**
     * @var Mailgun\Mailgun
     */
    protected $mailgunClient;

    /**
     * {@inheritdoc}
     */
    public function __construct()
    {
        $config = $this->config();
        $this->setMailgunClient(new Mailgun(
            $config->api_key,
            $config->api_endpoint,
            $config->api_version,
            $config->api_ssl
        ));
    }

    /**
     * @param Mailgun\Mailgun $client

     * @return self
     */
    public function setMailgunClient(Mailgun $client)
    {
        $this->mailgunClient = $client;

        return $this;
    }

    /**
     * @return Mailgun\Mailgun
     */
    public function getMailgunClient()
    {
        return $this->mailgunClient;
    }

    /**
     * {@inheritdoc}
     */
    public function sendPlain($to, $from, $subject, $plainContent, $attachments = [], $headers = [])
    {
        $this->sendMessage($to, $from, $subject, $htmlContent = '', $plainContent, $attachments, $headers);
    }

    /**
     * {@inheritdoc}
     */
    public function sendHTML($to, $from, $subject, $htmlContent, $attachments = [], $headers = [], $plainContent = '')
    {
        $this->sendMessage($to, $from, $subject, $htmlContent, $plainContent, $attachments, $headers);
    }

    /**
     * @param string $to
     * @param string $from
     * @param string $subject
     * @param string $content
     * @param string $plainContent
     * @param array $attachments
     * @param array $headers
     */
    protected function sendMessage($to, $from, $subject, $content, $plainContent, $attachments, $headers)
    {
        $client = $this->getMailgunClient();
        $messageBuilder = $client->MessageBuilder();

        $this->buildMessage($messageBuilder, $to, $from, $subject, $content, $plainContent, $headers);

        if (!empty($attachments)) {
            $attachments = $this->prepareAttachments($attachments);
        }

        try {
            $client->sendMessage($this->config()->api_domain, $messageBuilder->getMessage(), $attachments);
        } catch (\Exception $e) {
            // Close and remove any temp files created for attachments, then let the exception bubble up
            $this->closeTempFileHandles();
            throw $e;
        }

        $this->closeTempFileHandles();
    }

    /**
     * @param Mailgun\Messages\MessageBuilder $messageBuilder
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $to
     * @param string $from
     * @param string $subject
     * @param string $content
     * @param string $plainContent
     * @param array $attachments
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param array $headers
     */
    protected function buildMessage(MessageBuilder $builder, $to, $from, $subject, $content, $plainContent, $headers)
    {
        // Add base info
        $builder->addToRecipient($to);
        $builder->setFromAddress($from);
        $builder->setSubject($subject);

        // HTML content (if not empty)
        if ($content) {
            $builder->setHtmlBody($content);
        }

        // Plain text content (if not empty)
        if ($plainContent) {
            $builder->setTextBody($plainContent);
        }

        // Parse Cc & Bcc headers out if they're set
        if (isset($headers['Cc'])) {
            foreach (explode(', ', $headers['Cc']) as $ccAddress) {
                $builder->addCcRecipient($ccAddress);
            }
            unset($headers['Cc']);
        }

        if (isset($headers['Bcc'])) {
            foreach (explode(', ', $headers['Bcc']) as $bccAddress) {
                $builder->addBccRecipient($bccAddress);
            }
            unset($headers['Bcc']);
        }

        // Add remaining custom headers
        foreach ($headers as $name => $data) {
            $builder->addCustomHeader($name, $data);
        }
    }

    /**
     * Prepare attachments for sending. SilverStripe extracts the content and
     * passes that to the mailer, so to save encoding it we just write them all
     * to individual files and let Mailgun deal with the rest.
     * 
     * @todo Can we handle this better?
     * @param array $attachments
     * @return array
     */
    protected function prepareAttachments(array $attachments)
    {
        $prepared = [];
            
        foreach ($attachments as $attachment) {
            $tempFile = $this->writeToTempFile($attachment['contents']);
            
            $prepared[] = [
                'filePath' => $tempFile,
                'remoteName' => $attachment['filename']
            ];
        }

       return ['attachment' => $prepared];
    }

    /**
     * @param string $contents
     * @return string
     */
    protected function writeToTempFile($contents)
    {
        $tempFile = tempnam(sys_get_temp_dir(), 'SS_MG_TMP');
        $fileHandle = fopen($tempFile, 'r+');
        fwrite($fileHandle, $contents);

        $this->tempFileHandles[] = [
            'handle' => $fileHandle,
            'path' => $tempFile
        ];

        return $tempFile;
    }

    /**
     * @return void
     */
    protected function closeTempFileHandles()
    {
        foreach ($this->tempFileHandles as $key => $data) {
            fclose($data['handle']);
            unlink($data['path']);
            unset($this->tempFileHandles[$key]);
        }
    }
}


1			<?php
2
3			namespace Kinglozzer\SilverStripeMailgunner;
4
5			use Mailer as SilverstripeMailer;
6			use Mailgun\Mailgun;
7			use Mailgun\Messages\MessageBuilder;
8
9			class Mailer extends SilverstripeMailer
10			{
11			/**
12			* @var string
13			* @config
14			*/
15			private static $api_domain = '';
16
17			/**
18			* @var string
19			* @config
20			*/
21			private static $api_endpoint = 'api.mailgun.net';
22
23			/**
24			* @var string
25			* @config
26			*/
27			private static $api_key = '';
28
29			/**
30			* @var boolean
31			* @config
32			*/
33			private static $api_ssl = true;
34
35			/**
36			* @var string
37			* @config
38			*/
39			private static $api_version = 'v3';
40
41			/**
42			* An array of temporary file handles opened to store attachments
43			* @var array
44			*/
45			protected $tempFileHandles = [];
46
47			/**
48			* @var Mailgun\Mailgun
49			*/
50			protected $mailgunClient;
51
52			/**
53			* {@inheritdoc}
54			*/
55			public function __construct()
56			{
57			$config = $this->config();
58			$this->setMailgunClient(new Mailgun(
59			$config->api_key,
60			$config->api_endpoint,
61			$config->api_version,
62			$config->api_ssl
63			));
64			}
65
66			/**
67			* @param Mailgun\Mailgun $client
			0 ignored issues – show Documentation introduced 2016-02-27 19:56 UTC by Report Bug Copy Issue Report Should the type for parameter `$client` not be `Mailgun`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
68			* @return self
69			*/
70			public function setMailgunClient(Mailgun $client)
71			{
72			$this->mailgunClient = $client;
			0 ignored issues – show Documentation Bug introduced 2016-02-27 19:56 UTC by Report Bug Copy Issue Report It seems like `$client` of type `object<Mailgun\Mailgun>` is incompatible with the declared type `object<Mailgun\Mailgun\Mailgun>` of property `$mailgunClient`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
73			return $this;
74			}
75
76			/**
77			* @return Mailgun\Mailgun
78			*/
79			public function getMailgunClient()
80			{
81			return $this->mailgunClient;
82			}
83
84			/**
85			* {@inheritdoc}
86			*/
87			public function sendPlain($to, $from, $subject, $plainContent, $attachments = [], $headers = [])
88			{
89			$this->sendMessage($to, $from, $subject, $htmlContent = '', $plainContent, $attachments, $headers);
90			}
91
92			/**
93			* {@inheritdoc}
94			*/
95			public function sendHTML($to, $from, $subject, $htmlContent, $attachments = [], $headers = [], $plainContent = '')
96			{
97			$this->sendMessage($to, $from, $subject, $htmlContent, $plainContent, $attachments, $headers);
98			}
99
100			/**
101			* @param string $to
102			* @param string $from
103			* @param string $subject
104			* @param string $content
105			* @param string $plainContent
106			* @param array $attachments
107			* @param array $headers
108			*/
109			protected function sendMessage($to, $from, $subject, $content, $plainContent, $attachments, $headers)
110			{
111			$client = $this->getMailgunClient();
112			$messageBuilder = $client->MessageBuilder();
113
114			$this->buildMessage($messageBuilder, $to, $from, $subject, $content, $plainContent, $headers);
115
116			if (!empty($attachments)) {
117			$attachments = $this->prepareAttachments($attachments);
118			}
119
120			try {
121			$client->sendMessage($this->config()->api_domain, $messageBuilder->getMessage(), $attachments);
122			} catch (\Exception $e) {
123			// Close and remove any temp files created for attachments, then let the exception bubble up
124			$this->closeTempFileHandles();
125			throw $e;
126			}
127
128			$this->closeTempFileHandles();
129			}
130
131			/**
132			* @param Mailgun\Messages\MessageBuilder $messageBuilder
			0 ignored issues – show Documentation introduced 2016-02-27 19:56 UTC by Report Bug Copy Issue Report There is no parameter named `$messageBuilder`. Did you maybe mean `$builder`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
133			* @param string $to
134			* @param string $from
135			* @param string $subject
136			* @param string $content
137			* @param string $plainContent
138			* @param array $attachments
			0 ignored issues – show Bug introduced 2016-02-27 19:56 UTC by Report Bug Copy Issue Report There is no parameter named `$attachments`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
139			* @param array $headers
140			*/
141			protected function buildMessage(MessageBuilder $builder, $to, $from, $subject, $content, $plainContent, $headers)
142			{
143			// Add base info
144			$builder->addToRecipient($to);
145			$builder->setFromAddress($from);
146			$builder->setSubject($subject);
147
148			// HTML content (if not empty)
149			if ($content) {
150			$builder->setHtmlBody($content);
151			}
152
153			// Plain text content (if not empty)
154			if ($plainContent) {
155			$builder->setTextBody($plainContent);
156			}
157
158			// Parse Cc & Bcc headers out if they're set
159			if (isset($headers['Cc'])) {
160			foreach (explode(', ', $headers['Cc']) as $ccAddress) {
161			$builder->addCcRecipient($ccAddress);
162			}
163			unset($headers['Cc']);
164			}
165
166			if (isset($headers['Bcc'])) {
167			foreach (explode(', ', $headers['Bcc']) as $bccAddress) {
168			$builder->addBccRecipient($bccAddress);
169			}
170			unset($headers['Bcc']);
171			}
172
173			// Add remaining custom headers
174			foreach ($headers as $name => $data) {
175			$builder->addCustomHeader($name, $data);
176			}
177			}
178
179			/**
180			* Prepare attachments for sending. SilverStripe extracts the content and
181			* passes that to the mailer, so to save encoding it we just write them all
182			* to individual files and let Mailgun deal with the rest.
183			*
184			* @todo Can we handle this better?
185			* @param array $attachments
186			* @return array
187			*/
188			protected function prepareAttachments(array $attachments)
189			{
190			$prepared = [];
191
192			foreach ($attachments as $attachment) {
193			$tempFile = $this->writeToTempFile($attachment['contents']);
194
195			$prepared[] = [
196			'filePath' => $tempFile,
197			'remoteName' => $attachment['filename']
198			];
199			}
200
201			return ['attachment' => $prepared];
202			}
203
204			/**
205			* @param string $contents
206			* @return string
207			*/
208			protected function writeToTempFile($contents)
209			{
210			$tempFile = tempnam(sys_get_temp_dir(), 'SS_MG_TMP');
211			$fileHandle = fopen($tempFile, 'r+');
212			fwrite($fileHandle, $contents);
213
214			$this->tempFileHandles[] = [
215			'handle' => $fileHandle,
216			'path' => $tempFile
217			];
218
219			return $tempFile;
220			}
221
222			/**
223			* @return void
224			*/
225			protected function closeTempFileHandles()
226			{
227			foreach ($this->tempFileHandles as $key => $data) {
228			fclose($data['handle']);
229			unlink($data['path']);
230			unset($this->tempFileHandles[$key]);
231			}
232			}
233			}
234

kinglozzer / silverstripe-mailgunner

Push — master ( 1ff499...32025a )

Mailer::prepareAttachments() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like