FileLinkFormatter.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\Component\ErrorHandler\ErrorRenderer;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;

/**
 * Formats debug file links.
 *
 * @author Jérémy Romey <jeremy@free-agent.fr>
 *
 * @final
 */
class FileLinkFormatter {
    private array|false $fileLinkFormat;
    
    /**
     * @param string|\Closure $urlFormat The URL format, or a closure that returns it on-demand
     */
    public function __construct(string|array|null $fileLinkFormat = null, ?RequestStack $requestStack = null, ?string $baseDir = null, string|\Closure|null $urlFormat = null) {
        $fileLinkFormat ??= $_ENV['SYMFONY_IDE'] ?? $_SERVER['SYMFONY_IDE'] ?? '';
        if (!\is_array($f = $fileLinkFormat)) {
            $f = ((ErrorRendererInterface::IDE_LINK_FORMATS[$f] ?? $f ?: \ini_get('xdebug.file_link_format')) ?: get_cfg_var('xdebug.file_link_format')) ?: 'file://%f#L%l';
            $i = strpos($f, '&', max(strrpos($f, '%f'), strrpos($f, '%l'))) ?: \strlen($f);
            $fileLinkFormat = [
                substr($f, 0, $i),
            ] + preg_split('/&([^>]++)>/', substr($f, $i), -1, \PREG_SPLIT_DELIM_CAPTURE);
        }
        $this->fileLinkFormat = $fileLinkFormat;
    }
    public function format(string $file, int $line) : string|false {
        if ($fmt = $this->getFileLinkFormat()) {
            for ($i = 1; isset($fmt[$i]); ++$i) {
                if (str_starts_with($file, $k = $fmt[$i++])) {
                    $file = substr_replace($file, $fmt[$i], 0, \strlen($k));
                    break;
                }
            }
            return strtr($fmt[0], [
                '%f' => $file,
                '%l' => $line,
            ]);
        }
        return false;
    }
    
    /**
     * @internal
     */
    public function __sleep() : array {
        $this->fileLinkFormat = $this->getFileLinkFormat();
        return [
            'fileLinkFormat',
        ];
    }
    
    /**
     * @internal
     */
    public static function generateUrlFormat(UrlGeneratorInterface $router, string $routeName, string $queryString) : ?string {
        try {
            return $router->generate($routeName) . $queryString;
        } catch (\Throwable) {
            return null;
        }
    }
    private function getFileLinkFormat() : array|false {
        if ($this->fileLinkFormat) {
            return $this->fileLinkFormat;
        }
        if ($this->requestStack && $this->baseDir && $this->urlFormat) {
            $request = $this->requestStack
                ->getMainRequest();
            if ($request instanceof Request && (!$this->urlFormat instanceof \Closure || ($this->urlFormat = ($this->urlFormat)()))) {
                return [
                    $request->getSchemeAndHttpHost() . $this->urlFormat,
                    $this->baseDir . \DIRECTORY_SEPARATOR,
                    '',
                ];
            }
        }
        return false;
    }

}