<?php
/*********************************************************************
*
* $HeadURL: http://svn.sysco.ch/svn/al/trunk/developer.sysco.ch/php/syslog.php $
* $LastChangedRevision: 5 $
* Language: PHP 4.x or higher
* Copyright: SysCo systèmes de communication sa
* CreationDate: 2005-11-05
* CreatedBy: SysCo/al
* $LastChangedDate: 2018-02-26
* $LastChangedBy: al@sysco.ch $
* WebSite: http://developer.sysco.ch/php/
* Email: developer@sysco.ch
*
*
* Description
*
* The Syslog class is a syslog device implementation in PHP
* following the RFC 3164 rules
* (http://www.faqs.org/rfcs/rfc3164.html)
* (ftp://ftp.rfc-editor.org/in-notes/rfc3164.txt)
*
* Facility values:
* 0 kernel messages
* 1 user-level messages
* 2 mail system
* 3 system daemons
* 4 security/authorization messages
* 5 messages generated internally by syslogd
* 6 line printer subsystem
* 7 network news subsystem
* 8 UUCP subsystem
* 9 clock daemon
* 10 security/authorization messages
* 11 FTP daemon
* 12 NTP subsystem
* 13 log audit
* 14 log alert
* 15 clock daemon
* 16 local user 0 (local0) (default value)
* 17 local user 1 (local1)
* 18 local user 2 (local2)
* 19 local user 3 (local3)
* 20 local user 4 (local4)
* 21 local user 5 (local5)
* 22 local user 6 (local6)
* 23 local user 7 (local7)
*
* Severity values:
* 0 Emergency: system is unusable
* 1 Alert: action must be taken immediately
* 2 Critical: critical conditions
* 3 Error: error conditions
* 4 Warning: warning conditions
* 5 Notice: normal but significant condition (default value)
* 6 Informational: informational messages
* 7 Debug: debug-level messages
*
*
* Usage
*
* require_once('syslog.php');
* $syslog = new Syslog($facility = 16, $severity = 5, $hostname = "", $fqdn= "", $ip_from = "", $process="", $content = "");
* $syslog->Send($server = "", $content = "", $timeout = 0);
*
*
* Examples
*
* Example 1
* <?php
* require_once('syslog.php');
* $syslog = new Syslog();
* $syslog->Send('192.168.0.12', 'My first PHP syslog message');
* ?>
*
* Example 2
* <?php
* require_once('syslog.php');
* $syslog = new Syslog(23, 7, 'MYSERVER', 'myserver.mydomain.net', '192.168.0.1', 'webautomation');
* $syslog->Send('192.168.0.12', 'My second PHP syslog message');
* ?>
*
* Example 3
* <?php
* require_once('syslog.php');
* $syslog = new Syslog();
* $syslog->SetFacility(23);
* $syslog->SetSeverity(7);
* $syslog->SetHostname('MYSERVER');
* $syslog->SetFqdn('myserver.mydomain.net');
* $syslog->SetIpFrom('192.168.0.1');
* $syslog->SetProcess('webautomation');
* $syslog->SetContent('My third PHP syslog message');
* $syslog->SetServer('192.168.0.12');
* $syslog->Send();
* ?>
*
* Example 4
* <?php
* // Do not follow the conventions of the RFC
* // and send a customized MSG part instead of
* // the recommanded format "process fqdn ip content"
* require_once('syslog.php');
* $syslog = new Syslog();
* $syslog->SetFacility(23);
* $syslog->SetSeverity(7);
* $syslog->SetHostname('MYSERVER');
* $syslog->SetMsg('My customized MSG PHP syslog message');
* $syslog->SetServer('192.168.0.12');
* $syslog->Send();
* ?>
*
*
* External file needed
*
* none.
*
*
* External file created
*
* none.
*
*
* Special issues
*
* - Sockets support must be enabled.
* * In Linux and *nix environments, the extension is enabled at
* compile time using the --enable-sockets configure option
* * In Windows, PHP Sockets can be activated by un-commenting
* extension=php_sockets.dll in php.ini
*
*
* Licence
*
* Copyright (c) 2005, SysCo systèmes de communication sa
* SysCo (tm) is a trademark of SysCo systèmes de communication sa
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* - Neither the name of SysCo systèmes de communication sa nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
* SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*
* Change Log
*
* 2018-02-26 1.1.2.1 SysCo/al __construct instead of the name of the class
* 2006-xx-xx 1.1.2 SysCo/al Timeout implementation, extended documentation
* 2005-12-24 1.1 SysCo/al Generic release and documentation
* 2005-11-05 1.0 SysCo/al Initial release
*
*********************************************************************/
class MultiotpSyslog
{
var $_facility; // Facility 0-23 (see above, default is '16', meaning 'local0')
var $_severity; // 0-7 (see above, default is '5', meaning 'notice')
var $_hostname; // Hostname without embedded space, no domain nameor fqdn, only a-z A-Z 0-9 and other authorized characters
var $_fqdn; // FQDN of the device
var $_ip_from; // IP address of the device
var $_process; // Process name (default is 'PHP')
var $_content; // Content of the detailed information
var $_msg; // Alternate MSG information (to overload the conventions of the RFC)
var $_server; // Syslog destination server
var $_port; // Standard syslog port (default value is 514)
var $_timeout; // Timeout of the UDP connection in seconds (default value is 20)
function __construct($facility = 16, $severity = 5, $hostname = "", $fqdn= "", $ip_from = "", $process="", $content = "")
{
$this->_msg = '';
$this->_server = '127.0.0.1';
$this->_port = 514;
$this->_timeout = 20;
$this->_facility = $facility;
$this->_severity = $severity;
$this->_hostname = $hostname;
if ($this->_hostname == "")
{
if (isset($_ENV["COMPUTERNAME"]))
{
$this->_hostname = $_ENV["COMPUTERNAME"];
}
elseif (isset($_ENV["HOSTNAME"]))
{
$this->_hostname = $_ENV["HOSTNAME"];
}
else
{
$this->_hostname = "WEBSERVER";
}
}
$this->_hostname = substr($this->_hostname, 0, strpos($this->_hostname.".", "."));
$this->_fqdn = $fqdn;
if ($this->_fqdn == "")
{
if (isset($_SERVER["SERVER_NAME"]))
{
$this->_fqdn = $_SERVER["SERVER_NAME"];
}
}
$this->_ip_from = $ip_from;
if ($this->_ip_from == "")
{
if (isset($_SERVER["SERVER_ADDR"]))
{
$this->_ip_from = $_SERVER["SERVER_ADDR"];
}
}
$this->_process = $process;
if ($this->_process == "")
{
$this->_process = "PHP";
}
$this->_content = $content;
if ($this->_content == "")
{
$this->_content = "PHP generated message";
}
}
function SetFacility($facility)
{
$this->_facility = $facility;
}
function SetSeverity($severity)
{
$this->_severity = $severity;
}
function SetHostname($hostname)
{
$this->_hostname = $hostname;
}
function SetFqdn($fqdn)
{
$this->_fqdn = $fqdn;
}
function SetIpFrom($ip_from)
{
$this->_ip_from = $ip_from;
}
function SetProcess($process)
{
$this->_process = $process;
}
function SetContent($content)
{
$this->_content = $content;
}
function SetMsg($msg)
{
$this->_msg = $msg;
}
function SetServer($server)
{
$this->_server = $server;
}
function SetPort($port)
{
if ((intval($port) > 0) && (intval($port) < 65536))
{
$this->_port = intval($port);
}
}
function SetTimeout($timeout)
{
if (intval($timeout) > 0)
{
$this->_timeout = intval($timeout);
}
}
function Send($server = "", $content = "", $timeout = 0)
{
if ($server != "")
{
$this->_server = $server;
}
if ($content != "")
{
$this->_content = $content;
}
if (intval($timeout) > 0)
{
$this->_timeout = intval($timeout);
}
if ($this->_facility < 0) { $this->_facility = 0; }
if ($this->_facility > 23) { $this->_facility = 23; }
if ($this->_severity < 0) { $this->_severity = 0; }
if ($this->_severity > 7) { $this->_severity = 7; }
$this->_process = substr($this->_process, 0, 32);
$actualtime = time();
$month = date("M", $actualtime);
$day = substr(" ".date("j", $actualtime), -2);
$hhmmss = date("H:i:s", $actualtime);
$timestamp = $month." ".$day." ".$hhmmss;
$pri = "<".($this->_facility*8 + $this->_severity).">";
$header = $timestamp." ".$this->_hostname;
if ($this->_msg != "")
{
$msg = $this->_msg;
}
else
{
$msg = $this->_process.": ".$this->_fqdn." ".$this->_ip_from." ".$this->_content;
}
$message = substr($pri.$header." ".$msg, 0, 1024);
$fp = fsockopen("udp://".$this->_server, $this->_port, $errno, $errstr, $this->_timeout);
if ($fp)
{
fwrite($fp, $message);
fclose($fp);
$result = $message;
}
else
{
$result = "ERROR: $errno - $errstr";
}
return $result;
}
}
?>
|
Download
