|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* @link https://www.yiiframework.com/ |
|
4
|
|
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
5
|
|
|
* @license https://www.yiiframework.com/license/ |
|
6
|
|
|
*/ |
|
7
|
|
|
|
|
8
|
|
|
namespace yii\log; |
|
9
|
|
|
|
|
10
|
|
|
use Yii; |
|
11
|
|
|
use yii\base\InvalidConfigException; |
|
12
|
|
|
use yii\helpers\FileHelper; |
|
13
|
|
|
|
|
14
|
|
|
/** |
|
15
|
|
|
* FileTarget records log messages in a file. |
|
16
|
|
|
* |
|
17
|
|
|
* The log file is specified via [[logFile]]. If the size of the log file exceeds |
|
18
|
|
|
* [[maxFileSize]] (in kilo-bytes), a rotation will be performed, which renames |
|
19
|
|
|
* the current log file by suffixing the file name with '.1'. All existing log |
|
20
|
|
|
* files are moved backwards by one place, i.e., '.2' to '.3', '.1' to '.2', and so on. |
|
21
|
|
|
* The property [[maxLogFiles]] specifies how many history files to keep. |
|
22
|
|
|
* |
|
23
|
|
|
* Since 2.0.46 rotation of the files is done only by copy and the |
|
24
|
|
|
* `rotateByCopy` property is deprecated. |
|
25
|
|
|
* |
|
26
|
|
|
* @author Qiang Xue <[email protected]> |
|
27
|
|
|
* @since 2.0 |
|
28
|
|
|
*/ |
|
29
|
|
|
class FileTarget extends Target |
|
30
|
|
|
{ |
|
31
|
|
|
/** |
|
32
|
|
|
* @var string|null log file path or [path alias](guide:concept-aliases). If not set, it will use the "@runtime/logs/app.log" file. |
|
33
|
|
|
* The directory containing the log files will be automatically created if not existing. |
|
34
|
|
|
*/ |
|
35
|
|
|
public $logFile; |
|
36
|
|
|
/** |
|
37
|
|
|
* @var bool whether log files should be rotated when they reach a certain [[maxFileSize|maximum size]]. |
|
38
|
|
|
* Log rotation is enabled by default. This property allows you to disable it, when you have configured |
|
39
|
|
|
* an external tools for log rotation on your server. |
|
40
|
|
|
* @since 2.0.3 |
|
41
|
|
|
*/ |
|
42
|
|
|
public $enableRotation = true; |
|
43
|
|
|
/** |
|
44
|
|
|
* @var int maximum log file size, in kilo-bytes. Defaults to 10240, meaning 10MB. |
|
45
|
|
|
*/ |
|
46
|
|
|
public $maxFileSize = 10240; // in KB |
|
47
|
|
|
/** |
|
48
|
|
|
* @var int number of log files used for rotation. Defaults to 5. |
|
49
|
|
|
*/ |
|
50
|
|
|
public $maxLogFiles = 5; |
|
51
|
|
|
/** |
|
52
|
|
|
* @var int|null the permission to be set for newly created log files. |
|
53
|
|
|
* This value will be used by PHP chmod() function. No umask will be applied. |
|
54
|
|
|
* If not set, the permission will be determined by the current environment. |
|
55
|
|
|
*/ |
|
56
|
|
|
public $fileMode; |
|
57
|
|
|
/** |
|
58
|
|
|
* @var int the permission to be set for newly created directories. |
|
59
|
|
|
* This value will be used by PHP chmod() function. No umask will be applied. |
|
60
|
|
|
* Defaults to 0775, meaning the directory is read-writable by owner and group, |
|
61
|
|
|
* but read-only for other users. |
|
62
|
|
|
*/ |
|
63
|
|
|
public $dirMode = 0775; |
|
64
|
|
|
/** |
|
65
|
|
|
* @var bool Whether to rotate log files by copy and truncate in contrast to rotation by |
|
66
|
|
|
* renaming files. Defaults to `true` to be more compatible with log tailers and windows |
|
67
|
|
|
* systems which do not play well with rename on open files. Rotation by renaming however is |
|
68
|
|
|
* a bit faster. |
|
69
|
|
|
* |
|
70
|
|
|
* The problem with windows systems where the [rename()](https://www.php.net/manual/en/function.rename.php) |
|
71
|
|
|
* function does not work with files that are opened by some process is described in a |
|
72
|
|
|
* [comment by Martin Pelletier](https://www.php.net/manual/en/function.rename.php#102274) in |
|
73
|
|
|
* the PHP documentation. By setting rotateByCopy to `true` you can work |
|
74
|
|
|
* around this. |
|
75
|
|
|
* @deprecated since 2.0.46 and setting it to false has no effect anymore |
|
76
|
|
|
* since rotating is now always done by copy. |
|
77
|
|
|
*/ |
|
78
|
|
|
public $rotateByCopy = true; |
|
79
|
|
|
|
|
80
|
|
|
|
|
81
|
|
|
/** |
|
82
|
|
|
* Initializes the route. |
|
83
|
|
|
* This method is invoked after the route is created by the route manager. |
|
84
|
|
|
*/ |
|
85
|
3 |
|
public function init() |
|
86
|
|
|
{ |
|
87
|
3 |
|
parent::init(); |
|
88
|
3 |
|
if ($this->logFile === null) { |
|
89
|
1 |
|
$this->logFile = Yii::$app->getRuntimePath() . '/logs/app.log'; |
|
90
|
|
|
} else { |
|
91
|
2 |
|
$this->logFile = Yii::getAlias($this->logFile); |
|
|
|
|
|
|
92
|
|
|
} |
|
93
|
3 |
|
if ($this->maxLogFiles < 1) { |
|
94
|
|
|
$this->maxLogFiles = 1; |
|
95
|
|
|
} |
|
96
|
3 |
|
if ($this->maxFileSize < 1) { |
|
97
|
|
|
$this->maxFileSize = 1; |
|
98
|
|
|
} |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
/** |
|
102
|
|
|
* Writes log messages to a file. |
|
103
|
|
|
* Starting from version 2.0.14, this method throws LogRuntimeException in case the log can not be exported. |
|
104
|
|
|
* @throws InvalidConfigException if unable to open the log file for writing |
|
105
|
|
|
* @throws LogRuntimeException if unable to write complete log to file |
|
106
|
|
|
*/ |
|
107
|
2 |
|
public function export() |
|
108
|
|
|
{ |
|
109
|
2 |
|
$text = implode("\n", array_map([$this, 'formatMessage'], $this->messages)) . "\n"; |
|
110
|
|
|
|
|
111
|
2 |
|
if (trim($text) === '') { |
|
112
|
1 |
|
return; // No messages to export, so we exit the function early |
|
113
|
|
|
} |
|
114
|
|
|
|
|
115
|
2 |
|
if (strpos($this->logFile, '://') === false || strncmp($this->logFile, 'file://', 7) === 0) { |
|
|
|
|
|
|
116
|
2 |
|
$logPath = dirname($this->logFile); |
|
|
|
|
|
|
117
|
2 |
|
FileHelper::createDirectory($logPath, $this->dirMode, true); |
|
118
|
|
|
} |
|
119
|
|
|
|
|
120
|
2 |
|
if (($fp = @fopen($this->logFile, 'a')) === false) { |
|
|
|
|
|
|
121
|
|
|
throw new InvalidConfigException("Unable to append to log file: {$this->logFile}"); |
|
122
|
|
|
} |
|
123
|
2 |
|
@flock($fp, LOCK_EX); |
|
|
|
|
|
|
124
|
2 |
|
if ($this->enableRotation) { |
|
125
|
|
|
// clear stat cache to ensure getting the real current file size and not a cached one |
|
126
|
|
|
// this may result in rotating twice when cached file size is used on subsequent calls |
|
127
|
2 |
|
clearstatcache(); |
|
128
|
|
|
} |
|
129
|
2 |
|
if ($this->enableRotation && @filesize($this->logFile) > $this->maxFileSize * 1024) { |
|
|
|
|
|
|
130
|
1 |
|
$this->rotateFiles(); |
|
131
|
|
|
} |
|
132
|
2 |
|
$writeResult = @fwrite($fp, $text); |
|
133
|
2 |
|
if ($writeResult === false) { |
|
134
|
|
|
$message = "Unable to export log through file ($this->logFile)!"; |
|
135
|
|
|
if ($error = error_get_last()) { |
|
136
|
|
|
$message .= ": {$error['message']}"; |
|
137
|
2 |
|
} |
|
138
|
2 |
|
throw new LogRuntimeException($message); |
|
139
|
|
|
} |
|
140
|
|
|
$textSize = strlen($text); |
|
141
|
2 |
|
if ($writeResult < $textSize) { |
|
142
|
2 |
|
throw new LogRuntimeException("Unable to export whole log through file ({$this->logFile})! Wrote $writeResult out of $textSize bytes."); |
|
143
|
2 |
|
} |
|
144
|
|
|
@fflush($fp); |
|
|
|
|
|
|
145
|
2 |
|
@flock($fp, LOCK_UN); |
|
146
|
|
|
@fclose($fp); |
|
|
|
|
|
|
147
|
|
|
|
|
148
|
|
|
if ($this->fileMode !== null) { |
|
149
|
|
|
@chmod($this->logFile, $this->fileMode); |
|
|
|
|
|
|
150
|
|
|
} |
|
151
|
|
|
} |
|
152
|
|
|
|
|
153
|
1 |
|
/** |
|
154
|
|
|
* Rotates log files. |
|
155
|
1 |
|
*/ |
|
156
|
1 |
|
protected function rotateFiles() |
|
157
|
|
|
{ |
|
158
|
1 |
|
$file = $this->logFile; |
|
159
|
1 |
|
for ($i = $this->maxLogFiles; $i >= 0; --$i) { |
|
160
|
|
|
// $i == 0 is the original log file |
|
161
|
1 |
|
$rotateFile = $file . ($i === 0 ? '' : '.' . $i); |
|
162
|
1 |
|
if (is_file($rotateFile)) { |
|
163
|
1 |
|
// suppress errors because it's possible multiple processes enter into this section |
|
164
|
|
|
if ($i === $this->maxLogFiles) { |
|
165
|
1 |
|
@unlink($rotateFile); |
|
|
|
|
|
|
166
|
1 |
|
continue; |
|
167
|
1 |
|
} |
|
168
|
1 |
|
$newFile = $this->logFile . '.' . ($i + 1); |
|
169
|
|
|
$this->rotateByCopy($rotateFile, $newFile); |
|
170
|
|
|
if ($i === 0) { |
|
171
|
|
|
$this->clearLogFile($rotateFile); |
|
172
|
|
|
} |
|
173
|
|
|
} |
|
174
|
|
|
} |
|
175
|
|
|
} |
|
176
|
|
|
|
|
177
|
|
|
/*** |
|
178
|
1 |
|
* Clear log file without closing any other process open handles |
|
179
|
|
|
* @param string $rotateFile |
|
180
|
1 |
|
*/ |
|
181
|
1 |
|
private function clearLogFile($rotateFile) |
|
182
|
1 |
|
{ |
|
183
|
|
|
if ($filePointer = @fopen($rotateFile, 'a')) { |
|
184
|
|
|
@ftruncate($filePointer, 0); |
|
|
|
|
|
|
185
|
|
|
@fclose($filePointer); |
|
|
|
|
|
|
186
|
|
|
} |
|
187
|
|
|
} |
|
188
|
|
|
|
|
189
|
|
|
/*** |
|
190
|
|
|
* Copy rotated file into new file |
|
191
|
1 |
|
* @param string $rotateFile |
|
192
|
|
|
* @param string $newFile |
|
193
|
1 |
|
*/ |
|
194
|
1 |
|
private function rotateByCopy($rotateFile, $newFile) |
|
195
|
|
|
{ |
|
196
|
|
|
@copy($rotateFile, $newFile); |
|
|
|
|
|
|
197
|
|
|
if ($this->fileMode !== null) { |
|
198
|
|
|
@chmod($newFile, $this->fileMode); |
|
|
|
|
|
|
199
|
|
|
} |
|
200
|
|
|
} |
|
201
|
|
|
} |
|
202
|
|
|
|
yiisoft /
yii2
Loading history...
Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.
For example, imagine you have a variable
$accountIdthat can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to theidproperty of an instance of theAccountclass. This class holds a proper account, so the id value must no longer be false.Either this assignment is in error or a type check should be added for that assignment.