Yiisoft\Log\Target

Complexity

Total Complexity

51

Size/Duplication

Total Lines	401
Duplicated Lines	0 %

Test Coverage

Coverage

80.17%

Importance

Changes	2
Bugs	0	Features	0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	enable()	0	3	1
A	disable()	0	3	1
A	setTimestampFormat()	0	4	1
A	setMessages()	0	4	1
A	setEnabled()	0	5	1
A	setExcept()	0	4	1
A	getExcept()	0	3	1
A	setExportInterval()	0	4	1
A	getPrefix()	0	3	1
A	getCategories()	0	3	1
C	filterMessages()	0	46	15
A	formatMessage()	0	17	4
A	getLogVars()	0	3	1
A	setPrefix()	0	4	1
A	getMessagePrefix()	0	7	2
A	getExportInterval()	0	3	1
A	getLevels()	0	3	1
A	getMessages()	0	3	1
A	getTime()	0	5	2
A	collect()	0	26	6
A	setLevels()	0	4	1
A	isEnabled()	0	7	2
A	setCategories()	0	4	1
A	setLogVars()	0	4	1
A	getContextMessage()	0	9	2

<?php

declare(strict_types=1);

namespace Yiisoft\Log;

use DateTime;
use Psr\Log\LogLevel;
use Throwable;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\VarDumper\VarDumper;

use function array_merge;
use function count;
use function implode;
use function in_array;
use function is_callable;
use function rtrim;
use function strpos;
use function substr_compare;

/**
 * Target is the base class for all log target classes.
 *
 * A log target object will filter the messages logged by {@see \Yiisoft\Log\Logger} according
 * to its {@see Target::$levels} and {@see Target::$categories}. It may also export the filtered
 * messages to specific destination defined by the target, such as emails, files.
 *
 * Level filter and category filter are combinatorial, i.e., only messages
 * satisfying both filter conditions will be handled. Additionally, you
 * may specify {@see Target::$except} to exclude messages of certain categories.
 *
 * For more details and usage information on Target, see the
 * [guide article on logging & targets](guide:runtime-logging).
 */
abstract class Target
{
    /**
     * @var array list of message categories that this target is interested in.
     * Defaults to empty, meaning all categories.
     * You can use an asterisk at the end of a category so that the category may be used to
     * match those categories sharing the same common prefix. For example, 'Yiisoft\Db\*' will match
     * categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
     */
    private array $categories = [];

    /**
     * @var array list of message categories that this target is NOT interested in.
     * Defaults to empty, meaning no uninteresting messages.
     * If this property is not empty, then any category listed here will be excluded from {@see Target::$categories}.
     * You can use an asterisk at the end of a category so that the category can be used to
     * match those categories sharing the same common prefix. For example, 'Yiisoft\Db\*' will match
     * categories starting with 'Yiisoft\Db\', such as `Yiisoft\Db\Connection`.
     * @see categories
     */
    private array $except = [];

    /**
     * @var array the message levels that this target is interested in.
     *
     * The parameter should be an array of interested level names. See {@see LogLevel} constants for valid level names.
     *
     * For example:
     *
     * ```php
     * ['error', 'warning'],
     * // or
     * [LogLevel::ERROR, LogLevel::WARNING]
     * ```
     *
     * Defaults is empty array, meaning all available levels.
     */
    private array $levels = [];

    /**
     * @var array list of the PHP predefined variables that should be logged in a message.
     * Note that a variable must be accessible via `$GLOBALS`. Otherwise it won't be logged.
     *
     * Defaults to `['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER']`.
     *
     * Each element can also be specified as one of the following:
     *
     * - `var` - `var` will be logged.
     * - `var.key` - only `var[key]` key will be logged.
     * - `!var.key` - `var[key]` key will be excluded.
     *
     * Note that if you need $_SESSION to logged regardless if session was used you have to open it right at
     * the start of your request.
     *
     * @see \Yiisoft\Arrays\ArrayHelper::filter()
     */
    private array $logVars = ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER'];

    /**
     * @var callable|null a PHP callable that returns a string to be prefixed to every exported message.
     *
     * If not set, {@see Target::getMessagePrefix()} will be used, which prefixes the message with context information
     * such as user IP, user ID and session ID.
     *
     * The signature of the callable should be `function ($message)`.
     */
    private $prefix;

