You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

114 lines
3.1 KiB

13 years ago
<?php
/**
13 years ago
* FileTarget class file.
13 years ago
*
* @link http://www.yiiframework.com/
* @copyright Copyright &copy; 2008 Yii Software LLC
13 years ago
* @license http://www.yiiframework.com/license/
*/
13 years ago
namespace yii\logging;
use yii\base\InvalidConfigException;
13 years ago
13 years ago
/**
* FileTarget records log messages in a file.
13 years ago
*
* The log file is specified via [[logFile]]. If the size of the log file exceeds
* [[maxFileSize]] (in kilo-bytes), a rotation will be performed, which renames
* the current log file by suffixing the file name with '.1'. All existing log
* files are moved backwards by one place, i.e., '.2' to '.3', '.1' to '.2', and so on.
* The property [[maxLogFiles]] specifies how many files to keep.
13 years ago
*
* @author Qiang Xue <qiang.xue@gmail.com>
13 years ago
* @since 2.0
13 years ago
*/
13 years ago
class FileTarget extends Target
13 years ago
{
/**
* @var string log file path or path alias. If not set, it means the 'application.log' file under
* the application runtime directory. Please make sure the directory containing
* the log file is writable by the Web server process.
*/
public $logFile;
/**
13 years ago
* @var integer maximum log file size, in kilo-bytes. Defaults to 1024, meaning 1MB.
13 years ago
*/
13 years ago
public $maxFileSize = 1024; // in KB
13 years ago
/**
13 years ago
* @var integer number of log files used for rotation. Defaults to 5.
13 years ago
*/
13 years ago
public $maxLogFiles = 5;
13 years ago
/**
* Initializes the route.
* This method is invoked after the route is created by the route manager.
*/
public function init()
{
parent::init();
if ($this->logFile === null) {
$this->logFile = \Yii::$app->getRuntimePath() . DIRECTORY_SEPARATOR . 'application.log';
} else {
$this->logFile = \Yii::getAlias($this->logFile);
13 years ago
}
$logPath = dirname($this->logFile);
if (!is_dir($logPath) || !is_writable($logPath)) {
throw new InvalidConfigException("Directory '$logPath' does not exist or is not writable.");
13 years ago
}
if ($this->maxLogFiles < 1) {
$this->maxLogFiles = 1;
}
if ($this->maxFileSize < 1) {
$this->maxFileSize = 1;
}
13 years ago
}
/**
* Sends log messages to specified email addresses.
* @param array $messages the messages to be exported. See [[Logger::messages]] for the structure
* of each message.
13 years ago
*/
public function export($messages)
13 years ago
{
$text = '';
foreach ($messages as $message) {
$text .= $this->formatMessage($message);
}
$fp = @fopen($this->logFile, 'a');
@flock($fp, LOCK_EX);
if (@filesize($this->logFile) > $this->maxFileSize * 1024) {
13 years ago
$this->rotateFiles();
@flock($fp,LOCK_UN);
@fclose($fp);
@file_put_contents($this->logFile, $text, FILE_APPEND | LOCK_EX);
} else {
@fwrite($fp, $text);
@flock($fp,LOCK_UN);
@fclose($fp);
13 years ago
}
13 years ago
}
/**
* Rotates log files.
*/
protected function rotateFiles()
{
$file = $this->logFile;
13 years ago
for ($i = $this->maxLogFiles; $i > 0; --$i) {
13 years ago
$rotateFile = $file . '.' . $i;
13 years ago
if (is_file($rotateFile)) {
13 years ago
// suppress errors because it's possible multiple processes enter into this section
13 years ago
if ($i === $this->maxLogFiles) {
13 years ago
@unlink($rotateFile);
13 years ago
} else {
13 years ago
@rename($rotateFile, $file . '.' . ($i + 1));
13 years ago
}
13 years ago
}
}
13 years ago
if (is_file($file)) {
13 years ago
@rename($file, $file . '.1'); // suppress errors because it's possible multiple processes enter into this section
13 years ago
}
13 years ago
}
}