-
Notifications
You must be signed in to change notification settings - Fork 0
/
LogProviderFile.php
236 lines (210 loc) · 7.54 KB
/
LogProviderFile.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<?php
namespace Alpha\Util\Logging;
use Alpha\Util\Config\ConfigProvider;
use Alpha\Exception\PHPException;
use Alpha\Util\File\FileUtils;
/**
* Generic log file class to encapsulate common file I/O and rendering calls.
*
* @since 1.0
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2016, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*/
class LogProviderFile implements LogProviderInterface
{
/**
* The log file path.
*
* @var string
*
* @since 1.0
*/
private $path;
/**
* The maximum size of the log file in megabytes before a backup is created and a
* new file is created, default is 5.
*
* @var int
*
* @since 1.0
*/
private $maxSize = 5;
/**
* Set the file path.
*
* @param string $path
*
* @since 2.0
*/
public function setPath($path)
{
$this->path = $path;
}
/**
* Set the max log size in megabytes.
*
* @param int $maxSize
*
* @since 1.0
*/
public function setMaxSize($maxSize)
{
$this->maxSize = $maxSize;
}
/**
* {@inheritdoc}
*/
public function writeLine($line)
{
$config = ConfigProvider::getInstance();
if ($this->path != '') {
try {
$fp = fopen($this->path, 'a+');
fputcsv($fp, $line, ',', '"', '\\');
if ($this->checkFileSize() >= $this->maxSize) {
$this->backupFile();
}
} catch (\Exception $e) {
try {
$logsDir = $config->get('app.file.store.dir').'logs';
if (!file_exists($logsDir)) {
if (!mkdir($logsDir, 0766)) {
throw new PHPException('Could not create the directory ['.$logsDir.']');
}
}
$fp = fopen($this->path, 'a+');
if (!fputcsv($fp, $line, ',', '"', '\\')) {
throw new PHPException('Could not write to the CSV file ['.$this->path.']');
}
if ($this->checkFileSize() >= $this->maxSize) {
$this->backupFile();
}
} catch (\Exception $e) {
echo 'Unable to write to the log file ['.$this->path.'], error ['.$e->getMessage().']';
exit;
}
}
}
}
/**
* Returns the size in megabytes of the log file on disc.
*
* @return float
*
* @since 1.0
*/
private function checkFileSize()
{
$size = filesize($this->path);
return ($size / 1024) / 1024;
}
/**
* Creates a backup of the log file, which has the same file name and location as the
* current file plus a timestamp appended.
*
* @since 1.0
*/
private function backupFile()
{
// generate the name of the backup file name to contain a timestampe
$backName = str_replace('.log', '-backup-'.date('y-m-d H.i.s').'.log', $this->path);
// renames the logfile as the value of $backName
rename($this->path, $backName);
FileUtils::zip($backName, $backName.'.zip');
unlink($backName);
// creates a new log file, and sets it's permission for writing!
$fp = fopen($this->path, 'a+'); // remember set directory permissons to allow creation!
fclose($fp);
//s ets the new permission to rw+:rw+:rw+
chmod($this->path, 0666);
}
/**
* {@inheritdoc}
*/
public function renderLog($cols)
{
// render the start of the table
$body = '<table class="table">';
$body .= '<tr>';
foreach ($cols as $heading) {
$body .= '<th>'.$heading.'</th>';
}
$body .= '</tr>';
$fp = fopen($this->path, 'r');
while (($line = fgetcsv($fp)) !== false) {
$body .= '<tr>';
for ($col = 0; $col < count($line); ++$col) {
// if it is an error log, render the error types field in different colours
if ($col == 1 && $cols[1] == 'Level') {
switch ($line[$col]) {
case 'DEBUG':
$body .= '<td class="debug">'.htmlentities($line[$col], ENT_COMPAT, 'utf-8').'</td>';
break;
case 'INFO':
$body .= '<td class="info">'.htmlentities($line[$col], ENT_COMPAT, 'utf-8').'</td>';
break;
case 'WARN':
$body .= '<td class="warn">'.htmlentities($line[$col], ENT_COMPAT, 'utf-8').'</td>';
break;
case 'ERROR':
$body .= '<td class="error">'.htmlentities($line[$col], ENT_COMPAT, 'utf-8').'</td>';
break;
case 'FATAL':
$body .= '<td class="fatal">'.htmlentities($line[$col], ENT_COMPAT, 'utf-8').'</td>';
break;
case 'SQL':
$body .= '<td class="sql">'.htmlentities($line[$col], ENT_COMPAT, 'utf-8').'</td>';
break;
default:
$body .= '<td>'.htmlentities($line[$col], ENT_COMPAT, 'utf-8').'</td>';
break;
}
} else {
if ($cols[$col] == 'Message') {
$body .= '<td><pre>'.htmlentities($line[$col], ENT_COMPAT, 'utf-8').'</pre></td>';
} else {
$body .= '<td>'.htmlentities($line[$col], ENT_COMPAT, 'utf-8').'</td>';
}
}
}
$body .= '</tr>';
}
$body .= '</table>';
return $body;
}
}