Formatter.php

<?php
/*
    This file is part of Plop, a simple logging library for PHP.

    Copyright © 2010-2014 François Poirotte

    Plop 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.

    Plop 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 Plop.  If not, see <http://www.gnu.org/licenses/>.
*/

namespace Plop;

class Formatter implements \Plop\FormatterInterface
{
    const DEFAULT_FORMAT = '%(message)s';

    const DEFAULT_DATE_FORMAT = "Y-m-d H:i:s,u";

    protected $format;

    protected $dateFormat;

    protected $timezone;

    protected $pythonLike;

    protected $interpolator;

    public function __construct(
        $format = self::DEFAULT_FORMAT,
        $dateFormat = self::DEFAULT_DATE_FORMAT,
        $timezone = null,
        $pythonLike = false,
        \Plop\InterpolatorInterface $interpolator = null
    ) {
        if ($timezone !== null) {
            if (is_string($timezone)) {
                $timezone = new \DateTimeZone($timezone);
            } elseif (!is_object($timezone) || !($timezone instanceof \DateTimeZone)) {
                throw new \Plop\Exception('Invalid timezone');
            }
        }
        if ($interpolator === null) {
            $interpolator = new \Plop\Interpolator\Percent();
        }
        $this->setFormat($format);
        $this->setDateFormat($dateFormat);
        $this->setTimeZone($timezone);
        $this->setPythonLike($pythonLike);
        $this->setInterpolator($interpolator);
    }

    public function getFormat()
    {
        return $this->format;
    }

    public function setFormat($format)
    {
        $this->format = $format;
        return $this;
    }

    public function getDateFormat()
    {
        return $this->dateFormat;
    }

    public function setDateFormat($dateFormat)
    {
        $this->dateFormat = $dateFormat;
        return $this;
    }

    public function getTimezone()
    {
        return $this->timezone;
    }

    public function setTimezone(\DateTimeZone $timezone = null)
    {
        $this->timezone = $timezone;
        return $this;
    }

    public function getPythonLike()
    {
        return $this->pythonLike;
    }

    public function setPythonLike($pythonLike)
    {
        if (!is_bool($pythonLike)) {
            throw new \Plop\Exception('Invalid value');
        }
        $this->pythonLike = $pythonLike;
        return $this;
    }

    public function getInterpolator()
    {
        return $this->interpolator;
    }

    public function setInterpolator(\Plop\InterpolatorInterface $interpolator)
    {
        $this->interpolator = $interpolator;
        return $this;
    }

    public function format(\Plop\RecordInterface $record)
    {
        $record['message'] = $record->getMessage();
        $format = (string) $this->format;
        $dateFormat = (string) $this->dateFormat;
        if (strpos($format, '%(asctime)') !== false) {
            $record['asctime'] = $this->formatTime($record, $dateFormat);
        }

        $s = $this->interpolator->interpolate($format, $record->asArray());
        if ($record['exc_info']) {
            if (!$record['exc_text']) {
                $record['exc_text'] =
                    $this->formatException($record['exc_info']);
            }
        }
        if ($record['exc_text']) {
            $s .= "\n" . $record['exc_text'];
        }
        return $s;
    }

    protected function formatTime(
        \Plop\RecordInterface $record,
        $dateFormat = self::DEFAULT_DATE_FORMAT
    ) {
        $date = clone $record['createdDate'];
        if ($this->timezone !== null) {
            $date->setTimeZone($this->timezone);
        }
        return $date->format((string) $dateFormat);
    }

    protected function formatException(\Exception $exception)
    {
        if (!$this->pythonLike) {
            $s = (string) $exception;
            if (substr($s, -1) == "\n") {
                $s = substr($s, 0, -1);
            }
            return $s;
        }

        $s      = "Traceback (most recent call last):\n";
        $traces = array();
        foreach ($exception->getTrace() as $trace) {
            $origin = '';
            if (isset($trace['class'])) {
                $origin = $trace['class'].$trace['type'];
            }
            if (isset($trace['function'])) {
                $origin .= $trace['function'].'()';
            }
            if ($origin == '') {
                $origin = '???';
            }
            $file = isset($trace['file']) ? $trace['file'] : '{main}';
            $line = isset($trace['line']) ? $trace['line'] : 0;
            $traces[] = "File \"$file\", line $line, in $origin";
        }
        $s .= implode("\n", array_reverse($traces))."\n";
        $s .=   "Exception '" . get_class($exception) .
                "' with message '" . $exception->getMessage() .
                "' in " . $exception->getFile() .
                ":" . $exception->getLine();
        return $s;
    }
}