Mailer::getMailInstance() - Code Metrics - Inspection of "Merge pull request #9791 from nextcloud/3rdparty/n..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8969e1...3ade34 )

by Joas

created 2018-07-06 08:39 UTC

Mailer::getMailInstance() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
declare(strict_types=1);
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Joas Schilling <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\Mail;

use Egulias\EmailValidator\EmailValidator;
use Egulias\EmailValidator\Validation\RFCValidation;
use OCP\Defaults;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\Mail\IAttachment;
use OCP\Mail\IEMailTemplate;
use OCP\Mail\IMailer;
use OCP\ILogger;
use OCP\Mail\IMessage;

/**
 * Class Mailer provides some basic functions to create a mail message that can be used in combination with
 * \OC\Mail\Message.
 *
 * Example usage:
 *
 * 	$mailer = \OC::$server->getMailer();
 * 	$message = $mailer->createMessage();
 * 	$message->setSubject('Your Subject');
 * 	$message->setFrom(array('[email protected]' => 'ownCloud Notifier');
 * 	$message->setTo(array('[email protected]' => 'Recipient');
 * 	$message->setBody('The message text');
 * 	$mailer->send($message);
 *
 * This message can then be passed to send() of \OC\Mail\Mailer
 *
 * @package OC\Mail
 */
class Mailer implements IMailer {
	/** @var \Swift_Mailer Cached mailer */
	private $instance = null;
	/** @var IConfig */
	private $config;
	/** @var ILogger */
	private $logger;
	/** @var Defaults */
	private $defaults;
	/** @var IURLGenerator */
	private $urlGenerator;
	/** @var IL10N */
	private $l10n;

	/**
	 * @param IConfig $config
	 * @param ILogger $logger
	 * @param Defaults $defaults
	 * @param IURLGenerator $urlGenerator
	 * @param IL10N $l10n
	 */
	public function __construct(IConfig $config,
						 ILogger $logger,
						 Defaults $defaults,
						 IURLGenerator $urlGenerator,
						 IL10N $l10n) {
		$this->config = $config;
		$this->logger = $logger;
		$this->defaults = $defaults;
		$this->urlGenerator = $urlGenerator;
		$this->l10n = $l10n;
	}

	/**
	 * Creates a new message object that can be passed to send()
	 *
	 * @return IMessage
	 */
	public function createMessage(): IMessage {
		$plainTextOnly = $this->config->getSystemValue('mail_send_plaintext_only', false);
		return new Message(new \Swift_Message(), $plainTextOnly);
	}

	/**
	 * @param string|null $data
	 * @param string|null $filename
	 * @param string|null $contentType
	 * @return IAttachment
	 * @since 13.0.0
	 */
	public function createAttachment($data = null, $filename = null, $contentType = null): IAttachment {
		return new Attachment(new \Swift_Attachment($data, $filename, $contentType));
	}

	/**
	 * @param string $path
	 * @param string|null $contentType
	 * @return IAttachment
	 * @since 13.0.0
	 */
	public function createAttachmentFromPath(string $path, $contentType = null): IAttachment {
		return new Attachment(\Swift_Attachment::fromPath($path, $contentType));
	}

	/**
	 * Creates a new email template object
	 *
	 * @param string $emailId
	 * @param array $data
	 * @return IEMailTemplate
	 * @since 12.0.0
	 */
	public function createEMailTemplate(string $emailId, array $data = []): IEMailTemplate {
		$class = $this->config->getSystemValue('mail_template_class', '');

		if ($class !== '' && class_exists($class) && is_a($class, EMailTemplate::class, true)) {
			return new $class(
				$this->defaults,
				$this->urlGenerator,
				$this->l10n,
				$emailId,
				$data
			);
		}

		return new EMailTemplate(
			$this->defaults,
			$this->urlGenerator,
			$this->l10n,
			$emailId,
			$data
		);
	}

	/**
	 * Send the specified message. Also sets the from address to the value defined in config.php
	 * if no-one has been passed.
	 *
	 * @param IMessage|Message $message Message to send
	 * @return string[] Array with failed recipients. Be aware that this depends on the used mail backend and
	 * therefore should be considered
	 * @throws \Exception In case it was not possible to send the message. (for example if an invalid mail address
	 * has been supplied.)
	 */
	public function send(IMessage $message): array {
		$debugMode = $this->config->getSystemValue('mail_smtpdebug', false);

		if (empty($message->getFrom())) {
			$message->setFrom([\OCP\Util::getDefaultEmailAddress($this->defaults->getName()) => $this->defaults->getName()]);
		}

		$failedRecipients = [];

		$mailer = $this->getInstance();

		// Enable logger if debug mode is enabled
		if($debugMode) {
			$mailLogger = new \Swift_Plugins_Loggers_ArrayLogger();
			$mailer->registerPlugin(new \Swift_Plugins_LoggerPlugin($mailLogger));
		}

		$mailer->send($message->getSwiftMessage(), $failedRecipients);

		// Debugging logging
		$logMessage = sprintf('Sent mail to "%s" with subject "%s"', print_r($message->getTo(), true), $message->getSubject());
		$this->logger->debug($logMessage, ['app' => 'core']);
		if($debugMode && isset($mailLogger)) {
			$this->logger->debug($mailLogger->dump(), ['app' => 'core']);
		}

		return $failedRecipients;
	}

