Use xdebug links for messages, move to trait (#591)

* Use xdebug links for messages, move to trait * Tweak view templates
maximebf · Feb 10, 2024 · 80ad074 · 80ad074
1 parent d656602
commit 80ad074
Show file tree

Hide file tree

Showing 6 changed files with 255 additions and 231 deletions.
diff --git a/src/DebugBar/DataCollector/DataCollector.php b/src/DebugBar/DataCollector/DataCollector.php
@@ -11,190 +11,17 @@
 namespace DebugBar\DataCollector;
 
 use DebugBar\DataFormatter\HasDataFormatter;
+use DebugBar\DataFormatter\HasXdebugLinks;
 
 /**
  * Abstract class for data collectors
  */
 abstract class DataCollector implements DataCollectorInterface
 {
-    use HasDataFormatter;
+    use HasDataFormatter, HasXdebugLinks;
 
     public static $defaultDataFormatter;
     public static $defaultVarDumper;
 
-    protected $xdebugLinkTemplate = '';
-    protected $xdebugShouldUseAjax = false;
-    protected $xdebugReplacements = array();
 
-    /**
-     * Shorten the file path by removing the xdebug path replacements
-     *
-     * @param string $file
-     * @return string
-     */
-    public function normalizeFilePath($file)
-    {
-        if (empty($file)) {
-            return '';
-        }
-
-        if (@file_exists($file)) {
-            $file = realpath($file);
-        }
-
-        foreach (array_keys($this->xdebugReplacements) as $path) {
-            if (strpos($file, $path) === 0) {
-            	$file = substr($file, strlen($path));
-                break;
-            }
-        }
-
-        return ltrim(str_replace('\\', '/', $file), '/');
-    }
-
-    /**
-     * Get an Xdebug Link to a file
-     *
-     * @param string $file
-     * @param int    $line
-     *
-     * @return array {
-     * @var string   $url
-     * @var bool     $ajax should be used to open the url instead of a normal links
-     * }
-     */
-    public function getXdebugLink($file, $line = 1)
-    {
-        if (empty($file)) {
-            return null;
-        }
-
-        if (@file_exists($file)) {
-            $file = realpath($file);
-        }
-
-        foreach ($this->xdebugReplacements as $path => $replacement) {
-            if (strpos($file, $path) === 0) {
-            	$file = $replacement . substr($file, strlen($path));
-            	break;
-            }
-        }
-
-        $url = strtr($this->getXdebugLinkTemplate(), [
-            '%f' => rawurlencode(str_replace('\\', '/', $file)),
-            '%l' => rawurlencode((string) $line),
-        ]);
-        if ($url) {
-            return ['url' => $url, 'ajax' => $this->getXdebugShouldUseAjax()];
-        }
-    }
-
-    /**
-     * @return string
-     */
-    public function getXdebugLinkTemplate()
-    {
-        if (empty($this->xdebugLinkTemplate) && !empty(ini_get('xdebug.file_link_format'))) {
-            $this->xdebugLinkTemplate = ini_get('xdebug.file_link_format');
-        }
-
-        return $this->xdebugLinkTemplate;
-    }
-
-    /**
-     * @param string $editor
-     */
-    public function setEditorLinkTemplate($editor)
-    {
-        $editorLinkTemplates = array(
-            'sublime' => 'subl://open?url=file://%f&line=%l',
-            'textmate' => 'txmt://open?url=file://%f&line=%l',
-            'emacs' => 'emacs://open?url=file://%f&line=%l',
-            'macvim' => 'mvim://open/?url=file://%f&line=%l',
-            'phpstorm' => 'phpstorm://open?file=%f&line=%l',
-            'phpstorm-remote' => 'javascript:(()=>{let r=new XMLHttpRequest;' .
-                'r.open(\'get\',\'http://localhost:63342/api/file/%f:%l\');r.send();})()',
-            'idea' => 'idea://open?file=%f&line=%l',
-            'idea-remote' => 'javascript:(()=>{let r=new XMLHttpRequest;' .
-                'r.open(\'get\',\'http://localhost:63342/api/file/?file=%f&line=%l\');r.send();})()',
-            'vscode' => 'vscode://file/%f:%l',
-            'vscode-insiders' => 'vscode-insiders://file/%f:%l',
-            'vscode-remote' => 'vscode://vscode-remote/%f:%l',
-            'vscode-insiders-remote' => 'vscode-insiders://vscode-remote/%f:%l',
-            'vscodium' => 'vscodium://file/%f:%l',
-            'nova' => 'nova://core/open/file?filename=%f&line=%l',
-            'xdebug' => 'xdebug://%f@%l',
-            'atom' => 'atom://core/open/file?filename=%f&line=%l',
-            'espresso' => 'x-espresso://open?filepath=%f&lines=%l',
-            'netbeans' => 'netbeans://open/?f=%f:%l',
-        );
-
-        if (is_string($editor) && isset($editorLinkTemplates[$editor])) {
-            $this->setXdebugLinkTemplate($editorLinkTemplates[$editor]);
-        }
-    }
-
-    /**
-     * @param string $xdebugLinkTemplate
-     * @param bool $shouldUseAjax
-     */
-    public function setXdebugLinkTemplate($xdebugLinkTemplate, $shouldUseAjax = false)
-    {
-        if ($xdebugLinkTemplate === 'idea') {
-            $this->xdebugLinkTemplate  = 'http://localhost:63342/api/file/?file=%f&line=%l';
-            $this->xdebugShouldUseAjax = true;
-        } else {
-            $this->xdebugLinkTemplate  = $xdebugLinkTemplate;
-            $this->xdebugShouldUseAjax = $shouldUseAjax;
-        }
-    }
-
-    /**
-     * @return bool
-     */
-    public function getXdebugShouldUseAjax()
-    {
-        return $this->xdebugShouldUseAjax;
-    }
-
-    /**
-     * returns an array of filename-replacements
-     *
-     * this is useful f.e. when using vagrant or remote servers,
-     * where the path of the file is different between server and
-     * development environment
-     *
-     * @return array key-value-pairs of replacements, key = path on server, value = replacement
-     */
-    public function getXdebugReplacements()
-    {
-        return $this->xdebugReplacements;
-    }
-
-    /**
-     * @param array $xdebugReplacements
-     */
-    public function addXdebugReplacements($xdebugReplacements)
-    {
-        foreach ($xdebugReplacements as $serverPath => $replacement) {
-            $this->setXdebugReplacement($serverPath, $replacement);
-        }
-    }
-
-    /**
-     * @param array $xdebugReplacements
-     */
-    public function setXdebugReplacements($xdebugReplacements)
-    {
-        $this->xdebugReplacements = $xdebugReplacements;
-    }
-
-    /**
-     * @param string $serverPath
-     * @param string $replacement
-     */
-    public function setXdebugReplacement($serverPath, $replacement)
-    {
-        $this->xdebugReplacements[$serverPath] = $replacement;
-    }
 }
diff --git a/src/DebugBar/DataCollector/MessagesCollector.php b/src/DebugBar/DataCollector/MessagesCollector.php
@@ -10,6 +10,7 @@
 
 namespace DebugBar\DataCollector;
 
+use DebugBar\DataFormatter\HasXdebugLinks;
 use Psr\Log\AbstractLogger;
 use DebugBar\DataFormatter\HasDataFormatter;
 
@@ -18,7 +19,7 @@
  */
 class MessagesCollector extends AbstractLogger implements DataCollectorInterface, MessagesAggregateInterface, Renderable, AssetProvider
 {
-    use HasDataFormatter;
+    use HasDataFormatter, HasXdebugLinks;
 
     protected $name;
 
@@ -78,20 +79,14 @@ public function addMessage($message, $label = 'info', $isString = true)
             }
         }
 
-        if (!empty($stackItem)) {
-            $stackItem = [
-                'file_name' => $stackItem['file'],
-                'file_line' => $stackItem['line'],
-            ];
-        }
-
-        $this->messages[] = array_merge(array(
+        $this->messages[] = array(
             'message' => $messageText,
             'message_html' => $messageHtml,
             'is_string' => $isString,
             'label' => $label,
-            'time' => microtime(true)
-        ), $stackItem);
+            'time' => microtime(true),
+            'xdebug_link' => $stackItem ? $this->getXdebugLink($stackItem['file'], $stackItem['line']) : null,
+        );
     }
 
     /**