library/Zend/Log/Writer/Mail.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Log
  17  * @subpackage Writer
  18  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  * @version    $Id$
  21  */
  22
  23 /** Zend_Log_Writer_Abstract */
  24 require_once 'Zend/Log/Writer/Abstract.php';
  25
  26 /** Zend_Log_Exception */
  27 require_once 'Zend/Log/Exception.php';
  28
  29 /** Zend_Log_Formatter_Simple*/
  30 require_once 'Zend/Log/Formatter/Simple.php';
  31
  32 /**
  33  * Class used for writing log messages to email via Zend_Mail.
  34  *
  35  * Allows for emailing log messages at and above a certain level via a
  36  * Zend_Mail object.  Note that this class only sends the email upon
  37  * completion, so any log entries accumulated are sent in a single email.
  38  *
  39  * @category   Zend
  40  * @package    Zend_Log
  41  * @subpackage Writer
  42  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  43  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  44  * @version    $Id$
  45  */
  46 class Zend_Log_Writer_Mail extends Zend_Log_Writer_Abstract
  47 {
  48     /**
  49      * Array of formatted events to include in message body.
  50      *
  51      * @var array
  52      */
  53     protected $_eventsToMail = array();
  54
  55     /**
  56      * Array of formatted lines for use in an HTML email body; these events
  57      * are formatted with an optional formatter if the caller is using
  58      * Zend_Layout.
  59      *
  60      * @var array
  61      */
  62     protected $_layoutEventsToMail = array();
  63
  64     /**
  65      * Zend_Mail instance to use
  66      *
  67      * @var Zend_Mail
  68      */
  69     protected $_mail;
  70
  71     /**
  72      * Zend_Layout instance to use; optional.
  73      *
  74      * @var Zend_Layout
  75      */
  76     protected $_layout;
  77
  78     /**
  79      * Optional formatter for use when rendering with Zend_Layout.
  80      *
  81      * @var Zend_Log_Formatter_Interface
  82      */
  83     protected $_layoutFormatter;
  84
  85     /**
  86      * Array keeping track of the number of entries per priority level.
  87      *
  88      * @var array
  89      */
  90     protected $_numEntriesPerPriority = array();
  91
  92     /**
  93      * Subject prepend text.
  94      *
  95      * Can only be used of the Zend_Mail object has not already had its
  96      * subject line set.  Using this will cause the subject to have the entry
  97      * counts per-priority level appended to it.
  98      *
  99      * @var string|null
 100      */
 101     protected $_subjectPrependText;
 102
 103     /**
 104      * Class constructor.
 105      *
 106      * Constructs the mail writer; requires a Zend_Mail instance, and takes an
 107      * optional Zend_Layout instance.  If Zend_Layout is being used,
 108      * $this->_layout->events will be set for use in the layout template.
 109      *
 110      * @param  Zend_Mail $mail Mail instance
 111      * @param  Zend_Layout $layout Layout instance; optional
 112      * @return void
 113      */
 114     public function __construct(Zend_Mail $mail, Zend_Layout $layout = null)
 115     {
 116         $this->_mail      = $mail;
 117         $this->_layout    = $layout;
 118         $this->_formatter = new Zend_Log_Formatter_Simple();
 119     }
 120
 121     /**
 122      * Create a new instance of Zend_Log_Writer_Mail
 123      *
 124      * @param  array|Zend_Config $config
 125      * @return Zend_Log_Writer_Mail
 126      * @throws Zend_Log_Exception
 127      */
 128     static public function factory($config)
 129     {
 130         throw new Zend_Exception('Zend_Log_Writer_Mail does not currently implement a factory');
 131     }
 132
 133     /**
 134      * Places event line into array of lines to be used as message body.
 135      *
 136      * Handles the formatting of both plaintext entries, as well as those
 137      * rendered with Zend_Layout.
 138      *
 139      * @param  array $event Event data
 140      * @return void
 141      */
 142     protected function _write($event)
 143     {
 144         // Track the number of entries per priority level.
 145         if (!isset($this->_numEntriesPerPriority[$event['priorityName']])) {
 146             $this->_numEntriesPerPriority[$event['priorityName']] = 1;
 147         } else {
 148             $this->_numEntriesPerPriority[$event['priorityName']]++;
 149         }
 150
 151         $formattedEvent = $this->_formatter->format($event);
 152
 153         // All plaintext events are to use the standard formatter.
 154         $this->_eventsToMail[] = $formattedEvent;
 155
 156         // If we have a Zend_Layout instance, use a specific formatter for the
 157         // layout if one exists.  Otherwise, just use the event with its
 158         // default format.
 159         if ($this->_layout) {
 160             if ($this->_layoutFormatter) {
 161                 $this->_layoutEventsToMail[] =
 162                     $this->_layoutFormatter->format($event);
 163             } else {
 164                 $this->_layoutEventsToMail[] = $formattedEvent;
 165             }
 166         }
 167     }
 168
 169     /**
 170      * Gets instance of Zend_Log_Formatter_Instance used for formatting a
 171      * message using Zend_Layout, if applicable.
 172      *
 173      * @return Zend_Log_Formatter_Interface|null The formatter, or null.
 174      */
 175     public function getLayoutFormatter()
 176     {
 177         return $this->_layoutFormatter;
 178     }
 179
 180     /**
 181      * Sets a specific formatter for use with Zend_Layout events.
 182      *
 183      * Allows use of a second formatter on lines that will be rendered with
 184      * Zend_Layout.  In the event that Zend_Layout is not being used, this
 185      * formatter cannot be set, so an exception will be thrown.
 186      *
 187      * @param  Zend_Log_Formatter_Interface $formatter
 188      * @return Zend_Log_Writer_Mail
 189      * @throws Zend_Log_Exception
 190      */
 191     public function setLayoutFormatter(Zend_Log_Formatter_Interface $formatter)
 192     {
 193         if (!$this->_layout) {
 194             throw new Zend_Log_Exception(
 195                 'cannot set formatter for layout; ' .
 196                     'a Zend_Layout instance is not in use');
 197         }
 198
 199         $this->_layoutFormatter = $formatter;
 200         return $this;
 201     }
 202
 203     /**
 204      * Allows caller to have the mail subject dynamically set to contain the
 205      * entry counts per-priority level.
 206      *
 207      * Sets the text for use in the subject, with entry counts per-priority
 208      * level appended to the end.  Since a Zend_Mail subject can only be set
 209      * once, this method cannot be used if the Zend_Mail object already has a
 210      * subject set.
 211      *
 212      * @param  string $subject Subject prepend text.
 213      * @return Zend_Log_Writer_Mail
 214      */
 215     public function setSubjectPrependText($subject)
 216     {
 217         if ($this->_mail->getSubject()) {
 218             throw new Zend_Log_Exception(
 219                 'subject already set on mail; ' .
 220                     'cannot set subject prepend text');
 221         }
 222
 223         $this->_subjectPrependText = (string) $subject;
 224         return $this;
 225     }
 226
 227     /**
 228      * Sends mail to recipient(s) if log entries are present.  Note that both
 229      * plaintext and HTML portions of email are handled here.
 230      *
 231      * @return void
 232      */
 233     public function shutdown()
 234     {
 235         // If there are events to mail, use them as message body.  Otherwise,
 236         // there is no mail to be sent.
 237         if (empty($this->_eventsToMail)) {
 238             return;
 239         }
 240
 241         if ($this->_subjectPrependText !== null) {
 242             // Tack on the summary of entries per-priority to the subject
 243             // line and set it on the Zend_Mail object.
 244             $numEntries = $this->_getFormattedNumEntriesPerPriority();
 245             $this->_mail->setSubject(
 246                 "{$this->_subjectPrependText} ({$numEntries})");
 247         }
 248
 249
 250         // Always provide events to mail as plaintext.
 251         $this->_mail->setBodyText(implode('', $this->_eventsToMail));
 252
 253         // If a Zend_Layout instance is being used, set its "events"
 254         // value to the lines formatted for use with the layout.
 255         if ($this->_layout) {
 256             // Set the required "messages" value for the layout.  Here we
 257             // are assuming that the layout is for use with HTML.
 258             $this->_layout->events =
 259                 implode('', $this->_layoutEventsToMail);
 260
 261             // If an exception occurs during rendering, convert it to a notice
 262             // so we can avoid an exception thrown without a stack frame.
 263             try {
 264                 $this->_mail->setBodyHtml($this->_layout->render());
 265             } catch (Exception $e) {
 266                 trigger_error(
 267                     "exception occurred when rendering layout; " .
 268                         "unable to set html body for message; " .
 269                         "message = {$e->getMessage()}; " .
 270                         "code = {$e->getCode()}; " .
 271                         "exception class = " . get_class($e),
 272                     E_USER_NOTICE);
 273             }
 274         }
 275
 276         // Finally, send the mail.  If an exception occurs, convert it into a
 277         // warning-level message so we can avoid an exception thrown without a
 278         // stack frame.
 279         try {
 280             $this->_mail->send();
 281         } catch (Exception $e) {
 282             trigger_error(
 283                 "unable to send log entries via email; " .
 284                     "message = {$e->getMessage()}; " .
 285                     "code = {$e->getCode()}; " .
 286                         "exception class = " . get_class($e),
 287                 E_USER_WARNING);
 288         }
 289     }
 290
 291     /**
 292      * Gets a string of number of entries per-priority level that occurred, or
 293      * an emptry string if none occurred.
 294      *
 295      * @return string
 296      */
 297     protected function _getFormattedNumEntriesPerPriority()
 298     {
 299         $strings = array();
 300
 301         foreach ($this->_numEntriesPerPriority as $priority => $numEntries) {
 302             $strings[] = "{$priority}={$numEntries}";
 303         }
 304
 305         return implode(', ', $strings);
 306     }
 307 }