Swift_Transport_MailTransport::mail() - Code Metrics - Inspection of "bug #723 fixed php mail extra params on missing re..." - voku/swiftmailer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 5.x ( 8a5fdf...e05590 )

by Lars

created 2016-02-10 16:58 UTC

Swift_Transport_MailTransport::mail() A

↳ Parent: Swift_Transport_MailTransport

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Metric	Value
dl	0
loc	8
ccs	0
cts	4
cp	0
rs	9.4285
cc	2
eloc	4
nc	2
nop	5
crap	6

<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2004-2009 Chris Corbyn
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * Sends Messages using the mail() function.
 *
 * It is advised that users do not use this transport if at all possible
 * since a number of plugin features cannot be used in conjunction with this
 * transport due to the internal interface in PHP itself.
 *
 * The level of error reporting with this transport is incredibly weak, again
 * due to limitations of PHP's internal mail() function.  You'll get an
 * all-or-nothing result from sending.
 *
 * @author Chris Corbyn
 */
class Swift_Transport_MailTransport implements Swift_Transport
namespace YourVendor;

class YourClass { }
{
    /** Additional parameters to pass to mail() */
    private $_extraParams = '-f%s';

    /** The event dispatcher from the plugin API */
    private $_eventDispatcher;

    /**
     * Create a new MailTransport with the $log.
     *
     * @param Swift_Events_EventDispatcher $eventDispatcher
     */
    public function __construct(Swift_Events_EventDispatcher $eventDispatcher)
    {
        $this->_eventDispatcher = $eventDispatcher;
    }

    /**
     * Not used.
     */
    public function isStarted()
    {
        return false;
    }

    /**
     * Not used.
     */
    public function start()
    {
    }

    /**
     * Not used.
     */
    public function stop()
    {
    }

    /**
     * Set the additional parameters used on the mail() function.
     *
     * This string is formatted for sprintf() where %s is the sender address.
     *
     * @param string $params
     *
     * @return Swift_Transport_MailTransport
     */
    public function setExtraParams($params)
    {
        $this->_extraParams = $params;

        return $this;
    }

    /**
     * Get the additional parameters used on the mail() function.
     *
     * This string is formatted for sprintf() where %s is the sender address.
     *
     * @return string
     */
    public function getExtraParams()
    {
        return $this->_extraParams;
    }

    /**
     * Send the given Message.
     *
     * Recipient/sender data will be retrieved from the Message API.
     * The return value is the number of recipients who were accepted for delivery.
     *
     * @param Swift_Mime_Message $message
     * @param string[]           $failedRecipients An array of failures by-reference
     *
     * @return int
     *
     * @throws Swift_TransportException
     */
    public function send(Swift_Mime_Message $message, &$failedRecipients = null)
    {
        $failedRecipients = (array)$failedRecipients;

        $evt = $this->_eventDispatcher->createSendEvent($this, $message);
        if ($evt) {

            $this->_eventDispatcher->dispatchEvent($evt, 'beforeSendPerformed');
            if ($evt->bubbleCancelled()) {
                return 0;
            }
        }

        $count = (
            count((array)$message->getTo())
            + count((array)$message->getCc())
            + count((array)$message->getBcc())
        );

        /*

        // TODO: check if we need this check, breaks "Mockery"-Tests
        if ($count == 0) {
            $this->_throwException(new Swift_TransportException('Cannot send message without a recipient'));
        }
        */

        $toHeader = $message->getHeaders()->get('To');
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $subjectHeader = $message->getHeaders()->get('Subject');

        if (!$toHeader) {
            $this->_throwException(new Swift_TransportException('Cannot send message without a recipient'));
        }

        $to = $toHeader->getFieldBody();
        $subject = $subjectHeader ? $subjectHeader->getFieldBody() : '';

        $reversePath = $this->_getReversePath($message);

        // Remove headers that would otherwise be duplicated
        $message->getHeaders()->remove('To');
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $message->getHeaders()->remove('Subject');

        $messageStr = $message->toString();

        $message->getHeaders()->set($toHeader);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $message->getHeaders()->set($subjectHeader);

        // Separate headers from body
        if (false !== $endHeaders = strpos($messageStr, "\r\n\r\n")) {
            $headers = substr($messageStr, 0, $endHeaders) . "\r\n"; // Keep last EOL
            $body = substr($messageStr, $endHeaders + 4);
        } else {
            $headers = $messageStr . "\r\n";
            $body = '';
        }

        unset($messageStr);

        if ("\r\n" != PHP_EOL) {
            // Non-windows (not using SMTP)
            $headers = str_replace("\r\n", PHP_EOL, $headers);
            $subject = str_replace("\r\n", PHP_EOL, $subject);
            $body = str_replace("\r\n", PHP_EOL, $body);
        } else {
            // Windows, using SMTP
            $headers = str_replace("\r\n.", "\r\n..", $headers);
            $subject = str_replace("\r\n.", "\r\n..", $subject);
            $body = str_replace("\r\n.", "\r\n..", $body);
        }

        if ($this->mail($to, $subject, $body, $headers, $this->_formatExtraParams($this->_extraParams, $reversePath))) {
            if ($evt) {
                $evt->setResult(Swift_Events_SendEvent::RESULT_SUCCESS);
                $evt->setFailedRecipients($failedRecipients);
                $this->_eventDispatcher->dispatchEvent($evt, 'sendPerformed');
            }
        } else {
            $failedRecipients = array_merge(
                $failedRecipients,
                array_keys((array)$message->getTo()),
                array_keys((array)$message->getCc()),
                array_keys((array)$message->getBcc())
            );

            if ($evt) {
                $evt->setResult(Swift_Events_SendEvent::RESULT_FAILED);
                $evt->setFailedRecipients($failedRecipients);
                $this->_eventDispatcher->dispatchEvent($evt, 'sendPerformed');
            }

            // TODO: Why do we do this only on error?
            // -> take a look at "AbstractSmtpTransport"
            //
            $message->generateId(); // Make sure a new Message ID is used

            $count = 0;
        }

        return $count;
    }

