131 lines
3.2 KiB
PHP
131 lines
3.2 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Platform
|
|
* @subpackage Log
|
|
*
|
|
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE
|
|
*/
|
|
|
|
defined('JPATH_PLATFORM') or die;
|
|
|
|
/**
|
|
* Joomla! Syslog Log class
|
|
*
|
|
* This class is designed to call the PHP Syslog function call which is then sent to the
|
|
* system wide log system. For Linux/Unix based systems this is the syslog subsystem, for
|
|
* the Windows based implementations this can be found in the Event Log. For Windows,
|
|
* permissions may prevent PHP from properly outputting messages.
|
|
*
|
|
* @package Joomla.Platform
|
|
* @subpackage Log
|
|
* @since 11.1
|
|
*/
|
|
class JLogLoggerSyslog extends JLogLogger
|
|
{
|
|
/**
|
|
* @var array Translation array for JLogEntry priorities to SysLog priority names.
|
|
* @since 11.1
|
|
*/
|
|
protected $priorities = array(
|
|
JLog::EMERGENCY => 'EMERG',
|
|
JLog::ALERT => 'ALERT',
|
|
JLog::CRITICAL => 'CRIT',
|
|
JLog::ERROR => 'ERR',
|
|
JLog::WARNING => 'WARNING',
|
|
JLog::NOTICE => 'NOTICE',
|
|
JLog::INFO => 'INFO',
|
|
JLog::DEBUG => 'DEBUG');
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param array &$options Log object options.
|
|
*
|
|
* @since 11.1
|
|
*/
|
|
public function __construct(array &$options)
|
|
{
|
|
// Call the parent constructor.
|
|
parent::__construct($options);
|
|
|
|
// Ensure that we have an identity string for the Syslog entries.
|
|
if (empty($this->options['sys_ident']))
|
|
{
|
|
$this->options['sys_ident'] = 'Joomla Platform';
|
|
}
|
|
|
|
// If the option to add the process id to Syslog entries is set use it, otherwise default to true.
|
|
if (isset($this->options['sys_add_pid']))
|
|
{
|
|
$this->options['sys_add_pid'] = (bool) $this->options['sys_add_pid'];
|
|
}
|
|
else
|
|
{
|
|
$this->options['sys_add_pid'] = true;
|
|
}
|
|
|
|
// If the option to also send Syslog entries to STDERR is set use it, otherwise default to false.
|
|
if (isset($this->options['sys_use_stderr']))
|
|
{
|
|
$this->options['sys_use_stderr'] = (bool) $this->options['sys_use_stderr'];
|
|
}
|
|
else
|
|
{
|
|
$this->options['sys_use_stderr'] = false;
|
|
}
|
|
|
|
// Build the Syslog options from our log object options.
|
|
$sysOptions = 0;
|
|
|
|
if ($this->options['sys_add_pid'])
|
|
{
|
|
$sysOptions = $sysOptions | LOG_PID;
|
|
}
|
|
if ($this->options['sys_use_stderr'])
|
|
{
|
|
$sysOptions = $sysOptions | LOG_PERROR;
|
|
}
|
|
|
|
// Default logging facility is LOG_USER for Windows compatibility.
|
|
$sysFacility = LOG_USER;
|
|
|
|
// If we have a facility passed in and we're not on Windows, reset it.
|
|
if (isset($this->options['sys_facility']) && !IS_WIN)
|
|
{
|
|
$sysFacility = $this->options['sys_facility'];
|
|
}
|
|
|
|
// Open the Syslog connection.
|
|
openlog((string) $this->options['sys_ident'], $sysOptions, $sysFacility);
|
|
}
|
|
|
|
/**
|
|
* Destructor.
|
|
*
|
|
* @since 11.1
|
|
*/
|
|
public function __destruct()
|
|
{
|
|
closelog();
|
|
}
|
|
|
|
/**
|
|
* Method to add an entry to the log.
|
|
*
|
|
* @param JLogEntry $entry The log entry object to add to the log.
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 11.1
|
|
*/
|
|
public function addEntry(JLogEntry $entry)
|
|
{
|
|
// Generate the value for the priority based on predefined constants.
|
|
$priority = constant(strtoupper('LOG_' . $this->priorities[$entry->priority]));
|
|
|
|
// Send the entry to Syslog.
|
|
syslog($priority, '[' . $entry->category . '] ' . $entry->message);
|
|
}
|
|
}
|