297 lines
11 KiB
PHP
297 lines
11 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Symfony\Bundle\WebProfilerBundle\Profiler;
|
|
|
|
use Symfony\Component\ErrorHandler\ErrorRenderer\FileLinkFormatter;
|
|
use Twig\Extension\AbstractExtension;
|
|
use Twig\TwigFilter;
|
|
|
|
/**
|
|
* Twig extension related to PHP code and used by the profiler and the default exception templates.
|
|
*
|
|
* This extension should only be used for debugging tools code
|
|
* that is never executed in a production environment.
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*/
|
|
final class CodeExtension extends AbstractExtension
|
|
{
|
|
private string|FileLinkFormatter|array|false $fileLinkFormat;
|
|
|
|
public function __construct(
|
|
string|FileLinkFormatter $fileLinkFormat,
|
|
private string $projectDir,
|
|
private string $charset,
|
|
) {
|
|
$this->fileLinkFormat = $fileLinkFormat ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
|
|
$this->projectDir = str_replace('\\', '/', $projectDir).'/';
|
|
}
|
|
|
|
public function getFilters(): array
|
|
{
|
|
return [
|
|
new TwigFilter('abbr_class', $this->abbrClass(...), ['is_safe' => ['html'], 'pre_escape' => 'html']),
|
|
new TwigFilter('abbr_method', $this->abbrMethod(...), ['is_safe' => ['html'], 'pre_escape' => 'html']),
|
|
new TwigFilter('format_args', $this->formatArgs(...), ['is_safe' => ['html']]),
|
|
new TwigFilter('format_args_as_text', $this->formatArgsAsText(...)),
|
|
new TwigFilter('file_excerpt', $this->fileExcerpt(...), ['is_safe' => ['html']]),
|
|
new TwigFilter('format_file', $this->formatFile(...), ['is_safe' => ['html']]),
|
|
new TwigFilter('format_file_from_text', $this->formatFileFromText(...), ['is_safe' => ['html']]),
|
|
new TwigFilter('format_log_message', $this->formatLogMessage(...), ['is_safe' => ['html']]),
|
|
new TwigFilter('file_link', $this->getFileLink(...)),
|
|
new TwigFilter('file_relative', $this->getFileRelative(...)),
|
|
];
|
|
}
|
|
|
|
public function abbrClass(string $class): string
|
|
{
|
|
$parts = explode('\\', $class);
|
|
$short = array_pop($parts);
|
|
|
|
return \sprintf('<abbr title="%s">%s</abbr>', $class, $short);
|
|
}
|
|
|
|
public function abbrMethod(string $method): string
|
|
{
|
|
if (str_contains($method, '::')) {
|
|
[$class, $method] = explode('::', $method, 2);
|
|
$result = \sprintf('%s::%s()', $this->abbrClass($class), $method);
|
|
} elseif ('Closure' === $method) {
|
|
$result = \sprintf('<abbr title="%s">%1$s</abbr>', $method);
|
|
} else {
|
|
$result = \sprintf('<abbr title="%s">%1$s</abbr>()', $method);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Formats an array as a string.
|
|
*/
|
|
public function formatArgs(array $args): string
|
|
{
|
|
$result = [];
|
|
foreach ($args as $key => $item) {
|
|
if ('object' === $item[0]) {
|
|
$item[1] = htmlspecialchars($item[1], \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset);
|
|
$parts = explode('\\', $item[1]);
|
|
$short = array_pop($parts);
|
|
$formattedValue = \sprintf('<em>object</em>(<abbr title="%s">%s</abbr>)', $item[1], $short);
|
|
} elseif ('array' === $item[0]) {
|
|
$formattedValue = \sprintf('<em>array</em>(%s)', \is_array($item[1]) ? $this->formatArgs($item[1]) : htmlspecialchars(var_export($item[1], true), \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset));
|
|
} elseif ('null' === $item[0]) {
|
|
$formattedValue = '<em>null</em>';
|
|
} elseif ('boolean' === $item[0]) {
|
|
$formattedValue = '<em>'.strtolower(htmlspecialchars(var_export($item[1], true), \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset)).'</em>';
|
|
} elseif ('resource' === $item[0]) {
|
|
$formattedValue = '<em>resource</em>';
|
|
} elseif (preg_match('/[^\x07-\x0D\x1B\x20-\xFF]/', $item[1])) {
|
|
$formattedValue = '<em>binary string</em>';
|
|
} else {
|
|
$formattedValue = str_replace("\n", '', htmlspecialchars(var_export($item[1], true), \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset));
|
|
}
|
|
|
|
$result[] = \is_int($key) ? $formattedValue : \sprintf("'%s' => %s", htmlspecialchars($key, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset), $formattedValue);
|
|
}
|
|
|
|
return implode(', ', $result);
|
|
}
|
|
|
|
/**
|
|
* Formats an array as a string.
|
|
*/
|
|
public function formatArgsAsText(array $args): string
|
|
{
|
|
return strip_tags($this->formatArgs($args));
|
|
}
|
|
|
|
/**
|
|
* Returns an excerpt of a code file around the given line number.
|
|
*/
|
|
public function fileExcerpt(string $file, int $line, int $srcContext = 3): ?string
|
|
{
|
|
if (!is_file($file) || !is_readable($file)) {
|
|
return null;
|
|
}
|
|
|
|
$contents = file_get_contents($file);
|
|
|
|
if (!str_contains($contents, '<?php') && !str_contains($contents, '<?=')) {
|
|
$lines = explode("\n", $contents);
|
|
|
|
if (0 > $srcContext) {
|
|
$srcContext = \count($lines);
|
|
}
|
|
|
|
return $this->formatFileExcerpt(
|
|
$this->extractExcerptLines($lines, $line, $srcContext),
|
|
$line,
|
|
$srcContext
|
|
);
|
|
}
|
|
|
|
// highlight_string could throw warnings
|
|
// see https://bugs.php.net/25725
|
|
$code = @highlight_string($contents, true);
|
|
|
|
if (\PHP_VERSION_ID >= 80300) {
|
|
// remove main pre/code tags
|
|
$code = preg_replace('#^<pre.*?>\s*<code.*?>(.*)</code>\s*</pre>#s', '\\1', $code);
|
|
// split multiline span tags
|
|
$code = preg_replace_callback(
|
|
'#<span ([^>]++)>((?:[^<\\n]*+\\n)++[^<]*+)</span>#',
|
|
static fn (array $m): string => "<span $m[1]>".str_replace("\n", "</span>\n<span $m[1]>", $m[2]).'</span>',
|
|
$code
|
|
);
|
|
$lines = explode("\n", $code);
|
|
} else {
|
|
// remove main code/span tags
|
|
$code = preg_replace('#^<code.*?>\s*<span.*?>(.*)</span>\s*</code>#s', '\\1', $code);
|
|
// split multiline spans
|
|
$code = preg_replace_callback(
|
|
'#<span ([^>]++)>((?:[^<]*+<br \/>)++[^<]*+)</span>#',
|
|
static fn (array $m): string => "<span $m[1]>".str_replace('<br />', "</span><br /><span $m[1]>", $m[2]).'</span>',
|
|
$code
|
|
);
|
|
$lines = explode('<br />', $code);
|
|
}
|
|
|
|
if (0 > $srcContext) {
|
|
$srcContext = \count($lines);
|
|
}
|
|
|
|
return $this->formatFileExcerpt(
|
|
array_map(
|
|
self::fixCodeMarkup(...),
|
|
$this->extractExcerptLines($lines, $line, $srcContext),
|
|
),
|
|
$line,
|
|
$srcContext
|
|
);
|
|
}
|
|
|
|
private function extractExcerptLines(array $lines, int $selectedLine, int $srcContext): array
|
|
{
|
|
return \array_slice(
|
|
$lines,
|
|
max($selectedLine - $srcContext, 0),
|
|
min($srcContext * 2 + 1, \count($lines) - $selectedLine + $srcContext),
|
|
true
|
|
);
|
|
}
|
|
|
|
private function formatFileExcerpt(array $lines, int $selectedLine, int $srcContext): string
|
|
{
|
|
$start = max($selectedLine - $srcContext, 1);
|
|
|
|
return "<ol start=\"{$start}\">".implode("\n", array_map(
|
|
static fn (string $line, int $num): string => '<li'.(++$num === $selectedLine ? ' class="selected"' : '')."><a class=\"anchor\" id=\"line{$num}\"></a><code>{$line}</code></li>",
|
|
$lines,
|
|
array_keys($lines),
|
|
)).'</ol>';
|
|
}
|
|
|
|
/**
|
|
* Formats a file path.
|
|
*/
|
|
public function formatFile(string $file, int $line, ?string $text = null): string
|
|
{
|
|
$file = trim($file);
|
|
|
|
if (null === $text) {
|
|
if (null !== $rel = $this->getFileRelative($file)) {
|
|
$rel = explode('/', htmlspecialchars($rel, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset), 2);
|
|
$text = \sprintf('<abbr title="%s%2$s">%s</abbr>%s', htmlspecialchars($this->projectDir, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset), $rel[0], '/'.($rel[1] ?? ''));
|
|
} else {
|
|
$text = htmlspecialchars($file, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset);
|
|
}
|
|
} else {
|
|
$text = htmlspecialchars($text, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset);
|
|
}
|
|
|
|
if (0 < $line) {
|
|
$text .= ' at line '.$line;
|
|
}
|
|
|
|
if (false !== $link = $this->getFileLink($file, $line)) {
|
|
return \sprintf('<a href="%s" title="Click to open this file" class="file_link">%s</a>', htmlspecialchars($link, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset), $text);
|
|
}
|
|
|
|
return $text;
|
|
}
|
|
|
|
public function getFileLink(string $file, int $line): string|false
|
|
{
|
|
if ($fmt = $this->fileLinkFormat) {
|
|
return \is_string($fmt) ? strtr($fmt, ['%f' => $file, '%l' => $line]) : $fmt->format($file, $line);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
public function getFileRelative(string $file): ?string
|
|
{
|
|
$file = str_replace('\\', '/', $file);
|
|
|
|
if (null !== $this->projectDir && str_starts_with($file, $this->projectDir)) {
|
|
return ltrim(substr($file, \strlen($this->projectDir)), '/');
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
public function formatFileFromText(string $text): string
|
|
{
|
|
return preg_replace_callback('/in ("|")?(.+?)\1(?: +(?:on|at))? +line (\d+)/s', fn ($match) => 'in '.$this->formatFile($match[2], $match[3]), $text);
|
|
}
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
public function formatLogMessage(string $message, array $context): string
|
|
{
|
|
if ($context && str_contains($message, '{')) {
|
|
$replacements = [];
|
|
foreach ($context as $key => $val) {
|
|
if (\is_scalar($val)) {
|
|
$replacements['{'.$key.'}'] = $val;
|
|
}
|
|
}
|
|
|
|
if ($replacements) {
|
|
$message = strtr($message, $replacements);
|
|
}
|
|
}
|
|
|
|
return htmlspecialchars($message, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset);
|
|
}
|
|
|
|
protected static function fixCodeMarkup(string $line): string
|
|
{
|
|
// </span> ending tag from previous line
|
|
$opening = strpos($line, '<span');
|
|
$closing = strpos($line, '</span>');
|
|
if (false !== $closing && (false === $opening || $closing < $opening)) {
|
|
$line = substr_replace($line, '', $closing, 7);
|
|
}
|
|
|
|
// missing </span> tag at the end of line
|
|
$opening = strpos($line, '<span');
|
|
$closing = strpos($line, '</span>');
|
|
if (false !== $opening && (false === $closing || $closing < $opening)) {
|
|
$line .= '</span>';
|
|
}
|
|
|
|
return trim($line);
|
|
}
|
|
}
|