From eb3b2f45bcc2464b0e6fc8fcc9d782f110c92ed9 Mon Sep 17 00:00:00 2001 From: Qiang Xue Date: Thu, 28 Nov 2013 09:46:20 -0500 Subject: [PATCH] refactored EmailTarget with the new mailer interfaces. --- framework/yii/BaseYii.php | 2 ++ framework/yii/log/EmailTarget.php | 70 ++++++++++++++++++++++----------------- framework/yii/log/Target.php | 2 +- 3 files changed, 43 insertions(+), 31 deletions(-) diff --git a/framework/yii/BaseYii.php b/framework/yii/BaseYii.php index ee49c8e..e56d410 100644 --- a/framework/yii/BaseYii.php +++ b/framework/yii/BaseYii.php @@ -519,12 +519,14 @@ class BaseYii * Configures an object with the initial property values. * @param object $object the object to be configured * @param array $properties the property initial values given in terms of name-value pairs. + * @return object the object itself */ public static function configure($object, $properties) { foreach ($properties as $name => $value) { $object->$name = $value; } + return $object; } /** diff --git a/framework/yii/log/EmailTarget.php b/framework/yii/log/EmailTarget.php index 8ca3d97..69019e3 100644 --- a/framework/yii/log/EmailTarget.php +++ b/framework/yii/log/EmailTarget.php @@ -7,6 +7,10 @@ namespace yii\log; +use Yii; +use yii\base\InvalidConfigException; +use yii\mail\MailerInterface; + /** * EmailTarget sends selected log messages to the specified email addresses. * @@ -20,51 +24,57 @@ namespace yii\log; class EmailTarget extends Target { /** - * @var array list of destination email addresses. - */ - public $emails = []; - /** - * @var string email subject + * @var array the configuration array for creating a [[\yii\mail\MessageInterface|message]] object. + * Note that the "to" option must be set, which specifies the destination email address(es). */ - public $subject; + public $message = []; /** - * @var string email sent-from address + * @var MailerInterface|string the mailer object or the application component ID of the mailer object. + * After the EmailTarget object is created, if you want to change this property, you should only assign it + * with a mailer object. */ - public $sentFrom; + public $mail = 'mail'; + /** - * @var array list of additional headers to use when sending an email. + * @inheritdoc */ - public $headers = []; + public function init() + { + parent::init(); + if (empty($this->message['to'])) { + throw new InvalidConfigException('The "to" option must be set for EmailTarget::message.'); + } + if (empty($this->message['subject'])) { + $this->message['subject'] = Yii::t('yii', 'Application Log'); + } + if (is_string($this->mail)) { + $this->mail = Yii::$app->getComponent($this->mail); + } + if (!$this->mail instanceof MailerInterface) { + throw new InvalidConfigException("EmailTarget::mailer must be either a mailer object or the application component ID of a mailer object."); + } + } /** * Sends log messages to specified email addresses. */ public function export() { - $body = ''; - foreach ($this->messages as $message) { - $body .= $this->formatMessage($message); - } - $body = wordwrap($body, 70); - $subject = $this->subject === null ? \Yii::t('yii', 'Application Log') : $this->subject; - foreach ($this->emails as $email) { - $this->sendEmail($subject, $body, $email, $this->sentFrom, $this->headers); - } + $message = $this->mail->compose(); + Yii::configure($message, $this->message); + $this->composeMessage($message); + $this->mail->send($message); } /** - * Sends an email. - * @param string $subject email subject - * @param string $body email body - * @param string $sentTo sent-to email address - * @param string $sentFrom sent-from email address - * @param array $headers additional headers to be used when sending the email + * Composes the given mail message with body content. + * The default implementation fills the text body of the message with the log messages. + * @param \yii\mail\MessageInterface $message */ - protected function sendEmail($subject, $body, $sentTo, $sentFrom, $headers) + protected function composeMessage($message) { - if ($sentFrom !== null) { - $headers[] = "From: {$sentFrom}"; - } - mail($sentTo, $subject, $body, implode("\r\n", $headers)); + $messages = array_map([$this, 'formatMessage'], $this->messages); + $body = wordwrap(implode("\n", $messages), 70); + $message->setTextBody($body); } } diff --git a/framework/yii/log/Target.php b/framework/yii/log/Target.php index c9d5d97..d5d8e5b 100644 --- a/framework/yii/log/Target.php +++ b/framework/yii/log/Target.php @@ -233,6 +233,6 @@ abstract class Target extends Component $text = var_export($text, true); } $ip = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : '127.0.0.1'; - return date('Y/m/d H:i:s', $timestamp) . " [$ip] [$level] [$category] $text\n"; + return date('Y/m/d H:i:s', $timestamp) . " [$ip] [$level] [$category] $text"; } }