[Debug][WebProfilerBundle] Fix setting file link format

symfony · nicolas-grekas · Apr 30, 2018 · Apr 30, 2018 · Apr 27, 2018 · Apr 30, 2018
commit a4a1645d4475f08e08c54bec91184d8d1e061c2f
diff --git a/src/Symfony/Bridge/Twig/Extension/CodeExtension.php b/src/Symfony/Bridge/Twig/Extension/CodeExtension.php
@@ -181,7 +181,9 @@ public function formatFile($file, $line, $text = null)
            }
        }

-        $text = "$text at line $line";
+        if (0 < $line) {
+            $text .= ' at line '.$line;
+        }

        if (false !== $link = $this->getFileLink($file, $line)) {
            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);

diff --git a/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php b/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
@@ -61,6 +61,9 @@ class FrameworkBundle extends Bundle
 {
    public function boot()
    {
+        if (!ini_get('xdebug.file_link_format') && !get_cfg_var('xdebug.file_link_format')) {
+            ini_set('xdebug.file_link_format', $this->container->getParameter('debug.file_link_format'));
+        }
        ErrorHandler::register(null, false)->throwAt($this->container->getParameter('debug.error_handler.throw_at'), true);

        if ($this->container->hasParameter('kernel.trusted_proxies')) {

diff --git a/src/Symfony/Bundle/WebProfilerBundle/Controller/ExceptionController.php b/src/Symfony/Bundle/WebProfilerBundle/Controller/ExceptionController.php
@@ -11,6 +11,7 @@

 namespace Symfony\Bundle\WebProfilerBundle\Controller;

+use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 use Symfony\Component\HttpKernel\Profiler\Profiler;
 use Symfony\Component\Debug\ExceptionHandler;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@@ -30,11 +31,12 @@ class ExceptionController
    protected $debug;
    protected $profiler;

-    public function __construct(Profiler $profiler = null, Environment $twig, $debug)
+    public function __construct(Profiler $profiler = null, Environment $twig, $debug, FileLinkFormatter $fileLinkFormat = null)
    {
        $this->profiler = $profiler;
        $this->twig = $twig;
        $this->debug = $debug;
+        $this->fileLinkFormat = $fileLinkFormat;
    }

    /**
@@ -58,7 +60,7 @@ public function showAction($token)
        $template = $this->getTemplate();

        if (!$this->twig->getLoader()->exists($template)) {
-            $handler = new ExceptionHandler($this->debug, $this->twig->getCharset());
+            $handler = new ExceptionHandler($this->debug, $this->twig->getCharset(), $this->fileLinkFormat);

            return new Response($handler->getContent($exception), 200, array('Content-Type' => 'text/html'));
        }
@@ -98,7 +100,7 @@ public function cssAction($token)
        $template = $this->getTemplate();

        if (!$this->templateExists($template)) {
-            $handler = new ExceptionHandler($this->debug, $this->twig->getCharset());
+            $handler = new ExceptionHandler($this->debug, $this->twig->getCharset(), $this->fileLinkFormat);

            return new Response($handler->getStylesheet($exception), 200, array('Content-Type' => 'text/css'));
        }

diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/config/profiler.xml b/src/Symfony/Bundle/WebProfilerBundle/Resources/config/profiler.xml
@@ -27,6 +27,7 @@
            <argument type="service" id="profiler" on-invalid="null" />
            <argument type="service" id="twig" />
            <argument>%kernel.debug%</argument>
+            <argument type="service" id="debug.file_link_formatter" />
        </service>

        <service id="web_profiler.csp.handler" class="Symfony\Bundle\WebProfilerBundle\Csp\ContentSecurityPolicyHandler">

diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/open.html.twig b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Profiler/open.html.twig
@@ -8,7 +8,7 @@

 {% block body %}
 <div class="header">
-    <h1>{{ file }} <small>line {{ line }}</small></h1>
+    <h1>{{ file }}{% if 0 < line %} <small>line {{ line }}</small>{% endif %}</h1>
    <a class="doc" href="https://symfony.com/doc/{{ constant('Symfony\\Component\\HttpKernel\\Kernel::VERSION') }}/reference/configuration/framework.html#ide" rel="help">Open in your IDE?</a>
 </div>
 <div class="source">

diff --git a/src/Symfony/Bundle/WebProfilerBundle/Tests/DependencyInjection/WebProfilerExtensionTest.php b/src/Symfony/Bundle/WebProfilerBundle/Tests/DependencyInjection/WebProfilerExtensionTest.php
@@ -31,6 +31,7 @@ class WebProfilerExtensionTest extends TestCase
    public static function assertSaneContainer(Container $container, $message = '', $knownPrivates = array())
    {
        $errors = array();
+        $knownPrivates[] = 'debug.file_link_formatter.url_format';
        foreach ($container->getServiceIds() as $id) {
            if (in_array($id, $knownPrivates, true)) { // to be removed in 4.0
                continue;