<?php
/**
 * This code is licensed under AGPLv3 license or Afterlogic Software License
 * if commercial version of the product was purchased.
 * For full statements of the licenses see LICENSE-AFTERLOGIC and LICENSE-AGPL3 files.
 */

namespace MailSo\Log;

/**
 * @license https://www.gnu.org/licenses/agpl-3.0.html AGPL-3.0
 * @license https://afterlogic.com/products/common-licensing Afterlogic Software License
 * @copyright Copyright (c) 2019, Afterlogic Corp.
 *
 * @category MailSo
 * @package Log
 */
abstract class Driver
{
    /**
     * @var string
     */
    protected $sDatePattern;

    /**
     * @var string
     */
    protected $sName;

    /**
     * @var array
     */
    protected $aPrefixes;

    /**
     * @var bool
     */
    protected $bGuidPrefix;

    /**
     * @var bool
     */
    protected $bTimePrefix;

    /**
     * @var bool
     */
    protected $bTypedPrefix;

    /**
     * @var int
     */
    private $iWriteOnTimeoutOnly;

    /**
     * @var bool
     */
    private $bWriteOnErrorOnly;

    /**
     * @var bool
     */
    private $bWriteOnPhpErrorOnly;

    /**
     * @var bool
     */
    private $bFlushCache;

    /**
     * @var array
     */
    private $aCache;

    /**
     * @access protected
     */
    protected function __construct()
    {
        $this->sDatePattern = 'H:i:s';
        $this->sName = 'INFO';
        $this->bTimePrefix = true;
        $this->bTypedPrefix = true;
        $this->bGuidPrefix = true;

        $this->iWriteOnTimeoutOnly = 0;
        $this->bWriteOnErrorOnly = false;
        $this->bWriteOnPhpErrorOnly = false;
        $this->bFlushCache = false;
        $this->aCache = array();

        $this->aPrefixes = array(
            \MailSo\Log\Enumerations\Type::INFO => '[DATA]',
            \MailSo\Log\Enumerations\Type::SECURE => '[SECURE]',
            \MailSo\Log\Enumerations\Type::NOTE => '[NOTE]',
            \MailSo\Log\Enumerations\Type::TIME => '[TIME]',
            \MailSo\Log\Enumerations\Type::TIME_DELTA => '[TIME]',
            \MailSo\Log\Enumerations\Type::MEMORY => '[MEMORY]',
            \MailSo\Log\Enumerations\Type::NOTICE => '[NOTICE]',
            \MailSo\Log\Enumerations\Type::WARNING => '[WARNING]',
            \MailSo\Log\Enumerations\Type::ERROR => '[ERROR]',

            \MailSo\Log\Enumerations\Type::NOTICE_PHP => '[NOTICE]',
            \MailSo\Log\Enumerations\Type::WARNING_PHP => '[WARNING]',
            \MailSo\Log\Enumerations\Type::ERROR_PHP => '[ERROR]',
        );
    }

    /**
     * @return \MailSo\Log\Driver
     */
    public function DisableGuidPrefix()
    {
        $this->bGuidPrefix = false;
        return $this;
    }

    /**
     * @return \MailSo\Log\Driver
     */
    public function DisableTimePrefix()
    {
        $this->bTimePrefix = false;
        return $this;
    }

    /**
     * @param bool $bValue
     *
     * @return \MailSo\Log\Driver
     */
    public function WriteOnErrorOnly($bValue)
    {
        $this->bWriteOnErrorOnly = !!$bValue;
        return $this;
    }

    /**
     * @param bool $bValue
     *
     * @return \MailSo\Log\Driver
     */
    public function WriteOnPhpErrorOnly($bValue)
    {
        $this->bWriteOnPhpErrorOnly = !!$bValue;
        return $this;
    }

    /**
     * @param int $iTimeout
     *
     * @return \MailSo\Log\Driver
     */
    public function WriteOnTimeoutOnly($iTimeout)
    {
        $this->iWriteOnTimeoutOnly = (int) $iTimeout;
        if (0 > $this->iWriteOnTimeoutOnly) {
            $this->iWriteOnTimeoutOnly = 0;
        }

        return $this;
    }

    /**
     * @return \MailSo\Log\Driver
     */
    public function DisableTypedPrefix()
    {
        $this->bTypedPrefix = false;
        return $this;
    }

    /**
     * @param string|array $mDesc
     * @return bool
     */
    abstract protected function writeImplementation($mDesc);

    /**
     * @return bool
     */
    protected function writeEmptyLineImplementation()
    {
        return $this->writeImplementation('');
    }

