402 lines
15 KiB
PHP
402 lines
15 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @link http://www.yiiframework.com/
|
||
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
||
|
|
* @license http://www.yiiframework.com/license/
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace yii\log;
|
||
|
|
|
||
|
|
use Yii;
|
||
|
|
use yii\base\Component;
|
||
|
|
use yii\base\InvalidConfigException;
|
||
|
|
use yii\helpers\ArrayHelper;
|
||
|
|
use yii\helpers\StringHelper;
|
||
|
|
use yii\helpers\VarDumper;
|
||
|
|
use yii\web\Request;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Target is the base class for all log target classes.
|
||
|
|
*
|
||
|
|
* A log target object will filter the messages logged by [[Logger]] according
|
||
|
|
* to its [[levels]] and [[categories]] properties. 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 [[except]] to exclude messages of certain categories.
|
||
|
|
*
|
||
|
|
* @property bool $enabled Indicates whether this log target is enabled. Defaults to true. Note that the type
|
||
|
|
* of this property differs in getter and setter. See [[getEnabled()]] and [[setEnabled()]] for details.
|
||
|
|
* @property int $levels The message levels that this target is interested in. This is a bitmap of level
|
||
|
|
* values. Defaults to 0, meaning all available levels. Note that the type of this property differs in getter and
|
||
|
|
* setter. See [[getLevels()]] and [[setLevels()]] for details.
|
||
|
|
*
|
||
|
|
* For more details and usage information on Target, see the [guide article on logging & targets](guide:runtime-logging).
|
||
|
|
*
|
||
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
||
|
|
* @since 2.0
|
||
|
|
*/
|
||
|
|
abstract class Target extends Component
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* @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, 'yii\db\*' will match
|
||
|
|
* categories starting with 'yii\db\', such as 'yii\db\Connection'.
|
||
|
|
*/
|
||
|
|
public $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 [[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, 'yii\db\*' will match
|
||
|
|
* categories starting with 'yii\db\', such as 'yii\db\Connection'.
|
||
|
|
* @see categories
|
||
|
|
*/
|
||
|
|
public $except = [];
|
||
|
|
/**
|
||
|
|
* @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']`.
|
||
|
|
*
|
||
|
|
* Since version 2.0.9 additional syntax can be used:
|
||
|
|
* Each element could 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 \yii\helpers\ArrayHelper::filter()
|
||
|
|
*/
|
||
|
|
public $logVars = [
|
||
|
|
'_GET',
|
||
|
|
'_POST',
|
||
|
|
'_FILES',
|
||
|
|
'_COOKIE',
|
||
|
|
'_SESSION',
|
||
|
|
'_SERVER',
|
||
|
|
];
|
||
|
|
/**
|
||
|
|
* @var array list of the PHP predefined variables that should NOT be logged "as is" and should always be replaced
|
||
|
|
* with a mask `***` before logging, when exist.
|
||
|
|
*
|
||
|
|
* Defaults to `[ '_SERVER.HTTP_AUTHORIZATION', '_SERVER.PHP_AUTH_USER', '_SERVER.PHP_AUTH_PW']`
|
||
|
|
*
|
||
|
|
* Each element could be specified as one of the following:
|
||
|
|
*
|
||
|
|
* - `var` - `var` will be logged as `***`
|
||
|
|
* - `var.key` - only `var[key]` will be logged as `***`
|
||
|
|
*
|
||
|
|
* @since 2.0.16
|
||
|
|
*/
|
||
|
|
public $maskVars = [
|
||
|
|
'_SERVER.HTTP_AUTHORIZATION',
|
||
|
|
'_SERVER.PHP_AUTH_USER',
|
||
|
|
'_SERVER.PHP_AUTH_PW',
|
||
|
|
];
|
||
|
|
/**
|
||
|
|
* @var callable a PHP callable that returns a string to be prefixed to every exported message.
|
||
|
|
*
|
||
|
|
* If not set, [[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)`.
|
||
|
|
*/
|
||
|
|
public $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.
|
||
|
|
*/
|
||
|
|
public $exportInterval = 1000;
|
||
|
|
/**
|
||
|
|
* @var array the messages that are retrieved from the logger so far by this log target.
|
||
|
|
* Please refer to [[Logger::messages]] for the details about the message structure.
|
||
|
|
*/
|
||
|
|
public $messages = [];
|
||
|
|
/**
|
||
|
|
* @var bool whether to log time with microseconds.
|
||
|
|
* Defaults to false.
|
||
|
|
* @since 2.0.13
|
||
|
|
*/
|
||
|
|
public $microtime = false;
|
||
|
|
|
||
|
|
private $_levels = 0;
|
||
|
|
private $_enabled = true;
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Exports log [[messages]] to a specific destination.
|
||
|
|
* Child classes must implement this method.
|
||
|
|
*/
|
||
|
|
abstract public function export();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Processes the given log messages.
|
||
|
|
* This method will filter the given messages with [[levels]] and [[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 [[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($messages, $final)
|
||
|
|
{
|
||
|
|
$this->messages = array_merge($this->messages, static::filterMessages($messages, $this->getLevels(), $this->categories, $this->except));
|
||
|
|
$count = count($this->messages);
|
||
|
|
if ($count > 0 && ($final || $this->exportInterval > 0 && $count >= $this->exportInterval)) {
|
||
|
|
if (($context = $this->getContextMessage()) !== '') {
|
||
|
|
$this->messages[] = [$context, Logger::LEVEL_INFO, 'application', YII_BEGIN_TIME, [], 0];
|
||
|
|
}
|
||
|
|
// 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()
|
||
|
|
{
|
||
|
|
$context = ArrayHelper::filter($GLOBALS, $this->logVars);
|
||
|
|
foreach ($this->maskVars as $var) {
|
||
|
|
if (ArrayHelper::getValue($context, $var) !== null) {
|
||
|
|
ArrayHelper::setValue($context, $var, '***');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$result = [];
|
||
|
|
foreach ($context as $key => $value) {
|
||
|
|
$result[] = "\${$key} = " . VarDumper::dumpAsString($value);
|
||
|
|
}
|
||
|
|
|
||
|
|
return implode("\n\n", $result);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return int the message levels that this target is interested in. This is a bitmap of
|
||
|
|
* level values. Defaults to 0, meaning all available levels.
|
||
|
|
*/
|
||
|
|
public function getLevels()
|
||
|
|
{
|
||
|
|
return $this->_levels;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the message levels that this target is interested in.
|
||
|
|
*
|
||
|
|
* The parameter can be either an array of interested level names or an integer representing
|
||
|
|
* the bitmap of the interested level values. Valid level names include: 'error',
|
||
|
|
* 'warning', 'info', 'trace' and 'profile'; valid level values include:
|
||
|
|
* [[Logger::LEVEL_ERROR]], [[Logger::LEVEL_WARNING]], [[Logger::LEVEL_INFO]],
|
||
|
|
* [[Logger::LEVEL_TRACE]] and [[Logger::LEVEL_PROFILE]].
|
||
|
|
*
|
||
|
|
* For example,
|
||
|
|
*
|
||
|
|
* ```php
|
||
|
|
* ['error', 'warning']
|
||
|
|
* // which is equivalent to:
|
||
|
|
* Logger::LEVEL_ERROR | Logger::LEVEL_WARNING
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @param array|int $levels message levels that this target is interested in.
|
||
|
|
* @throws InvalidConfigException if $levels value is not correct.
|
||
|
|
*/
|
||
|
|
public function setLevels($levels)
|
||
|
|
{
|
||
|
|
static $levelMap = [
|
||
|
|
'error' => Logger::LEVEL_ERROR,
|
||
|
|
'warning' => Logger::LEVEL_WARNING,
|
||
|
|
'info' => Logger::LEVEL_INFO,
|
||
|
|
'trace' => Logger::LEVEL_TRACE,
|
||
|
|
'profile' => Logger::LEVEL_PROFILE,
|
||
|
|
];
|
||
|
|
if (is_array($levels)) {
|
||
|
|
$this->_levels = 0;
|
||
|
|
foreach ($levels as $level) {
|
||
|
|
if (isset($levelMap[$level])) {
|
||
|
|
$this->_levels |= $levelMap[$level];
|
||
|
|
} else {
|
||
|
|
throw new InvalidConfigException("Unrecognized level: $level");
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$bitmapValues = array_reduce($levelMap, function ($carry, $item) {
|
||
|
|
return $carry | $item;
|
||
|
|
});
|
||
|
|
if (!($bitmapValues & $levels) && $levels !== 0) {
|
||
|
|
throw new InvalidConfigException("Incorrect $levels value");
|
||
|
|
}
|
||
|
|
$this->_levels = $levels;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Filters the given messages according to their categories and levels.
|
||
|
|
* @param array $messages messages to be filtered.
|
||
|
|
* The message structure follows that in [[Logger::messages]].
|
||
|
|
* @param int $levels the message levels to filter by. This is a bitmap of
|
||
|
|
* level values. Value 0 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($messages, $levels = 0, $categories = [], $except = [])
|
||
|
|
{
|
||
|
|
foreach ($messages as $i => $message) {
|
||
|
|
if ($levels && !($levels & $message[1])) {
|
||
|
|
unset($messages[$i]);
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
$matched = empty($categories);
|
||
|
|
foreach ($categories as $category) {
|
||
|
|
if ($message[2] === $category || !empty($category) && substr_compare($category, '*', -1, 1) === 0 && strpos($message[2], rtrim($category, '*')) === 0) {
|
||
|
|
$matched = true;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($matched) {
|
||
|
|
foreach ($except as $category) {
|
||
|
|
$prefix = rtrim($category, '*');
|
||
|
|
if (($message[2] === $category || $prefix !== $category) && strpos($message[2], $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 [[Logger::messages]].
|
||
|
|
* @return string the formatted message
|
||
|
|
*/
|
||
|
|
public function formatMessage($message)
|
||
|
|
{
|
||
|
|
list($text, $level, $category, $timestamp) = $message;
|
||
|
|
$level = Logger::getLevelName($level);
|
||
|
|
if (!is_string($text)) {
|
||
|
|
// exceptions may not be serializable if in the call stack somewhere is a Closure
|
||
|
|
if ($text instanceof \Throwable || $text instanceof \Exception) {
|
||
|
|
$text = (string) $text;
|
||
|
|
} else {
|
||
|
|
$text = VarDumper::export($text);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$traces = [];
|
||
|
|
if (isset($message[4])) {
|
||
|
|
foreach ($message[4] 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 [[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 [[Logger::messages]].
|
||
|
|
* @return string the prefix string
|
||
|
|
*/
|
||
|
|
public function getMessagePrefix($message)
|
||
|
|
{
|
||
|
|
if ($this->prefix !== null) {
|
||
|
|
return call_user_func($this->prefix, $message);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (Yii::$app === null) {
|
||
|
|
return '';
|
||
|
|
}
|
||
|
|
|
||
|
|
$request = Yii::$app->getRequest();
|
||
|
|
$ip = $request instanceof Request ? $request->getUserIP() : '-';
|
||
|
|
|
||
|
|
/* @var $user \yii\web\User */
|
||
|
|
$user = Yii::$app->has('user', true) ? Yii::$app->get('user') : null;
|
||
|
|
if ($user && ($identity = $user->getIdentity(false))) {
|
||
|
|
$userID = $identity->getId();
|
||
|
|
} else {
|
||
|
|
$userID = '-';
|
||
|
|
}
|
||
|
|
|
||
|
|
/* @var $session \yii\web\Session */
|
||
|
|
$session = Yii::$app->has('session', true) ? Yii::$app->get('session') : null;
|
||
|
|
$sessionID = $session && $session->getIsActive() ? $session->getId() : '-';
|
||
|
|
|
||
|
|
return "[$ip][$userID][$sessionID]";
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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.
|
||
|
|
* The callable value is available since version 2.0.13.
|
||
|
|
*
|
||
|
|
* 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::$app->user->isGuest;
|
||
|
|
* }
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
public function setEnabled($value)
|
||
|
|
{
|
||
|
|
$this->_enabled = $value;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check whether the log target is enabled.
|
||
|
|
* @property bool Indicates whether this log target is enabled. Defaults to true.
|
||
|
|
* @return bool A value indicating whether this log target is enabled.
|
||
|
|
*/
|
||
|
|
public function getEnabled()
|
||
|
|
{
|
||
|
|
if (is_callable($this->_enabled)) {
|
||
|
|
return call_user_func($this->_enabled, $this);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->_enabled;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns formatted ('Y-m-d H:i:s') timestamp for message.
|
||
|
|
* If [[microtime]] is configured to true it will return format 'Y-m-d H:i:s.u'.
|
||
|
|
* @param float $timestamp
|
||
|
|
* @return string
|
||
|
|
* @since 2.0.13
|
||
|
|
*/
|
||
|
|
protected function getTime($timestamp)
|
||
|
|
{
|
||
|
|
$parts = explode('.', sprintf('%F', $timestamp));
|
||
|
|
|
||
|
|
return date('Y-m-d H:i:s', $parts[0]) . ($this->microtime ? ('.' . $parts[1]) : '');
|
||
|
|
}
|
||
|
|
}
|