Da

✏️ Editing: PleskPluginLogger.php

<?php

/** ******************************************
 * LiteSpeed Web Server Plugin for Plesk
 *
 * @author    Michael Alegre
 * @copyright 2019-2025 LiteSpeed Technologies, Inc.
 * @since     1.3
 * ******************************************* */

use Modules_Litespeed_PleskEscalate as PleskEscalate;
use Modules_Litespeed_PleskExtensionException as PleskExtensionException;
use Modules_Litespeed_PleskPluginLogEntry as PleskPluginLogEntry;
use Modules_Litespeed_PleskPluginLogger as PleskPluginLogger;

/**
 * PleskPluginLogger is a singleton.
 *
 * Functions starting with 'p_' are implemented for compatibility with shared
 * code Logger class and are not intended for use directly.
 *
 * @since 1.3
 */
class Modules_Litespeed_PleskPluginLogger
{

/**
     * @since 1.3
     * @var   string
     */
    const TEMP_LOG_BASE = '/tmp/ls-plesk-tmp';

/**
     * @since 1.3
     * @var   int
     */
    const L_NONE = 0;

/**
     * @since 1.3
     * @var   int
     */
    const L_ERROR = 1;

/**
     * @since 1.3
     * @var   int
     */
    const L_WARN = 2;

/**
     * @since 1.3
     * @var   int
     */
    const L_NOTICE = 3;

/**
     * @since 1.3
     * @var   int
     */
    const L_INFO = 4;

/**
     * @since 1.3
     * @var   int
     */
    const L_VERBOSE = 5;

/**
     * @since 1.3
     * @var   int
     */
    const L_DEBUG = 9;

/**
     * @since 1.3
     * @var   int
     */
    const UI_INFO = 0;

/**
     * @since 1.3
     * @var   int
     */
    const UI_SUCC = 1;

/**
     * @since 1.3
     * @var   int
     */
    const UI_ERR = 2;

/**
     * @since 1.3
     * @var   int
     */
    const UI_WARN = 3;

/**
     * @since 1.3
     * @var   null|PleskPluginLogger
     */
    protected static $instance;

/**
     * @since 1.3
     * @var   int  Highest log message level allowed to be logged. Set to the
     *     higher value between $this->logFileLvl and $this->logEchoLvl.
     */
    protected $logLvl;

/**
     * @since 1.3
     * @var   string  File that log messages will be written to (if writable).
     */
    protected $logFile;

/**
     * @since 1.3
     * @var   int  Highest log message level allowed to be written to the log
     *     file.
     */
    protected $logFileLvl;

/**
     * @since 1.3
     * @var   string  Additional tag to be added at the start of any log
     *     messages.
     */
    protected $addTagInfo = '';

/**
     * @since 1.3
     * @var   bool  When set to true, log messages will not be written to the
     *     log file immediately. Messages will be automatically written when
     *     this PleskPluginLogger object is destroyed.
     */
    protected $bufferedWrite;

/**
     * @since 1.3
     * @var   PleskPluginLogEntry[]  Stores created PleskPluginLogEntry objects.
     */
    protected $msgQueue = [];

/**
     * @since 1.3
     * @var   int  Highest log message level allowed to echo.
     */
    protected $logEchoLvl;

/**
     * @since 1.3
     * @var   bool  When set to true, echoing of log messages will not occur
     *     immediately. Messages will be automatically echoed when this
     *     PleskPluginLogger object is destroyed.
     */
    protected $bufferedEcho;

/**
     * @since 1.3
     * @var   string[][]  Leveraged by Control Panel GUI to store and retrieve
     *     display messages.
     */
    protected $uiMsgs = [
        self::UI_INFO => [],
        self::UI_SUCC => [],
        self::UI_ERR  => [],
        self::UI_WARN => []
    ];

/**
     *
     * @since 1.3
     *
     * @throws PleskExtensionException  Thrown indirectly by $this->init() call.
     */
    protected function __construct()
    {
        $this->init();
    }

/**
     *
     * @since 1.3
     *
     * @throws PleskExtensionException  Thrown when getmypid() call returns
     *     boolean false.
     */
    protected function init()
    {
        if ( ($pid = getmypid()) === false ) {
            throw new PleskExtensionException(
                'Failed to get current PHP process ID when attempting to '
                    . 'initialize class PleskPluginLogger.'
            );
        }

date_default_timezone_set('UTC');

$this->logFile       = self::TEMP_LOG_BASE . "_$pid.log";
        $this->logFileLvl    = self::L_INFO;
        $this->logEchoLvl    = self::L_NONE;
        $this->bufferedWrite = true;
        $this->bufferedEcho  = true;

$this->logLvl = max($this->logEchoLvl, $this->logFileLvl);
    }

/**
     *
     * @since 1.3
     *
     * @throws PleskExtensionException  Thrown indirectly by
     *     $this->writeToFile() call.
     */
    public function __destruct()
    {
        if ( $this->bufferedWrite ) {
            $this->writeToFile($this->msgQueue);
        }
    }

/**
     *
     * @since 1.3
     *
     * @throws PleskExtensionException  Thrown when class PleskPluginLogger has
     *     already been initialized.
     * @throws PleskExtensionException  Thrown indirectly by "new static()"
     *     call.
     */
    public static function Initialize()
    {
        if ( self::$instance != null ) {
            throw new PleskExtensionException(
                'Plugin logger class cannot be initialized twice.',
                PleskExtensionException::E_PROGRAM
            );
        }

self::$instance = new static();
    }

/**
     *
     * @since 1.3
     *
     * @return null|PleskPluginLogger
     */
    public static function getInstance()
    {
        return self::$instance;
    }

/**
     * Create log file if it does not already exist. Useful for creating temp
     * log file with correct permissions before writing to it in escalated
     * functions.
     *
     * @since 1.3
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     */
    public static function preCreateLogFile()
    {
        $m = self::me();

if ( !file_exists($m->logFile) ) {
            touch($m->logFile);
        }
    }

/**
     *
     * @since 1.3
     *
     * @param string $logFile
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     */
    public static function changeLogFileUsed( $logFile )
    {
        self::me()->logFile = $logFile;
    }

/**
     *
     * @since 1.3
     *
     * @param string $addInfo
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     */
    public static function setAdditionalTagInfo( $addInfo )
    {
        self::me()->addTagInfo = $addInfo;
    }

/**
     *
     * @since 1.3
     *
     * @param string $msg
     * @param int    $type
     */
    public function p_addUiMsg( $msg, $type )
    {
        switch ( $type ) {

case self::UI_INFO:
            case self::UI_SUCC:
            case self::UI_ERR:
            case self::UI_WARN:
                $this->uiMsgs[$type][] = $msg;
                break;

//no default
        }
    }

/**
     *
     * @since 1.3
     *
     * @param PleskPluginLogEntry[] $entries
     *
     * @throws PleskExtensionException  Thrown indirectly by
     *     $this->echoEntries() call.
     */
    public function p_echoEntries( array $entries )
    {
        $this->echoEntries($entries);
    }

/**
     *
     * @since 1.3
     *
     * @return string
     */
    public function p_getAddTagInfo()
    {
        return $this->addTagInfo;
    }

/**
     *
     * @since 1.3
     *
     * @return bool
     */
    public function p_getBufferedEcho()
    {
        return $this->bufferedEcho;
    }

/**
     *
     * @since 1.3
     *
     * @return bool
     */
    public function p_getBufferedWrite()
    {
        return $this->bufferedWrite;
    }

/**
     *
     * @since 1.3
     *
     * @return string
     */
    public function p_getLogFile()
    {
        return $this->logFile;
    }

/**
     *
     * @since 1.3
     *
     * @return PleskPluginLogEntry[]
     */
    public function p_getMsgQueue()
    {
        return $this->msgQueue;
    }

/**
     *
     * @since 1.3
     *
     * @param int $type
     *
     * @return string[]
     */
    public function p_getUiMsgs( $type )
    {
        switch ( $type ) {

case self::UI_INFO:
            case self::UI_SUCC:
            case self::UI_ERR:
            case self::UI_WARN:
                return $this->uiMsgs[$type];

default:
                return [];
        }
    }

/**
     *
     * @since 1.3
     *
     * @param string $msg
     * @param int    $lvl
     *
     * @throws PleskExtensionException  Thrown indirectly by $this->log() call.
     */
    public function p_log( $msg, $lvl )
    {
        $this->log($msg, $lvl);
    }

/**
     *
     * @since 1.3
     *
     * @param string $addInfo
     */
    public function p_setAddTagInfo( $addInfo )
    {
        $this->addTagInfo = $addInfo;
    }

/**
     *
     * @since 1.3
     *
     * @param string $logFile
     */
    public function p_setLogFile( $logFile )
    {
        $this->logFile = $logFile;
    }

/**
     *
     * @since 1.3
     *
     * @param int $logFileLvl
     */
    public function p_setLogFileLvl( $logFileLvl )
    {
        $this->logFileLvl = $logFileLvl;
    }

/**
     *
     * @since 1.3
     *
     * @param PleskPluginLogEntry[] $msgQueue
     */
    public function p_setMsgQueue( array $msgQueue )
    {
        $this->msgQueue = $msgQueue;
    }

/**
     *
     * @since 1.3
     *
     * @param PleskPluginLogEntry[] $entries  Array of objects that implement
     *     all LogEntry class public functions.
     *
     * @throws PleskExtensionException  Thrown indirectly by
     *     $this->writeToFile() call.
     */
    public function p_writeToFile( array $entries )
    {
        $this->writeToFile($entries);
    }

/**
     *
     * @since 1.3
     *
     * @return string
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     */
    public static function getAdditionalTagInfo()
    {
        return self::me()->addTagInfo;
    }

/**
     *
     * @since 1.3
     *
     * @return string
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     */
    public static function getLogFilePath()
    {
        return self::me()->logFile;
    }

/**
     *
     * @since 1.3
     *
     * @return PleskPluginLogEntry[]  Array of objects that implement all
     *     LogEntry class public functions.
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     */
    public static function getLogMsgQueue()
    {
        return self::me()->p_getMsgQueue();
    }

/**
     *
     * @since 1.3
     *
     * @param int $type
     *
     * @return string[]
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     */
    public static function getUiMsgs( $type )
    {
        return self::me()->p_getUiMsgs($type);
    }

/**
     * Processes any buffered output and write it to the log file, echo it out,
     * or both.
     *
     * @since 1.3
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     * @throws PleskExtensionException  Thrown indirectly by $m->writeToFile()
     *     call.
     * @throws PleskExtensionException  Thrown indirectly by $m->echoEntries()
     *     call.
     */
    public static function processBuffer()
    {
        $m = self::me();

if ( $m->bufferedWrite ) {
            $m->writeToFile($m->msgQueue);
            $m->msgQueue = [];
        }

if ( $m->bufferedEcho ) {
            $m->echoEntries($m->msgQueue);
            $m->msgQueue = [];
        }
    }
    /**
     * This deprecated function exists to more closely match the public API of
     * the shared code Logger class in which an object of this class may be
     * used as the value of the Logger class' protected $instance class
     * variable.
     *
     * @deprecated 1.3
     *
     * @since 1.3
     *
     * @param string $msg
     * @param int    $type
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     */
    public static function addUiMsg( $msg, $type )
    {
        self::me()->p_addUiMsg($msg, $type);
    }

/**
     * Calls addUiMsg() with message level self::UI_INFO.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::addUiMsg()
     *     call.
     */
    public static function uiInfo( $msg )
    {
        self::addUiMsg($msg, self::UI_INFO);
    }

/**
     * Calls addUiMsg() with message level self::UI_SUCC.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::addUiMsg()
     *     call.
     */
    public static function uiSuccess( $msg )
    {
        self::addUiMsg($msg, self::UI_SUCC);
    }

/**
     * Calls addUiMsg() with message level self::UI_ERR.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::addUiMsg()
     *     call.
     */
    public static function uiError( $msg )
    {
        self::addUiMsg($msg, self::UI_ERR);
    }

/**
     * Calls addUiMsg() with message level self::UI_WARN.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::addUiMsg()
     *     call.
     */
    public static function uiWarning( $msg )
    {
        self::addUiMsg($msg, self::UI_WARN);
    }

/**
     *
     * @since 1.3
     *
     * @param string $msg
     * @param int    $lvl
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     * @throws PleskExtensionException  Thrown indirectly by self::me()->log()
     *     call.
     */
    protected static function logMsg( $msg, $lvl )
    {
        self::me()->log($msg, $lvl);
    }

/**
     * Calls logMsg() with message level self::L_ERROR.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::logMsg()
     *     call.
     */
    public static function error( $msg )
    {
        self::logMsg($msg, self::L_ERROR);
    }

/**
     * Calls logMsg() with message level self::L_WARN.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::logMsg()
     *     call.
     */
    public static function warn( $msg )
    {
        self::logMsg($msg, self::L_WARN);
    }

/**
     * Calls logMsg() with message level self::L_NOTICE.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::logMsg()
     *     call.
     */
    public static function notice( $msg )
    {
        self::logMsg($msg, self::L_NOTICE);
    }

/**
     * Calls logMsg() with message level self::L_INFO.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::logMsg()
     *     call.
     */
    public static function info( $msg )
    {
        self::logMsg($msg, self::L_INFO);
    }

/**
     * Calls logMsg() with message level self::L_VERBOSE.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::logMsg()
     *     call.
     */
    public static function verbose( $msg )
    {
        self::logMsg($msg, self::L_VERBOSE);
    }

/**
     * Calls logMsg() with message level self::L_DEBUG.
     *
     * @since 1.3
     *
     * @param string $msg
     *
     * @throws PleskExtensionException  Thrown indirectly by self::logMsg()
     *     call.
     */
    public static function debug( $msg )
    {
        self::logMsg($msg, self::L_DEBUG);
    }

/**
     *
     * @since 1.3
     *
     * @return PleskPluginLogger
     *
     * @throws PleskExtensionException  Thrown when class PleskPluginLogger has
     *     not yet been initialized.
     */
    protected static function me()
    {
        if ( self::$instance == null ) {
            throw new PleskExtensionException(
                'Plugin logger class uninitialized.',
                PleskExtensionException::E_PROGRAM
            );
        }

return self::$instance;
    }

/**
     *
     * @since 1.3
     *
     * @param string $msg
     * @param int    $lvl
     *
     * @throws PleskExtensionException  Thrown indirectly by
     *     $this->writeToFile() call.
     * @throws PleskExtensionException  Thrown indirectly by
     *     $this->echoEntries() call.
     */
    protected function log( $msg, $lvl )
    {
        $entry = new PleskPluginLogEntry($msg, $lvl);

$this->msgQueue[] = $entry;

if ( !$this->bufferedWrite ) {
            $this->writeToFile([ $entry ]);
        }

if ( !$this->bufferedEcho ) {
            $this->echoEntries([ $entry ]);
        }
    }

/**
     * Escalate and write temp log file contents to real shared log file.
     *
     * @since 1.3
     *
     * @param PleskPluginLogEntry[] $entries
     *
     * @throws PleskExtensionException  Thrown indirectly by $e->getOutput()
     *     call.
     * @throws PleskExtensionException  Thrown indirectly by
     *     PleskEscalate::escalate() call.
     */
    protected function writeToFile( array $entries )
    {
        $content = '';

foreach ( $entries as $e ) {
            $content .= $e->getOutput($this->logFileLvl);
        }

if ( $content != '' ) {

if ( $this->logFile ) {

if ( ($f = fopen($this->logFile, "a")) !== false ) {
                    fwrite($f, $content);
                    fclose($f);
                }
            }
            else {
                error_log($content);
            }

PleskEscalate::escalate(PleskEscalate::CMD_WRITE_TO_LOG);
        }

if ( file_exists($this->logFile) ) {
            unlink($this->logFile);
        }
    }

/**
     *
     * @since 1.3
     *
     * @param PleskPluginLogEntry[] $entries
     *
     * @throws PleskExtensionException  Thrown indirectly by $entry->getOutput()
     *     call.
     */
    protected function echoEntries( array $entries )
    {
        foreach ( $entries as $entry ) {

if ( ($msg = $entry->getOutput($this->logEchoLvl)) !== '' ) {
                echo $msg;
            }
        }
    }

/**
     *
     * @since 1.3
     *
     * @param int $lvl
     *
     * @return string
     */
    public static function getLvlDescr( $lvl )
    {
        switch ( $lvl ) {

case self::L_ERROR:
                return 'ERROR';

case self::L_WARN:
                return 'WARN';

case self::L_NOTICE:
                return 'NOTICE';

case self::L_INFO:
                return 'INFO';

case self::L_VERBOSE:
                return 'DETAIL';

case self::L_DEBUG:
                return 'DEBUG';

default:
                /**
                 * Do silently.
                 */
                return '';
        }
    }

/**
     * This deprecated function exists to more closely match the public API of
     * the shared code Logger class in which an object of this class may be
     * used as the value of the Logger class' protected $instance class
     * variable.
     *
     * @deprecated 1.3
     *
     * @since 1.3
     *
     * @param int $lvl
     *
     * @return bool
     *
     * @throws PleskExtensionException  Thrown indirectly by self::me() call.
     */
    public static function setLogFileLvl( $lvl )
    {
        $lvl = (int)$lvl;

if ( !self::isValidLogFileLvl($lvl) ) {
            return false;
        }

if ( $lvl > self::L_DEBUG ) {
            $lvl = self::L_DEBUG;
        }

self::me()->p_setLogFileLvl($lvl);

return true;
    }

/**
     *
     * @since 1.3
     *
     * @param int $lvl
     *
     * @return bool
     */
    protected static function isValidLogFileLvl( $lvl )
    {
        return (is_int($lvl) && $lvl >= 0);
    }

/**
     *
     * @since 2.3.0
     *
     * @throws PleskExtensionException  Thrown indirectly by static::me() call.
     */
    public static function setDebug()
    {
        static::me()->logFileLvl = static::L_DEBUG;
    }

/**
     * Prevent cloning here and in extending classes.
     *
     * @since 1.3
     */
    final protected function __clone() {}

}

📁 Sid Gifari File Manager