vendor/symfony/twig-bridge/Extension/CodeExtension.php line 217

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bridge\Twig\Extension;
  14. use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
  15. use Twig\Extension\AbstractExtension;
  16. use Twig\TwigFilter;
  18. /**
  19.  * Twig extension relate to PHP code and used by the profiler and the default exception templates.
  20.  *
  21.  * @author Fabien Potencier <fabien@symfony.com>
  22.  *
  23.  * @final since Symfony 4.4
  24.  */
  25. class CodeExtension extends AbstractExtension
  26. {
  27.     private $fileLinkFormat;
  28.     private $charset;
  29.     private $projectDir;
  31.     /**
  32.      * @param string|FileLinkFormatter $fileLinkFormat The format for links to source files
  33.      * @param string                   $projectDir     The project directory
  34.      * @param string                   $charset        The charset
  35.      */
  36.     public function __construct($fileLinkFormat, string $projectDir, string $charset)
  37.     {
  38.         $this->fileLinkFormat = $fileLinkFormat ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
  39.         $this->projectDir = str_replace('\\', '/', $projectDir).'/';
  40.         $this->charset = $charset;
  41.     }
  43.     /**
  44.      * {@inheritdoc}
  45.      *
  46.      * @return TwigFilter[]
  47.      */
  48.     public function getFilters()
  49.     {
  50.         return [
  51.             new TwigFilter('abbr_class', [$this, 'abbrClass'], ['is_safe' => ['html'], 'pre_escape' => 'html']),
  52.             new TwigFilter('abbr_method', [$this, 'abbrMethod'], ['is_safe' => ['html'], 'pre_escape' => 'html']),
  53.             new TwigFilter('format_args', [$this, 'formatArgs'], ['is_safe' => ['html']]),
  54.             new TwigFilter('format_args_as_text', [$this, 'formatArgsAsText']),
  55.             new TwigFilter('file_excerpt', [$this, 'fileExcerpt'], ['is_safe' => ['html']]),
  56.             new TwigFilter('format_file', [$this, 'formatFile'], ['is_safe' => ['html']]),
  57.             new TwigFilter('format_file_from_text', [$this, 'formatFileFromText'], ['is_safe' => ['html']]),
  58.             new TwigFilter('format_log_message', [$this, 'formatLogMessage'], ['is_safe' => ['html']]),
  59.             new TwigFilter('file_link', [$this, 'getFileLink']),
  60.             new TwigFilter('file_relative', [$this, 'getFileRelative']),
  61.         ];
  62.     }
  64.     public function abbrClass($class)
  65.     {
  66.         $parts = explode('\\', $class);
  67.         $short = array_pop($parts);
  69.         return sprintf('<abbr title="%s">%s</abbr>', $class, $short);
  70.     }
  72.     public function abbrMethod($method)
  73.     {
  74.         if (str_contains($method, '::')) {
  75.             [$class, $method] = explode('::', $method, 2);
  76.             $result = sprintf('%s::%s()', $this->abbrClass($class), $method);
  77.         } elseif ('Closure' === $method) {
  78.             $result = sprintf('<abbr title="%s">%1$s</abbr>', $method);
  79.         } else {
  80.             $result = sprintf('<abbr title="%s">%1$s</abbr>()', $method);
  81.         }
  83.         return $result;
  84.     }
  86.     /**
  87.      * Formats an array as a string.
  88.      *
  89.      * @param array $args The argument array
  90.      *
  91.      * @return string
  92.      */
  93.     public function formatArgs($args)
  94.     {
  95.         $result = [];
  96.         foreach ($args as $key => $item) {
  97.             if ('object' === $item[0]) {
  98.                 $item[1] = htmlspecialchars($item[1], \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset);
  99.                 $parts = explode('\\', $item[1]);
  100.                 $short = array_pop($parts);
  101.                 $formattedValue = sprintf('<em>object</em>(<abbr title="%s">%s</abbr>)', $item[1], $short);
  102.             } elseif ('array' === $item[0]) {
  103.                 $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));
  104.             } elseif ('null' === $item[0]) {
  105.                 $formattedValue = '<em>null</em>';
  106.             } elseif ('boolean' === $item[0]) {
  107.                 $formattedValue = '<em>'.strtolower(htmlspecialchars(var_export($item[1], true), \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset)).'</em>';
  108.             } elseif ('resource' === $item[0]) {
  109.                 $formattedValue = '<em>resource</em>';
  110.             } else {
  111.                 $formattedValue = str_replace("\n", '', htmlspecialchars(var_export($item[1], true), \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset));
  112.             }
  114.             $result[] = \is_int($key) ? $formattedValue : sprintf("'%s' => %s", htmlspecialchars($key, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset), $formattedValue);
  115.         }
  117.         return implode(', ', $result);
  118.     }
  120.     /**
  121.      * Formats an array as a string.
  122.      *
  123.      * @param array $args The argument array
  124.      *
  125.      * @return string
  126.      */
  127.     public function formatArgsAsText($args)
  128.     {
  129.         return strip_tags($this->formatArgs($args));
  130.     }
  132.     /**
  133.      * Returns an excerpt of a code file around the given line number.
  134.      *
  135.      * @param string $file       A file path
  136.      * @param int    $line       The selected line number
  137.      * @param int    $srcContext The number of displayed lines around or -1 for the whole file
  138.      *
  139.      * @return string An HTML string
  140.      */
  141.     public function fileExcerpt($file, $line, $srcContext = 3)
  142.     {
  143.         if (is_file($file) && is_readable($file)) {
  144.             // highlight_file could throw warnings
  145.             // see https://bugs.php.net/25725
  146.             $code = @highlight_file($file, true);
  147.             // remove main code/span tags
  148.             $code = preg_replace('#^<code.*?>\s*<span.*?>(.*)</span>\s*</code>#s', '\\1', $code);
  149.             // split multiline spans
  150.             $code = preg_replace_callback('#<span ([^>]++)>((?:[^<]*+<br \/>)++[^<]*+)</span>#', function ($m) {
  151.                 return "<span $m[1]>".str_replace('<br />', "</span><br /><span $m[1]>", $m[2]).'</span>';
  152.             }, $code);
  153.             $content = explode('<br />', $code);
  155.             $lines = [];
  156.             if (0 > $srcContext) {
  157.                 $srcContext = \count($content);
  158.             }
  160.             for ($i = max($line - $srcContext, 1), $max = min($line + $srcContext, \count($content)); $i <= $max; ++$i) {
  161.                 $lines[] = '<li'.($i == $line ? ' class="selected"' : '').'><a class="anchor" name="line'.$i.'"></a><code>'.self::fixCodeMarkup($content[$i - 1]).'</code></li>';
  162.             }
  164.             return '<ol start="'.max($line - $srcContext, 1).'">'.implode("\n", $lines).'</ol>';
  165.         }
  167.         return null;
  168.     }
  170.     /**
  171.      * Formats a file path.
  172.      *
  173.      * @param string $file An absolute file path
  174.      * @param int    $line The line number
  175.      * @param string $text Use this text for the link rather than the file path
  176.      *
  177.      * @return string
  178.      */
  179.     public function formatFile($file, $line, $text = null)
  180.     {
  181.         $file = trim($file);
  182.         $line = (int) $line;
  184.         if (null === $text) {
  185.             if (null !== $rel = $this->getFileRelative($file)) {
  186.                 $rel = explode('/', htmlspecialchars($rel, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset), 2);
  187.                 $text = sprintf('<abbr title="%s%2$s">%s</abbr>%s', htmlspecialchars($this->projectDir, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset), $rel[0], '/'.($rel[1] ?? ''));
  188.             } else {
  189.                 $text = htmlspecialchars($file, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset);
  190.             }
  191.         } else {
  192.             $text = htmlspecialchars($text, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset);
  193.         }
  195.         if (0 < $line) {
  196.             $text .= ' at line '.$line;
  197.         }
  199.         if (false !== $link = $this->getFileLink($file, $line)) {
  200.             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);
  201.         }
  203.         return $text;
  204.     }
  206.     /**
  207.      * Returns the link for a given file/line pair.
  208.      *
  209.      * @param string $file An absolute file path
  210.      * @param int    $line The line number
  211.      *
  212.      * @return string|false A link or false
  213.      */
  214.     public function getFileLink($file, $line)
  215.     {
  216.         if ($fmt = $this->fileLinkFormat) {
  217.             return \is_string($fmt) ? strtr($fmt, ['%f' => $file, '%l' => $line]) : $fmt->format($file, $line);
  218.         }
  220.         return false;
  221.     }
  223.     public function getFileRelative(string $file): ?string
  224.     {
  225.         $file = str_replace('\\', '/', $file);
  227.         if (null !== $this->projectDir && str_starts_with($file, $this->projectDir)) {
  228.             return ltrim(substr($file, \strlen($this->projectDir)), '/');
  229.         }
  231.         return null;
  232.     }
  234.     public function formatFileFromText($text)
  235.     {
  236.         return preg_replace_callback('/in ("|&quot;)?(.+?)\1(?: +(?:on|at))? +line (\d+)/s', function ($match) {
  237.             return 'in '.$this->formatFile($match[2], $match[3]);
  238.         }, $text);
  239.     }
  241.     /**
  242.      * @internal
  243.      */
  244.     public function formatLogMessage(string $message, array $context): string
  245.     {
  246.         if ($context && str_contains($message, '{')) {
  247.             $replacements = [];
  248.             foreach ($context as $key => $val) {
  249.                 if (\is_scalar($val)) {
  250.                     $replacements['{'.$key.'}'] = $val;
  251.                 }
  252.             }
  254.             if ($replacements) {
  255.                 $message = strtr($message, $replacements);
  256.             }
  257.         }
  259.         return htmlspecialchars($message, \ENT_COMPAT | \ENT_SUBSTITUTE, $this->charset);
  260.     }
  262.     /**
  263.      * {@inheritdoc}
  264.      */
  265.     public function getName()
  266.     {
  267.         return 'code';
  268.     }
  270.     protected static function fixCodeMarkup($line)
  271.     {
  272.         // </span> ending tag from previous line
  273.         $opening = strpos($line, '<span');
  274.         $closing = strpos($line, '</span>');
  275.         if (false !== $closing && (false === $opening || $closing < $opening)) {
  276.             $line = substr_replace($line, '', $closing, 7);
  277.         }
  279.         // missing </span> tag at the end of line
  280.         $opening = strpos($line, '<span');
  281.         $closing = strpos($line, '</span>');
  282.         if (false !== $opening && (false === $closing || $closing > $opening)) {
  283.             $line .= '</span>';
  284.         }
  286.         return trim($line);
  287.     }
  288. }