777 lines
26 KiB
PHP
777 lines
26 KiB
PHP
<?php
|
||
|
||
declare(strict_types=1);
|
||
|
||
/**
|
||
* This file is part of CodeIgniter 4 framework.
|
||
*
|
||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||
*
|
||
* For the full copyright and license information, please view
|
||
* the LICENSE file that was distributed with this source code.
|
||
*/
|
||
|
||
namespace CodeIgniter\Debug;
|
||
|
||
use CodeIgniter\Exceptions\HasExitCodeInterface;
|
||
use CodeIgniter\Exceptions\HTTPExceptionInterface;
|
||
use CodeIgniter\Exceptions\PageNotFoundException;
|
||
use Config\Exceptions as ExceptionsConfig;
|
||
use ErrorException;
|
||
use Throwable;
|
||
|
||
/**
|
||
* Exceptions manager
|
||
*
|
||
* @see \CodeIgniter\Debug\ExceptionsTest
|
||
*/
|
||
class Exceptions
|
||
{
|
||
|
||
/**
|
||
* Nesting level of the output buffering mechanism
|
||
*
|
||
* @var int
|
||
*
|
||
* @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
|
||
*/
|
||
public $ob_level;
|
||
|
||
/**
|
||
* The path to the directory containing the
|
||
* cli and html error view directories.
|
||
*
|
||
* @var string
|
||
*
|
||
* @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
|
||
*/
|
||
protected $viewPath;
|
||
|
||
/**
|
||
* Config for debug exceptions.
|
||
*
|
||
* @var ExceptionsConfig
|
||
*/
|
||
protected $config;
|
||
|
||
/**
|
||
* The request.
|
||
*
|
||
* @var RequestInterface|null
|
||
*/
|
||
protected $request;
|
||
|
||
/**
|
||
* The outgoing response.
|
||
*
|
||
* @var ResponseInterface
|
||
*/
|
||
protected $response;
|
||
|
||
private ?Throwable $exceptionCaughtByExceptionHandler = null;
|
||
|
||
public function __construct(ExceptionsConfig $config)
|
||
{
|
||
// For backward compatibility
|
||
$this->ob_level = ob_get_level();
|
||
$this->viewPath = rtrim($config->errorViewPath, '\\/ ') . DIRECTORY_SEPARATOR;
|
||
|
||
$this->config = $config;
|
||
|
||
// workaround for upgraded users
|
||
// This causes "Deprecated: Creation of dynamic property" in PHP 8.2.
|
||
// @TODO remove this after dropping PHP 8.1 support.
|
||
if (! isset($this->config->sensitiveDataInTrace)) {
|
||
$this->config->sensitiveDataInTrace = [];
|
||
}
|
||
if (! isset($this->config->logDeprecations, $this->config->deprecationLogLevel)) {
|
||
$this->config->logDeprecations = false;
|
||
$this->config->deprecationLogLevel = 'warning';
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Responsible for registering the error, exception and shutdown
|
||
* handling of our application.
|
||
*
|
||
* @codeCoverageIgnore
|
||
*
|
||
* @return void
|
||
*/
|
||
public function initialize()
|
||
{
|
||
set_exception_handler([$this, 'exceptionHandler']);
|
||
set_error_handler([$this, 'errorHandler']);
|
||
//set_exception_handler($this->exceptionHandler(...));
|
||
//set_error_handler($this->errorHandler(...));
|
||
register_shutdown_function([$this, 'shutdownHandler']);
|
||
}
|
||
|
||
/**
|
||
* 中文翻译输出的错误信息
|
||
*/
|
||
private function _cn_msg($message) {
|
||
|
||
if (!$message) {
|
||
return $message;
|
||
}
|
||
|
||
if (strpos($message, 'Unable to connect to the database') !== false) {
|
||
$message.= '<br>无法连接到数据库，检查数据库是否启动或者数据库配置文件不对，config/database.php';
|
||
} elseif (strpos($message, 'Unclosed \'{\'') !== false) {
|
||
$message.= '<br>循环体或者if语句，缺少结束语句，{ }没有成对出现';
|
||
} elseif (strpos($message, 'Cannot access offset of type string on string') !== false) {
|
||
$message.= '<br>此变量是字符串，不能使用数组的方式调用他，检查下代码语法';
|
||
} elseif (strpos($message, 'Call to undefined function') !== false) {
|
||
$message.= '<br>'.str_replace('Call to undefined function', '函数没有定义', $message);
|
||
} elseif (strpos($message, 'open_basedir restriction in effect') !== false) {
|
||
$message.= '<br>目录被限制读取，需要设置.users.ini文件中的目录白名单';
|
||
} elseif (strpos($message, 'Undefined constant') !== false) {
|
||
$message.= '<br>'.str_replace('Undefined constant', '变量或者常量没有定义', $message);
|
||
} elseif (preg_match("/Table '(.+)' doesn't exist/", $message, $mt)) {
|
||
$message.= '<br>数据库表'.$mt[1].'不存在，表丢失或者表没有创建成功';
|
||
} elseif (preg_match("/Unknown column '(.+)' in 'field list'/", $message, $mt)) {
|
||
$message.= '<br>表中没有字段'.$mt[1].'，字段没有被创建';
|
||
} elseif (preg_match("/Access level to (.+) must be protected \(as in class (.+)\) or weaker/U", $message, $mt)) {
|
||
$message.= '<br>'.$mt[1].'在类'.$mt[2].'中已经被定义过更高级别的权限，请删除本文件的定义代码';
|
||
} elseif (preg_match("/Creation of dynamic property (.+) is deprecated/", $message, $mt)) {
|
||
$message.= '<br>动态属性被废除'.$mt[1].'，请预先定义';
|
||
} elseif (preg_match("/Failed opening required '(.+)'/", $message, $mt)) {
|
||
$message.= '<br>文件'.$mt[1].'不存在，文件丢失或者文件没有创建成功';
|
||
} elseif (preg_match("/syntax error, unexpected token (.+)/", $message, $mt)) {
|
||
$message.= '<br>PHP语法错误 或者 模板标签语法错误，检查上下行代码是否写对';
|
||
} elseif (preg_match("/Cannot declare class (.+), because the name is already in use/", $message, $mt)) {
|
||
$message.= '<br>类名'.$mt[1].'重复，全文搜索下哪个地方被重复命名了';
|
||
} elseif (preg_match("/Controller method is not found: (.+)/", $message, $mt)) {
|
||
$message.= '<br>检查此文件中是否有'.$mt[1].'方法名：'.$this->_get_file();
|
||
} elseif (preg_match("/Controller or its method is not found:(.+)/", $message, $mt)) {
|
||
$message.= '<br>检查此文件是否存在：'.$this->_get_file().'，检查地址是否正确，注意控制器文件首字母要大写';
|
||
} elseif (preg_match("/count\(\): Argument #1 \((.+)\) must be of type Countable\|array/", $message, $mt)) {
|
||
$message.= '<br>需要将count函数改为dr_count';
|
||
} elseif (IS_XRDEV) {
|
||
|
||
}
|
||
|
||
return $message;
|
||
}
|
||
|
||
|
||
/**
|
||
* 替换模板文件显示完整路径
|
||
*/
|
||
private function _rp_file($file) {
|
||
|
||
if (strpos((string)$file, '.cache.php') !== false && strpos((string)$file, '_DS_') !== false) {
|
||
$file = str_replace([WRITEPATH.'template/', '_DS_', '.cache.php'], ['', '/', ''], $file);
|
||
}
|
||
|
||
return $file;
|
||
}
|
||
|
||
/**
|
||
* 获取控制器地址
|
||
*/
|
||
private function _get_file() {
|
||
$file = APPPATH;
|
||
if ($file == FRAMEPATH) {
|
||
$file = CMSPATH.'Control';
|
||
} else {
|
||
$file.= 'Controllers';
|
||
}
|
||
|
||
if (IS_ADMIN) {
|
||
$file.= '/Admin';
|
||
} elseif (IS_MEMBER) {
|
||
$file.= '/Member';
|
||
} elseif (IS_API) {
|
||
$file.= '/Api';
|
||
}
|
||
|
||
return $file.'/'.ucfirst(\Phpcmf\Service::L('Router')->class).'.php';
|
||
}
|
||
|
||
|
||
|
||
/**
|
||
* Catches any uncaught errors and exceptions, including most Fatal errors
|
||
* (Yay PHP7!). Will log the error, display it if display_errors is on,
|
||
* and fire an event that allows custom actions to be taken at this point.
|
||
*
|
||
* @return void
|
||
*/
|
||
public function exceptionHandler(Throwable $exception)
|
||
{
|
||
|
||
$message = $this->_cn_msg($exception->getMessage());
|
||
// ajax 返回
|
||
if (IS_AJAX || IS_API) {
|
||
// 调试模式不屏蔽敏感信息
|
||
$file = $exception->getFile();
|
||
if (strpos($file, WRITEPATH.'template') !== false) {
|
||
$file = $this->_rp_file($file);
|
||
$message = '模板标签写法错误：'.$message;
|
||
$arr = \Phpcmf\Service::V()->get_view_files();
|
||
if ($arr) {
|
||
$one = current($arr);
|
||
$message.= '（'.CI_DEBUG ? $one['path'] : basename($one['path']).'）';
|
||
}
|
||
}
|
||
if (CI_DEBUG) {
|
||
$message.= '<br>错误文件：'.$file.'（'.$exception->getLine().'）';
|
||
$message.= '<br>访问地址：'.\Phpcmf\Service::V()->now_php_url();
|
||
$trace = $exception->getTrace();
|
||
if ($trace) {
|
||
foreach ($trace as $t) {
|
||
if ($t['file'] && strpos((string)$t['file'], FRAMEPATH) === false) {
|
||
$message.= '<br>'.$t['function'].'：'.$t['file'].'（'.$t['line'].'）';
|
||
}
|
||
}
|
||
}
|
||
} else {
|
||
$message = str_replace([FCPATH, WEBPATH], ['/', '/'], $message);
|
||
}
|
||
dr_exit_msg(0, $message);
|
||
}
|
||
|
||
|
||
$this->exceptionCaughtByExceptionHandler = null;
|
||
|
||
$this->exceptionCaughtByExceptionHandler = $exception;
|
||
|
||
[$statusCode, $exitCode] = $this->determineCodes($exception);
|
||
|
||
if ($this->config->log === true && ! in_array($statusCode, $this->config->ignoreCodes, true)) {
|
||
$uri = '';
|
||
$routeInfo = '';
|
||
|
||
log_message('critical', $exception::class . ": {message}\n{routeInfo}\nin {exFile} on line {exLine}.\n{trace}", [
|
||
'message' => $exception->getMessage(),
|
||
'routeInfo' => $routeInfo,
|
||
'exFile' => clean_path($exception->getFile()), // {file} refers to THIS file
|
||
'exLine' => $exception->getLine(), // {line} refers to THIS line
|
||
'trace' => self::renderBacktrace($exception->getTrace()),
|
||
]);
|
||
|
||
// Get the first exception.
|
||
$last = $exception;
|
||
|
||
while ($prevException = $last->getPrevious()) {
|
||
$last = $prevException;
|
||
|
||
log_message('critical', '[Caused by] ' . $prevException::class . ": {message}\nin {exFile} on line {exLine}.\n{trace}", [
|
||
'message' => $prevException->getMessage(),
|
||
'exFile' => clean_path($prevException->getFile()), // {file} refers to THIS file
|
||
'exLine' => $prevException->getLine(), // {line} refers to THIS line
|
||
'trace' => self::renderBacktrace($prevException->getTrace()),
|
||
]);
|
||
}
|
||
}
|
||
|
||
|
||
if (method_exists($this->config, 'handler')) {
|
||
// Use new ExceptionHandler
|
||
$handler = $this->config->handler($statusCode, $exception);
|
||
$handler->handle(
|
||
$exception,
|
||
null,
|
||
null,
|
||
$statusCode,
|
||
$exitCode,
|
||
);
|
||
|
||
return;
|
||
} else {
|
||
exit($exception->getMessage());
|
||
}
|
||
|
||
}
|
||
|
||
/**
|
||
* The callback to be registered to `set_error_handler()`.
|
||
*
|
||
* @return bool
|
||
*
|
||
* @throws ErrorException
|
||
*
|
||
* @codeCoverageIgnore
|
||
*/
|
||
public function errorHandler(int $severity, string $message, ?string $file = null, ?int $line = null)
|
||
{
|
||
if ($this->isDeprecationError($severity)) {
|
||
if ($this->isSessionSidDeprecationError($message, $file, $line)) {
|
||
return true;
|
||
}
|
||
|
||
if ($this->isImplicitNullableDeprecationError($message, $file, $line)) {
|
||
return true;
|
||
}
|
||
|
||
if (! $this->config->logDeprecations || (bool) env('CODEIGNITER_SCREAM_DEPRECATIONS')) {
|
||
throw new ErrorException($message, 0, $severity, $file, $line);
|
||
}
|
||
|
||
return $this->handleDeprecationError($message, $file, $line);
|
||
}
|
||
|
||
if ((error_reporting() & $severity) !== 0) {
|
||
throw new ErrorException($message, 0, $severity, $file, $line);
|
||
}
|
||
|
||
return false; // return false to propagate the error to PHP standard error handler
|
||
}
|
||
|
||
/**
|
||
* Handles session.sid_length and session.sid_bits_per_character deprecations
|
||
* in PHP 8.4.
|
||
*/
|
||
private function isSessionSidDeprecationError(string $message, ?string $file = null, ?int $line = null): bool
|
||
{
|
||
if (
|
||
PHP_VERSION_ID >= 80400
|
||
&& str_contains($message, 'session.sid_')
|
||
) {
|
||
log_message(
|
||
'wranting',
|
||
'[DEPRECATED] {message} in {errFile} on line {errLine}.',
|
||
[
|
||
'message' => $message,
|
||
'errFile' => clean_path($file ?? ''),
|
||
'errLine' => $line ?? 0,
|
||
],
|
||
);
|
||
|
||
return true;
|
||
}
|
||
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Workaround to implicit nullable deprecation errors in PHP 8.4.
|
||
*
|
||
* "Implicitly marking parameter $xxx as nullable is deprecated,
|
||
* the explicit nullable type must be used instead"
|
||
*
|
||
* @TODO remove this before v4.6.0 release
|
||
*/
|
||
private function isImplicitNullableDeprecationError(string $message, ?string $file = null, ?int $line = null): bool
|
||
{
|
||
if (
|
||
PHP_VERSION_ID >= 80400
|
||
&& str_contains($message, 'the explicit nullable type must be used instead')
|
||
// Only Kint and Faker, which cause this error, are logged.
|
||
&& (str_starts_with($message, 'Kint\\') || str_starts_with($message, 'Faker\\'))
|
||
) {
|
||
log_message(
|
||
'wranting',
|
||
'[DEPRECATED] {message} in {errFile} on line {errLine}.',
|
||
[
|
||
'message' => $message,
|
||
'errFile' => clean_path($file ?? ''),
|
||
'errLine' => $line ?? 0,
|
||
],
|
||
);
|
||
|
||
return true;
|
||
}
|
||
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Checks to see if any errors have happened during shutdown that
|
||
* need to be caught and handle them.
|
||
*
|
||
* @codeCoverageIgnore
|
||
*
|
||
* @return void
|
||
*/
|
||
public function shutdownHandler()
|
||
{
|
||
$error = error_get_last();
|
||
|
||
if ($error === null) {
|
||
return;
|
||
}
|
||
|
||
['type' => $type, 'message' => $message, 'file' => $file, 'line' => $line] = $error;
|
||
|
||
if ($this->exceptionCaughtByExceptionHandler instanceof Throwable) {
|
||
$message .= "\n【Previous Exception】\n"
|
||
. $this->exceptionCaughtByExceptionHandler::class . "\n"
|
||
. $this->exceptionCaughtByExceptionHandler->getMessage() . "\n"
|
||
. $this->exceptionCaughtByExceptionHandler->getTraceAsString();
|
||
}
|
||
|
||
if (in_array($type, [E_ERROR, E_CORE_ERROR, E_COMPILE_ERROR, E_PARSE], true)) {
|
||
$this->exceptionHandler(new ErrorException($message, 0, $type, $file, $line));
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Determines the view to display based on the exception thrown,
|
||
* whether an HTTP or CLI request, etc.
|
||
*
|
||
* @return string The path and filename of the view file to use
|
||
*
|
||
* @deprecated 4.4.0 No longer used. Moved to ExceptionHandler.
|
||
*/
|
||
protected function determineView(Throwable $exception, string $templatePath): string
|
||
{
|
||
// Production environments should have a custom exception file.
|
||
$view = 'production.php';
|
||
$templatePath = rtrim($templatePath, '\\/ ') . DIRECTORY_SEPARATOR;
|
||
|
||
if (
|
||
in_array(
|
||
strtolower(ini_get('display_errors')),
|
||
['1', 'true', 'on', 'yes'],
|
||
true,
|
||
)
|
||
) {
|
||
$view = 'error_exception.php';
|
||
}
|
||
|
||
// 404 Errors
|
||
if ($exception instanceof PageNotFoundException) {
|
||
return 'error_404.php';
|
||
}
|
||
|
||
// Allow for custom views based upon the status code
|
||
if (is_file($templatePath . 'error_' . $exception->getCode() . '.php')) {
|
||
return 'error_' . $exception->getCode() . '.php';
|
||
}
|
||
|
||
return $view;
|
||
}
|
||
|
||
/**
|
||
* Given an exception and status code will display the error to the client.
|
||
*
|
||
* @return void
|
||
*
|
||
* @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
|
||
*/
|
||
protected function render(Throwable $exception, int $statusCode)
|
||
{
|
||
// Determine possible directories of error views
|
||
$path = $this->viewPath;
|
||
$altPath = rtrim((new Paths())->viewDirectory, '\\/ ') . DIRECTORY_SEPARATOR . 'errors' . DIRECTORY_SEPARATOR;
|
||
|
||
$path .= (is_cli() ? 'cli' : 'html') . DIRECTORY_SEPARATOR;
|
||
$altPath .= (is_cli() ? 'cli' : 'html') . DIRECTORY_SEPARATOR;
|
||
|
||
// Determine the views
|
||
$view = $this->determineView($exception, $path);
|
||
$altView = $this->determineView($exception, $altPath);
|
||
|
||
// Check if the view exists
|
||
if (is_file($path . $view)) {
|
||
$viewFile = $path . $view;
|
||
} elseif (is_file($altPath . $altView)) {
|
||
$viewFile = $altPath . $altView;
|
||
}
|
||
|
||
if (! isset($viewFile)) {
|
||
echo 'The error view files were not found. Cannot render exception trace.';
|
||
|
||
exit(1);
|
||
}
|
||
|
||
echo (function () use ($exception, $statusCode, $viewFile): string {
|
||
$vars = $this->collectVars($exception, $statusCode);
|
||
extract($vars, EXTR_SKIP);
|
||
|
||
ob_start();
|
||
include $viewFile;
|
||
|
||
return ob_get_clean();
|
||
})();
|
||
}
|
||
|
||
/**
|
||
* Gathers the variables that will be made available to the view.
|
||
*
|
||
* @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
|
||
*/
|
||
protected function collectVars(Throwable $exception, int $statusCode): array
|
||
{
|
||
// Get the first exception.
|
||
$firstException = $exception;
|
||
|
||
while ($prevException = $firstException->getPrevious()) {
|
||
$firstException = $prevException;
|
||
}
|
||
|
||
$trace = $firstException->getTrace();
|
||
|
||
if ($this->config->sensitiveDataInTrace !== []) {
|
||
$trace = $this->maskSensitiveData($trace, $this->config->sensitiveDataInTrace);
|
||
}
|
||
|
||
return [
|
||
'title' => $exception::class,
|
||
'type' => $exception::class,
|
||
'code' => $statusCode,
|
||
'message' => $exception->getMessage(),
|
||
'file' => $exception->getFile(),
|
||
'line' => $exception->getLine(),
|
||
'trace' => $trace,
|
||
];
|
||
}
|
||
|
||
/**
|
||
* Mask sensitive data in the trace.
|
||
*
|
||
* @param array $trace
|
||
*
|
||
* @return array
|
||
*
|
||
* @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
|
||
*/
|
||
protected function maskSensitiveData($trace, array $keysToMask, string $path = '')
|
||
{
|
||
foreach ($trace as $i => $line) {
|
||
$trace[$i]['args'] = $this->maskData($line['args'], $keysToMask);
|
||
}
|
||
|
||
return $trace;
|
||
}
|
||
|
||
/**
|
||
* @param array|object $args
|
||
*
|
||
* @return array|object
|
||
*
|
||
* @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
|
||
*/
|
||
private function maskData($args, array $keysToMask, string $path = '')
|
||
{
|
||
foreach ($keysToMask as $keyToMask) {
|
||
$explode = explode('/', $keyToMask);
|
||
$index = end($explode);
|
||
|
||
if (str_starts_with(strrev($path . '/' . $index), strrev($keyToMask))) {
|
||
if (is_array($args) && array_key_exists($index, $args)) {
|
||
$args[$index] = '******************';
|
||
} elseif (
|
||
is_object($args) && property_exists($args, $index)
|
||
&& isset($args->{$index}) && is_scalar($args->{$index})
|
||
) {
|
||
$args->{$index} = '******************';
|
||
}
|
||
}
|
||
}
|
||
|
||
if (is_array($args)) {
|
||
foreach ($args as $pathKey => $subarray) {
|
||
$args[$pathKey] = $this->maskData($subarray, $keysToMask, $path . '/' . $pathKey);
|
||
}
|
||
} elseif (is_object($args)) {
|
||
foreach ($args as $pathKey => $subarray) {
|
||
$args->{$pathKey} = $this->maskData($subarray, $keysToMask, $path . '/' . $pathKey);
|
||
}
|
||
}
|
||
|
||
return $args;
|
||
}
|
||
|
||
/**
|
||
* Determines the HTTP status code and the exit status code for this request.
|
||
*/
|
||
protected function determineCodes(Throwable $exception): array
|
||
{
|
||
$statusCode = 500;
|
||
$exitStatus = EXIT_ERROR;
|
||
|
||
if ($exception instanceof HTTPExceptionInterface) {
|
||
$statusCode = $exception->getCode();
|
||
}
|
||
|
||
if ($exception instanceof HasExitCodeInterface) {
|
||
$exitStatus = $exception->getExitCode();
|
||
}
|
||
|
||
return [$statusCode, $exitStatus];
|
||
}
|
||
|
||
private function isDeprecationError(int $error): bool
|
||
{
|
||
$deprecations = E_DEPRECATED | E_USER_DEPRECATED;
|
||
|
||
return ($error & $deprecations) !== 0;
|
||
}
|
||
|
||
/**
|
||
* @return true
|
||
*/
|
||
private function handleDeprecationError(string $message, ?string $file = null, ?int $line = null): bool
|
||
{
|
||
// Remove the trace of the error handler.
|
||
$trace = array_slice(debug_backtrace(), 2);
|
||
|
||
log_message(
|
||
$this->config->deprecationLogLevel,
|
||
"[DEPRECATED] {message} in {errFile} on line {errLine}.\n{trace}",
|
||
[
|
||
'message' => $message,
|
||
'errFile' => clean_path($file ?? ''),
|
||
'errLine' => $line ?? 0,
|
||
'trace' => self::renderBacktrace($trace),
|
||
],
|
||
);
|
||
|
||
return true;
|
||
}
|
||
|
||
// --------------------------------------------------------------------
|
||
// Display Methods
|
||
// --------------------------------------------------------------------
|
||
|
||
/**
|
||
* This makes nicer looking paths for the error output.
|
||
*
|
||
* @deprecated Use dedicated `clean_path()` function.
|
||
*/
|
||
public static function cleanPath(string $file): string
|
||
{
|
||
return CI_DEBUG ? $file : match (true) {
|
||
str_starts_with($file, APPPATH) => 'APPPATH' . DIRECTORY_SEPARATOR . substr($file, strlen(APPPATH)),
|
||
str_starts_with($file, SYSTEMPATH) => 'SYSTEMPATH' . DIRECTORY_SEPARATOR . substr($file, strlen(SYSTEMPATH)),
|
||
str_starts_with($file, FCPATH) => 'FCPATH' . DIRECTORY_SEPARATOR . substr($file, strlen(FCPATH)),
|
||
defined('VENDORPATH') && str_starts_with($file, VENDORPATH) => 'VENDORPATH' . DIRECTORY_SEPARATOR . substr($file, strlen(VENDORPATH)),
|
||
default => $file,
|
||
};
|
||
}
|
||
|
||
/**
|
||
* Describes memory usage in real-world units. Intended for use
|
||
* with memory_get_usage, etc.
|
||
*
|
||
* @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
|
||
*/
|
||
public static function describeMemory(int $bytes): string
|
||
{
|
||
if ($bytes < 1024) {
|
||
return $bytes . 'B';
|
||
}
|
||
|
||
if ($bytes < 1_048_576) {
|
||
return round($bytes / 1024, 2) . 'KB';
|
||
}
|
||
|
||
return round($bytes / 1_048_576, 2) . 'MB';
|
||
}
|
||
|
||
/**
|
||
* Creates a syntax-highlighted version of a PHP file.
|
||
*
|
||
* @return bool|string
|
||
*
|
||
* @deprecated 4.4.0 No longer used. Moved to BaseExceptionHandler.
|
||
*/
|
||
public static function highlightFile(string $file, int $lineNumber, int $lines = 15)
|
||
{
|
||
if ($file === '' || ! is_readable($file)) {
|
||
return false;
|
||
}
|
||
|
||
// Set our highlight colors:
|
||
if (function_exists('ini_set')) {
|
||
ini_set('highlight.comment', '#767a7e; font-style: italic');
|
||
ini_set('highlight.default', '#c7c7c7');
|
||
ini_set('highlight.html', '#06B');
|
||
ini_set('highlight.keyword', '#f1ce61;');
|
||
ini_set('highlight.string', '#869d6a');
|
||
}
|
||
|
||
try {
|
||
$source = file_get_contents($file);
|
||
} catch (Throwable) {
|
||
return false;
|
||
}
|
||
|
||
$source = str_replace(["\r\n", "\r"], "\n", $source);
|
||
$source = explode("\n", highlight_string($source, true));
|
||
$source = str_replace('<br />', "\n", $source[1]);
|
||
$source = explode("\n", str_replace("\r\n", "\n", $source));
|
||
|
||
// Get just the part to show
|
||
$start = max($lineNumber - (int) round($lines / 2), 0);
|
||
|
||
// Get just the lines we need to display, while keeping line numbers...
|
||
$source = array_splice($source, $start, $lines, true);
|
||
|
||
// Used to format the line number in the source
|
||
$format = '% ' . strlen((string) ($start + $lines)) . 'd';
|
||
|
||
$out = '';
|
||
// Because the highlighting may have an uneven number
|
||
// of open and close span tags on one line, we need
|
||
// to ensure we can close them all to get the lines
|
||
// showing correctly.
|
||
$spans = 1;
|
||
|
||
foreach ($source as $n => $row) {
|
||
$spans += substr_count($row, '<span') - substr_count($row, '</span');
|
||
$row = str_replace(["\r", "\n"], ['', ''], $row);
|
||
|
||
if (($n + $start + 1) === $lineNumber) {
|
||
preg_match_all('#<[^>]+>#', $row, $tags);
|
||
|
||
$out .= sprintf(
|
||
"<span class='line highlight'><span class='number'>{$format}</span> %s\n</span>%s",
|
||
$n + $start + 1,
|
||
strip_tags($row),
|
||
implode('', $tags[0]),
|
||
);
|
||
} else {
|
||
$out .= sprintf('<span class="line"><span class="number">' . $format . '</span> %s', $n + $start + 1, $row) . "\n";
|
||
}
|
||
}
|
||
|
||
if ($spans > 0) {
|
||
$out .= str_repeat('</span>', $spans);
|
||
}
|
||
|
||
return '<pre><code>' . $out . '</code></pre>';
|
||
}
|
||
|
||
private static function renderBacktrace(array $backtrace): string
|
||
{
|
||
$backtraces = [];
|
||
|
||
foreach ($backtrace as $index => $trace) {
|
||
$frame = $trace + ['file' => '[internal function]', 'line' => '', 'class' => '', 'type' => '', 'args' => []];
|
||
|
||
if ($frame['file'] !== '[internal function]') {
|
||
$frame['file'] = sprintf('%s(%s)', $frame['file'], $frame['line']);
|
||
}
|
||
|
||
unset($frame['line']);
|
||
$idx = $index;
|
||
$idx = str_pad((string) ++$idx, 2, ' ', STR_PAD_LEFT);
|
||
|
||
$args = implode(', ', array_map(static fn ($value): string => match (true) {
|
||
is_object($value) => sprintf('Object(%s)', $value::class),
|
||
is_array($value) => $value !== [] ? '[...]' : '[]',
|
||
$value === null => 'null',
|
||
is_resource($value) => sprintf('resource (%s)', get_resource_type($value)),
|
||
default => var_export($value, true),
|
||
}, $frame['args']));
|
||
|
||
$backtraces[] = sprintf(
|
||
'%s %s: %s%s%s(%s)',
|
||
$idx,
|
||
clean_path($frame['file']),
|
||
$frame['class'],
|
||
$frame['type'],
|
||
$frame['function'],
|
||
$args,
|
||
);
|
||
}
|
||
|
||
return implode("\n", $backtraces);
|
||
}
|
||
}
|