1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: <?php
namespace VSP\Modules;
defined( 'ABSPATH' ) || exit;
use Exception;
/**
* Class VSP_Logger
*
* @author Varun Sridharan <varunsridharan23@gmail.com>
*/
class Logger implements \VSP\Core\Interfaces\Logger {
/**
* Stores registered log handlers.
*
* @var array
*/
protected $handlers;
/**
* Minimum log level this handler will process.
*
* @var int Integer representation of minimum log level to handle.
*/
protected $threshold;
/**
* Constructor for the logger.
*
* @param array $handlers Optional. Array of log handlers. If $handlers is not provided,
* the filter 'vsp_register_log_handlers' will be used to define the handlers.
* If $handlers is provided, the filter will not be applied and the handlers will be
* used directly.
* @param string $threshold Optional. Define an explicit threshold. May be configured
* via VSP_LOG_THRESHOLD. By default, all logs will be processed.
*/
public function __construct( $handlers = null, $threshold = null ) {
if ( null === $handlers ) {
$handlers = apply_filters( 'vsp/log/register/handlers', array() );
}
$register_handlers = array();
if ( ! empty( $handlers ) && is_array( $handlers ) ) {
foreach ( $handlers as $handler ) {
$implements = class_implements( $handler );
if ( is_object( $handler ) && is_array( $implements ) && in_array( 'VSP\Core\Interfaces\Log_Handler', $implements, true ) ) {
$register_handlers[] = $handler;
} else {
/* translators: 1: class name 2: VSP_Log_Handler_Interface */
vsp_doing_it_wrong( __METHOD__, sprintf( esc_html__( 'The provided handler %1$s does not implement %2$s.', 'vsp-framework' ), '<code>' . esc_html( is_object( $handler ) ? get_class( $handler ) : $handler ) . '</code>', '<code>VSP\Core\Interfaces\Log_Handler</code>' ), '3.0' );
}
}
}
if ( null !== $threshold ) {
$threshold = Logger\Levels::get_level_severity( $threshold );
} elseif ( defined( 'VSP_LOG_THRESHOLD' ) && Logger\Levels::is_valid_level( VSP_LOG_THRESHOLD ) ) {
$threshold = Logger\Levels::get_level_severity( VSP_LOG_THRESHOLD );
} else {
$threshold = null;
}
$this->handlers = $register_handlers;
$this->threshold = $threshold;
register_shutdown_function( array( $this, 'log_errors' ) );
}
/**
* Ensures fatal errors are logged so they can be picked up in the status report.
*/
public function log_errors() {
$error = error_get_last();
if ( E_ERROR === $error['type'] ) {
vsp_log_msg( esc_html__( 'File & Line No :', 'vsp-framework' ) . $error['file'] . '-' . $error['line'], 'critical', false, array(
'source' => 'fatal-errors',
) );
vsp_log_msg( $error['message'], 'critical', false, array(
'source' => 'fatal-errors',
) );
}
}
/**
* Adds a critical level message.
*
* Critical conditions.
* Example: Application component unavailable, unexpected exception.
*
* @param string $message
* @param array $context
*
* @return $this
*/
public function critical( $message, $context = array() ) {
$this->log( Logger\Levels::CRITICAL, $message, $context );
return $this;
}
/**
* Add a log entry.
*
* @param string $level One of the following:
* 'emergency': System is unusable.
* 'alert': Action must be taken immediately.
* 'critical': Critical conditions.
* 'error': Error conditions.
* 'warning': Warning conditions.
* 'notice': Normal but significant condition.
* 'info': Informational messages.
* 'debug': Debug-level messages.
* @param string|array $message Log message.
* @param array $context Optional. Additional information for log handlers.
*
* @return $this
*/
public function log( $level, $message, $context = array() ) {
try {
if ( ! Logger\Levels::is_valid_level( $level ) ) {
/* translators: 1: VSP_Logger::log 2: level */
vsp_doing_it_wrong( __METHOD__, sprintf( esc_html__( '%1$s was called with an invalid level "%2$s".', 'vsp-framework' ), '<code>VSP_Logger::log</code>', $level ), '3.0' );
}
if ( $this->should_handle( $level ) ) {
$timestamp = current_time( 'timestamp' );
$message = apply_filters( 'vsp/log/message', $message, $level, $context );
if ( is_array( $message ) ) {
$message = implode( PHP_EOL, $message );
}
foreach ( $this->handlers as $handler ) {
$handler->handle( $timestamp, $level, $message, $context );
}
}
} catch ( Exception$exception ) {
}
return $this;
}
/**
* Determine whether to handle or ignore log.
*
* @param string $level emergency|alert|critical|error|warning|notice|info|debug
*
* @return bool True if the log should be handled.
*/
protected function should_handle( $level ) {
if ( null === $this->threshold ) {
return true;
}
return $this->threshold <= Logger\Levels::get_level_severity( $level );
}
/**
* Adds an emergency level message.
*
* System is unusable.
*
* @param string|array $message
* @param array $context
*
* @return $this
*/
public function emergency( $message, $context = array() ) {
$this->log( Logger\Levels::EMERGENCY, $message, $context );
return $this;
}
/**
* Adds an alert level message.
*
* Action must be taken immediately.
* Example: Entire website down, database unavailable, etc.
*
* @param string|array $message
* @param array $context
*
* @return $this
*/
public function alert( $message, $context = array() ) {
$this->log( Logger\Levels::ALERT, $message, $context );
return $this;
}
/**
* Adds an error level message.
*
* Runtime errors that do not require immediate action but should typically be logged
* and monitored.
*
* @param string|array $message
* @param array $context
*
* @return $this
*/
public function error( $message, $context = array() ) {
$this->log( Logger\Levels::ERROR, $message, $context );
return $this;
}
/**
* Adds a warning level message.
*
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things that are not
* necessarily wrong.
*
* @param string|array $message
* @param array $context
*
* @return $this
*/
public function warning( $message, $context = array() ) {
$this->log( Logger\Levels::WARNING, $message, $context );
return $this;
}
/**
* Adds a notice level message.
*
* Normal but significant events.
*
* @param string|array $message
* @param array $context
*
* @return $this
*/
public function notice( $message, $context = array() ) {
$this->log( Logger\Levels::NOTICE, $message, $context );
return $this;
}
/**
* Adds a info level message.
*
* Interesting events.
* Example: User logs in, SQL logs.
*
* @param string|array $message
* @param array $context
*
* @return $this
*/
public function info( $message, $context = array() ) {
$this->log( Logger\Levels::INFO, $message, $context );
return $this;
}
/**
* Adds a debug level message.
*
* Detailed debug information.
*
* @param string|array $message
* @param array $context
*
* @return $this
*/
public function debug( $message, $context = array() ) {
$this->log( Logger\Levels::DEBUG, $message, $context );
return $this;
}
}