|
| 1 | +<?php |
| 2 | + |
| 3 | +/* |
| 4 | + * This file is part of Twig. |
| 5 | + * |
| 6 | + * (c) Fabien Potencier |
| 7 | + * |
| 8 | + * For the full copyright and license information, please view the LICENSE |
| 9 | + * file that was distributed with this source code. |
| 10 | + */ |
| 11 | + |
| 12 | +namespace Twig\Cache; |
| 13 | + |
| 14 | +/** |
| 15 | + * Cache decorator that writes Xdebug source map files alongside compiled templates. |
| 16 | + * |
| 17 | + * Xdebug 3.5+ supports native path mapping via .map files in .xdebug directories. |
| 18 | + * This allows setting breakpoints in Twig templates and having Xdebug map them |
| 19 | + * to the correct lines in the compiled PHP files. |
| 20 | + * |
| 21 | + * @author Fabien Potencier <fabien@symfony.com> |
| 22 | + * |
| 23 | + * @internal |
| 24 | + */ |
| 25 | +final class XdebugSourceMapCache implements CacheInterface, RemovableCacheInterface |
| 26 | +{ |
| 27 | + private ?string $pendingTemplatePath = null; |
| 28 | + private ?array $pendingDebugInfo = null; |
| 29 | + |
| 30 | + public function __construct( |
| 31 | + private DirectoryCacheInterface&CacheInterface $cache, |
| 32 | + ) { |
| 33 | + $this->registerExistingSourceMaps(); |
| 34 | + } |
| 35 | + |
| 36 | + /** |
| 37 | + * Registers all existing source map files with Xdebug. |
| 38 | + * |
| 39 | + * This is called at startup to ensure previously compiled templates |
| 40 | + * have their source maps available for debugging. |
| 41 | + */ |
| 42 | + private function registerExistingSourceMaps(): void |
| 43 | + { |
| 44 | + foreach ($this->cache->getDirectories() as $directory) { |
| 45 | + $mapPath = $directory.'/.xdebug'; |
| 46 | + if (!is_dir($mapPath)) { |
| 47 | + continue; |
| 48 | + } |
| 49 | + |
| 50 | + foreach (glob($mapPath.'/*.map') as $mapFile) { |
| 51 | + xdebug_set_source_map($mapFile); |
| 52 | + } |
| 53 | + } |
| 54 | + } |
| 55 | + |
| 56 | + public function setSourceMapData(string $templatePath, array $debugInfo): void |
| 57 | + { |
| 58 | + $this->pendingTemplatePath = $templatePath; |
| 59 | + $this->pendingDebugInfo = $debugInfo; |
| 60 | + } |
| 61 | + |
| 62 | + public function generateKey(string $name, string $className): string |
| 63 | + { |
| 64 | + return $this->cache->generateKey($name, $className); |
| 65 | + } |
| 66 | + |
| 67 | + public function write(string $key, string $content): void |
| 68 | + { |
| 69 | + $this->cache->write($key, $content); |
| 70 | + |
| 71 | + if ($this->pendingTemplatePath && $this->pendingDebugInfo) { |
| 72 | + try { |
| 73 | + $this->writeSourceMap($key, $this->pendingTemplatePath, $this->pendingDebugInfo); |
| 74 | + } finally { |
| 75 | + $this->pendingTemplatePath = null; |
| 76 | + $this->pendingDebugInfo = null; |
| 77 | + } |
| 78 | + } |
| 79 | + } |
| 80 | + |
| 81 | + public function load(string $key): void |
| 82 | + { |
| 83 | + $this->cache->load($key); |
| 84 | + } |
| 85 | + |
| 86 | + public function getTimestamp(string $key): int |
| 87 | + { |
| 88 | + return $this->cache->getTimestamp($key); |
| 89 | + } |
| 90 | + |
| 91 | + public function remove(string $name, string $className): void |
| 92 | + { |
| 93 | + if ($this->cache instanceof RemovableCacheInterface) { |
| 94 | + $this->cache->remove($name, $className); |
| 95 | + } |
| 96 | + |
| 97 | + $this->removeSourceMap($this->cache->generateKey($name, $className)); |
| 98 | + } |
| 99 | + |
| 100 | + private function writeSourceMap(string $cacheKey, string $templatePath, array $debugInfo): void |
| 101 | + { |
| 102 | + $content = $this->buildMapContent($cacheKey, $templatePath, $debugInfo); |
| 103 | + $filename = pathinfo($cacheKey, \PATHINFO_FILENAME).'.map'; |
| 104 | + |
| 105 | + foreach ($this->cache->getDirectories() as $directory) { |
| 106 | + $mapPath = $directory.'/.xdebug'; |
| 107 | + |
| 108 | + if (!is_dir($mapPath)) { |
| 109 | + mkdir($mapPath, 0777, true); |
| 110 | + } |
| 111 | + |
| 112 | + $mapFile = $mapPath.'/'.$filename; |
| 113 | + $tmpFile = tempnam($mapPath, 'map'); |
| 114 | + if (false !== @file_put_contents($tmpFile, $content) && @rename($tmpFile, $mapFile)) { |
| 115 | + @chmod($mapFile, 0666 & ~umask()); |
| 116 | + xdebug_set_source_map($mapFile); |
| 117 | + |
| 118 | + continue; |
| 119 | + } |
| 120 | + |
| 121 | + throw new \RuntimeException(\sprintf('Failed to write Xdebug source map file "%s".', $mapFile)); |
| 122 | + } |
| 123 | + } |
| 124 | + |
| 125 | + private function removeSourceMap(string $cacheKey): void |
| 126 | + { |
| 127 | + $filename = pathinfo($cacheKey, \PATHINFO_FILENAME).'.map'; |
| 128 | + |
| 129 | + foreach ($this->cache->getDirectories() as $directory) { |
| 130 | + $mapFile = $directory.'/.xdebug/'.$filename; |
| 131 | + if (is_file($mapFile)) { |
| 132 | + @unlink($mapFile); |
| 133 | + } |
| 134 | + } |
| 135 | + } |
| 136 | + |
| 137 | + private function buildMapContent(string $cacheKey, string $templatePath, array $debugInfo): string |
| 138 | + { |
| 139 | + $lines = "# Xdebug source map for Twig template\n"; |
| 140 | + $lines .= \sprintf("remote_prefix: %s/\n", \dirname($cacheKey)); |
| 141 | + $lines .= \sprintf("local_prefix: %s/\n\n", \dirname($templatePath)); |
| 142 | + |
| 143 | + $compiledLines = array_keys($debugInfo); |
| 144 | + for ($i = 0, $count = \count($compiledLines); $i < $count; ++$i) { |
| 145 | + $startLine = $compiledLines[$i]; |
| 146 | + // End line is exclusive, so use next start line minus 1 |
| 147 | + // Use a reasonable max for last range (Xdebug can't handle PHP_INT_MAX) |
| 148 | + $endLine = isset($compiledLines[$i + 1]) ? $compiledLines[$i + 1] - 1 : 999999; |
| 149 | + $lines .= \sprintf( |
| 150 | + "%s:%d-%d = %s:%d\n", |
| 151 | + basename($cacheKey), |
| 152 | + $startLine, |
| 153 | + $endLine, |
| 154 | + basename($templatePath), |
| 155 | + $debugInfo[$startLine], |
| 156 | + ); |
| 157 | + } |
| 158 | + |
| 159 | + return $lines; |
| 160 | + } |
| 161 | +} |
0 commit comments