	/**
	 * Checks if an e-mail address is valid
	 *
	 * @param string $email Email address to be validated
	 * @return bool True if the mail address is valid, false otherwise
	 */
	public function validateMailAddress(string $email): bool {
		$validator = new EmailValidator();
		$validation = new RFCValidation();

		return $validator->isValid($this->convertEmail($email), $validation);
	}

	/**
	 * SwiftMailer does currently not work with IDN domains, this function therefore converts the domains
	 *
	 * FIXME: Remove this once SwiftMailer supports IDN
	 *
	 * @param string $email
	 * @return string Converted mail address if `idn_to_ascii` exists
	 */
	protected function convertEmail(string $email): string {
		if (!function_exists('idn_to_ascii') || !defined('INTL_IDNA_VARIANT_UTS46') || strpos($email, '@') === false) {
			return $email;
		}

		list($name, $domain) = explode('@', $email, 2);
		$domain = idn_to_ascii($domain, 0,INTL_IDNA_VARIANT_UTS46);
		return $name.'@'.$domain;
	}

	protected function getInstance(): \Swift_Mailer {
		if (!is_null($this->instance)) {
			return $this->instance;
		}

		$transport = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

		switch ($this->config->getSystemValue('mail_smtpmode', 'smtp')) {
			case 'sendmail':
				$transport = $this->getSendMailInstance();
				break;
			case 'smtp':
			default:
				$transport = $this->getSmtpInstance();
				break;
		}

		return new \Swift_Mailer($transport);
	}

	/**
	 * Returns the SMTP transport
	 *
	 * @return \Swift_SmtpTransport
	 */
	protected function getSmtpInstance(): \Swift_SmtpTransport {
		$transport = new \Swift_SmtpTransport();
		$transport->setTimeout($this->config->getSystemValue('mail_smtptimeout', 10));
		$transport->setHost($this->config->getSystemValue('mail_smtphost', '127.0.0.1'));
		$transport->setPort($this->config->getSystemValue('mail_smtpport', 25));
		if ($this->config->getSystemValue('mail_smtpauth', false)) {
			$transport->setUsername($this->config->getSystemValue('mail_smtpname', ''));
			$transport->setPassword($this->config->getSystemValue('mail_smtppassword', ''));
			$transport->setAuthMode($this->config->getSystemValue('mail_smtpauthtype', 'LOGIN'));
		}
		$smtpSecurity = $this->config->getSystemValue('mail_smtpsecure', '');
		if (!empty($smtpSecurity)) {
			$transport->setEncryption($smtpSecurity);
		}

		return $transport;
	}

	/**
	 * Returns the sendmail transport
	 *
	 * @return \Swift_SendmailTransport
	 */
	protected function getSendMailInstance(): \Swift_SendmailTransport {
		switch ($this->config->getSystemValue('mail_smtpmode', 'smtp')) {
			case 'qmail':
				$binaryPath = '/var/qmail/bin/sendmail';
				break;
			default:
				$binaryPath = '/usr/sbin/sendmail';
				break;
		}

		return new \Swift_SendmailTransport($binaryPath . ' -bs');
	}
}


