| Path : /opt/z-push/lib/log/ |
|
B-Con CMD Config cPanel C-Rdp D-Log Info Jump Mass Ransom Symlink vHost Zone-H |
| Current File : //opt/z-push/lib/log/syslog.php |
<?php
/***********************************************
* File : syslog.php
* Project : Z-Push
* Descr : Logging functionalities
*
* Created : 13.11.2015
*
* Copyright 2007 - 2016 Zarafa Deutschland GmbH
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Consult LICENSE file for details
************************************************/
class Syslog extends Log {
protected $program_name = '';
protected $host;
protected $port;
/**
* @access public
* @return string
*/
public function GetProgramName() {
return $this->program_name;
}
/**
* @param string $value
*
* @access public
*/
public function SetProgramName($value) {
$this->program_name = $value;
}
/**
* @access public
* @return string
*/
public function GetHost() {
return $this->host;
}
/**
* @param string $value
*
* @access public
*/
public function SetHost($value) {
$this->host = $value;
}
/**
* @access public
* @return int
*/
public function GetPort() {
return $this->port;
}
/**
* @param int $value
*
* @access public
*/
public function SetPort($value) {
if (is_numeric($value)) {
$this->port = (int)$value;
}
}
/**
* Constructor.
* Sets configured values if no parameters are given.
*
* @param string $program_name
* @param string $host
* @param string $port
*/
public function __construct($program_name = null, $host = null, $port = null) {
parent::__construct();
if (is_null($program_name)) $program_name = LOG_SYSLOG_PROGRAM;
if (is_null($host)) $host = LOG_SYSLOG_HOST;
if (is_null($port)) $port = LOG_SYSLOG_PORT;
$this->SetProgramName($program_name);
$this->SetHost($host);
$this->SetPort($port);
}
/**
* Return the full program name for syslog.
* The name can be z-push/core or z-push/{backend} where backend is the backend that initiated the log.
*
* @access protected
* @return string
*/
protected function GenerateProgramName() {
// @TODO Use another mechanism than debug_backtrace to determine to origin of the log
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
// Shift the "syslog.php" entry.
array_shift($backtrace);
foreach ($backtrace as $trace) {
if (!isset($trace['file'])) {
continue;
}
if (strpos($trace['file'], REAL_BASE_PATH . 'backend/') !== false) {
preg_match('/\/backend\/([a-zA-Z]*)/', $trace['file'], $match);
if (isset($match[1])) {
return $this->GetProgramName() . '/' . $match[1];
}
} elseif (basename($trace['file'], '.php') != 'zlog') {
return $this->GetProgramName() . '/core';
}
}
return $this->GetProgramName() . '/core';
}
/**
* Maps the z-push loglevel with those of syslog.
*
* @access protected
* @param int $loglevel
* @return int One of many LOG_* syslog level.
*/
protected function GetZpushLogLevelToSyslogLogLevel($loglevel) {
switch ($loglevel) {
case LOGLEVEL_FATAL: return LOG_ALERT; break;
case LOGLEVEL_ERROR: return LOG_ERR; break;
case LOGLEVEL_WARN: return LOG_WARNING; break;
case LOGLEVEL_INFO: return LOG_INFO; break;
case LOGLEVEL_DEBUG: return LOG_DEBUG; break;
case LOGLEVEL_WBXML: return LOG_DEBUG; break;
case LOGLEVEL_DEVICEID: return LOG_DEBUG; break;
case LOGLEVEL_WBXMLSTACK: return LOG_DEBUG; break;
}
return null;
}
/**
* Build the log string for syslog.
*
* @param int $loglevel
* @param string $message
* @param boolean $includeUserDevice puts username and device in the string, default: true
*
* @access public
* @return string
*/
public function BuildLogString($loglevel, $message, $includeUserDevice = true) {
$log = $this->GetLogLevelString($loglevel); // Never pad syslog log because syslog log are usually read with a software.
// when the users differ, we need to log both
if (strcasecmp($this->GetAuthUser(), $this->GetUser()) == 0) {
$log .= ' ['. $this->GetUser() .']';
}
else {
$log .= ' ['. $this->GetAuthUser() . Request::IMPERSONATE_DELIM . $this->GetUser() .']';
}
if ($loglevel >= LOGLEVEL_DEVICEID) {
$log .= '['. $this->GetDevid() .']';
}
$log .= ' ' . $message;
return $log;
}
//
// Implementation of Log
//
/**
* Writes a log message to the general log.
*
* @param int $loglevel
* @param string $message
*
* @access protected
* @return void
*/
protected function Write($loglevel, $message) {
if ($this->GetHost() && $this->GetPort()) {
$sock = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
$facility = 1; // user level
$pri = ($facility * 8) + $loglevel; // multiplying the Facility number by 8 + adding the level
$data = $this->BuildLogString($loglevel, $message);
if (strlen(trim($data)) > 0) {
$syslog_message = "<{$pri}>" . date('M d H:i:s ') . '[' . $this->GetProgramName() . ']: ' . $data;
socket_sendto($sock, $syslog_message, strlen($syslog_message), 0, $this->GetHost(), $this->GetPort());
}
socket_close($sock);
} else {
openlog($this->GenerateProgramName(), LOG_PID, LOG_SYSLOG_FACILITY);
syslog(
$this->GetZpushLogLevelToSyslogLogLevel($loglevel),
$this->BuildLogString($loglevel, $message)
);
}
}
/**
* This function is used as an event for log implementer.
* It happens when the a call to the Log function is finished.
*
* @access public
* @return void
*/
public function WriteForUser($loglevel, $message) {
$this->Write(LOGLEVEL_DEBUG, $message); // Always pass the logleveldebug so it uses syslog level LOG_DEBUG
}
}