diff options
author | Lukas Reschke <lukas@owncloud.com> | 2015-02-12 13:53:27 +0100 |
---|---|---|
committer | Lukas Reschke <lukas@owncloud.com> | 2015-03-16 12:47:05 +0100 |
commit | 13486a5ada62e4355473ca01e07371c162951e84 (patch) | |
tree | c079e9c53691ca14e5e1898c40a93322d6e727f5 /lib | |
parent | 0d9f149dd93997085b85e2b174f5989a1b996263 (diff) | |
download | nextcloud-server-13486a5ada62e4355473ca01e07371c162951e84.tar.gz nextcloud-server-13486a5ada62e4355473ca01e07371c162951e84.zip |
Migrate to SwiftMail
Replaces the OC_Mail and phpmailer with SwiftMail allowing us to mock it properly.
Fixes the unit test execution on master on local machines and https://github.com/owncloud/core/issues/12014
Conflicts:
3rdparty
lib/private/server.php
lib/public/iservercontainer.php
tests/lib/mail.php
tests/settings/controller/mailsettingscontrollertest.php
Conflicts:
3rdparty
lib/private/mail.php
lib/private/server.php
lib/public/iservercontainer.php
settings/ajax/lostpassword.php
settings/application.php
Diffstat (limited to 'lib')
-rw-r--r-- | lib/private/mail.php | 153 | ||||
-rw-r--r-- | lib/private/mail/mailer.php | 154 | ||||
-rw-r--r-- | lib/private/mail/message.php | 206 | ||||
-rw-r--r-- | lib/private/mail/util.php | 45 | ||||
-rw-r--r-- | lib/private/server.php | 13 | ||||
-rw-r--r-- | lib/public/iservercontainer.php | 8 | ||||
-rw-r--r-- | lib/public/mail/imailer.php | 49 | ||||
-rw-r--r-- | lib/public/mail/util.php | 26 | ||||
-rw-r--r-- | lib/public/util.php | 27 |
9 files changed, 523 insertions, 158 deletions
diff --git a/lib/private/mail.php b/lib/private/mail.php deleted file mode 100644 index 6b7eec6e080..00000000000 --- a/lib/private/mail.php +++ /dev/null @@ -1,153 +0,0 @@ -<?php -/** - * Copyright (c) 2012 Frank Karlitschek <frank@owncloud.org> - * This file is licensed under the Affero General Public License version 3 or - * later. - * See the COPYING-README file. - */ - -/** - * OC_Mail - * - * A class to handle mail sending. - */ - -class OC_Mail { - - /** - * send an email - * - * @param string $toaddress - * @param string $toname - * @param string $subject - * @param string $mailtext - * @param string $fromaddress - * @param string $fromname - * @param integer $html - * @param string $altbody - * @param string $ccaddress - * @param string $ccname - * @param string $bcc - * @throws Exception - */ - public static function send($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname, - $html=0, $altbody='', $ccaddress='', $ccname='', $bcc='') { - - $SMTPMODE = OC_Config::getValue( 'mail_smtpmode', 'sendmail' ); - $SMTPHOST = OC_Config::getValue( 'mail_smtphost', '127.0.0.1' ); - $SMTPPORT = OC_Config::getValue( 'mail_smtpport', 25 ); - $SMTPAUTH = OC_Config::getValue( 'mail_smtpauth', false ); - $SMTPAUTHTYPE = OC_Config::getValue( 'mail_smtpauthtype', 'LOGIN' ); - $SMTPUSERNAME = OC_Config::getValue( 'mail_smtpname', '' ); - $SMTPPASSWORD = OC_Config::getValue( 'mail_smtppassword', '' ); - $SMTPDEBUG = OC_Config::getValue( 'mail_smtpdebug', false ); - $SMTPTIMEOUT = OC_Config::getValue( 'mail_smtptimeout', 10 ); - $SMTPSECURE = OC_Config::getValue( 'mail_smtpsecure', '' ); - - - $mailo = new PHPMailer(true); - if($SMTPMODE=='sendmail') { - $mailo->IsSendmail(); - }elseif($SMTPMODE=='smtp') { - $mailo->IsSMTP(); - }elseif($SMTPMODE=='qmail') { - $mailo->IsQmail(); - }else{ - $mailo->IsMail(); - } - - - $mailo->Host = $SMTPHOST; - $mailo->Port = $SMTPPORT; - $mailo->SMTPAuth = $SMTPAUTH; - $mailo->SMTPDebug = $SMTPDEBUG; - $mailo->Debugoutput = 'error_log'; - $mailo->SMTPSecure = $SMTPSECURE; - $mailo->AuthType = $SMTPAUTHTYPE; - $mailo->Username = $SMTPUSERNAME; - $mailo->Password = $SMTPPASSWORD; - $mailo->Timeout = $SMTPTIMEOUT; - - $mailo->From = $fromaddress; - $mailo->FromName = $fromname;; - $mailo->Sender = $fromaddress; - $mailo->XMailer = ' '; - try { - $toaddress = self::buildAsciiEmail($toaddress); - $mailo->AddAddress($toaddress, $toname); - - if($ccaddress != '') $mailo->AddCC($ccaddress, $ccname); - if($bcc != '') $mailo->AddBCC($bcc); - - $mailo->AddReplyTo($fromaddress, $fromname); - - $mailo->WordWrap = 78; - $mailo->IsHTML($html == 1); - - $mailo->Subject = $subject; - if($altbody == '') { - $mailo->Body = $mailtext.OC_MAIL::getfooter(); - $mailo->AltBody = ''; - }else{ - $mailo->Body = $mailtext; - $mailo->AltBody = $altbody; - } - $mailo->CharSet = 'UTF-8'; - - $mailo->Send(); - unset($mailo); - OC_Log::write('mail', - 'Mail from '.$fromname.' ('.$fromaddress.')'.' to: '.$toname.'('.$toaddress.')'.' subject: '.$subject, - OC_Log::DEBUG); - } catch (Exception $exception) { - OC_Log::write('mail', $exception->getMessage(), OC_Log::ERROR); - throw($exception); - } - } - - /** - * return the footer for a mail - * - */ - public static function getfooter() { - - $defaults = new OC_Defaults(); - - $txt="\n--\n"; - $txt.=$defaults->getName() . "\n"; - $txt.=$defaults->getSlogan() . "\n"; - - return($txt); - - } - - /** - * @param string $emailAddress a given email address to be validated - * @return bool - */ - public static function validateAddress($emailAddress) { - if (strpos($emailAddress, '@') === false) { - return false; - } - $emailAddress = self::buildAsciiEmail($emailAddress); - return PHPMailer::ValidateAddress($emailAddress); - } - - /** - * IDN domains will be properly converted to ascii domains. - * - * @param string $emailAddress - * @return string - */ - public static function buildAsciiEmail($emailAddress) { - if (!function_exists('idn_to_ascii')) { - return $emailAddress; - } - - list($name, $domain) = explode('@', $emailAddress, 2); - $domain = idn_to_ascii($domain); - - return "$name@$domain"; - } - -} diff --git a/lib/private/mail/mailer.php b/lib/private/mail/mailer.php new file mode 100644 index 00000000000..ff4b0a0ef62 --- /dev/null +++ b/lib/private/mail/mailer.php @@ -0,0 +1,154 @@ +<?php +/** + * Copyright (c) 2014 Lukas Reschke <lukas@owncloud.com> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OC\Mail; + +use OCP\IConfig; +use OCP\Mail\IMailer; + +/** + * 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('cloud@domain.org' => 'ownCloud Notifier'); + * $message->setTo(array('recipient@domain.org' => '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_SmtpTransport|\Swift_SendmailTransport|\Swift_MailTransport Cached transport */ + private $instance = null; + /** @var IConfig */ + private $config; + /** @var \OC_Defaults */ + private $defaults; + + /** + * @param IConfig $config + * @param \OC_Defaults $defaults + */ + function __construct(IConfig $config, \OC_Defaults $defaults) { + $this->config = $config; + $this->defaults = $defaults; + } + + /** + * Creates a new message object that can be passed to send() + * + * @return Message + */ + public function createMessage() { + return new Message(new \Swift_Message()); + } + + /** + * Send the specified message. Also sets the from address to the value defined in config.php + * if no-one has been passed. + * + * @param 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(Message $message) { + if (sizeof($message->getFrom()) === 0) { + $message->setFrom(array(\OCP\Util::getDefaultEmailAddress($this->defaults->getName()))); + } + + $failedRecipients = array(); + + $this->getInstance()->send($message->getSwiftMessage(), $failedRecipients); + + return $failedRecipients; + } + + /** + * Returns whatever transport is configured within the config + * + * @return \Swift_SmtpTransport|\Swift_SendmailTransport|\Swift_MailTransport + */ + protected function getInstance() { + if (!is_null($this->instance)) { + return $this->instance; + } + + switch ($this->config->getSystemValue('mail_smtpmode', 'php')) { + case 'smtp': + $this->instance = $this->getSMTPInstance(); + break; + case 'sendmail': + $this->instance = $this->getSendMailInstance(); + break; + default: + $this->instance = $this->getMailInstance(); + break; + } + + return $this->instance; + } + + /** + * Returns the SMTP transport + * + * @return \Swift_SmtpTransport + */ + protected function getSmtpInstance() { + $transport = \Swift_SmtpTransport::newInstance(); + $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() { + switch ($this->config->getSystemValue('mail_smtpmode', 'sendmail')) { + case 'qmail': + $binaryPath = '/var/qmail/bin/sendmail'; + break; + default: + $binaryPath = '/usr/sbin/sendmail'; + break; + } + + return \Swift_SendmailTransport::newInstance($binaryPath . ' -bs'); + } + + /** + * Returns the mail transport + * + * @return \Swift_MailTransport + */ + protected function getMailInstance() { + return \Swift_MailTransport::newInstance(); + } + +} diff --git a/lib/private/mail/message.php b/lib/private/mail/message.php new file mode 100644 index 00000000000..60700196c5f --- /dev/null +++ b/lib/private/mail/message.php @@ -0,0 +1,206 @@ +<?php +/** + * Copyright (c) 2014 Lukas Reschke <lukas@owncloud.com> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OC\Mail; + +use Swift_Message; + +/** + * Class Message provides a wrapper around SwiftMail + * + * @package OC\Mail + */ +class Message { + /** @var Swift_Message */ + private $swiftMessage; + + /** + * @param Swift_Message $swiftMessage + */ + function __construct(Swift_Message $swiftMessage) { + $this->swiftMessage = $swiftMessage; + } + + /** + * SwiftMailer does currently not work with IDN domains, this function therefore converts the domains + * FIXME: Remove this once SwiftMailer supports IDN + * + * @param array $addresses Array of mail addresses, key will get converted + * @return array Converted addresses if `idn_to_ascii` exists + */ + protected function convertAddresses($addresses) { + if (!function_exists('idn_to_ascii')) { + return $addresses; + } + + $convertedAddresses = array(); + + foreach($addresses as $email => $readableName) { + if(!is_numeric($email)) { + list($name, $domain) = explode('@', $email, 2); + $domain = idn_to_ascii($domain); + $convertedAddresses[$name.'@'.$domain] = $readableName; + } else { + list($name, $domain) = explode('@', $readableName, 2); + $domain = idn_to_ascii($domain); + $convertedAddresses[$email] = $name.'@'.$domain; + } + } + + return $convertedAddresses; + } + + /** + * Set the from address of this message. + * + * If no "From" address is used \OC\Mail\Mailer will use mail_from_address and mail_domain from config.php + * + * @param array $addresses Example: array('sender@domain.org', 'other@domain.org' => 'A name') + * @return $this + */ + public function setFrom(array $addresses) { + $addresses = $this->convertAddresses($addresses); + + $this->swiftMessage->setFrom($addresses); + return $this; + } + + /** + * Get the from address of this message. + * + * @return array + */ + public function getFrom() { + return $this->swiftMessage->getFrom(); + } + + /** + * Set the to addresses of this message. + * + * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name') + * @return $this + */ + public function setTo(array $recipients) { + $recipients = $this->convertAddresses($recipients); + + $this->swiftMessage->setTo($recipients); + return $this; + } + + /** + * Get the to address of this message. + * + * @return array + */ + public function getTo() { + return $this->swiftMessage->getTo(); + } + + /** + * Set the CC recipients of this message. + * + * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name') + * @return $this + */ + public function setCc(array $recipients) { + $recipients = $this->convertAddresses($recipients); + + $this->swiftMessage->setCc($recipients); + return $this; + } + + /** + * Get the cc address of this message. + * + * @return array + */ + public function getCc() { + return $this->swiftMessage->getCc(); + } + + /** + * Set the BCC recipients of this message. + * + * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name') + * @return $this + */ + public function setBcc(array $recipients) { + $recipients = $this->convertAddresses($recipients); + + $this->swiftMessage->setBcc($recipients); + return $this; + } + + /** + * Get the Bcc address of this message. + * + * @return array + */ + public function getBcc() { + return $this->swiftMessage->getBcc(); + } + + /** + * Set the subject of this message. + * + * @param $subject + * @return $this + */ + public function setSubject($subject) { + $this->swiftMessage->setSubject($subject); + return $this; + } + + /** + * Get the from subject of this message. + * + * @return string + */ + public function getSubject() { + return $this->swiftMessage->getSubject(); + } + + /** + * Set the plain-text body of this message. + * + * @param string $body + * @return $this + */ + public function setPlainBody($body) { + $this->swiftMessage->setBody($body); + return $this; + } + + /** + * Get the plain body of this message. + * + * @return string + */ + public function getPlainBody() { + return $this->swiftMessage->getBody(); + } + + /** + * Set the HTML body of this message. Consider also sending a plain-text body instead of only an HTML one. + * + * @param string $body + * @return $this + */ + public function setHtmlBody($body) { + $this->swiftMessage->addPart($body, 'text/html'); + return $this; + } + + /** + * Get's the underlying SwiftMessage + * @return Swift_Message + */ + public function getSwiftMessage() { + return $this->swiftMessage; + } +} diff --git a/lib/private/mail/util.php b/lib/private/mail/util.php new file mode 100644 index 00000000000..b301e79d492 --- /dev/null +++ b/lib/private/mail/util.php @@ -0,0 +1,45 @@ +<?php +/** + * Copyright (c) 2014-2015 Lukas Reschke <lukas@owncloud.com> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OC\Mail; + +/** + * Class Util + * + * @package OC\Mail + */ +class Util { + /** + * 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 static function validateMailAddress($email) { + return \Swift_Validate::email(self::convertEmail($email)); + } + + /** + * 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 static function convertEmail($email) { + if (!function_exists('idn_to_ascii') || strpos($email, '@') === false) { + return $email; + } + + list($name, $domain) = explode('@', $email, 2); + $domain = idn_to_ascii($domain); + return $name.'@'.$domain; + } + +} diff --git a/lib/private/server.php b/lib/private/server.php index 896abf04a40..a3682dea6b3 100644 --- a/lib/private/server.php +++ b/lib/private/server.php @@ -11,6 +11,7 @@ use OC\Command\AsyncBus; use OC\Diagnostics\NullQueryLogger; use OC\Diagnostics\EventLogger; use OC\Diagnostics\QueryLogger; +use OC\Mail\Mailer; use OC\Security\CertificateManager; use OC\Files\Node\Root; use OC\Files\View; @@ -312,6 +313,9 @@ class Server extends SimpleContainer implements IServerContainer { $stream ); }); + $this->registerService('Mailer', function(Server $c) { + return new Mailer($c->getConfig(), new \OC_Defaults()); + }); } /** @@ -713,6 +717,15 @@ class Server extends SimpleContainer implements IServerContainer { } /** + * Creates a new mailer + * + * @return \OCP\Mail\IMailer + */ + function getMailer() { + return $this->query('Mailer'); + } + + /** * Get the webroot * * @return string diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php index ec23cc52345..20345e61212 100644 --- a/lib/public/iservercontainer.php +++ b/lib/public/iservercontainer.php @@ -318,9 +318,15 @@ interface IServerContainer { * @return \bantu\IniGetWrapper\IniGetWrapper */ function getIniWrapper(); - /** * @return \OCP\Command\IBus */ function getCommandBus(); + + /** + * Creates a new mailer + * + * @return \OCP\Mail\IMailer + */ + function getMailer(); } diff --git a/lib/public/mail/imailer.php b/lib/public/mail/imailer.php new file mode 100644 index 00000000000..2a20ead612b --- /dev/null +++ b/lib/public/mail/imailer.php @@ -0,0 +1,49 @@ +<?php +/** + * Copyright (c) 2014 Lukas Reschke <lukas@owncloud.com> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OCP\Mail; +use OC\Mail\Message; + +/** + * Class IMailer 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('cloud@domain.org' => 'ownCloud Notifier'); + * $message->setTo(array('recipient@domain.org' => 'Recipient'); + * $message->setBody('The message text'); + * $mailer->send($message); + * + * This message can then be passed to send() of \OC\Mail\Mailer + * + * @package OCP\Mail + */ +interface IMailer { + /** + * Creates a new message object that can be passed to send() + * + * @return Message + */ + public function createMessage(); + + /** + * Send the specified message. Also sets the from address to the value defined in config.php + * if no-one has been passed. + * + * @param 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(Message $message); +} diff --git a/lib/public/mail/util.php b/lib/public/mail/util.php new file mode 100644 index 00000000000..ea59649e620 --- /dev/null +++ b/lib/public/mail/util.php @@ -0,0 +1,26 @@ +<?php +/** + * Copyright (c) 2014 Lukas Reschke <lukas@owncloud.com> + * This file is licensed under the Affero General Public License version 3 or + * later. + * See the COPYING-README file. + */ + +namespace OCP\Mail; + +/** + * Class Util provides some helpers for mail addresses + * + * @package OCP\Mail + */ +class Util { + /** + * 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 static function validateMailAddress($email) { + return \OC\Mail\Util::validateMailAddress($email); + } +} diff --git a/lib/public/util.php b/lib/public/util.php index aa6cd5ba012..71ab8cabce5 100644 --- a/lib/public/util.php +++ b/lib/public/util.php @@ -63,12 +63,31 @@ class Util { * @param string $ccaddress * @param string $ccname * @param string $bcc + * @deprecated Use \OCP\Mail\IMailer instead */ public static function sendMail( $toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname, $html = 0, $altbody = '', $ccaddress = '', $ccname = '', $bcc = '') { - // call the internal mail class - \OC_MAIL::send($toaddress, $toname, $subject, $mailtext, $fromaddress, $fromname, - $html, $altbody, $ccaddress, $ccname, $bcc); + $mailer = \OC::$server->getMailer(); + $message = $mailer->createMessage(); + $message->setTo(array($toaddress => $toname)); + $message->setSubject($subject); + $message->setPlainBody($mailtext); + $message->setFrom(array($fromaddress => $fromname)); + if($html === 1) { + $message->setHTMLBody($altbody); + } + if(!empty($ccaddress)) { + if(!empty($ccname)) { + $message->setCc(array($ccaddress => $ccname)); + } else { + $message->setCc(array($ccaddress)); + } + } + if(!empty($bcc)) { + $message->setBcc(array($bcc)); + } + + $mailer->send($message); } /** @@ -275,7 +294,7 @@ class Util { $host_name = \OC_Config::getValue('mail_domain', $host_name); $defaultEmailAddress = $user_part.'@'.$host_name; - if (\OC_Mail::validateAddress($defaultEmailAddress)) { + if (\OCP\Mail\Util::validateMailAddress($defaultEmailAddress)) { return $defaultEmailAddress; } |