Files
espocrm/application/Espo/Core/Log/Handler/EspoFileHandler.php
2023-03-20 09:34:55 +02:00

118 lines
3.5 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2023 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM 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.
*
* EspoCRM 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 EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Core\Log\Handler;
use Monolog\Handler\StreamHandler as MonologStreamHandler;
use Monolog\Logger;
use Espo\Core\Utils\Config;
use Espo\Core\Utils\File\Manager as FileManager;
use RuntimeException;
use Throwable;
class EspoFileHandler extends MonologStreamHandler
{
protected FileManager $fileManager;
/** @var int */
protected $maxErrorMessageLength = 10000;
public function __construct(
Config $config,
string $filename,
int $level = Logger::DEBUG,
bool $bubble = true
) {
parent::__construct($filename, $level, $bubble);
$defaultPermissions = $config->get('defaultPermissions');
$this->fileManager = new FileManager($defaultPermissions);
}
/**
* @param array{
* message: string,
* formatted: string,
* } $record
*/
protected function write(array $record): void
{
if (!$this->url) {
throw new RuntimeException("Missing a logger file path. Check logger params in config.");
}
try {
if (!is_writable($this->url)) {
$checkFileResult = $this->fileManager->checkCreateFile($this->url);
if (!$checkFileResult) {
return;
}
}
$this->fileManager->appendContents(
$this->url,
$this->pruneMessage($record)
);
}
catch (Throwable $e) {
$msg = "Could not write file `" . $this->url . "`.";
if ($e->getMessage()) {
$msg .= " Error message: " . $e->getMessage();
}
throw new RuntimeException($msg);
}
}
/**
* @param array{
* message: string,
* formatted: string,
* } $record
* @return string
*/
protected function pruneMessage(array $record)
{
$message = (string) $record['message'];
if (strlen($message) > $this->maxErrorMessageLength) {
$record['message'] = substr($message, 0, $this->maxErrorMessageLength) . '...';
$record['formatted'] = $this->getFormatter()->format($record);
}
return (string) $record['formatted'];
}
}