interface/modules/zend_modules/library/Zend/Log/Writer/Mail.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Log\Writer;
  11
  12 use Traversable;
  13 use Zend\Log\Exception;
  14 use Zend\Log\Formatter\Simple as SimpleFormatter;
  15 use Zend\Mail\Message as MailMessage;
  16 use Zend\Mail\Transport;
  17 use Zend\Mail\Transport\Exception as TransportException;
  18
  19 /**
  20  * Class used for writing log messages to email via Zend\Mail.
  21  *
  22  * Allows for emailing log messages at and above a certain level via a
  23  * Zend\Mail\Message object.  Note that this class only sends the email upon
  24  * completion, so any log entries accumulated are sent in a single email.
  25  * The email is sent using a Zend\Mail\Transport\TransportInterface object
  26  * (Sendmail is default).
  27  */
  28 class Mail extends AbstractWriter
  29 {
  30     /**
  31      * Array of formatted events to include in message body.
  32      *
  33      * @var array
  34      */
  35     protected $eventsToMail = array();
  36
  37     /**
  38      * Mail message instance to use
  39      *
  40      * @var MailMessage
  41      */
  42     protected $mail;
  43
  44     /**
  45      * Mail transport instance to use; optional.
  46      *
  47      * @var Transport\TransportInterface
  48      */
  49     protected $transport;
  50
  51     /**
  52      * Array keeping track of the number of entries per priority level.
  53      *
  54      * @var array
  55      */
  56     protected $numEntriesPerPriority = array();
  57
  58     /**
  59      * Subject prepend text.
  60      *
  61      * Can only be used of the Zend\Mail object has not already had its
  62      * subject line set.  Using this will cause the subject to have the entry
  63      * counts per-priority level appended to it.
  64      *
  65      * @var string|null
  66      */
  67     protected $subjectPrependText;
  68
  69     /**
  70      * Constructor
  71      *
  72      * @param  MailMessage|array|Traversable $mail
  73      * @param  Transport\TransportInterface $transport Optional
  74      * @throws Exception\InvalidArgumentException
  75      */
  76     public function __construct($mail, Transport\TransportInterface $transport = null)
  77     {
  78         if ($mail instanceof Traversable) {
  79             $mail = iterator_to_array($mail);
  80         }
  81
  82         if (is_array($mail)) {
  83             parent::__construct($mail);
  84             if (isset($mail['subject_prepend_text'])) {
  85                 $this->setSubjectPrependText($mail['subject_prepend_text']);
  86             }
  87             $transport = isset($mail['transport']) ? $mail['transport'] : null;
  88             $mail      = isset($mail['mail']) ? $mail['mail'] : null;
  89         }
  90
  91         // Ensure we have a valid mail message
  92         if (!$mail instanceof MailMessage) {
  93             throw new Exception\InvalidArgumentException(sprintf(
  94                 'Mail parameter of type %s is invalid; must be of type Zend\Mail\Message',
  95                 (is_object($mail) ? get_class($mail) : gettype($mail))
  96             ));
  97         }
  98         $this->mail = $mail;
  99
 100         // Ensure we have a valid mail transport
 101         if (null === $transport) {
 102             $transport = new Transport\Sendmail();
 103         }
 104         if (!$transport instanceof Transport\TransportInterface) {
 105             throw new Exception\InvalidArgumentException(sprintf(
 106                 'Transport parameter of type %s is invalid; must be of type Zend\Mail\Transport\TransportInterface',
 107                 (is_object($transport) ? get_class($transport) : gettype($transport))
 108             ));
 109         }
 110         $this->setTransport($transport);
 111
 112         if ($this->formatter === null) {
 113             $this->formatter = new SimpleFormatter();
 114         }
 115     }
 116
 117     /**
 118      * Set the transport message
 119      *
 120      * @param  Transport\TransportInterface $transport
 121      * @return Mail
 122      */
 123     public function setTransport(Transport\TransportInterface $transport)
 124     {
 125         $this->transport = $transport;
 126         return $this;
 127     }
 128
 129     /**
 130      * Places event line into array of lines to be used as message body.
 131      *
 132      * @param array $event Event data
 133      */
 134     protected function doWrite(array $event)
 135     {
 136         // Track the number of entries per priority level.
 137         if (!isset($this->numEntriesPerPriority[$event['priorityName']])) {
 138             $this->numEntriesPerPriority[$event['priorityName']] = 1;
 139         } else {
 140             $this->numEntriesPerPriority[$event['priorityName']]++;
 141         }
 142
 143         // All plaintext events are to use the standard formatter.
 144         $this->eventsToMail[] = $this->formatter->format($event);
 145     }
 146
 147     /**
 148      * Allows caller to have the mail subject dynamically set to contain the
 149      * entry counts per-priority level.
 150      *
 151      * Sets the text for use in the subject, with entry counts per-priority
 152      * level appended to the end.  Since a Zend\Mail\Message subject can only be set
 153      * once, this method cannot be used if the Zend\Mail\Message object already has a
 154      * subject set.
 155      *
 156      * @param  string $subject Subject prepend text
 157      * @return Mail
 158      */
 159     public function setSubjectPrependText($subject)
 160     {
 161         $this->subjectPrependText = (string) $subject;
 162         return $this;
 163     }
 164
 165     /**
 166      * Sends mail to recipient(s) if log entries are present.  Note that both
 167      * plaintext and HTML portions of email are handled here.
 168      */
 169     public function shutdown()
 170     {
 171         // If there are events to mail, use them as message body.  Otherwise,
 172         // there is no mail to be sent.
 173         if (empty($this->eventsToMail)) {
 174             return;
 175         }
 176
 177         if ($this->subjectPrependText !== null) {
 178             // Tack on the summary of entries per-priority to the subject
 179             // line and set it on the Zend\Mail object.
 180             $numEntries = $this->getFormattedNumEntriesPerPriority();
 181             $this->mail->setSubject("{$this->subjectPrependText} ({$numEntries})");
 182         }
 183
 184         // Always provide events to mail as plaintext.
 185         $this->mail->setBody(implode(PHP_EOL, $this->eventsToMail));
 186
 187         // Finally, send the mail.  If an exception occurs, convert it into a
 188         // warning-level message so we can avoid an exception thrown without a
 189         // stack frame.
 190         try {
 191             $this->transport->send($this->mail);
 192         } catch (TransportException\ExceptionInterface $e) {
 193             trigger_error(
 194                 "unable to send log entries via email; " .
 195                     "message = {$e->getMessage()}; " .
 196                     "code = {$e->getCode()}; " .
 197                         "exception class = " . get_class($e),
 198                 E_USER_WARNING);
 199         }
 200     }
 201
 202     /**
 203      * Gets a string of number of entries per-priority level that occurred, or
 204      * an empty string if none occurred.
 205      *
 206      * @return string
 207      */
 208     protected function getFormattedNumEntriesPerPriority()
 209     {
 210         $strings = array();
 211
 212         foreach ($this->numEntriesPerPriority as $priority => $numEntries) {
 213             $strings[] = "{$priority}={$numEntries}";
 214         }
 215
 216         return implode(', ', $strings);
 217     }
 218 }