sysPass/inc/SP/Log/ActionLog.class.php

<?php
/**
 * sysPass
 *
 * @author    nuxsmin
 * @link      http://syspass.org
 * @copyright 2012-2015 Rubén Domínguez nuxsmin@syspass.org
 *
 * This file is part of sysPass.
 *
 * sysPass 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.
 *
 * sysPass 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 sysPass.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace SP\Log;
use SP\Html\Html;

/**
 * Clase abstracta ActionLog para la gestión de mensajes de eventos
 *
 * @package SP
 */
abstract class ActionLog extends LogLevel
{
    /**
     * Constante de nueva línea para descripciones
     */
    const NEWLINE_TXT = PHP_EOL;
    /**
     * Constante de nueva línea para descriciones en formato HTML
     */
    const NEWLINE_HTML = '<br>';
    /**
     * Acción realizada
     *
     * @var string
     */
    protected $action = __CLASS__;
    /**
     * Detalles de la acción
     *
     * @var array
     */
    protected $description;
    /**
     * Formato de nueva línea en HTML
     *
     * @var bool
     */
    protected $newLineHtml = false;
    /**
     * @var string
     */
    protected $logLevel = '';
    /**
     * @var array
     */
    protected $details;

    /**
     * Contructor
     *
     * @param string $action      La acción realizada
     * @param string $description La descripción de la acción realizada
     * @param string $level       El nivel del mensaje
     */
    public function __construct($action = null, $description = null, $level = Log::INFO)
    {
        if (null !== $action) {
            $this->setAction($action);
        }

        if (null !== $description) {
            $this->addDescription($description);
        }

        $this->logLevel = $level;
    }

    /**
     * Establece la descripción de la acción realizada
     *
     * @param string $description
     */
    public function addDescription($description = '')
    {
        $this->description[] = $this->formatString($description);
    }

    /**
     * Establece la descripción de la acción realizada en formato HTML
     *
     * @param string $description
     */
    public function addDescriptionHtml($description = '')
    {
        $this->addDescription(Html::strongText($description));
    }

    /**
     * Añadir una línea en blanco a la descripción
     */
    public function addDescriptionLine()
    {
        $this->description[] = '';
    }

    /**
     * Formatear una cadena para guardarla en el registro
     *
     * @param $string string La cadena a formatear
     * @return string
     */
    private function formatString($string)
    {
        return strip_tags(utf8_encode($string));
    }

    /**
     * @return string
     */
    public function getLogLevel()
    {
        return strtoupper($this->logLevel);
    }

    /**
     * @param string $logLevel
     */
    public function setLogLevel($logLevel)
    {
        $this->logLevel = $logLevel;
    }

    /**
     * Devuelve los detalles de la acción realizada
     *
     * @return string
     */
    public function getDetails()
    {
        if (null === $this->details) {
            return '';
        }

        if (count($this->details) > 1) {
            $newline = ($this->newLineHtml === false) ? PHP_EOL : self::NEWLINE_HTML;

            return implode($newline, $this->details);
        }

        return $this->details[0];
    }

    /**
     * Devuelve la acción realizada
     *
     * @return string
     */
    public function getAction()
    {
        return $this->action;
    }

    /**
     * Establece la acción realizada
     *
     * @param string $action
     */
    public function setAction($action)
    {
        $this->action = $this->formatString($action);
    }

    /**
     * Devuelve la descripción de la acción realizada
     *
     * @return string
     */
    public function getDescription()
    {
        if (null === $this->description) {
            return '';
        }

        if (count($this->description) > 1) {
            $newline = ($this->newLineHtml === false) ? PHP_EOL : self::NEWLINE_HTML;

            return implode($newline, $this->description);
        }

        return $this->description[0];
    }

    /**
     * Establece los detalles de la acción realizada
     *
     * @param $key   string
     * @param $value string
     */
    public function addDetails($key, $value)
    {
        $this->details[] = sprintf('%s: %s', $this->formatString($key), $this->formatString($value));
    }

    /**
     * Añadir detalle en formato HTML. Se resalta el texto clave.
     *
     * @param $key string
     * @param $value string
     */
    public function addDetailsHtml($key, $value)
    {
        $this->addDetails(Html::strongText($key), $value);
    }

    /**
     * Establecer el formato de nueva línea a HTML
     *
     * @param $bool bool
     */
    public function setNewLineHtml($bool)
    {
        $this->newLineHtml = $bool;
    }

    /**
     * Restablecer la variable de descripcion
     */
    public function resetDescription()
    {
        $this->description = null;
    }
}