    /**
     * @var int how many messages should be accumulated before they are exported.
     * Defaults to 1000. Note that messages will always be exported when the application terminates.
     * Set this property to be 0 if you don't want to export messages until the application terminates.
     */
    private int $exportInterval = 1000;

    /**
     * @var array the messages that are retrieved from the logger so far by this log target.
     * Please refer to {@see Logger::$messages} for the details about the message structure.
     */
    private array $messages = [];

    /**
     * @var string The date format for the log timestamp.
     * Defaults to Y-m-d H:i:s.u
     */
    private string $timestampFormat = 'Y-m-d H:i:s.u';


    /**
     * @var bool|callable
     */
    private $enabled = true;

    /**
     * Exports log {@see Target::$messages} to a specific destination.
     * Child classes must implement this method.
     */
    abstract public function export(): void;

    /**
     * Processes the given log messages.
     * This method will filter the given messages with {@see Target::$levels} and {@see Target::$categories}.
     * And if requested, it will also export the filtering result to specific medium (e.g. email).
     * @param array $messages log messages to be processed. See {@see Logger::$messages} for the structure
     * of each message.
     * @param bool $final whether this method is called at the end of the current application
     */
    public function collect(array $messages, bool $final): void
    {
        $this->messages = array_merge(
            $this->messages,
            static::filterMessages($messages, $this->levels, $this->categories, $this->except)
        );

        $count = count($this->messages);
        if ($count > 0 && ($final || ($this->exportInterval > 0 && $count >= $this->exportInterval))) {
            if (($context = $this->getContextMessage()) !== '') {
                $this->messages[] = [
                    LogLevel::INFO,
                    $context,
                    [
                        'category' => 'application',
                        'time' => $_SERVER['REQUEST_TIME_FLOAT']
                    ]
                ];
            }
            // set exportInterval to 0 to avoid triggering export again while exporting
            $oldExportInterval = $this->exportInterval;
            $this->exportInterval = 0;
            $this->export();
            $this->exportInterval = $oldExportInterval;

            $this->messages = [];
        }
    }

    /**
     * Generates the context information to be logged.
     * The default implementation will dump user information, system variables, etc.
     * @return string the context information. If an empty string, it means no context information.
     */
    protected function getContextMessage(): string
    {
        $context = ArrayHelper::filter($GLOBALS, $this->logVars);
        $result = [];
        foreach ($context as $key => $value) {
            $result[] = "\${$key} = " . VarDumper::create($value)->asString();
        }

        return implode("\n\n", $result);
    }

    /**
     * Filters the given messages according to their categories and levels.
     * @param array $messages messages to be filtered.
     * The message structure follows that in {@see Logger::$messages}.
     * @param array $levels the message levels to filter by. Empty value means allowing all levels.
     * @param array $categories the message categories to filter by. If empty, it means all categories are allowed.
     * @param array $except the message categories to exclude. If empty, it means all categories are allowed.
     * @return array the filtered messages.
     */
    public static function filterMessages(
        array $messages,
        array $levels = [],
        array $categories = [],
        array $except = []
    ): array {
        foreach ($messages as $i => $message) {
            if (!empty($levels) && !in_array($message[0], $levels, true)) {
                unset($messages[$i]);
                continue;
            }

            $matched = empty($categories);
            foreach ($categories as $category) {
                if (
                    $message[2]['category'] === $category
                    || (
                        !empty($category)
                        && substr_compare($category, '*', -1, 1) === 0
                        && strpos($message[2]['category'], rtrim($category, '*')) === 0
                    )
                ) {
                    $matched = true;
                    break;
                }
            }

            if ($matched) {
                foreach ($except as $category) {
                    $prefix = rtrim($category, '*');
                    if (
                        ($message[2]['category'] === $category || $prefix !== $category)
                        && strpos($message[2]['category'], $prefix) === 0
                    ) {
                        $matched = false;
                        break;
                    }
                }
            }

            if (!$matched) {
                unset($messages[$i]);
            }
        }

        return $messages;
    }

