MonologConfiguration.php

<?php

/**
 * Copyright (c) D3 Data Development (Inh. Thomas Dartsch)
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * https://www.d3data.de
 *
 * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
 * @author    D3 Data Development - Daniel Seifert <info@shopmodule.com>
 * @link      https://www.oxidmodule.com
 */

declare(strict_types=1);

namespace D3\OxLogIQ;

use D3\OxLogIQ\Interfaces\MonologConfigurationInterface as OxLogIQConfigurationInterface;
use D3\OxLogIQ\Release\ReleaseServiceInterface;
use InvalidArgumentException;
use Monolog\Logger;
use OxidEsales\Eshop\Application\Model\Shop;
use OxidEsales\Eshop\Core\Config;
use OxidEsales\EshopCommunity\Internal\Container\ContainerFactory;
use OxidEsales\EshopCommunity\Internal\Framework\Logger\Configuration\MonologConfigurationInterface;
use OxidEsales\EshopCommunity\Internal\Transition\Utility\ContextInterface;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;

class MonologConfiguration implements MonologConfigurationInterface, OxLogIQConfigurationInterface
{
    /**
     * @param \OxidEsales\EshopCommunity\Internal\Framework\Logger\Configuration\MonologConfiguration $innerConfig
     * @param \OxidEsales\EshopCommunity\Core\Config $config
     * @param Context $context
     */
    public function __construct(
        protected MonologConfigurationInterface $innerConfig,
        protected Config $config,
        protected ContextInterface $context
    ) {
    }

    public function getLoggerName(): string
    {
        /** @var Shop $shop */
        $shop = $this->config->getActiveShop();

        return implode(
            '|',
            [
                $this->innerConfig->getLoggerName(),
                'shp-'.$shop->getId(),
                $this->getContext(),
            ]
        );
    }

    /**
     * @codeCoverageIgnore
     */
    protected function getContext(): string
    {
        return isAdmin() ? 'backend' : 'frontend';  // @phpstan-ignore function.notFound
    }

    public function getLogFilePath(): string
    {
        return $this->innerConfig->getLogFilePath();
    }

    public function getLogLevel(): string
    {
        // is already validated
        return $this->innerConfig->getLogLevel();
    }

    public function getRetentionDays(): ?int
    {
        return $this->context->getRetentionDays();
    }

    public function useAlertMail(): bool
    {
        return $this->context->useAlertMail() && $this->hasAlertMailRecipient();
    }

    public function hasAlertMailRecipient(): bool
    {
        $recipients = $this->getAlertMailRecipients();

        return is_array($recipients) && count($recipients) > 0;
    }

    /**
     * @return string[]|null
     */
    public function getAlertMailRecipients(): ?array
    {
        return $this->context->getAlertMailRecipients();
    }

    /**
     * @throws InvalidArgumentException
     */
    public function getAlertMailLevel(): string
    {
        $level = strtoupper($this->context->getAlertMailLevel());

        if (!in_array($level, array_keys(Logger::getLevels()), true)) {
            throw new InvalidArgumentException(
                'Mail alerting level must be one of '.implode(', ', array_keys(Logger::getLevels()))
            );
        }

        return $level;
    }

    public function getAlertMailSubject(): string
    {
        return $this->context->getAlertMailSubject();
    }

    public function getAlertMailFrom(): ?string
    {
        return $this->context->getAlertMailFrom();
    }

    /**
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    public function getRelease(): string
    {
        /** @var ReleaseServiceInterface $service */
        $service = ContainerFactory::getInstance()->getContainer()->get(ReleaseServiceInterface::class);
        return $service->getRelease();
    }
}