    /**
     * Register a plugin.
     *
     * @param Swift_Events_EventListener $plugin
     */
    public function registerPlugin(Swift_Events_EventListener $plugin)
    {
        $this->_eventDispatcher->bindEventListener($plugin);
    }

    /**
     * Throw a TransportException, first sending it to any listeners
     *
     * @param Swift_TransportException $e
     *
     * @throws Swift_TransportException
     */
    protected function _throwException(Swift_TransportException $e)

    {
        $evt = $this->_eventDispatcher->createTransportExceptionEvent($this, $e);
        if ($evt) {

            $this->_eventDispatcher->dispatchEvent($evt, 'exceptionThrown');
            if (!$evt->bubbleCancelled()) {
                throw $e;
            }

        } else {
            throw $e;
        }
    }

    /**
     * Send mail via the mail() function.
     *
     * This method takes the same arguments as PHP mail().
     *
     * @param string $to
     * @param string $subject
     * @param string $body
     * @param string $headers
     * @param string $extraParams
     *
     * @return bool
     */
    public function mail($to, $subject, $body, $headers = null, $extraParams = null)
    {
        if (!ini_get('safe_mode')) {
            return @mail($to, $subject, $body, $headers, $extraParams);
        }

        return @mail($to, $subject, $body, $headers);
    }

    /**
     * Determine the best-use reverse path for this message
     *
     * @param Swift_Mime_Message $message
     *
     * @return mixed|null|string
     */
    private function _getReversePath(Swift_Mime_Message $message)

    {
        $return = $message->getReturnPath();
        $sender = $message->getSender();
        $from = $message->getFrom();
        $path = null;
        if (!empty($return)) {
            $path = $return;
        } elseif (!empty($sender)) {
            $keys = array_keys($sender);
            $path = array_shift($keys);
        } elseif (!empty($from)) {
            $keys = array_keys($from);
            $path = array_shift($keys);
        }

        return $path;
    }

    /**
     * Return php mail extra params to use for invoker->mail.
     *
     * @param $extraParams
     * @param $reversePath
     *
     * @return mixed <string|null>
     */
    private function _formatExtraParams($extraParams, $reversePath)
    {
        if (strpos($extraParams, '-f%s') !== false) {
            $extraParams = empty($reversePath)
                ? str_replace('-f%s', '', $extraParams)
                : sprintf($extraParams, escapeshellarg($reversePath));
        }

        return !empty($extraParams) ? $extraParams : null;
    }
}


Push — 5.x ( 8a5fdf...e05590 )

Swift_Transport_MailTransport::mail() A

Complexity

Size

Duplication

