-
Notifications
You must be signed in to change notification settings - Fork 0
/
Bedoved.php
437 lines (395 loc) · 14.7 KB
/
Bedoved.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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
<?php
/**
* Бедовед
*
* @version 1.2.0
* @copyright Михаил Красильников <m.krasilnikov@yandex.ru>
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
* @author Михаил Красильников <m.krasilnikov@yandex.ru>
*
* Copyright 2012 Mikhail Krasilnikov (Михаил Красильников).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* @package Bedoved
*/
/**
* Ядро обработчика ошибок и исключительных ситуаций
*
* @package Bedoved
*/
class Bedoved
{
/**
* Размер буфера для работы в условиях переполнения памяти (в Кб)
*
* @var int
*/
const MEMORY_OVERFLOW_BUFFER_SIZE = 64;
/**
* Режим отладки
*
* @var bool
*
* @since 1.2.0
*/
private $debug;
/**
* Битовая маска, определяющая какие ошибки, будут превращены в исключения
*
* @var int
*/
private $errorConversionMask = null;
/**
* Состояние перехвата исключительных ситуаций
*
* @var bool
*/
private $exceptionHandlingEnabled = false;
/**
* Состояние перехвата фатальных ошибок
*
* @var bool
*/
private $fatalErrorHandlingEnabled = false;
/**
* Адреса e-mail для отправки извещений об ошибках
*
* @var null|string
*/
private $notify = null;
/**
* Путь к файлу с сообщением об ошибке
*
* @var null|string
*/
private $messageFile = null;
/**
* Обработчик фатальных ошибок
*
* @var callable
*/
private $fatalErrorHandler = null;
/**
* Маркер чтобы отличать настоящие сообщения об ошибках от похожих текстов, являющихся частью
* контента.
*
* @var string
*/
private $errorMarker;
/**
* Регулярное выражение, соответствующее сообщениям об ошибках
*
* @var string
* @since 1.03
*/
private $errorPattern;
/**
* Инициализирует Бедоведа
*
* @param bool $debug true — включить режим отладки
*/
public function __construct($debug = false)
{
$this->debug = $debug;
}
/**
* Включает преобразование ошибок в исключения
*
* По умолчанию $mask включает в себя все ошибки кроме E_STRICT, E_NOTICE и E_USER_NOTICE.
*
* @param int $mask битовая маска, задающая какие ошибки преобразовывать
*
* @return $this
*/
public function enableErrorConversion($mask = null)
{
if (null === $mask)
{
$mask = E_ALL ^ (E_NOTICE | E_USER_NOTICE);
if (version_compare(PHP_VERSION, '5.4', '>='))
{
$mask = $mask ^ E_STRICT;
}
}
$this->errorConversionMask = $mask;
set_error_handler(array($this, 'errorHandler'));
return $this;
}
/**
* Включает перехват исключительных ситуаций
*
* Вы можете указать файл, который надо вывести при возникновении такой ситуации, с помощью
* метода {@link setMessageFile()}.
*
* @return $this
*/
public function enableExceptionHandling()
{
if (!$this->exceptionHandlingEnabled)
{
$this->exceptionHandlingEnabled = true;
set_exception_handler(array($this, 'handleException'));
}
return $this;
}
/**
* Включает перехват фатальных ошибок
*
* Этот метод:
* 1. резервирует в памяти буфер, освобождаемый для обработки ошибок нехватки памяти;
* 2. отключает HTML-оформление стандартных сообщений об ошибках;
*
* @return $this
*/
public function enableFatalErrorHandling()
{
if (!$this->fatalErrorHandlingEnabled)
{
$this->fatalErrorHandlingEnabled = true;
/*
* В PHP нет стандартных методов для перехвата некоторых типов ошибок (например E_PARSE или
* E_ERROR), однако способ всё же есть — зарегистрировать функцию через ob_start.
* Но только не в режиме CLI.
*/
// Резервируем буфер на случай переполнения памяти
$GLOBALS['BEDOVED_MEMORY_OVERFLOW_BUFFER'] =
str_repeat('x', self::MEMORY_OVERFLOW_BUFFER_SIZE * 1024);
/* Задаём маркер, чтобы отличать реальные ошибки от текстовых сообщений */
$this->errorMarker = uniqid();
ini_set('error_append_string', '[' . $this->errorMarker . ']');
$this->errorPattern
= '/(Parse|Fatal) error:(.+) in (.+) on line (\d+)\s+(Call Stack.*\s)?\['
. $this->errorMarker . '\]/s';
// Необходимо для правильного определения фатальных ошибок
ini_set('html_errors', 0);
ob_start(array($this, 'fatalErrorHandler'), 4096);
}
return $this;
}
/**
* Задаёт адрес (или адреса через запятую) куда будут отправляться сообщения об ошибках
*
* @param string $emails
*
* @return $this
*/
public function setNotifyEmails($emails)
{
assert('is_string($emails)');
$this->notify = $emails;
return $this;
}
/**
* Задаёт путь к файлу, содержимое которого должно быть отправлено клиенту в случае ошибки
*
* Если файл не существует, будет сделано предупреждение E_USER_WARNING.
*
* @param string $filename путь к файлу
*
* @return $this
*/
public function setMessageFile($filename)
{
assert('is_string($filename)');
$path = realpath($filename);
if ($path)
{
$this->messageFile = $filename;
}
else
{
trigger_error('File not found: ' . $filename, E_USER_WARNING);
}
return $this;
}
/**
* Устанавливает обработчик фатальных ошибок
*
* Автоматически вызывает метод {@link enableFatalErrorHandling()}.
*
* @param callable $callback обработчик фатальных ошибок
*
* @return $this
*/
public function setFatalErrorHandler($callback)
{
if (is_callable($callback))
{
$this->fatalErrorHandler = $callback;
$this->enableFatalErrorHandling();
}
return $this;
}
/**
* Обработчик ошибок
*
* Обработчик ошибок, устанавливаемый через {@link set_error_handler() set_error_handler()} в
* методе {@link enableErrorConversion()}. Все ошибки, соответствующие заданной маске,
* превращаются в исключения {@link http://php.net/ErrorException ErrorException}.
*
* Примечание: На самом деле этот метод обрабатывает только E_STRICT, E_NOTICE, E_USER_NOTICE,
* E_WARNING, E_USER_WARNING и E_USER_ERROR.
*
* @param int $errno тип ошибки
* @param string $errstr описание ошибки
* @param string $errfile имя файла, в котором произошла ошибка
* @param int $errline строка, где произошла ошибка
*
* @throws ErrorException
*
* @return bool
*/
public function errorHandler($errno, $errstr, $errfile, $errline)
{
/* Нулевое значение 'error_reporting' означает что был использован оператор "@" */
if (error_reporting() == 0 || ($errno & $this->errorConversionMask) == 0)
{
return true;
}
throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
}
/**
* Обработчик фатальных ошибок
*
* Этот обработчик пытается перехватывать сообщения о фатальных ошибках, недоступных при
* использовании {@link set_error_handler() set_error_handler()}. Это делается через обработчик
* {@link ob_start() ob_start()}, устанавливаемый в методе {@link setFatalErrorHandler()}.
*
* <i>Замечание по производительности</i>: этот метод освобождает в начале и выделяет в конце
* своей работы буфер в памяти для отлова ошибок переполнения памяти. Эти операции замедляют
* вывод примерно на 1-2%.
*
* @param string $output содержимое буфера вывода
*
* @return string|bool
*/
public function fatalErrorHandler($output)
{
// Освобождает резервный буфер
unset($GLOBALS['BEDOVED_MEMORY_OVERFLOW_BUFFER']);
/* Предварительная проверка без использования медленных регулярных выражений */
$errorTokens =
strpos($output, 'Fatal error:') !== false ||
strpos($output, 'Parse error:') !== false;
/*
* Окончательная проверка. Регулярные выражения будут применены только если переменная
* $errorTokens истинна.
*/
if ($errorTokens && @preg_match($this->errorPattern, $output, $m))
{
$errtype = $m[1];
$errstr = trim($m[2]);
$errfile = trim($m[3]);
$errline = trim($m[4]);
$severity = 'Parse' == $errtype ? E_PARSE : E_ERROR;
$e = new ErrorException($errstr, 0, $severity, $errfile, $errline);
if ($this->fatalErrorHandler)
{
return call_user_func($this->fatalErrorHandler, $e, $output);
}
else
{
return $this->handleException($e, true);
}
}
$GLOBALS['BEDOVED_MEMORY_OVERFLOW_BUFFER'] =
str_repeat('x', self::MEMORY_OVERFLOW_BUFFER_SIZE * 1024);
// возвращаем false для вывода буфера
return false;
}
/**
* Обработчик исключений
*
* @param Exception $e
* @param bool $return true чтобы вернуть сообщение вместо вывода
*
* @return null|string
*/
public function handleException(Exception $e, $return = false)
{
/*
* Сообщение для администратора
*/
$message = sprintf(
"%s\n\n%s in %s at %s\n\nBacktrace:\n%s\n",
$e->getMessage(),
get_class($e),
$e->getFile(),
$e->getLine(),
$e->getTraceAsString()
);
// Отправляем в журнал
error_log($message);
/* Отправляем по e-mail */
if ($this->notify && false === $this->debug)
{
$message .= "\n";
@$message .= 'URI: ' . $_SERVER['REQUEST_URI'] . "\n";
@$message .= 'Host: ' . gethostbyaddr($_SERVER['REMOTE_ADDR']) . "\n";
@$message .= 'Agent: ' . $_SERVER['HTTP_USER_AGENT'] . "\n";
$subject = '[Bedoved] Error on ';
$subject .= isset($_SERVER['HTTP_HOST'])
? substr($_SERVER['HTTP_HOST'], 0, 4) == 'www.'
? substr($_SERVER['HTTP_HOST'], 4)
: $_SERVER['HTTP_HOST']
: php_uname('n');
mail($this->notify, $subject, $message);
}
$message = $this->getUserNotification($e);
if ($return)
{
return $message;
}
if (!headers_sent())
{
header('Internal Server Error', true, 500);
}
echo $message;
return null;
}
/**
* Возвращает сообщение об ошибке для пользователя
*
* @param Exception $e
*
* @return bool|string
*
* @since 1.2.0
*
* @SuppressWarnings(PHPMD.UnusedFormalParameters)
*/
private function getUserNotification(Exception $e)
{
$message = false;
if ($this->debug)
{
$message = require __DIR__ . '/Resources/Debug.html.php';
}
else
{
$messageFile = $this->messageFile ? : __DIR__ . '/Resources/FatalError.html';
if (@file_exists($messageFile) && @is_readable($messageFile))
{
@$message = file_get_contents($messageFile);
}
if (!$message)
{
$message =
"<!doctype html>\n<html><head><title>Internal Server Error</title></head>\n" .
"<body><h1>Internal Server Error</h1></body></html>";
}
}
return $message;
}
}