FileWriter.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Log\Writer;
 
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Log\Exception\InvalidLogWriterConfigurationException;
use ‪TYPO3\CMS\Core\Log\LogRecord;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
class ‪FileWriter extends ‪AbstractWriter
{
    protected string ‪$logFile = '';
 
    protected string ‪$logFileInfix = '';
 
    protected string ‪$defaultLogFileTemplate = '/log/typo3_%s.log';
 
    protected static array ‪$logFileHandles = [];
 
    protected static array ‪$logFileHandlesCount = [];
 
    public function ‪__construct(array $options = [])
    {
        // the parent constructor reads $options and sets them
        parent::__construct($options);
        if (empty($options['logFile']) &&
            // omit logging if TYPO3 has not been configured (avoid creating a guessable filename)
            (‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] ?? '') !== ''
        ) {
            $this->‪setLogFile($this->‪getDefaultLogFileName());
        }
    }
 
    public function ‪__destruct()
    {
        if ($this->logFile === '') {
            return;
        }
        self::$logFileHandlesCount[‪$this->logFile]--;
        if (self::$logFileHandlesCount[$this->logFile] <= 0) {
            $this->‪closeLogFile();
        }
    }
 
    public function ‪setLogFileInfix(string $infix)
    {
        $this->logFileInfix = $infix;
    }
 
    public function ‪setLogFile(string $relativeLogFile)
    {
        ‪$logFile = $relativeLogFile;
        // Skip handling if logFile is a stream resource. This is used by unit tests with vfs:// directories
        if (!‪PathUtility::hasProtocolAndScheme(‪$logFile) && !‪PathUtility::isAbsolutePath(‪$logFile)) {
            ‪$logFile = GeneralUtility::getFileAbsFileName(‪$logFile);
            if (empty(‪$logFile)) {
                throw new ‪InvalidLogWriterConfigurationException(
                    'Log file path "' . $relativeLogFile . '" is not valid!',
                    1444374805
                );
            }
        }
        $this->logFile = ‪$logFile;
        $this->‪openLogFile();
 
        return $this;
    }
 
    public function ‪getLogFile(): string
    {
        return ‪$this->logFile;
    }
 
    public function ‪writeLog(‪LogRecord $record)
    {
        if ($this->logFile === '') {
            return $this;
        }
 
        $data = '';
        $context = $record->‪getData();
        $message = $record->‪getMessage();
        if (!empty($context)) {
            // Fold an exception into the message, and string-ify it into context so it can be jsonified.
            if (isset($context['exception']) && $context['exception'] instanceof \Throwable) {
                $message .= $this->‪formatException($context['exception']);
                $context['exception'] = (string)$context['exception'];
            }
            $data = '- ' . json_encode($context, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
        }
 
        $message = sprintf(
            '%s [%s] request="%s" component="%s": %s %s',
            date('r', (int)$record->‪getCreated()),
            strtoupper($record->‪getLevel()),
            $record->‪getRequestId(),
            $record->‪getComponent(),
            $this->interpolate($message, $context),
            $data
        );
 
        if (fwrite(self::$logFileHandles[$this->logFile], $message . LF) === false) {
            throw new \RuntimeException('Could not write log record to log file', 1345036335);
        }
 
        return $this;
    }
 
    protected function ‪openLogFile()
    {
        if (isset(self::$logFileHandlesCount[$this->logFile])) {
            self::$logFileHandlesCount[‪$this->logFile]++;
        } else {
            self::$logFileHandlesCount[‪$this->logFile] = 1;
        }
        if (isset(self::$logFileHandles[$this->logFile]) && is_resource(self::$logFileHandles[$this->logFile] ?? false)) {
            return;
        }
 
        $this->‪createLogFile();
        self::$logFileHandles[‪$this->logFile] = fopen($this->logFile, 'a');
        if (!is_resource(self::$logFileHandles[$this->logFile])) {
            throw new \RuntimeException('Could not open log file "' . $this->logFile . '"', 1321804422);
        }
    }
 
    protected function ‪closeLogFile()
    {
        if (!empty(self::$logFileHandles[$this->logFile]) && is_resource(self::$logFileHandles[$this->logFile])) {
            fclose(self::$logFileHandles[$this->logFile]);
            unset(self::$logFileHandles[$this->logFile]);
        }
    }
 
    protected function ‪createLogFile()
    {
        if (file_exists($this->logFile)) {
            return;
        }
 
        // skip mkdir if logFile refers to any scheme but vfs://, file:// or empty
        $scheme = parse_url($this->logFile, PHP_URL_SCHEME);
        if ($scheme === null || $scheme === 'file' || $scheme === 'vfs' || ‪PathUtility::isAbsolutePath($this->logFile)) {
            // remove file:/ before creating the directory
            $logFileDirectory = ‪PathUtility::dirname((string)preg_replace('#^file:/#', '', $this->logFile));
            if (!@is_dir($logFileDirectory)) {
                ‪GeneralUtility::mkdir_deep($logFileDirectory);
                // create .htaccess file if log file is within the site path
                if (‪PathUtility::getCommonPrefix([‪Environment::getPublicPath() . '/', $logFileDirectory]) === (‪Environment::getPublicPath() . '/')) {
                    // only create .htaccess, if we created the directory on our own
                    $this->‪createHtaccessFile($logFileDirectory . '/.htaccess');
                }
            }
        }
        // create the log file
        ‪GeneralUtility::writeFile($this->logFile, '');
    }
 
    protected function ‪createHtaccessFile($htaccessFile)
    {
        // write .htaccess file to protect the log file
        if (!empty(‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['generateApacheHtaccess']) && !file_exists($htaccessFile)) {
            $htaccessContent = <<<END
# Apache < 2.3
<IfModule !mod_authz_core.c>
    Order allow,deny
    Deny from all
    Satisfy All
</IfModule>
 
# Apache ≥ 2.3
<IfModule mod_authz_core.c>
    Require all denied
</IfModule>
END;
            ‪GeneralUtility::writeFile($htaccessFile, $htaccessContent);
        }
    }
 
    protected function ‪getDefaultLogFileName()
    {
        $namePart = substr(GeneralUtility::hmac($this->defaultLogFileTemplate, 'defaultLogFile'), 0, 10);
        if ($this->logFileInfix !== '') {
            $namePart = $this->logFileInfix . '_' . $namePart;
        }
        return ‪Environment::getVarPath() . sprintf($this->defaultLogFileTemplate, $namePart);
    }
}