* * 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 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 */ class CodeExtension extends AbstractExtension { private $fileLinkFormat; private $rootDir; private $charset; /** * @param string $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('file_link', array($this, 'getFileLink')), ); } public function abbrClass($class) { $parts = explode('\\', $class); $short = array_pop($parts); return sprintf('%s', $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('%1$s', $method); } else { $result = sprintf('%1$s()', $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('object(%s)', $item[1], $short); } elseif ('array' === $item[0]) { $formattedValue = sprintf('array(%s)', \is_array($item[1]) ? $this->formatArgs($item[1]) : $item[1]); } elseif ('string' === $item[0]) { $formattedValue = sprintf("'%s'", htmlspecialchars($item[1], ENT_QUOTES, $this->charset)); } elseif ('null' === $item[0]) { $formattedValue = 'null'; } elseif ('boolean' === $item[0]) { $formattedValue = ''.strtolower(var_export($item[1], true)).''; } elseif ('resource' === $item[0]) { $formattedValue = 'resource'; } else { $formattedValue = str_replace("\n", '', var_export(htmlspecialchars((string) $item[1], ENT_QUOTES, $this->charset), true)); } $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 * * @return string An HTML string */ public function fileExcerpt($file, $line) { 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('#^\s*(.*)\s*#s', '\\1', $code); $content = explode('
', $code); $lines = array(); for ($i = max($line - 3, 1), $max = min($line + 3, \count($content)); $i <= $max; ++$i) { $lines[] = ''.self::fixCodeMarkup($content[$i - 1]).''; } return '

'.implode("\n", $lines).'

'; } } /** * 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('%s%s', $this->rootDir, $text[0], isset($text[1]) ? \DIRECTORY_SEPARATOR.$text[1] : ''); } } $text = "$text at line $line"; if (false !== $link = $this->getFileLink($file, $line)) { if (\PHP_VERSION_ID >= 50400) { $flags = ENT_QUOTES | ENT_SUBSTITUTE; } else { $flags = ENT_QUOTES; } return sprintf('%s', htmlspecialchars($link, $flags, $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 ($this->fileLinkFormat && is_file($file)) { return strtr($this->fileLinkFormat, array('%f' => $file, '%l' => $line)); } return false; } public function formatFileFromText($text) { $that = $this; return preg_replace_callback('/in ("|")?(.+?)\1(?: +(?:on|at))? +line (\d+)/s', function ($match) use ($that) { return 'in '.$that->formatFile($match[2], $match[3]); }, $text); } /** * {@inheritdoc} */ public function getName() { return 'code'; } protected static function fixCodeMarkup($line) { // ending tag from previous line $opening = strpos($line, ''); if (false !== $closing && (false === $opening || $closing < $opening)) { $line = substr_replace($line, '', $closing, 7); } // missing tag at the end of line $opening = strpos($line, ''); if (false !== $opening && (false === $closing || $closing > $opening)) { $line .= ''; } return $line; } }