265 lines
9.2 KiB
PHP
265 lines
9.2 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\Bridge\Twig\Extension;
|
|
|
|
use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
|
|
use Twig\Extension\AbstractExtension;
|
|
use Twig\TwigFilter;
|
|
|
|
/**
|
|
* Twig extension relate to PHP code and used by the profiler and the default exception templates.
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*/
|
|
class CodeExtension extends AbstractExtension
|
|
{
|
|
private $fileLinkFormat;
|
|
private $rootDir;
|
|
private $charset;
|
|
|
|
/**
|
|
* @param string|FileLinkFormatter $fileLinkFormat The format for links to source files
|
|
* @param string $rootDir The project root directory
|
|
* @param string $charset The charset
|
|
*/
|
|
public function __construct($fileLinkFormat, $rootDir, $charset)
|
|
{
|
|
$this->fileLinkFormat = $fileLinkFormat ?: ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
|
|
$this->rootDir = str_replace('/', DIRECTORY_SEPARATOR, dirname($rootDir)).DIRECTORY_SEPARATOR;
|
|
$this->charset = $charset;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getFilters()
|
|
{
|
|
return array(
|
|
new TwigFilter('abbr_class', array($this, 'abbrClass'), array('is_safe' => array('html'))),
|
|
new TwigFilter('abbr_method', array($this, 'abbrMethod'), array('is_safe' => array('html'))),
|
|
new TwigFilter('format_args', array($this, 'formatArgs'), array('is_safe' => array('html'))),
|
|
new TwigFilter('format_args_as_text', array($this, 'formatArgsAsText')),
|
|
new TwigFilter('file_excerpt', array($this, 'fileExcerpt'), array('is_safe' => array('html'))),
|
|
new TwigFilter('format_file', array($this, 'formatFile'), array('is_safe' => array('html'))),
|
|
new TwigFilter('format_file_from_text', array($this, 'formatFileFromText'), array('is_safe' => array('html'))),
|
|
new TwigFilter('format_log_message', array($this, 'formatLogMessage'), array('is_safe' => array('html'))),
|
|
new TwigFilter('file_link', array($this, 'getFileLink')),
|
|
);
|
|
}
|
|
|
|
public function abbrClass($class)
|
|
{
|
|
$parts = explode('\\', $class);
|
|
$short = array_pop($parts);
|
|
|
|
return sprintf('<abbr title="%s">%s</abbr>', $class, $short);
|
|
}
|
|
|
|
public function abbrMethod($method)
|
|
{
|
|
if (false !== strpos($method, '::')) {
|
|
list($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.
|
|
*
|
|
* @param array $args The argument array
|
|
*
|
|
* @return string
|
|
*/
|
|
public function formatArgs($args)
|
|
{
|
|
$result = array();
|
|
foreach ($args as $key => $item) {
|
|
if ('object' === $item[0]) {
|
|
$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]) : $item[1]);
|
|
} elseif ('null' === $item[0]) {
|
|
$formattedValue = '<em>null</em>';
|
|
} elseif ('boolean' === $item[0]) {
|
|
$formattedValue = '<em>'.strtolower(var_export($item[1], true)).'</em>';
|
|
} elseif ('resource' === $item[0]) {
|
|
$formattedValue = '<em>resource</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", $key, $formattedValue);
|
|
}
|
|
|
|
return implode(', ', $result);
|
|
}
|
|
|
|
/**
|
|
* Formats an array as a string.
|
|
*
|
|
* @param array $args The argument array
|
|
*
|
|
* @return string
|
|
*/
|
|
public function formatArgsAsText($args)
|
|
{
|
|
return strip_tags($this->formatArgs($args));
|
|
}
|
|
|
|
/**
|
|
* Returns an excerpt of a code file around the given line number.
|
|
*
|
|
* @param string $file A file path
|
|
* @param int $line The selected line number
|
|
* @param int $srcContext The number of displayed lines around or -1 for the whole file
|
|
*
|
|
* @return string An HTML string
|
|
*/
|
|
public function fileExcerpt($file, $line, $srcContext = 3)
|
|
{
|
|
if (is_readable($file)) {
|
|
// highlight_file could throw warnings
|
|
// see https://bugs.php.net/bug.php?id=25725
|
|
$code = @highlight_file($file, true);
|
|
// 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>#', function ($m) {
|
|
return "<span $m[1]>".str_replace('<br />', "</span><br /><span $m[1]>", $m[2]).'</span>';
|
|
}, $code);
|
|
$content = explode('<br />', $code);
|
|
|
|
$lines = array();
|
|
if (0 > $srcContext) {
|
|
$srcContext = count($content);
|
|
}
|
|
|
|
for ($i = max($line - $srcContext, 1), $max = min($line + $srcContext, count($content)); $i <= $max; ++$i) {
|
|
$lines[] = '<li'.($i == $line ? ' class="selected"' : '').'><a class="anchor" name="line'.$i.'"></a><code>'.self::fixCodeMarkup($content[$i - 1]).'</code></li>';
|
|
}
|
|
|
|
return '<ol start="'.max($line - $srcContext, 1).'">'.implode("\n", $lines).'</ol>';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Formats a file path.
|
|
*
|
|
* @param string $file An absolute file path
|
|
* @param int $line The line number
|
|
* @param string $text Use this text for the link rather than the file path
|
|
*
|
|
* @return string
|
|
*/
|
|
public function formatFile($file, $line, $text = null)
|
|
{
|
|
$file = trim($file);
|
|
|
|
if (null === $text) {
|
|
$text = str_replace('/', DIRECTORY_SEPARATOR, $file);
|
|
if (0 === strpos($text, $this->rootDir)) {
|
|
$text = substr($text, strlen($this->rootDir));
|
|
$text = explode(DIRECTORY_SEPARATOR, $text, 2);
|
|
$text = sprintf('<abbr title="%s%2$s">%s</abbr>%s', $this->rootDir, $text[0], isset($text[1]) ? DIRECTORY_SEPARATOR.$text[1] : '');
|
|
}
|
|
}
|
|
|
|
$text = "$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;
|
|
}
|
|
|
|
/**
|
|
* Returns the link for a given file/line pair.
|
|
*
|
|
* @param string $file An absolute file path
|
|
* @param int $line The line number
|
|
*
|
|
* @return string|false A link or false
|
|
*/
|
|
public function getFileLink($file, $line)
|
|
{
|
|
if ($fmt = $this->fileLinkFormat) {
|
|
return is_string($fmt) ? strtr($fmt, array('%f' => $file, '%l' => $line)) : $fmt->format($file, $line);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
public function formatFileFromText($text)
|
|
{
|
|
return preg_replace_callback('/in ("|")?(.+?)\1(?: +(?:on|at))? +line (\d+)/s', function ($match) {
|
|
return 'in '.$this->formatFile($match[2], $match[3]);
|
|
}, $text);
|
|
}
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
public function formatLogMessage($message, array $context)
|
|
{
|
|
if ($context && false !== strpos($message, '{')) {
|
|
$replacements = array();
|
|
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);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getName()
|
|
{
|
|
return 'code';
|
|
}
|
|
|
|
protected static function fixCodeMarkup($line)
|
|
{
|
|
// </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 $line;
|
|
}
|
|
}
|