1			<?php
2			declare(strict_types=1);
3			/**
4			* @copyright Copyright (c) 2016, ownCloud, Inc.
5			*
6			* @author Joas Schilling <[email protected]>
7			* @author Lukas Reschke <[email protected]>
8			* @author Morris Jobke <[email protected]>
9			* @author Roeland Jago Douma <[email protected]>
10			*
11			* @license AGPL-3.0
12			*
13			* This code is free software: you can redistribute it and/or modify
14			* it under the terms of the GNU Affero General Public License, version 3,
15			* as published by the Free Software Foundation.
16			*
17			* This program is distributed in the hope that it will be useful,
18			* but WITHOUT ANY WARRANTY; without even the implied warranty of
19			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20			* GNU Affero General Public License for more details.
21			*
22			* You should have received a copy of the GNU Affero General Public License, version 3,
23			* along with this program. If not, see <http://www.gnu.org/licenses/>
24			*
25			*/
26
27			namespace OC\Mail;
28
29			use Egulias\EmailValidator\EmailValidator;
30			use Egulias\EmailValidator\Validation\RFCValidation;
31			use OCP\Defaults;
32			use OCP\IConfig;
33			use OCP\IL10N;
34			use OCP\IURLGenerator;
35			use OCP\Mail\IAttachment;
36			use OCP\Mail\IEMailTemplate;
37			use OCP\Mail\IMailer;
38			use OCP\ILogger;
39			use OCP\Mail\IMessage;
40
41			/**
42			* Class Mailer provides some basic functions to create a mail message that can be used in combination with
43			* \OC\Mail\Message.
44			*
45			* Example usage:
46			*
47			* $mailer = \OC::$server->getMailer();
48			* $message = $mailer->createMessage();
49			* $message->setSubject('Your Subject');
50			* $message->setFrom(array('[email protected]' => 'ownCloud Notifier');
51			* $message->setTo(array('[email protected]' => 'Recipient');
52			* $message->setBody('The message text');
53			* $mailer->send($message);
54			*
55			* This message can then be passed to send() of \OC\Mail\Mailer
56			*
57			* @package OC\Mail
58			*/
59			class Mailer implements IMailer {
60			/** @var \Swift_Mailer Cached mailer */
61			private $instance = null;
62			/** @var IConfig */
63			private $config;
64			/** @var ILogger */
65			private $logger;
66			/** @var Defaults */
67			private $defaults;
68			/** @var IURLGenerator */
69			private $urlGenerator;
70			/** @var IL10N */
71			private $l10n;
72
73			/**
74			* @param IConfig $config
75			* @param ILogger $logger
76			* @param Defaults $defaults
77			* @param IURLGenerator $urlGenerator
78			* @param IL10N $l10n
79			*/
80			public function __construct(IConfig $config,
81			ILogger $logger,
82			Defaults $defaults,
83			IURLGenerator $urlGenerator,
84			IL10N $l10n) {
85			$this->config = $config;
86			$this->logger = $logger;
87			$this->defaults = $defaults;
88			$this->urlGenerator = $urlGenerator;
89			$this->l10n = $l10n;
90			}
91
92			/**
93			* Creates a new message object that can be passed to send()
94			*
95			* @return IMessage
96			*/
97			public function createMessage(): IMessage {
98			$plainTextOnly = $this->config->getSystemValue('mail_send_plaintext_only', false);
99			return new Message(new \Swift_Message(), $plainTextOnly);
100			}
101
102			/**
103			* @param string\|null $data
104			* @param string\|null $filename
105			* @param string\|null $contentType
106			* @return IAttachment
107			* @since 13.0.0
108			*/
109			public function createAttachment($data = null, $filename = null, $contentType = null): IAttachment {
110			return new Attachment(new \Swift_Attachment($data, $filename, $contentType));
111			}
112
113			/**
114			* @param string $path
115			* @param string\|null $contentType
116			* @return IAttachment
117			* @since 13.0.0
118			*/
119			public function createAttachmentFromPath(string $path, $contentType = null): IAttachment {
120			return new Attachment(\Swift_Attachment::fromPath($path, $contentType));
121			}
122
123			/**
124			* Creates a new email template object
125			*
126			* @param string $emailId
127			* @param array $data
128			* @return IEMailTemplate
129			* @since 12.0.0
130			*/
131			public function createEMailTemplate(string $emailId, array $data = []): IEMailTemplate {
132			$class = $this->config->getSystemValue('mail_template_class', '');
133
134			if ($class !== '' && class_exists($class) && is_a($class, EMailTemplate::class, true)) {
135			return new $class(
136			$this->defaults,
137			$this->urlGenerator,
138			$this->l10n,
139			$emailId,
140			$data
141			);
142			}
143
144			return new EMailTemplate(
145			$this->defaults,
146			$this->urlGenerator,
147			$this->l10n,
148			$emailId,
149			$data
150			);
151			}
152
153			/**
154			* Send the specified message. Also sets the from address to the value defined in config.php
155			* if no-one has been passed.
156			*
157			* @param IMessage\|Message $message Message to send
158			* @return string[] Array with failed recipients. Be aware that this depends on the used mail backend and
159			* therefore should be considered
160			* @throws \Exception In case it was not possible to send the message. (for example if an invalid mail address
161			* has been supplied.)
162			*/
163			public function send(IMessage $message): array {
164			$debugMode = $this->config->getSystemValue('mail_smtpdebug', false);
165
166			if (empty($message->getFrom())) {
167			$message->setFrom([\OCP\Util::getDefaultEmailAddress($this->defaults->getName()) => $this->defaults->getName()]);
168			}
169
170			$failedRecipients = [];
171
172			$mailer = $this->getInstance();
173
174			// Enable logger if debug mode is enabled
175			if($debugMode) {
176			$mailLogger = new \Swift_Plugins_Loggers_ArrayLogger();
177			$mailer->registerPlugin(new \Swift_Plugins_LoggerPlugin($mailLogger));
178			}
179
180			$mailer->send($message->getSwiftMessage(), $failedRecipients);
181
182			// Debugging logging
183			$logMessage = sprintf('Sent mail to "%s" with subject "%s"', print_r($message->getTo(), true), $message->getSubject());
184			$this->logger->debug($logMessage, ['app' => 'core']);
185			if($debugMode && isset($mailLogger)) {
186			$this->logger->debug($mailLogger->dump(), ['app' => 'core']);
187			}
188
189			return $failedRecipients;
190			}
191
192			/**
193			* Checks if an e-mail address is valid
194			*
195			* @param string $email Email address to be validated
196			* @return bool True if the mail address is valid, false otherwise
197			*/
198			public function validateMailAddress(string $email): bool {
199			$validator = new EmailValidator();
200			$validation = new RFCValidation();
201
202			return $validator->isValid($this->convertEmail($email), $validation);
203			}
204
205			/**
206			* SwiftMailer does currently not work with IDN domains, this function therefore converts the domains
207			*
208			* FIXME: Remove this once SwiftMailer supports IDN
209			*
210			* @param string $email
211			* @return string Converted mail address if `idn_to_ascii` exists
212			*/
213			protected function convertEmail(string $email): string {
214			if (!function_exists('idn_to_ascii') \|\| !defined('INTL_IDNA_VARIANT_UTS46') \|\| strpos($email, '@') === false) {
215			return $email;
216			}
217
218			list($name, $domain) = explode('@', $email, 2);
219			$domain = idn_to_ascii($domain, 0,INTL_IDNA_VARIANT_UTS46);
220			return $name.'@'.$domain;
221			}
222
223			protected function getInstance(): \Swift_Mailer {
224			if (!is_null($this->instance)) {
225			return $this->instance;
226			}
227
228			$transport = null;
			0 ignored issues – show Unused Code introduced 2018-06-08 09:03 UTC by Report Bug Copy Issue Report `$transport` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
229
230			switch ($this->config->getSystemValue('mail_smtpmode', 'smtp')) {
231			case 'sendmail':
232			$transport = $this->getSendMailInstance();
233			break;
234			case 'smtp':
235			default:
236			$transport = $this->getSmtpInstance();
237			break;
238			}
239
240			return new \Swift_Mailer($transport);
241			}
242
243			/**
244			* Returns the SMTP transport
245			*
246			* @return \Swift_SmtpTransport
247			*/
248			protected function getSmtpInstance(): \Swift_SmtpTransport {
249			$transport = new \Swift_SmtpTransport();
250			$transport->setTimeout($this->config->getSystemValue('mail_smtptimeout', 10));
251			$transport->setHost($this->config->getSystemValue('mail_smtphost', '127.0.0.1'));
252			$transport->setPort($this->config->getSystemValue('mail_smtpport', 25));
253			if ($this->config->getSystemValue('mail_smtpauth', false)) {
254			$transport->setUsername($this->config->getSystemValue('mail_smtpname', ''));
255			$transport->setPassword($this->config->getSystemValue('mail_smtppassword', ''));
256			$transport->setAuthMode($this->config->getSystemValue('mail_smtpauthtype', 'LOGIN'));
257			}
258			$smtpSecurity = $this->config->getSystemValue('mail_smtpsecure', '');
259			if (!empty($smtpSecurity)) {
260			$transport->setEncryption($smtpSecurity);
261			}
262
263			return $transport;
264			}
265
266			/**
267			* Returns the sendmail transport
268			*
269			* @return \Swift_SendmailTransport
270			*/
271			protected function getSendMailInstance(): \Swift_SendmailTransport {
272			switch ($this->config->getSystemValue('mail_smtpmode', 'smtp')) {
273			case 'qmail':
274			$binaryPath = '/var/qmail/bin/sendmail';
275			break;
276			default:
277			$binaryPath = '/usr/sbin/sendmail';
278			break;
279			}
280
281			return new \Swift_SendmailTransport($binaryPath . ' -bs');
282			}
283			}
284

nextcloud / server

Push — master ( 8969e1...3ade34 )

Mailer::getMailInstance() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like