From 2b0ba0eabcd0da5ee97326e81d293de03e3c6a37 Mon Sep 17 00:00:00 2001
From: Simon Wisselink <wisskid@users.noreply.github.com>
Date: Sat, 24 Feb 2024 23:36:06 +0100
Subject: [PATCH] Add template path to CompilerException to enable rich debug
 features (#936)

* Add template path to CompilerException to enable rich debug features
Fixes #935
---
 changelog/935.md           | 1 +
 docs/upgrading.md          | 1 +
 src/Compiler/CodeFrame.php | 2 +-
 src/Compiler/Template.php  | 2 +-
 src/Template/Source.php    | 4 ++--
 5 files changed, 6 insertions(+), 4 deletions(-)
 create mode 100644 changelog/935.md

diff --git a/changelog/935.md b/changelog/935.md
new file mode 100644
index 00000000..735a2af9
--- /dev/null
+++ b/changelog/935.md
@@ -0,0 +1 @@
+- Add template path to CompilerException to enable rich debug features [#935](https://github.com/smarty-php/smarty/issues/935)
\ No newline at end of file
diff --git a/docs/upgrading.md b/docs/upgrading.md
index b538ec9e..ef9cc4c9 100644
--- a/docs/upgrading.md
+++ b/docs/upgrading.md
@@ -117,6 +117,7 @@ The following constants have been removed to prevent global side effects.
 - Smarty now always runs in multibyte mode. Make sure you use the [PHP multibyte extension](https://www.php.net/manual/en/book.mbstring.php) in production for optimal performance.
 - Generated `<script>` tags lo longer have deprecated `type="text/javascript"` or `language="Javascript"` attributes
 - Smarty will throw a compiler exception instead of silently ignoring a modifier on a function call, like this: `{include|dot:"x-template-id" file="included.dot.tpl"}`
+- The ::getFile() method of a CompilerException will now return the full path of the template being compiled, if possible. This used to be 'file:relative_dir/filename.tpl'.
 
 ## Upgrading from v3 to v4
 
diff --git a/src/Compiler/CodeFrame.php b/src/Compiler/CodeFrame.php
index 69d17ed9..5e782150 100644
--- a/src/Compiler/CodeFrame.php
+++ b/src/Compiler/CodeFrame.php
@@ -121,6 +121,6 @@ class CodeFrame
 	 * @return string
 	 */
 	public function insertLocalVariables(): string {
-		return '$_smarty_current_dir = ' . var_export(dirname($this->_template->getSource()->getFilepath()), true) . ";\n";
+		return '$_smarty_current_dir = ' . var_export(dirname($this->_template->getSource()->getFilepath() ?? '.'), true) . ";\n";
 	}
 }
diff --git a/src/Compiler/Template.php b/src/Compiler/Template.php
index 184457f3..c60aed21 100644
--- a/src/Compiler/Template.php
+++ b/src/Compiler/Template.php
@@ -848,7 +848,7 @@ class Template extends BaseCompiler {
 		$e = new CompilerException(
 			$error_text,
 			0,
-			$this->template->getSource()->getFullResourceName(),
+			$this->template->getSource()->getFilepath() ?? $this->template->getSource()->getFullResourceName(),
 			$line
 		);
 		$e->source = trim(preg_replace('![\t\r\n]+!', ' ', $match[$line - 1]));
diff --git a/src/Template/Source.php b/src/Template/Source.php
index cba8106f..382e710a 100644
--- a/src/Template/Source.php
+++ b/src/Template/Source.php
@@ -271,11 +271,11 @@ class Source {
 		return $this->type . ':' . $this->name;
 	}
 
-	public function getFilepath(): string {
+	public function getFilepath(): ?string {
 		if ($this->handler instanceof FilePlugin) {
 			return $this->handler->getFilePath($this->name, $this->smarty, $this->isConfig);
 		}
-		return '.';
+		return null;
 	}
 
 	public function isConfig(): bool {