    /**
     * @param string $sTimePrefix
     * @param string $sDesc
     * @param int $iType = \MailSo\Log\Enumerations\Type::INFO
     * @param string $sName = ''
     *
     * @return string
     */
    protected function loggerLineImplementation(
        $sTimePrefix,
        $sDesc,
        $iType = \MailSo\Log\Enumerations\Type::INFO,
        $sName = ''
    ) {
        return \ltrim(
            ($this->bTimePrefix ? '['.$sTimePrefix.']' : '').
            ($this->bGuidPrefix ? '['.\MailSo\Log\Logger::Guid().']' : '').
            ($this->bTypedPrefix ? ' '.$this->getTypedPrefix($iType, $sName) : '')
        ).$sDesc;
    }

    /**
     * @return bool
     */
    protected function clearImplementation()
    {
        return true;
    }

    /**
     * @return string
     */
    protected function getTimeWithMicroSec()
    {
        $aMicroTimeItems = \explode(' ', \microtime());
        return \gmdate($this->sDatePattern, $aMicroTimeItems[1]).'.'.
            \str_pad((int) $aMicroTimeItems[0] * 1000, 3, '0', STR_PAD_LEFT);
    }

    /**
     * @param int $iType
     * @param string $sName = ''
     *
     * @return string
     */
    protected function getTypedPrefix($iType, $sName = '')
    {
        $sName = 0 < \strlen($sName) ? $sName : $this->sName;
        return isset($this->aPrefixes[$iType]) ? $sName.$this->aPrefixes[$iType].': ' : '';
    }

    /**
     * @final
     * @param string $sDesc
     * @param int $iType = \MailSo\Log\Enumerations\Type::INFO
     * @param string $sName = ''
     *
     * @return bool
     */
    final public function Write($sDesc, $iType = \MailSo\Log\Enumerations\Type::INFO, $sName = '')
    {
        $bResult = true;
        if (!$this->bFlushCache && ($this->bWriteOnErrorOnly || $this->bWriteOnPhpErrorOnly || 0 < $this->iWriteOnTimeoutOnly)) {
            $bErrorPhp = false;

            $bError = $this->bWriteOnErrorOnly && \in_array($iType, array(
                \MailSo\Log\Enumerations\Type::NOTICE,
                \MailSo\Log\Enumerations\Type::NOTICE_PHP,
                \MailSo\Log\Enumerations\Type::WARNING,
                \MailSo\Log\Enumerations\Type::WARNING_PHP,
                \MailSo\Log\Enumerations\Type::ERROR,
                \MailSo\Log\Enumerations\Type::ERROR_PHP
            ));

            if (!$bError) {
                $bErrorPhp = $this->bWriteOnPhpErrorOnly && \in_array($iType, array(
                    \MailSo\Log\Enumerations\Type::NOTICE_PHP,
                    \MailSo\Log\Enumerations\Type::WARNING_PHP,
                    \MailSo\Log\Enumerations\Type::ERROR_PHP
                ));
            }

            if ($bError || $bErrorPhp) {
                $sFlush = '--- FlushLogCache: '.($bError ? 'WriteOnErrorOnly' : 'WriteOnPhpErrorOnly');
                if (isset($this->aCache[0]) && empty($this->aCache[0])) {
                    $this->aCache[0] = $sFlush;
                    array_unshift($this->aCache, '');
                } else {
                    array_unshift($this->aCache, $sFlush);
                }

                $this->aCache[] = '--- FlushLogCache: Trigger';
                $this->aCache[] = $this->loggerLineImplementation($this->getTimeWithMicroSec(), $sDesc, $iType, $sName);

                $this->bFlushCache = true;
                $bResult = $this->writeImplementation($this->aCache);
                $this->aCache = array();
            } else {
                $this->aCache[] = $this->loggerLineImplementation($this->getTimeWithMicroSec(), $sDesc, $iType, $sName);
            }
        } else {
            $bResult = $this->writeImplementation(
                $this->loggerLineImplementation($this->getTimeWithMicroSec(), $sDesc, $iType, $sName)
            );
        }

        return $bResult;
    }

    /**
     * @final
     * @return bool
     */
    final public function clear()
    {
        return $this->clearImplementation();
    }

    /**
     * @final
     * @return void
     */
    final public function WriteEmptyLine()
    {
        if (!$this->bFlushCache && ($this->bWriteOnErrorOnly || $this->bWriteOnPhpErrorOnly || 0 < $this->iWriteOnTimeoutOnly)) {
            $this->aCache[] = '';
        } else {
            $this->writeEmptyLineImplementation();
        }
    }
}

• [D] Drivers
• [D] Enumerations
• [F] Driver.php
  Delete
• [F] Logger.php
  Delete