library/Zend/Log/Writer/Syslog.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 /**
  27  * Writes log messages to syslog
  28  *
  29  * @category   Zend
  30  * @package    Zend_Log
  31  * @subpackage Writer
  32  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  33  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  34  */
  35 class Zend_Log_Writer_Syslog extends Zend_Log_Writer_Abstract
  36 {
  37     /**
  38      * Maps Zend_Log priorities to PHP's syslog priorities
  39      * @var array
  40      */
  41     protected $_priorities = array(
  42         Zend_Log::EMERG  => LOG_EMERG,
  43         Zend_Log::ALERT  => LOG_ALERT,
  44         Zend_Log::CRIT   => LOG_CRIT,
  45         Zend_Log::ERR    => LOG_ERR,
  46         Zend_Log::WARN   => LOG_WARNING,
  47         Zend_Log::NOTICE => LOG_NOTICE,
  48         Zend_Log::INFO   => LOG_INFO,
  49         Zend_Log::DEBUG  => LOG_DEBUG,
  50     );
  51
  52     /**
  53      * The default log priority - for unmapped custom priorities
  54      * @var string
  55      */
  56     protected $_defaultPriority = LOG_NOTICE;
  57
  58     /**
  59      * Last application name set by a syslog-writer instance
  60      * @var string
  61      */
  62     protected static $_lastApplication;
  63
  64     /**
  65      * Last facility name set by a syslog-writer instance
  66      * @var string
  67      */
  68     protected static $_lastFacility;
  69
  70     /**
  71      * Application name used by this syslog-writer instance
  72      * @var string
  73      */
  74     protected $_application = 'Zend_Log';
  75
  76     /**
  77      * Facility used by this syslog-writer instance
  78      * @var int
  79      */
  80     protected $_facility = LOG_USER;
  81
  82     /**
  83      * _validFacilities
  84      *
  85      * @var array
  86      */
  87     protected $_validFacilities = array();
  88
  89     /**
  90      * Class constructor
  91      *
  92      * @param  array $options Array of options; may include "application" and "facility" keys
  93      * @return void
  94      */
  95     public function __construct(array $params = array())
  96     {
  97         if (isset($params['application'])) {
  98             $this->_application = $params['application'];
  99         }
 100
 101         $runInitializeSyslog = true;
 102         if (isset($params['facility'])) {
 103             $this->_facility = $this->setFacility($params['facility']);
 104             $runInitializeSyslog = false;
 105         }
 106
 107         if ($runInitializeSyslog) {
 108             $this->_initializeSyslog();
 109         }
 110     }
 111
 112     /**
 113      * Create a new instance of Zend_Log_Writer_Syslog
 114      *
 115      * @param  array|Zend_Config $config
 116      * @return Zend_Log_Writer_Syslog
 117      * @throws Zend_Log_Exception
 118      */
 119     static public function factory($config)
 120     {
 121         return new self(self::_parseConfig($config));
 122     }
 123
 124     /**
 125      * Initialize values facilities
 126      *
 127      * @return void
 128      */
 129     protected function _initializeValidFacilities()
 130     {
 131         $constants = array(
 132             'LOG_AUTH',
 133             'LOG_AUTHPRIV',
 134             'LOG_CRON',
 135             'LOG_DAEMON',
 136             'LOG_KERN',
 137             'LOG_LOCAL0',
 138             'LOG_LOCAL1',
 139             'LOG_LOCAL2',
 140             'LOG_LOCAL3',
 141             'LOG_LOCAL4',
 142             'LOG_LOCAL5',
 143             'LOG_LOCAL6',
 144             'LOG_LOCAL7',
 145             'LOG_LPR',
 146             'LOG_MAIL',
 147             'LOG_NEWS',
 148             'LOG_SYSLOG',
 149             'LOG_USER',
 150             'LOG_UUCP'
 151         );
 152
 153         foreach ($constants as $constant) {
 154             if (defined($constant)) {
 155                 $this->_validFacilities[] = constant($constant);
 156             }
 157         }
 158     }
 159
 160     /**
 161      * Initialize syslog / set application name and facility
 162      *
 163      * @return void
 164      */
 165     protected function _initializeSyslog()
 166     {
 167         self::$_lastApplication = $this->_application;
 168         self::$_lastFacility    = $this->_facility;
 169         openlog($this->_application, LOG_PID, $this->_facility);
 170     }
 171
 172     /**
 173      * Set syslog facility
 174      *
 175      * @param  int $facility Syslog facility
 176      * @return void
 177      * @throws Zend_Log_Exception for invalid log facility
 178      */
 179     public function setFacility($facility)
 180     {
 181         if ($this->_facility === $facility) {
 182             return;
 183         }
 184
 185         if (!count($this->_validFacilities)) {
 186             $this->_initializeValidFacilities();
 187         }
 188
 189         if (!in_array($facility, $this->_validFacilities)) {
 190             require_once 'Zend/Log/Exception.php';
 191             throw new Zend_Log_Exception('Invalid log facility provided; please see http://php.net/openlog for a list of valid facility values');
 192         }
 193
 194         if (strstr(strtolower(PHP_OS), 'windows')
 195             && ($facility !== LOG_USER)
 196         ) {
 197             require_once 'Zend/Log/Exception.php';
 198             throw new Zend_Log_Exception('Only LOG_USER is a valid log facility on Windows');
 199         }
 200
 201         $this->_facility = $facility;
 202         $this->_initializeSyslog();
 203     }
 204
 205     /**
 206      * Set application name
 207      *
 208      * @param  string $application Application name
 209      * @return void
 210      */
 211     public function setApplicationName($application)
 212     {
 213         if ($this->_application === $application) {
 214             return;
 215         }
 216         $this->_application = $application;
 217         $this->_initializeSyslog();
 218     }
 219
 220     /**
 221      * Close syslog.
 222      *
 223      * @return void
 224      */
 225     public function shutdown()
 226     {
 227         closelog();
 228     }
 229
 230     /**
 231      * Write a message to syslog.
 232      *
 233      * @param  array $event  event data
 234      * @return void
 235      */
 236     protected function _write($event)
 237     {
 238         if (array_key_exists($event['priority'], $this->_priorities)) {
 239             $priority = $this->_priorities[$event['priority']];
 240         } else {
 241             $priority = $this->_defaultPriority;
 242         }
 243
 244         if ($this->_application !== self::$_lastApplication
 245             || $this->_facility !== self::$_lastFacility)
 246         {
 247             $this->_initializeSyslog();
 248         }
 249
 250         syslog($priority, $event['message']);
 251     }
 252 }