icingaweb2/library/Icinga/Application/Logger/Writer/FileWriter.php

<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}

namespace Icinga\Application\Logger\Writer;

use Exception;
use Icinga\Data\ConfigObject;
use Icinga\Application\Logger;
use Icinga\Application\Logger\LogWriter;
use Icinga\Exception\ConfigurationError;
use Icinga\Util\File;

/**
 * Log to a file
 */
class FileWriter extends LogWriter
{
    /**
     * Path to the file
     *
     * @var string
     */
    protected $file;

    /**
     * Create a new file log writer
     *
     * @param   ConfigObject  $config
     *
     * @throws  ConfigurationError  If the configuration directive 'file' is missing or if the path to 'file' does
     *                              not exist or if writing to 'file' is not possible
     */
    public function __construct(ConfigObject $config)
    {
        if ($config->file === null) {
            throw new ConfigurationError('Required logging configuration directive \'file\' missing');
        }
        $this->file = $config->file;

        if (substr($this->file, 0, 6) !== 'php://' && ! file_exists(dirname($this->file))) {
            throw new ConfigurationError(
                'Log path "%s" does not exist',
                dirname($this->file)
            );
        }

        try {
            $this->write(''); // Avoid to handle such errors on every write access
        } catch (Exception $e) {
            throw new ConfigurationError(
                'Cannot write to log file "%s" (%s)',
                $this->file,
                $e->getMessage()
            );
        }
    }

    /**
     * Log a message
     *
     * @param   int     $level      The logging level
     * @param   string  $message    The log message
     */
    public function log($level, $message)
    {
        $this->write(date('c') . ' - ' . Logger::$levels[$level] . ' - ' . $message . PHP_EOL);
    }

    /**
     * Write a message to the log
     *
     * @param string $message
     */
    protected function write($message)
    {
        $file = new File($this->file, 'a');
        $file->fwrite($message);
        $file->fflush();
    }
}