FileLinkFormatter.php 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\ErrorHandler\ErrorRenderer;
  11. use Symfony\Component\HttpFoundation\Request;
  12. use Symfony\Component\HttpFoundation\RequestStack;
  13. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  14. /**
  15. * Formats debug file links.
  16. *
  17. * @author Jérémy Romey <jeremy@free-agent.fr>
  18. *
  19. * @final
  20. */
  21. class FileLinkFormatter
  22. {
  23. private array|false $fileLinkFormat;
  24. /**
  25. * @param string|\Closure $urlFormat The URL format, or a closure that returns it on-demand
  26. */
  27. public function __construct(
  28. string|array|null $fileLinkFormat = null,
  29. private ?RequestStack $requestStack = null,
  30. private ?string $baseDir = null,
  31. private string|\Closure|null $urlFormat = null,
  32. ) {
  33. $fileLinkFormat ??= $_ENV['SYMFONY_IDE'] ?? $_SERVER['SYMFONY_IDE'] ?? '';
  34. if (!\is_array($f = $fileLinkFormat)) {
  35. $f = (ErrorRendererInterface::IDE_LINK_FORMATS[$f] ?? $f) ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: 'file://%f#L%l';
  36. $i = strpos($f, '&', max(strrpos($f, '%f'), strrpos($f, '%l'))) ?: \strlen($f);
  37. $fileLinkFormat = [substr($f, 0, $i)] + preg_split('/&([^>]++)>/', substr($f, $i), -1, \PREG_SPLIT_DELIM_CAPTURE);
  38. }
  39. $this->fileLinkFormat = $fileLinkFormat;
  40. }
  41. public function format(string $file, int $line): string|false
  42. {
  43. if ($fmt = $this->getFileLinkFormat()) {
  44. for ($i = 1; isset($fmt[$i]); ++$i) {
  45. if (str_starts_with($file, $k = $fmt[$i++])) {
  46. $file = substr_replace($file, $fmt[$i], 0, \strlen($k));
  47. break;
  48. }
  49. }
  50. return strtr($fmt[0], ['%f' => $file, '%l' => $line]);
  51. }
  52. return false;
  53. }
  54. public function __serialize(): array
  55. {
  56. $this->fileLinkFormat = $this->getFileLinkFormat();
  57. return ['fileLinkFormat' => $this->fileLinkFormat];
  58. }
  59. /**
  60. * @internal
  61. */
  62. public static function generateUrlFormat(UrlGeneratorInterface $router, string $routeName, string $queryString): ?string
  63. {
  64. try {
  65. return $router->generate($routeName).$queryString;
  66. } catch (\Throwable) {
  67. return null;
  68. }
  69. }
  70. private function getFileLinkFormat(): array|false
  71. {
  72. if ($this->fileLinkFormat) {
  73. return $this->fileLinkFormat;
  74. }
  75. if ($this->requestStack && $this->baseDir && $this->urlFormat) {
  76. $request = $this->requestStack->getMainRequest();
  77. if ($request instanceof Request && (!$this->urlFormat instanceof \Closure || $this->urlFormat = ($this->urlFormat)())) {
  78. return [
  79. $request->getSchemeAndHttpHost().$this->urlFormat,
  80. $this->baseDir.\DIRECTORY_SEPARATOR, '',
  81. ];
  82. }
  83. }
  84. return false;
  85. }
  86. }