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: 

<?php
namespace Nethgui\Log;

/*
 * Copyright (C) 2011 Nethesis S.r.l.
 * 
 * This script is part of NethServer.
 * 
 * NethServer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * NethServer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with NethServer.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Provides message formatting capabilities without specify the log message destination
 *
 * @api
 * @since 1.0
 * @author Davide Principi <davide.principi@nethesis.it>
 */
abstract class AbstractLog implements LogInterface, \Nethgui\Utility\PhpConsumerInterface
{

    /**
     * Implementors must send the given message and level strings to the log facility
     *
     * @api
     * @param string $level
     * @param string $message
     * @return AbstractLog
     */
    abstract protected function message($level, $message);
    /**
     * @var \Nethgui\Utility\PhpWrapper
     */
    protected $phpWrapper;
    private $level;
    protected static $emitted = array();

    /**
     * @see setLevel()
     * @param integer $level
     */
    public function __construct($level = E_ALL)
    {
        $this->level = $level;
        $this->phpWrapper = new \Nethgui\Utility\PhpWrapper();
    }

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

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

    public function exception(\Exception $ex, $stackTrace = FALSE)
    {
        if (($this->level & E_ERROR) === 0) {
            return $this;
        }

        $message = sprintf('%s %s: %s (in %s:%d)', get_class($ex), $ex->getCode(),
            $ex->getMessage(), $ex->getFile(), $ex->getLine());
        $this->message(__FUNCTION__, $message);

        if ($stackTrace) {
            foreach (explode("\n", $ex->getTraceAsString()) as $line) {
                $this->message(__FUNCTION__, $line);
            }
        }

        return $this;
    }

    public function notice($message)
    {
        if (($this->level & E_NOTICE) === 0) {
            return $this;
        }

        $this->message(__FUNCTION__, $message);
        return $this;
    }

    public function error($message)
    {
        if (($this->level & E_ERROR) === 0) {
            return $this;
        }

        $this->message(__FUNCTION__, $message);
        return $this;
    }

    public function warning($message)
    {
        if (($this->level & E_WARNING) === 0) {
            return $this;
        }

        $this->message(__FUNCTION__, $message);
        return $this;
    }

    public function deprecated($message = "%s: method %s is DEPRECATED!")
    {
        if( ! NETHGUI_DEBUG) {
            return $this;
        }
        $backtrace = debug_backtrace();
        $caller = $backtrace[2];
        $callee = $backtrace[1];
        $calleeInfo = isset($callee['class'], $callee['function']) ? ($callee['class'] . '::' . $callee['function'] . '()') : '[no callee infos]';
        $callerInfo = isset($caller['class'], $caller['function']) ? ($caller['class'] . '::' . $caller['function'] . '()') : '[no caller infos]';
        if ( ! isset(static::$emitted[$callerInfo])) {
            $this->warning(sprintf($message, $callerInfo, $calleeInfo));
            static::$emitted[$callerInfo] = TRUE;
        }
        return $this;
    }

    public function setPhpWrapper(\Nethgui\Utility\PhpWrapper $object)
    {
        $this->phpWrapper = $object;
        return $this;
    }

}