Log.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred;

class Log extends Component{

  const CUSTOM = 10; //!< Everything above this is only logged when exactly matched.
  const EMERGENCY = 7; //!< System is unusable.
  const ALERT = 6; //!< Action must be taken immediately.
  const CRITICAL = 5; //!< Critical conditions.
  const ERROR = 4; //!< Error conditions.
  const WARNING = 3; //!< Warning conditions.
  const NOTICE = 2; //!< Normal, but significant, condition.
  const INFO = 1; //!< Informational message.
  const DEBUG = 0; //!< Debug-level message.

  public $handlers = []; //!< Array with handlers (key = name, value = config).
  public $ignore = []; //!< Reg-exp's for concatination of IP + '#' + user agent + '#' + filename + '#' + message to ignore.
  public $break = null; //!< Reg-exp for message to throw an Exception on.

  protected $_busy = false;
  protected $_timers = [];

  protected function init(){
    parent::init();
    foreach($this->handlers as &$config){
      if(!$config) $config = [];
      $prio = $config['prio'] ?? null;
      if(!array_key_exists('prios',$config) || ($prio !== null))
        $config['prios'] = array_merge($config['prios'] ?? [],range($prio ?: self::DEBUG,self::CUSTOM - 1));
    }
    unset($config);
  }
  /**
   * Get a handler.
   * @param string $name  Name of the handler.
   * @return Log\\Handler
   */
  public function handler($name){
    if(!is_array($this->handlers[$name])) $this->handlers[$name] = [];
    if(!array_key_exists(null,$config =& $this->handlers[$name])){
      $class_name = \Rsi\Record::get($config,'className',__CLASS__ . '\\Handler\\' . ucfirst($name));
      $config[null] = new $class_name($this,$config,$name);
    }
    return $config[null];
  }
  /**
   * Check if the log has a specific handler.
   * @param string $name  Name of the handler.
   * @return bool  True if the log has the specified handler.
   */
  public function has($name){
    return array_key_exists($name,$this->handlers) ? $this->handler($name) : false;
  }

  protected function context($filename,$line_no,$context){
    return is_array($filename)
      ? $filename
      : array_merge(array_filter(['*filename' => $filename,'*lineNo' => $line_no]),$context ?: []);
  }
  /**
   * Add a message to the log.
   * @param int $prio  Priority of the message. Only if this priority surpasses a handlers minimum priority, the message is
   *   processed by the handler.
   * @param string|Exception $message  Message to add (if this is an Exception all other parameters will be derived from it).
   * @param string|array $filename  File from which the message originated (or context when no specific file).
   * @param int $line_no  Line from which the message originated.
   * @param array $context  Context for the message. If a key is prefixed with an '@' the value has to be a callback function
   *   that returns the real value. This is only done (once) when the message is processed by a handler.
   */
  public function add($prio,$message,$filename = null,$line_no = null,$context = null){
    if($this->break && preg_match($this->break,$message)) throw new \Exception('[break]');
    if(!$this->_busy) try{
      $this->_busy = true;
      $parsed = null;
      foreach($this->handlers as $name => $config) if(in_array($prio,$config['prios'])) try{
        if($parsed === null){
          $parsed = [];
          if($message instanceof \Exception){
            $context = ($filename ?: []) + ['trace' => $message->getTraceAsString()];
            $filename = $message->getFile();
            $line_no = $message->getLine();
            $message = $message->getMessage();
          }
          if($this->ignore){
            $subject = implode('#',[
              \Rsi\Record::get($context,'remoteAddr') ?: $this->component('security')->remoteAddr,
              $_SERVER['HTTP_USER_AGENT'] ?? null,
              is_string($filename) ? $filename : null,
              $message
            ]);
            foreach($this->ignore as $filter) if(preg_match($filter,$subject)) return false;
          }
          foreach($this->context($filename,$line_no,$context) as $key => $value){
            if(substr($key,0,1) == '@') $value = call_user_func($value,$key = substr($key,1));
            $parsed[$key] = $value;
          }
        }
        $this->handler($name)->add($prio,$message,$parsed);
      }
      catch(\Rsi\Fred\Exception $e){
        if($this->_fred->debug) throw $e;
      }
    }
    finally{
      $this->_busy = false;
    }
  }
  /**
   * Add a timer start message to the log.
   * @param int $prio  See add().
   * @param string|Exception $message  See add().
   * @param string|array $filename  See add().
   * @param int $line_no  See add().
   * @param array $context  See add().
   * @return string  Timer id.
   */
  public function start($prio,$message,$filename = null,$line_no = null,$context = null){
    $context = $this->context($filename,$line_no,$context);
    $this->_timers[$id = \Rsi\Str::random()] = compact('prio','message','context');
    $this->add($prio,$message,['*start' => $id] + $context);
    return $id;
  }
  /**
   * Stop a timer message.
   * Empty parameters are copied from the start message.
   * @param string $id  Timer id.
   * @param int $prio  See add().
   * @param string $message  See add().
   * @param string|array $filename  See add().
   * @param int $line_no  See add().
   * @param array $context  See add().
   */
  public function stop($id,$prio = null,$message = null,$filename = null,$line_no = null,$context = null){
    $timer = $this->_timers[$id] ?? [];
    $this->add(
      $prio === null ? $timer['prio'] ?? self::DEBUG : $prio,
      $message === null ? '[stop] ' . ($timer['message'] ?? null) : $message,
      ['*stop' => $id] + (($filename === null) && ($line_no === null) && ($context === null)
        ? $timer['context'] ?? []
        : $this->context($filename,$line_no,$context)
      )
    );
  }

  protected function _get($key){
    return $this->handler($key);
  }

  public function __call($func_name,$params){
    array_unshift($params,constant('self::' . strtoupper($func_name)));
    call_user_func_array([$this,'add'],$params);
  }

  public function __invoke($message,$filename = null,$line_no = null,$context = null){
    $this->add(self::DEBUG,$message,$filename,$line_no,$context);
  }

}