Code Coverage

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/*
4			* This file is part of SwiftMailer.
5			* (c) 2004-2009 Chris Corbyn
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			/**
12			* Sends Messages using the mail() function.
13			*
14			* It is advised that users do not use this transport if at all possible
15			* since a number of plugin features cannot be used in conjunction with this
16			* transport due to the internal interface in PHP itself.
17			*
18			* The level of error reporting with this transport is incredibly weak, again
19			* due to limitations of PHP's internal mail() function. You'll get an
20			* all-or-nothing result from sending.
21			*
22			* @author Chris Corbyn
23			*/
24			class Swift_Transport_MailTransport implements Swift_Transport
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
25			{
26			/** Additional parameters to pass to mail() */
27			private $_extraParams = '-f%s';
28
29			/** The event dispatcher from the plugin API */
30			private $_eventDispatcher;
31
32			/**
33			* Create a new MailTransport with the $log.
34			*
35			* @param Swift_Events_EventDispatcher $eventDispatcher
36			*/
37	16		public function __construct(Swift_Events_EventDispatcher $eventDispatcher)
38			{
39	16		$this->_eventDispatcher = $eventDispatcher;
40	16		}
41
42			/**
43			* Not used.
44			*/
45			public function isStarted()
46			{
47			return false;
48			}
49
50			/**
51			* Not used.
52			*/
53			public function start()
54			{
55			}
56
57			/**
58			* Not used.
59			*/
60			public function stop()
61			{
62			}
63
64			/**
65			* Set the additional parameters used on the mail() function.
66			*
67			* This string is formatted for sprintf() where %s is the sender address.
68			*
69			* @param string $params
70			*
71			* @return Swift_Transport_MailTransport
72			*/
73	2		public function setExtraParams($params)
74			{
75	2		$this->_extraParams = $params;
76
77	2		return $this;
78			}
79
80			/**
81			* Get the additional parameters used on the mail() function.
82			*
83			* This string is formatted for sprintf() where %s is the sender address.
84			*
85			* @return string
86			*/
87			public function getExtraParams()
88			{
89			return $this->_extraParams;
90			}
91
92			/**
93			* Send the given Message.
94			*
95			* Recipient/sender data will be retrieved from the Message API.
96			* The return value is the number of recipients who were accepted for delivery.
97			*
98			* @param Swift_Mime_Message $message
99			* @param string[] $failedRecipients An array of failures by-reference
100			*
101			* @return int
102			*
103			* @throws Swift_TransportException
104			*/
105	15		public function send(Swift_Mime_Message $message, &$failedRecipients = null)
106			{
107	15		$failedRecipients = (array)$failedRecipients;
108
109	15		$evt = $this->_eventDispatcher->createSendEvent($this, $message);
110	15		if ($evt) {
111
112			$this->_eventDispatcher->dispatchEvent($evt, 'beforeSendPerformed');
113			if ($evt->bubbleCancelled()) {
114			return 0;
115			}
116			}
117
118			$count = (
119	15		count((array)$message->getTo())
120	15		+ count((array)$message->getCc())
121	15		+ count((array)$message->getBcc())
122			);
123
124			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-10 17:04 UTC by Report Bug Copy Issue Report `41%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
125			// TODO: check if we need this check, breaks "Mockery"-Tests
126			if ($count == 0) {
127			$this->_throwException(new Swift_TransportException('Cannot send message without a recipient'));
128			}
129			*/
130
131	15		$toHeader = $message->getHeaders()->get('To');
			0 ignored issues – show Bug introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report The method `get` does only exist in `Swift_Mime_HeaderSet`, but not in `Swift_Mime_Header`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
132	15		$subjectHeader = $message->getHeaders()->get('Subject');
133
134	15		if (!$toHeader) {
135			$this->_throwException(new Swift_TransportException('Cannot send message without a recipient'));
136			}
137
138	15		$to = $toHeader->getFieldBody();
139	15		$subject = $subjectHeader ? $subjectHeader->getFieldBody() : '';
140
141	15		$reversePath = $this->_getReversePath($message);
142
143			// Remove headers that would otherwise be duplicated
144	15		$message->getHeaders()->remove('To');
			0 ignored issues – show Bug introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report The method `remove` does only exist in `Swift_Mime_HeaderSet`, but not in `Swift_Mime_Header`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
145	15		$message->getHeaders()->remove('Subject');
146
147	15		$messageStr = $message->toString();
148
149	15		$message->getHeaders()->set($toHeader);
			0 ignored issues – show Bug introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report The method `set` does only exist in `Swift_Mime_HeaderSet`, but not in `Swift_Mime_Header`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
150	15		$message->getHeaders()->set($subjectHeader);
151
152			// Separate headers from body
153	15		if (false !== $endHeaders = strpos($messageStr, "\r\n\r\n")) {
154	3		$headers = substr($messageStr, 0, $endHeaders) . "\r\n"; // Keep last EOL
155	3		$body = substr($messageStr, $endHeaders + 4);
156			} else {
157	12		$headers = $messageStr . "\r\n";
158	12		$body = '';
159			}
160
161	15		unset($messageStr);
162
163	15		if ("\r\n" != PHP_EOL) {
164			// Non-windows (not using SMTP)
165	15		$headers = str_replace("\r\n", PHP_EOL, $headers);
166	15		$subject = str_replace("\r\n", PHP_EOL, $subject);
167	15		$body = str_replace("\r\n", PHP_EOL, $body);
168			} else {
169			// Windows, using SMTP
170			$headers = str_replace("\r\n.", "\r\n..", $headers);
171			$subject = str_replace("\r\n.", "\r\n..", $subject);
172			$body = str_replace("\r\n.", "\r\n..", $body);
173			}
174
175	15		if ($this->mail($to, $subject, $body, $headers, $this->_formatExtraParams($this->_extraParams, $reversePath))) {
176	1		if ($evt) {
177			$evt->setResult(Swift_Events_SendEvent::RESULT_SUCCESS);
178			$evt->setFailedRecipients($failedRecipients);
179	1		$this->_eventDispatcher->dispatchEvent($evt, 'sendPerformed');
180			}
181			} else {
182	14		$failedRecipients = array_merge(
183			$failedRecipients,
184	14		array_keys((array)$message->getTo()),
185	14		array_keys((array)$message->getCc()),
186	14		array_keys((array)$message->getBcc())
187			);
188
189	14		if ($evt) {
190			$evt->setResult(Swift_Events_SendEvent::RESULT_FAILED);
191			$evt->setFailedRecipients($failedRecipients);
192			$this->_eventDispatcher->dispatchEvent($evt, 'sendPerformed');
193			}
194
195			// TODO: Why do we do this only on error?
196			// -> take a look at "AbstractSmtpTransport"
197			//
198	14		$message->generateId(); // Make sure a new Message ID is used
199
200	14		$count = 0;
201			}
202
203	15		return $count;
204			}
205
206			/**
207			* Register a plugin.
208			*
209			* @param Swift_Events_EventListener $plugin
210			*/
211			public function registerPlugin(Swift_Events_EventListener $plugin)
212			{
213			$this->_eventDispatcher->bindEventListener($plugin);
214			}
215
216			/**
217			* Throw a TransportException, first sending it to any listeners
218			*
219			* @param Swift_TransportException $e
220			*
221			* @throws Swift_TransportException
222			*/
223		View Code Duplication	protected function _throwException(Swift_TransportException $e)
			0 ignored issues – show Duplication introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
224			{
225			$evt = $this->_eventDispatcher->createTransportExceptionEvent($this, $e);
226			if ($evt) {
227
228			$this->_eventDispatcher->dispatchEvent($evt, 'exceptionThrown');
229			if (!$evt->bubbleCancelled()) {
230			throw $e;
231			}
232
233			} else {
234			throw $e;
235			}
236			}
237
238			/**
239			* Send mail via the mail() function.
240			*
241			* This method takes the same arguments as PHP mail().
242			*
243			* @param string $to
244			* @param string $subject
245			* @param string $body
246			* @param string $headers
247			* @param string $extraParams
248			*
249			* @return bool
250			*/
251			public function mail($to, $subject, $body, $headers = null, $extraParams = null)
252			{
253			if (!ini_get('safe_mode')) {
254			return @mail($to, $subject, $body, $headers, $extraParams);
255			}
256
257			return @mail($to, $subject, $body, $headers);
258			}
259
260			/**
261			* Determine the best-use reverse path for this message
262			*
263			* @param Swift_Mime_Message $message
264			*
265			* @return mixed\|null\|string
266			*/
267	15	View Code Duplication	private function _getReversePath(Swift_Mime_Message $message)
			0 ignored issues – show Duplication introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
268			{
269	15		$return = $message->getReturnPath();
270	15		$sender = $message->getSender();
271	15		$from = $message->getFrom();
272	15		$path = null;
273	15		if (!empty($return)) {
274	3		$path = $return;
275	12		} elseif (!empty($sender)) {
276			$keys = array_keys($sender);
277			$path = array_shift($keys);
278	12		} elseif (!empty($from)) {
279			$keys = array_keys($from);
280			$path = array_shift($keys);
281			}
282
283	15		return $path;
284			}
285
286			/**
287			* Return php mail extra params to use for invoker->mail.
288			*
289			* @param $extraParams
290			* @param $reversePath
291			*
292			* @return mixed <string\|null>
293			*/
294	15		private function _formatExtraParams($extraParams, $reversePath)
295			{
296	15		if (strpos($extraParams, '-f%s') !== false) {
297	14		$extraParams = empty($reversePath)
298	12		? str_replace('-f%s', '', $extraParams)
299	14		: sprintf($extraParams, escapeshellarg($reversePath));
300			}
301
302	15		return !empty($extraParams) ? $extraParams : null;
303			}
304			}
305

voku / swiftmailer

Push — 5.x ( 8a5fdf...e05590 )

Swift_Transport_MailTransport::mail() A

Complexity

Size

Duplication

Code Coverage

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like