Syslog

Complexity

Total Complexity

34

Size/Duplication

Total Lines	207
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	GenerateProgramName()	0	21	6
A	GetPort()	0	2	1
A	__construct()	0	16	4
A	WriteForUser()	0	2	1
A	GetProgramName()	0	2	1
A	SetPort()	0	3	2
B	GetGsyncLogLevelToSyslogLogLevel()	0	28	9
A	Write()	0	17	4
A	GetHost()	0	2	1
A	SetHost()	0	2	1
A	BuildLogString()	0	15	3
A	SetProgramName()	0	2	1

<?php
/*
 * SPDX-License-Identifier: AGPL-3.0-only
 * SPDX-FileCopyrightText: Copyright 2007-2016 Zarafa Deutschland GmbH
 * SPDX-FileCopyrightText: Copyright 2020-2022 grommunio GmbH
 *
 * Logging functionalities
 */

class Syslog extends Log {
	protected $program_name = '';
	protected $host;
	protected $port;

	/**
	 * @return string
	 */
	public function GetProgramName() {
		return $this->program_name;
	}

	/**
	 * @param string $value
	 */
	public function SetProgramName($value) {
		$this->program_name = $value;
	}

	/**
	 * @return string
	 */
	public function GetHost() {
		return $this->host;

The expression return $this->host also could return the type boolean which is incompatible with the documented return type string.

	}

	/**
	 * @param string $value
	 */
	public function SetHost($value) {
		$this->host = $value;
	}

	/**
	 * @return int
	 */
	public function GetPort() {
		return $this->port;
	}

	/**
	 * @param int $value
	 */
	public function SetPort($value) {
		if (is_numeric($value)) {

The condition is_numeric($value) is always true.

			$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);

It seems like $host can also be of type false; however, parameter $value of Syslog::SetHost() does only seem to accept string, maybe add an additional type check?

		$this->SetPort($port);

It seems like $port can also be of type string; however, parameter $value of Syslog::SetPort() does only seem to accept integer, maybe add an additional type check?

	}

	/**
	 * Return the full program name for syslog.
	 * The name can be grommunio-sync/core or grommunio-sync/{backend} where backend is the backend that initiated the log.
	 *
	 * @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') != 'slog') {
				return $this->GetProgramName() . '/core';
			}
		}

		return $this->GetProgramName() . '/core';
	}

	/**
	 * Maps the grommunio-sync loglevel with those of syslog.
	 *
	 * @param int $loglevel
	 *
	 * @return int one of many LOG_* syslog level
	 */
	protected function GetGsyncLogLevelToSyslogLogLevel($loglevel) {
		switch ($loglevel) {
			case LOGLEVEL_FATAL:
				return LOG_ALERT;

			case LOGLEVEL_ERROR:
				return LOG_ERR;

			case LOGLEVEL_WARN:
				return LOG_WARNING;

			case LOGLEVEL_INFO:
				return LOG_INFO;

			case LOGLEVEL_DEBUG:
				return LOG_DEBUG;

			case LOGLEVEL_WBXML:
				return LOG_DEBUG;

			case LOGLEVEL_DEVICEID:
				return LOG_DEBUG;

			case LOGLEVEL_WBXMLSTACK:
				return LOG_DEBUG;
		}

		return null;
	}

	/**
	 * Build the log string for syslog.
	 *
	 * @param int    $loglevel
	 * @param string $message
	 * @param bool   $includeUserDevice puts username and device in the string, default: true
	 *
	 * @return string
	 */
	public function BuildLogString($loglevel, $message, $includeUserDevice = true) {

The parameter $includeUserDevice is not used and could be removed.

		$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
	 */
	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->GetGsyncLogLevelToSyslogLogLevel($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.
	 *
	 * @param mixed $loglevel
	 * @param mixed $message
	 */
	public function WriteForUser($loglevel, $message) {
		$this->Write(LOGLEVEL_DEBUG, $message); // Always pass the logleveldebug so it uses syslog level LOG_DEBUG
	}
}