Logger.php

Go to the documentation of this file.

<?php
namespace Elgg;

class Logger {

    const OFF = 0;
    const ERROR = 400;
    const WARNING = 300;
    const NOTICE = 250;
    const INFO = 200;

    protected static $levels = array(
        0 => 'OFF',
        200 => 'INFO',
        250 => 'NOTICE',
        300 => 'WARNING',
        400 => 'ERROR',
    );

    protected $level = self::ERROR;

    protected $display = false;

    protected $hooks;

    private $config;

    private $context;

    private $disabled_stack;

    public function __construct(PluginHooksService $hooks, Config $config, Context $context) {
        $this->config = $config;
        $this->hooks = $hooks;
        $this->context = $context;
    }

    public function setLevel($level) {
        // @todo Elgg has used string constants for logging levels
        if (is_string($level)) {
            $levelStringsToInts = array_flip(self::$levels);
            $level = $levelStringsToInts[$level];
        }
        $this->level = $level;
    }

    public function getLevel() {
        return $this->level;
    }

    public function setDisplay($display) {
        $this->display = $display;
    }

    public function log($message, $level = self::NOTICE) {
        if ($this->disabled_stack) {
            // capture to top of stack
            end($this->disabled_stack);
            $key = key($this->disabled_stack);
            $this->disabled_stack[$key][] = [
                'message' => $message,
                'level' => $level,
            ];
        }

        if ($this->level == self::OFF || $level < $this->level) {
            return false;
        }

        if (!array_key_exists($level, self::$levels)) {
            return false;
        }

        // when capturing, still use consistent return value
        if ($this->disabled_stack) {
            return true;
        }

        $levelString = self::$levels[$level];

        // notices and below never displayed to user
        $display = $this->display && $level > self::NOTICE;

        $this->process("$levelString: $message", $display, $level);

        return true;
    }

    public function error($message) {
        return $this->log($message, self::ERROR);
    }

    public function warn($message) {
        return $this->log($message, self::WARNING);
    }

    public function notice($message) {
        return $this->log($message, self::NOTICE);
    }

    public function info($message) {
        return $this->log($message, self::INFO);
    }

    public function dump($data, $display = true) {
        $this->process($data, $display, self::ERROR);
    }

    protected function process($data, $display, $level) {
        

        // plugin can return false to stop the default logging method
        $params = array(
            'level' => $level,
            'msg' => $data,
            'display' => $display,
            'to_screen' => $display,
        );

        if (!$this->hooks->trigger('debug', 'log', $params, true)) {
            return;
        }

        // Do not want to write to screen before page creation has started.
        // This is not fool-proof but probably fixes 95% of the cases when logging
        // results in data sent to the browser before the page is begun.
        if (!isset($GLOBALS['_ELGG']->pagesetupdone)) {
            $display = false;
        }

        // Do not want to write to JS or CSS pages
        if ($this->context->contains('js') || $this->context->contains('css')) {
            $display = false;
        }

        // don't display in simplecache requests
        $path = substr(current_page_url(), strlen(elgg_get_site_url()));
        if (preg_match('~^(cache|action|serve-file)/~', $path)) {
            $display = false;
        }

        if ($display == true) {
            echo '<pre class="elgg-logger-data">';
            echo htmlspecialchars(print_r($data, true), ENT_QUOTES, 'UTF-8');
            echo '</pre>';
        }
        
        error_log(print_r($data, true));
    }

    public function disable() {
        $this->disabled_stack[] = [];
    }

    public function enable() {
        return array_pop($this->disabled_stack);
    }

    public function setHooks(PluginHooksService $hooks) {
        $this->hooks = $hooks;
        $this->hooks->setLogger($this);
    }
}