mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-03-05 23:17:00 -05:00
314077a457
Take advantage of https://phpstan.org/blog/bring-your-exceptions-under-control Minimum changes to pass `tooWideThrowType` and `implicitThrows`. Revert some mistakes from: https://github.com/FreshRSS/FreshRSS/pull/5504 Preparation needed before new PRs of the same type: https://github.com/FreshRSS/FreshRSS/pull/5962 Fix several wrong PHPDocs and catches: > Method ... has ...Exception in PHPDoc @throws tag but it's not thrown. > Dead catch - ...Exception is never thrown in the try block.
123 lines
3.8 KiB
PHP
123 lines
3.8 KiB
PHP
<?php
|
||
declare(strict_types=1);
|
||
|
||
/**
|
||
* MINZ - Copyright 2011 Marien Fressinaud
|
||
* Sous licence AGPL3 <http://www.gnu.org/licenses/>
|
||
*/
|
||
|
||
/**
|
||
* The Minz_Log class is used to log errors and warnings
|
||
*/
|
||
class Minz_Log {
|
||
/**
|
||
* Enregistre un message dans un fichier de log spécifique
|
||
* Message non loggué si
|
||
* - environment = SILENT
|
||
* - level = LOG_WARNING et environment = PRODUCTION
|
||
* - level = LOG_NOTICE et environment = PRODUCTION
|
||
* @param string $information message d'erreur / information à enregistrer
|
||
* @param int $level niveau d'erreur https://php.net/function.syslog
|
||
* @param string $file_name fichier de log
|
||
* @throws Minz_PermissionDeniedException
|
||
*/
|
||
public static function record(string $information, int $level, ?string $file_name = null): void {
|
||
$env = getenv('FRESHRSS_ENV');
|
||
if ($env == '') {
|
||
try {
|
||
$conf = Minz_Configuration::get('system');
|
||
$env = $conf->environment;
|
||
} catch (Minz_ConfigurationException $e) {
|
||
$env = 'production';
|
||
}
|
||
}
|
||
|
||
if (! ($env === 'silent' || ($env === 'production' && ($level >= LOG_NOTICE)))) {
|
||
$username = Minz_User::name() ?? Minz_User::INTERNAL_USER;
|
||
if ($file_name == null) {
|
||
$file_name = join_path(USERS_PATH, $username, LOG_FILENAME);
|
||
}
|
||
|
||
switch ($level) {
|
||
case LOG_ERR :
|
||
$level_label = 'error';
|
||
break;
|
||
case LOG_WARNING :
|
||
$level_label = 'warning';
|
||
break;
|
||
case LOG_NOTICE :
|
||
$level_label = 'notice';
|
||
break;
|
||
case LOG_DEBUG :
|
||
$level_label = 'debug';
|
||
break;
|
||
default :
|
||
$level = LOG_INFO;
|
||
$level_label = 'info';
|
||
}
|
||
|
||
$log = '[' . date('r') . '] [' . $level_label . '] --- ' . $information . "\n";
|
||
|
||
if (defined('COPY_LOG_TO_SYSLOG') && COPY_LOG_TO_SYSLOG) {
|
||
syslog($level, '[' . $username . '] ' . trim($log));
|
||
}
|
||
|
||
self::ensureMaxLogSize($file_name);
|
||
|
||
if (file_put_contents($file_name, $log, FILE_APPEND | LOCK_EX) === false) {
|
||
throw new Minz_PermissionDeniedException($file_name, Minz_Exception::ERROR);
|
||
}
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Make sure we do not waste a huge amount of disk space with old log messages.
|
||
*
|
||
* This method can be called multiple times for one script execution, but its result will not change unless
|
||
* you call clearstatcache() in between. We won’t do do that for performance reasons.
|
||
*
|
||
* @param string $file_name
|
||
* @throws Minz_PermissionDeniedException
|
||
*/
|
||
protected static function ensureMaxLogSize(string $file_name): void {
|
||
$maxSize = defined('MAX_LOG_SIZE') ? MAX_LOG_SIZE : 1048576;
|
||
if ($maxSize > 0 && @filesize($file_name) > $maxSize) {
|
||
$fp = fopen($file_name, 'c+');
|
||
if (is_resource($fp) && flock($fp, LOCK_EX)) {
|
||
fseek($fp, -(int)($maxSize / 2), SEEK_END);
|
||
$content = fread($fp, $maxSize);
|
||
rewind($fp);
|
||
ftruncate($fp, 0);
|
||
fwrite($fp, $content ?: '');
|
||
fwrite($fp, sprintf("[%s] [notice] --- Log rotate.\n", date('r')));
|
||
fflush($fp);
|
||
flock($fp, LOCK_UN);
|
||
} else {
|
||
throw new Minz_PermissionDeniedException($file_name, Minz_Exception::ERROR);
|
||
}
|
||
fclose($fp);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Some helpers to Minz_Log::record() method
|
||
* Parameters are the same of those of the record() method.
|
||
* @throws Minz_PermissionDeniedException
|
||
*/
|
||
public static function debug(string $msg, ?string $file_name = null): void {
|
||
self::record($msg, LOG_DEBUG, $file_name);
|
||
}
|
||
/** @throws Minz_PermissionDeniedException */
|
||
public static function notice(string $msg, ?string $file_name = null): void {
|
||
self::record($msg, LOG_NOTICE, $file_name);
|
||
}
|
||
/** @throws Minz_PermissionDeniedException */
|
||
public static function warning(string $msg, ?string $file_name = null): void {
|
||
self::record($msg, LOG_WARNING, $file_name);
|
||
}
|
||
/** @throws Minz_PermissionDeniedException */
|
||
public static function error(string $msg, ?string $file_name = null): void {
|
||
self::record($msg, LOG_ERR, $file_name);
|
||
}
|
||
}
|