fix: highlightFile() in BaseExceptionHandler

Author: michalsn

system/Debug/BaseExceptionHandler.php

@@ -180,9 +180,16 @@ protected static function highlightFile(string $file, int $lineNumber, int $line
             return false;
         }
 
-        $source = str_replace(["\r\n", "\r"], "\n", $source);
-        $source = explode("\n", highlight_string($source, true));
-        $source = str_replace('<br />', "\n", $source[1]);
+        if (version_compare(PHP_VERSION, '8.3.0', '<')) {
+            $source = str_replace(["\r\n", "\r"], "\n", $source);
+            $source = explode("\n", highlight_string($source, true));
+            $source = str_replace('<br />', "\n", $source[1]);
+        } else {
+            $source = highlight_string($source, true);
+            // We have to remove these tags since we're preparing the result
+            // ourselves and these tags are added manually at the end.
+            $source = str_replace(['<pre><code>', '</code></pre>'], '', $source);
+        }
         $source = explode("\n", str_replace("\r\n", "\n", $source));
 
         // Get just the part to show
@@ -199,7 +206,7 @@ protected static function highlightFile(string $file, int $lineNumber, int $line
         // of open and close span tags on one line, we need
         // to ensure we can close them all to get the lines
         // showing correctly.
-        $spans = 1;
+        $spans = 0;
 
         foreach ($source as $n => $row) {
             $spans += substr_count($row, '<span') - substr_count($row, '</span');
@@ -216,6 +223,9 @@ protected static function highlightFile(string $file, int $lineNumber, int $line
                 );
             } else {
                 $out .= sprintf('<span class="line"><span class="number">' . $format . '</span> %s', $n + $start + 1, $row) . "\n";
+                // We're closing only one span tag we added manually line before,
+                // so we have to increment $spans count to close this tag later.
+                $spans++;
             }
         }
 

tests/_support/Debug/highlightFile.html

@@ -0,0 +1,16 @@
+<pre><code><span class="line"><span class="number"> 9</span>  * the LICENSE file that was distributed with this source code.
+<span class="line"><span class="number">10</span>  */
+<span class="line"><span class="number">11</span> 
+<span class="line"><span class="number">12</span> </span><span style="color: #f1ce61;">namespace </span><span style="color: #c7c7c7">Tests\Support\Controllers</span><span style="color: #f1ce61;">;
+<span class="line"><span class="number">13</span> 
+<span class="line"><span class="number">14</span> use </span><span style="color: #c7c7c7">CodeIgniter\Controller</span><span style="color: #f1ce61;">;
+<span class="line"><span class="number">15</span> 
+<span class='line highlight'><span class='number'>16</span> class Hello extends Controller
+</span></span><span style="color: #c7c7c7"></span><span style="color: #f1ce61;"></span><span style="color: #c7c7c7"><span class="line"><span class="number">17</span> </span><span style="color: #f1ce61;">{
+<span class="line"><span class="number">18</span>     public function </span><span style="color: #c7c7c7">index</span><span style="color: #f1ce61;">()
+<span class="line"><span class="number">19</span>     {
+<span class="line"><span class="number">20</span>         return </span><span style="color: #869d6a">'Hello'</span><span style="color: #f1ce61;">;
+<span class="line"><span class="number">21</span>     }
+<span class="line"><span class="number">22</span> }
+<span class="line"><span class="number">23</span> </span>
+</span></span></span></span></span></span></span></span></span></span></span></span></span></code></pre>

tests/_support/Debug/highlightFile_pre_8_3_0.html

@@ -0,0 +1,16 @@
+<pre><code><span class="line"><span class="number"> 9</span> &nbsp;*&nbsp;the&nbsp;LICENSE&nbsp;file&nbsp;that&nbsp;was&nbsp;distributed&nbsp;with&nbsp;this&nbsp;source&nbsp;code.
+<span class="line"><span class="number">10</span> &nbsp;*/
+<span class="line"><span class="number">11</span> 
+<span class="line"><span class="number">12</span> </span><span style="color: #f1ce61;">namespace&nbsp;</span><span style="color: #c7c7c7">Tests\Support\Controllers</span><span style="color: #f1ce61;">;
+<span class="line"><span class="number">13</span> 
+<span class="line"><span class="number">14</span> use&nbsp;</span><span style="color: #c7c7c7">CodeIgniter\Controller</span><span style="color: #f1ce61;">;
+<span class="line"><span class="number">15</span> 
+<span class='line highlight'><span class='number'>16</span> class&nbsp;Hello&nbsp;extends&nbsp;Controller
+</span></span><span style="color: #c7c7c7"></span><span style="color: #f1ce61;"></span><span style="color: #c7c7c7"><span class="line"><span class="number">17</span> </span><span style="color: #f1ce61;">{
+<span class="line"><span class="number">18</span> &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;function&nbsp;</span><span style="color: #c7c7c7">index</span><span style="color: #f1ce61;">()
+<span class="line"><span class="number">19</span> &nbsp;&nbsp;&nbsp;&nbsp;{
+<span class="line"><span class="number">20</span> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;</span><span style="color: #869d6a">'Hello'</span><span style="color: #f1ce61;">;
+<span class="line"><span class="number">21</span> &nbsp;&nbsp;&nbsp;&nbsp;}
+<span class="line"><span class="number">22</span> }
+<span class="line"><span class="number">23</span> </span>
+</span></span></span></span></span></span></span></span></span></span></span></span></span></code></pre>

tests/system/Debug/ExceptionHandlerTest.php

@@ -237,4 +237,17 @@ public function testMaskSensitiveDataTraceDataKey(): void
 
         $this->assertSame('/var/www/CodeIgniter4/app/Controllers/Home.php', $newTrace[0]['file']);
     }
+
+    public function testHighlightFile(): void
+    {
+        $highlightFile = $this->getPrivateMethodInvoker($this->handler, 'highlightFile');
+        $result        = $highlightFile(SUPPORTPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Hello.php', 16);
+        $resultFile    = version_compare(PHP_VERSION, '8.3.0', '<') ?
+            'highlightFile_pre_8_3_0.html' :
+            'highlightFile.html';
+
+        $expected = file_get_contents(SUPPORTPATH . 'Debug' . DIRECTORY_SEPARATOR . $resultFile);
+
+        $this->assertSame($expected, $result);
+    }
 }