    /**
     * Formats a log message for display as a string.
     * @param array $message the log message to be formatted.
     * The message structure follows that in {@see Logger::$messages}.
     * @return string the formatted message
     * @throws Throwable
     */
    public function formatMessage(array $message): string
    {
        [$level, $text, $context] = $message;
        $category = $context['category'];
        $timestamp = $context['time'];
        $level = Logger::getLevelName($level);
        $traces = [];
        if (isset($context['trace'])) {
            foreach ($context['trace'] as $trace) {
                $traces[] = "in {$trace['file']}:{$trace['line']}";
            }
        }

        $prefix = $this->getMessagePrefix($message);

        return $this->getTime($timestamp) . " {$prefix}[$level][$category] $text"
            . (empty($traces) ? '' : "\n    " . implode("\n    ", $traces));
    }

    /**
     * Returns a string to be prefixed to the given message.
     * If {@see Target::$prefix} is configured it will return the result of the callback.
     * The default implementation will return user IP, user ID and session ID as a prefix.
     * @param array $message the message being exported.
     * The message structure follows that in {@see Logger::$messages}.
     * @return string the prefix string
     * @throws Throwable
     */
    public function getMessagePrefix(array $message): string
    {
        if ($this->prefix !== null) {
            return ($this->prefix)($message);
        }

        return '';
    }

    /**
     * Sets a value indicating whether this log target is enabled.
     * @param bool|callable $value a boolean value or a callable to obtain the value from.
     *
     * A callable may be used to determine whether the log target should be enabled in a dynamic way.
     * For example, to only enable a log if the current user is logged in you can configure the target
     * as follows:
     *
     * ```php
     * 'enabled' => function() {
     *     return !Yii::getApp()->user->isGuest;
     * }
     * ```
     * @return $this
     */
    public function setEnabled($value): self
    {
        $this->enabled = $value;

        return $this;
    }

    /**
     * Enables the log target
     *
     * @return $this
     */
    public function enable(): self
    {
        return $this->setEnabled(true);
    }

    /**
     * Disables the log target
     *
     * @return $this
     */
    public function disable(): self
    {
        return $this->setEnabled(false);
    }

    /**
     * Check whether the log target is enabled.
     * @return bool A value indicating whether this log target is enabled.
     */
    public function isEnabled(): bool
    {
        if (is_callable($this->enabled)) {
            return ($this->enabled)($this);
        }

        return $this->enabled;

The expression return $this->enabled could return the type callable which is incompatible with the type-hinted return boolean. Consider adding an additional type-check to rule them out.

    }

    /**
     * Returns formatted timestamp for message, according to {@see Target::$timestampFormat}
     * @param float|int $timestamp
     * @return string
     */
    protected function getTime($timestamp): string
    {
        $timestamp = (string) $timestamp;
        $format = strpos($timestamp, '.') === false ? 'U' : 'U.u';
        return DateTime::createFromFormat($format, $timestamp)->format($this->timestampFormat);
    }

    public function setLogVars(array $logVars): self
    {
        $this->logVars = $logVars;
        return $this;
    }

    public function getLogVars(): array
    {
        return $this->logVars;
    }

    public function setTimestampFormat(string $format): self
    {
        $this->timestampFormat = $format;
        return $this;
    }

    public function getCategories(): array
    {
        return $this->categories;
    }

    public function setCategories(array $categories): self
    {
        $this->categories = $categories;
        return $this;
    }

    public function getExcept(): array
    {
        return $this->except;
    }

    public function setExcept(array $except): self
    {
        $this->except = $except;
        return $this;
    }

    public function getLevels(): array
    {
        return $this->levels;
    }

    public function setLevels(array $levels): self
    {
        $this->levels = $levels;
        return $this;
    }

    public function getPrefix(): ?callable
    {
        return $this->prefix;
    }

    public function setPrefix(callable $prefix): self
    {
        $this->prefix = $prefix;
        return $this;
    }

    public function getExportInterval(): int
    {
        return $this->exportInterval;
    }

    public function setExportInterval(int $exportInterval): self
    {
        $this->exportInterval = $exportInterval;
        return $this;
    }

    public function getMessages(): array
    {
        return $this->messages;
    }

    public function setMessages(array $messages): self
    {
        $this->messages = $messages;
        return $this;
    }
}