fix: highlightFile() in BaseExceptionHandler for PHP 8.3#8401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 6 commits into from
Jan 7, 2024
Merged

fix: highlightFile() in BaseExceptionHandler for PHP 8.3 #8401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
688c8ba
fix: highlightFile() in BaseExceptionHandler
michalsn Jan 5, 2024
0cf729d
updates for $source handling based on kenjis PR
michalsn Jan 5, 2024
3eac5ab
add IniTestTrait to easy backup ini values
michalsn Jan 5, 2024
e98dcfd
add group to the IniTestTratiTest
michalsn Jan 5, 2024
f9bd4da
add separate results for PHP 7.4
michalsn Jan 6, 2024
d558f09
update separate results for PHP 7.4
michalsn Jan 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions system/Debug/BaseExceptionHandler.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -182,8 +182,15 @@ protected static function highlightFile(string $file, int $lineNumber, int $line

$source = str_replace(["\r\n", "\r"], "\n", $source);
$source = explode("\n", highlight_string($source, true));
$source = str_replace('<br />', "\n", $source[1]);
$source = explode("\n", str_replace("\r\n", "\n", $source));

if (PHP_VERSION_ID < 80300) {
$source = str_replace('<br />', "\n", $source[1]);
$source = explode("\n", str_replace("\r\n", "\n", $source));
} else {
// 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);
}

// Get just the part to show
$start = max($lineNumber - (int) round($lines / 2), 0);
Expand All@@ -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');
Expand All@@ -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++;
}
}

Expand Down
33 changes: 33 additions & 0 deletions system/Test/IniTestTrait.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Test;

trait IniTestTrait
{
private array $iniSettings = [];

private function backupIniValues(array $keys): void
{
foreach ($keys as $key) {
$this->iniSettings[$key] = ini_get($key);
}
}

private function restoreIniValues(): void
{
foreach ($this->iniSettings as $key => $value) {
ini_set($key, $value);
}

$this->iniSettings = [];
}
}
16 changes: 16 additions & 0 deletions tests/_support/Debug/highlightFile.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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>
16 changes: 16 additions & 0 deletions tests/_support/Debug/highlightFile_pre_80000.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">Support</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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>
16 changes: 16 additions & 0 deletions tests/_support/Debug/highlightFile_pre_80300.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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>
31 changes: 31 additions & 0 deletions tests/system/Debug/ExceptionHandlerTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use App\Controllers\Home;
use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\IniTestTrait;
use CodeIgniter\Test\StreamFilterTrait;
use Config\Exceptions as ExceptionsConfig;
use Config\Services;
Expand All@@ -27,6 +28,7 @@
final class ExceptionHandlerTest extends CIUnitTestCase
{
use StreamFilterTrait;
use IniTestTrait;

private ExceptionHandler $handler;

Expand DownExpand Up@@ -237,4 +239,33 @@ public function testMaskSensitiveDataTraceDataKey(): void

$this->assertSame('/var/www/CodeIgniter4/app/Controllers/Home.php', $newTrace[0]['file']);
}

public function testHighlightFile(): void
{
$this->backupIniValues([
'highlight.comment', 'highlight.default', 'highlight.html', 'highlight.keyword', 'highlight.string',
]);

$highlightFile = $this->getPrivateMethodInvoker($this->handler, 'highlightFile');
$result = $highlightFile(SUPPORTPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Hello.php', 16);

switch (true) {
case PHP_VERSION_ID < 80000:
$resultFile = 'highlightFile_pre_80000.html';
break;

case PHP_VERSION_ID < 80300:
$resultFile = 'highlightFile_pre_80300.html';
break;

default:
$resultFile = 'highlightFile.html';
}

$expected = file_get_contents(SUPPORTPATH . 'Debug' . DIRECTORY_SEPARATOR . $resultFile);

$this->assertSame($expected, $result);

$this->restoreIniValues();
}
}
43 changes: 43 additions & 0 deletions tests/system/Test/IniTestTraitTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Test;

use ReflectionException;

/**
* @internal
*
* @group Others
*/
final class IniTestTraitTest extends CIUnitTestCase
{
use IniTestTrait;

/**
* @throws ReflectionException
*/
public function testBackupAndRestoreIniValues(): void
{
$this->backupIniValues(['highlight.default']);
$backup = $this->getPrivateProperty($this, 'iniSettings');
$this->assertSame('#0000BB', $backup['highlight.default']);

ini_set('highlight.default', '#FFFFFF');
$this->assertSame('#FFFFFF', ini_get('highlight.default'));

$this->restoreIniValues();
$this->assertSame('#0000BB', ini_get('highlight.default'));

$backup = $this->getPrivateProperty($this, 'iniSettings');
$this->assertSame([], $backup);
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix: highlightFile() in BaseExceptionHandler for PHP 8.3#8401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

Jan 7, 2024
 Merged


fix: highlightFile() in BaseExceptionHandler for PHP 8.3
#8401
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
688c8ba

fix: highlightFile() in BaseExceptionHandler


michalsn Jan 5, 2024
0cf729d

updates for $source handling based on kenjis PR


michalsn Jan 5, 2024
3eac5ab

add IniTestTrait to easy backup ini values


michalsn Jan 5, 2024
e98dcfd

add group to the IniTestTratiTest


michalsn Jan 5, 2024
f9bd4da

add separate results for PHP 7.4


michalsn Jan 6, 2024
d558f09

update separate results for PHP 7.4


michalsn Jan 6, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 13 additions & 3 deletions
system/Debug/BaseExceptionHandler.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,8 +182,15 @@ protected static function highlightFile(string $file, int $lineNumber, int $line

 $source = str_replace(["\r\n", "\r"], "\n", $source);
 $source = explode("\n", highlight_string($source, true));
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));

 if (PHP_VERSION_ID < 80300) {
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));
 } else {
 // 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);
 }

 // Get just the part to show
 $start = max($lineNumber - (int) round($lines / 2), 0);
Expand All@@ -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');
Expand All@@ -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++;
 }
 }

Expand Down

33 changes: 33 additions & 0 deletions
system/Test/IniTestTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

trait IniTestTrait
{
 private array $iniSettings = [];

 private function backupIniValues(array $keys): void
 {
 foreach ($keys as $key) {
 $this->iniSettings[$key] = ini_get($key);
 }
 }

 private function restoreIniValues(): void
 {
 foreach ($this->iniSettings as $key => $value) {
 ini_set($key, $value);
 }

 $this->iniSettings = [];
 }
}

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80000.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">Support</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80300.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

31 changes: 31 additions & 0 deletions
tests/system/Debug/ExceptionHandlerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use App\Controllers\Home;
use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\IniTestTrait;
use CodeIgniter\Test\StreamFilterTrait;
use Config\Exceptions as ExceptionsConfig;
use Config\Services;
Expand All@@ -27,6 +28,7 @@
final class ExceptionHandlerTest extends CIUnitTestCase
{
 use StreamFilterTrait;
 use IniTestTrait;

 private ExceptionHandler $handler;

Expand DownExpand Up@@ -237,4 +239,33 @@ public function testMaskSensitiveDataTraceDataKey(): void

 $this->assertSame('/var/www/CodeIgniter4/app/Controllers/Home.php', $newTrace[0]['file']);
 }

 public function testHighlightFile(): void
 {
 $this->backupIniValues([
 'highlight.comment', 'highlight.default', 'highlight.html', 'highlight.keyword', 'highlight.string',
 ]);

 $highlightFile = $this->getPrivateMethodInvoker($this->handler, 'highlightFile');
 $result = $highlightFile(SUPPORTPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Hello.php', 16);

 switch (true) {
 case PHP_VERSION_ID < 80000:
 $resultFile = 'highlightFile_pre_80000.html';
 break;

 case PHP_VERSION_ID < 80300:
 $resultFile = 'highlightFile_pre_80300.html';
 break;

 default:
 $resultFile = 'highlightFile.html';
 }

 $expected = file_get_contents(SUPPORTPATH . 'Debug' . DIRECTORY_SEPARATOR . $resultFile);

 $this->assertSame($expected, $result);

 $this->restoreIniValues();
 }
}

43 changes: 43 additions & 0 deletions
tests/system/Test/IniTestTraitTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use ReflectionException;

/**
 * @internal
 *
 * @group Others
 */
final class IniTestTraitTest extends CIUnitTestCase
{
 use IniTestTrait;

 /**
 * @throws ReflectionException
 */
 public function testBackupAndRestoreIniValues(): void
 {
 $this->backupIniValues(['highlight.default']);
 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame('#0000BB', $backup['highlight.default']);

 ini_set('highlight.default', '#FFFFFF');
 $this->assertSame('#FFFFFF', ini_get('highlight.default'));

 $this->restoreIniValues();
 $this->assertSame('#0000BB', ini_get('highlight.default'));

 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame([], $backup);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: highlightFile() in BaseExceptionHandler for PHP 8.3#8401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

Jan 7, 2024
 Merged


fix: highlightFile() in BaseExceptionHandler for PHP 8.3
#8401
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
688c8ba

fix: highlightFile() in BaseExceptionHandler


michalsn Jan 5, 2024
0cf729d

updates for $source handling based on kenjis PR


michalsn Jan 5, 2024
3eac5ab

add IniTestTrait to easy backup ini values


michalsn Jan 5, 2024
e98dcfd

add group to the IniTestTratiTest


michalsn Jan 5, 2024
f9bd4da

add separate results for PHP 7.4


michalsn Jan 6, 2024
d558f09

update separate results for PHP 7.4


michalsn Jan 6, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 13 additions & 3 deletions
system/Debug/BaseExceptionHandler.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,8 +182,15 @@ protected static function highlightFile(string $file, int $lineNumber, int $line

 $source = str_replace(["\r\n", "\r"], "\n", $source);
 $source = explode("\n", highlight_string($source, true));
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));

 if (PHP_VERSION_ID < 80300) {
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));
 } else {
 // 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);
 }

 // Get just the part to show
 $start = max($lineNumber - (int) round($lines / 2), 0);
Expand All@@ -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');
Expand All@@ -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++;
 }
 }

Expand Down

33 changes: 33 additions & 0 deletions
system/Test/IniTestTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

trait IniTestTrait
{
 private array $iniSettings = [];

 private function backupIniValues(array $keys): void
 {
 foreach ($keys as $key) {
 $this->iniSettings[$key] = ini_get($key);
 }
 }

 private function restoreIniValues(): void
 {
 foreach ($this->iniSettings as $key => $value) {
 ini_set($key, $value);
 }

 $this->iniSettings = [];
 }
}

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80000.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">Support</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80300.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

31 changes: 31 additions & 0 deletions
tests/system/Debug/ExceptionHandlerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use App\Controllers\Home;
use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\IniTestTrait;
use CodeIgniter\Test\StreamFilterTrait;
use Config\Exceptions as ExceptionsConfig;
use Config\Services;
Expand All@@ -27,6 +28,7 @@
final class ExceptionHandlerTest extends CIUnitTestCase
{
 use StreamFilterTrait;
 use IniTestTrait;

 private ExceptionHandler $handler;

Expand DownExpand Up@@ -237,4 +239,33 @@ public function testMaskSensitiveDataTraceDataKey(): void

 $this->assertSame('/var/www/CodeIgniter4/app/Controllers/Home.php', $newTrace[0]['file']);
 }

 public function testHighlightFile(): void
 {
 $this->backupIniValues([
 'highlight.comment', 'highlight.default', 'highlight.html', 'highlight.keyword', 'highlight.string',
 ]);

 $highlightFile = $this->getPrivateMethodInvoker($this->handler, 'highlightFile');
 $result = $highlightFile(SUPPORTPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Hello.php', 16);

 switch (true) {
 case PHP_VERSION_ID < 80000:
 $resultFile = 'highlightFile_pre_80000.html';
 break;

 case PHP_VERSION_ID < 80300:
 $resultFile = 'highlightFile_pre_80300.html';
 break;

 default:
 $resultFile = 'highlightFile.html';
 }

 $expected = file_get_contents(SUPPORTPATH . 'Debug' . DIRECTORY_SEPARATOR . $resultFile);

 $this->assertSame($expected, $result);

 $this->restoreIniValues();
 }
}

43 changes: 43 additions & 0 deletions
tests/system/Test/IniTestTraitTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use ReflectionException;

/**
 * @internal
 *
 * @group Others
 */
final class IniTestTraitTest extends CIUnitTestCase
{
 use IniTestTrait;

 /**
 * @throws ReflectionException
 */
 public function testBackupAndRestoreIniValues(): void
 {
 $this->backupIniValues(['highlight.default']);
 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame('#0000BB', $backup['highlight.default']);

 ini_set('highlight.default', '#FFFFFF');
 $this->assertSame('#FFFFFF', ini_get('highlight.default'));

 $this->restoreIniValues();
 $this->assertSame('#0000BB', ini_get('highlight.default'));

 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame([], $backup);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: highlightFile() in BaseExceptionHandler for PHP 8.3#8401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

Jan 7, 2024
 Merged


fix: highlightFile() in BaseExceptionHandler for PHP 8.3
#8401
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
688c8ba

fix: highlightFile() in BaseExceptionHandler


michalsn Jan 5, 2024
0cf729d

updates for $source handling based on kenjis PR


michalsn Jan 5, 2024
3eac5ab

add IniTestTrait to easy backup ini values


michalsn Jan 5, 2024
e98dcfd

add group to the IniTestTratiTest


michalsn Jan 5, 2024
f9bd4da

add separate results for PHP 7.4


michalsn Jan 6, 2024
d558f09

update separate results for PHP 7.4


michalsn Jan 6, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 13 additions & 3 deletions
system/Debug/BaseExceptionHandler.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,8 +182,15 @@ protected static function highlightFile(string $file, int $lineNumber, int $line

 $source = str_replace(["\r\n", "\r"], "\n", $source);
 $source = explode("\n", highlight_string($source, true));
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));

 if (PHP_VERSION_ID < 80300) {
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));
 } else {
 // 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);
 }

 // Get just the part to show
 $start = max($lineNumber - (int) round($lines / 2), 0);
Expand All@@ -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');
Expand All@@ -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++;
 }
 }

Expand Down

33 changes: 33 additions & 0 deletions
system/Test/IniTestTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

trait IniTestTrait
{
 private array $iniSettings = [];

 private function backupIniValues(array $keys): void
 {
 foreach ($keys as $key) {
 $this->iniSettings[$key] = ini_get($key);
 }
 }

 private function restoreIniValues(): void
 {
 foreach ($this->iniSettings as $key => $value) {
 ini_set($key, $value);
 }

 $this->iniSettings = [];
 }
}

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80000.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">Support</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80300.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

31 changes: 31 additions & 0 deletions
tests/system/Debug/ExceptionHandlerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use App\Controllers\Home;
use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\IniTestTrait;
use CodeIgniter\Test\StreamFilterTrait;
use Config\Exceptions as ExceptionsConfig;
use Config\Services;
Expand All@@ -27,6 +28,7 @@
final class ExceptionHandlerTest extends CIUnitTestCase
{
 use StreamFilterTrait;
 use IniTestTrait;

 private ExceptionHandler $handler;

Expand DownExpand Up@@ -237,4 +239,33 @@ public function testMaskSensitiveDataTraceDataKey(): void

 $this->assertSame('/var/www/CodeIgniter4/app/Controllers/Home.php', $newTrace[0]['file']);
 }

 public function testHighlightFile(): void
 {
 $this->backupIniValues([
 'highlight.comment', 'highlight.default', 'highlight.html', 'highlight.keyword', 'highlight.string',
 ]);

 $highlightFile = $this->getPrivateMethodInvoker($this->handler, 'highlightFile');
 $result = $highlightFile(SUPPORTPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Hello.php', 16);

 switch (true) {
 case PHP_VERSION_ID < 80000:
 $resultFile = 'highlightFile_pre_80000.html';
 break;

 case PHP_VERSION_ID < 80300:
 $resultFile = 'highlightFile_pre_80300.html';
 break;

 default:
 $resultFile = 'highlightFile.html';
 }

 $expected = file_get_contents(SUPPORTPATH . 'Debug' . DIRECTORY_SEPARATOR . $resultFile);

 $this->assertSame($expected, $result);

 $this->restoreIniValues();
 }
}

43 changes: 43 additions & 0 deletions
tests/system/Test/IniTestTraitTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use ReflectionException;

/**
 * @internal
 *
 * @group Others
 */
final class IniTestTraitTest extends CIUnitTestCase
{
 use IniTestTrait;

 /**
 * @throws ReflectionException
 */
 public function testBackupAndRestoreIniValues(): void
 {
 $this->backupIniValues(['highlight.default']);
 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame('#0000BB', $backup['highlight.default']);

 ini_set('highlight.default', '#FFFFFF');
 $this->assertSame('#FFFFFF', ini_get('highlight.default'));

 $this->restoreIniValues();
 $this->assertSame('#0000BB', ini_get('highlight.default'));

 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame([], $backup);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix: highlightFile() in BaseExceptionHandler for PHP 8.3#8401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

Jan 7, 2024
 Merged


fix: highlightFile() in BaseExceptionHandler for PHP 8.3
#8401
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
688c8ba

fix: highlightFile() in BaseExceptionHandler


michalsn Jan 5, 2024
0cf729d

updates for $source handling based on kenjis PR


michalsn Jan 5, 2024
3eac5ab

add IniTestTrait to easy backup ini values


michalsn Jan 5, 2024
e98dcfd

add group to the IniTestTratiTest


michalsn Jan 5, 2024
f9bd4da

add separate results for PHP 7.4


michalsn Jan 6, 2024
d558f09

update separate results for PHP 7.4


michalsn Jan 6, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 13 additions & 3 deletions
system/Debug/BaseExceptionHandler.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,8 +182,15 @@ protected static function highlightFile(string $file, int $lineNumber, int $line

 $source = str_replace(["\r\n", "\r"], "\n", $source);
 $source = explode("\n", highlight_string($source, true));
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));

 if (PHP_VERSION_ID < 80300) {
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));
 } else {
 // 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);
 }

 // Get just the part to show
 $start = max($lineNumber - (int) round($lines / 2), 0);
Expand All@@ -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');
Expand All@@ -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++;
 }
 }

Expand Down

33 changes: 33 additions & 0 deletions
system/Test/IniTestTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

trait IniTestTrait
{
 private array $iniSettings = [];

 private function backupIniValues(array $keys): void
 {
 foreach ($keys as $key) {
 $this->iniSettings[$key] = ini_get($key);
 }
 }

 private function restoreIniValues(): void
 {
 foreach ($this->iniSettings as $key => $value) {
 ini_set($key, $value);
 }

 $this->iniSettings = [];
 }
}

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80000.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">Support</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80300.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

31 changes: 31 additions & 0 deletions
tests/system/Debug/ExceptionHandlerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use App\Controllers\Home;
use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\IniTestTrait;
use CodeIgniter\Test\StreamFilterTrait;
use Config\Exceptions as ExceptionsConfig;
use Config\Services;
Expand All@@ -27,6 +28,7 @@
final class ExceptionHandlerTest extends CIUnitTestCase
{
 use StreamFilterTrait;
 use IniTestTrait;

 private ExceptionHandler $handler;

Expand DownExpand Up@@ -237,4 +239,33 @@ public function testMaskSensitiveDataTraceDataKey(): void

 $this->assertSame('/var/www/CodeIgniter4/app/Controllers/Home.php', $newTrace[0]['file']);
 }

 public function testHighlightFile(): void
 {
 $this->backupIniValues([
 'highlight.comment', 'highlight.default', 'highlight.html', 'highlight.keyword', 'highlight.string',
 ]);

 $highlightFile = $this->getPrivateMethodInvoker($this->handler, 'highlightFile');
 $result = $highlightFile(SUPPORTPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Hello.php', 16);

 switch (true) {
 case PHP_VERSION_ID < 80000:
 $resultFile = 'highlightFile_pre_80000.html';
 break;

 case PHP_VERSION_ID < 80300:
 $resultFile = 'highlightFile_pre_80300.html';
 break;

 default:
 $resultFile = 'highlightFile.html';
 }

 $expected = file_get_contents(SUPPORTPATH . 'Debug' . DIRECTORY_SEPARATOR . $resultFile);

 $this->assertSame($expected, $result);

 $this->restoreIniValues();
 }
}

43 changes: 43 additions & 0 deletions
tests/system/Test/IniTestTraitTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use ReflectionException;

/**
 * @internal
 *
 * @group Others
 */
final class IniTestTraitTest extends CIUnitTestCase
{
 use IniTestTrait;

 /**
 * @throws ReflectionException
 */
 public function testBackupAndRestoreIniValues(): void
 {
 $this->backupIniValues(['highlight.default']);
 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame('#0000BB', $backup['highlight.default']);

 ini_set('highlight.default', '#FFFFFF');
 $this->assertSame('#FFFFFF', ini_get('highlight.default'));

 $this->restoreIniValues();
 $this->assertSame('#0000BB', ini_get('highlight.default'));

 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame([], $backup);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: highlightFile() in BaseExceptionHandler for PHP 8.3#8401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

Jan 7, 2024
 Merged


fix: highlightFile() in BaseExceptionHandler for PHP 8.3
#8401
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
688c8ba

fix: highlightFile() in BaseExceptionHandler


michalsn Jan 5, 2024
0cf729d

updates for $source handling based on kenjis PR


michalsn Jan 5, 2024
3eac5ab

add IniTestTrait to easy backup ini values


michalsn Jan 5, 2024
e98dcfd

add group to the IniTestTratiTest


michalsn Jan 5, 2024
f9bd4da

add separate results for PHP 7.4


michalsn Jan 6, 2024
d558f09

update separate results for PHP 7.4


michalsn Jan 6, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 13 additions & 3 deletions
system/Debug/BaseExceptionHandler.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,8 +182,15 @@ protected static function highlightFile(string $file, int $lineNumber, int $line

 $source = str_replace(["\r\n", "\r"], "\n", $source);
 $source = explode("\n", highlight_string($source, true));
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));

 if (PHP_VERSION_ID < 80300) {
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));
 } else {
 // 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);
 }

 // Get just the part to show
 $start = max($lineNumber - (int) round($lines / 2), 0);
Expand All@@ -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');
Expand All@@ -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++;
 }
 }

Expand Down

33 changes: 33 additions & 0 deletions
system/Test/IniTestTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

trait IniTestTrait
{
 private array $iniSettings = [];

 private function backupIniValues(array $keys): void
 {
 foreach ($keys as $key) {
 $this->iniSettings[$key] = ini_get($key);
 }
 }

 private function restoreIniValues(): void
 {
 foreach ($this->iniSettings as $key => $value) {
 ini_set($key, $value);
 }

 $this->iniSettings = [];
 }
}

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80000.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">Support</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80300.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

31 changes: 31 additions & 0 deletions
tests/system/Debug/ExceptionHandlerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use App\Controllers\Home;
use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\IniTestTrait;
use CodeIgniter\Test\StreamFilterTrait;
use Config\Exceptions as ExceptionsConfig;
use Config\Services;
Expand All@@ -27,6 +28,7 @@
final class ExceptionHandlerTest extends CIUnitTestCase
{
 use StreamFilterTrait;
 use IniTestTrait;

 private ExceptionHandler $handler;

Expand DownExpand Up@@ -237,4 +239,33 @@ public function testMaskSensitiveDataTraceDataKey(): void

 $this->assertSame('/var/www/CodeIgniter4/app/Controllers/Home.php', $newTrace[0]['file']);
 }

 public function testHighlightFile(): void
 {
 $this->backupIniValues([
 'highlight.comment', 'highlight.default', 'highlight.html', 'highlight.keyword', 'highlight.string',
 ]);

 $highlightFile = $this->getPrivateMethodInvoker($this->handler, 'highlightFile');
 $result = $highlightFile(SUPPORTPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Hello.php', 16);

 switch (true) {
 case PHP_VERSION_ID < 80000:
 $resultFile = 'highlightFile_pre_80000.html';
 break;

 case PHP_VERSION_ID < 80300:
 $resultFile = 'highlightFile_pre_80300.html';
 break;

 default:
 $resultFile = 'highlightFile.html';
 }

 $expected = file_get_contents(SUPPORTPATH . 'Debug' . DIRECTORY_SEPARATOR . $resultFile);

 $this->assertSame($expected, $result);

 $this->restoreIniValues();
 }
}

43 changes: 43 additions & 0 deletions
tests/system/Test/IniTestTraitTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use ReflectionException;

/**
 * @internal
 *
 * @group Others
 */
final class IniTestTraitTest extends CIUnitTestCase
{
 use IniTestTrait;

 /**
 * @throws ReflectionException
 */
 public function testBackupAndRestoreIniValues(): void
 {
 $this->backupIniValues(['highlight.default']);
 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame('#0000BB', $backup['highlight.default']);

 ini_set('highlight.default', '#FFFFFF');
 $this->assertSame('#FFFFFF', ini_get('highlight.default'));

 $this->restoreIniValues();
 $this->assertSame('#0000BB', ini_get('highlight.default'));

 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame([], $backup);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix: highlightFile() in BaseExceptionHandler for PHP 8.3#8401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

Jan 7, 2024
 Merged


fix: highlightFile() in BaseExceptionHandler for PHP 8.3
#8401
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
688c8ba

fix: highlightFile() in BaseExceptionHandler


michalsn Jan 5, 2024
0cf729d

updates for $source handling based on kenjis PR


michalsn Jan 5, 2024
3eac5ab

add IniTestTrait to easy backup ini values


michalsn Jan 5, 2024
e98dcfd

add group to the IniTestTratiTest


michalsn Jan 5, 2024
f9bd4da

add separate results for PHP 7.4


michalsn Jan 6, 2024
d558f09

update separate results for PHP 7.4


michalsn Jan 6, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 13 additions & 3 deletions
system/Debug/BaseExceptionHandler.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,8 +182,15 @@ protected static function highlightFile(string $file, int $lineNumber, int $line

 $source = str_replace(["\r\n", "\r"], "\n", $source);
 $source = explode("\n", highlight_string($source, true));
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));

 if (PHP_VERSION_ID < 80300) {
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));
 } else {
 // 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);
 }

 // Get just the part to show
 $start = max($lineNumber - (int) round($lines / 2), 0);
Expand All@@ -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');
Expand All@@ -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++;
 }
 }

Expand Down

33 changes: 33 additions & 0 deletions
system/Test/IniTestTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

trait IniTestTrait
{
 private array $iniSettings = [];

 private function backupIniValues(array $keys): void
 {
 foreach ($keys as $key) {
 $this->iniSettings[$key] = ini_get($key);
 }
 }

 private function restoreIniValues(): void
 {
 foreach ($this->iniSettings as $key => $value) {
 ini_set($key, $value);
 }

 $this->iniSettings = [];
 }
}

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80000.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">Support</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80300.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

31 changes: 31 additions & 0 deletions
tests/system/Debug/ExceptionHandlerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use App\Controllers\Home;
use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\IniTestTrait;
use CodeIgniter\Test\StreamFilterTrait;
use Config\Exceptions as ExceptionsConfig;
use Config\Services;
Expand All@@ -27,6 +28,7 @@
final class ExceptionHandlerTest extends CIUnitTestCase
{
 use StreamFilterTrait;
 use IniTestTrait;

 private ExceptionHandler $handler;

Expand DownExpand Up@@ -237,4 +239,33 @@ public function testMaskSensitiveDataTraceDataKey(): void

 $this->assertSame('/var/www/CodeIgniter4/app/Controllers/Home.php', $newTrace[0]['file']);
 }

 public function testHighlightFile(): void
 {
 $this->backupIniValues([
 'highlight.comment', 'highlight.default', 'highlight.html', 'highlight.keyword', 'highlight.string',
 ]);

 $highlightFile = $this->getPrivateMethodInvoker($this->handler, 'highlightFile');
 $result = $highlightFile(SUPPORTPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Hello.php', 16);

 switch (true) {
 case PHP_VERSION_ID < 80000:
 $resultFile = 'highlightFile_pre_80000.html';
 break;

 case PHP_VERSION_ID < 80300:
 $resultFile = 'highlightFile_pre_80300.html';
 break;

 default:
 $resultFile = 'highlightFile.html';
 }

 $expected = file_get_contents(SUPPORTPATH . 'Debug' . DIRECTORY_SEPARATOR . $resultFile);

 $this->assertSame($expected, $result);

 $this->restoreIniValues();
 }
}

43 changes: 43 additions & 0 deletions
tests/system/Test/IniTestTraitTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use ReflectionException;

/**
 * @internal
 *
 * @group Others
 */
final class IniTestTraitTest extends CIUnitTestCase
{
 use IniTestTrait;

 /**
 * @throws ReflectionException
 */
 public function testBackupAndRestoreIniValues(): void
 {
 $this->backupIniValues(['highlight.default']);
 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame('#0000BB', $backup['highlight.default']);

 ini_set('highlight.default', '#FFFFFF');
 $this->assertSame('#FFFFFF', ini_get('highlight.default'));

 $this->restoreIniValues();
 $this->assertSame('#0000BB', ini_get('highlight.default'));

 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame([], $backup);
 }
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix: highlightFile() in BaseExceptionHandler for PHP 8.3#8401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 6 commits into

from

Jan 7, 2024
 Merged


fix: highlightFile() in BaseExceptionHandler for PHP 8.3
#8401
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
688c8ba

fix: highlightFile() in BaseExceptionHandler


michalsn Jan 5, 2024
0cf729d

updates for $source handling based on kenjis PR


michalsn Jan 5, 2024
3eac5ab

add IniTestTrait to easy backup ini values


michalsn Jan 5, 2024
e98dcfd

add group to the IniTestTratiTest


michalsn Jan 5, 2024
f9bd4da

add separate results for PHP 7.4


michalsn Jan 6, 2024
d558f09

update separate results for PHP 7.4


michalsn Jan 6, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 13 additions & 3 deletions
system/Debug/BaseExceptionHandler.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,8 +182,15 @@ protected static function highlightFile(string $file, int $lineNumber, int $line

 $source = str_replace(["\r\n", "\r"], "\n", $source);
 $source = explode("\n", highlight_string($source, true));
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));

 if (PHP_VERSION_ID < 80300) {
 $source = str_replace('<br />', "\n", $source[1]);
 $source = explode("\n", str_replace("\r\n", "\n", $source));
 } else {
 // 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);
 }

 // Get just the part to show
 $start = max($lineNumber - (int) round($lines / 2), 0);
Expand All@@ -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');
Expand All@@ -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++;
 }
 }

Expand Down

33 changes: 33 additions & 0 deletions
system/Test/IniTestTrait.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

trait IniTestTrait
{
 private array $iniSettings = [];

 private function backupIniValues(array $keys): void
 {
 foreach ($keys as $key) {
 $this->iniSettings[$key] = ini_get($key);
 }
 }

 private function restoreIniValues(): void
 {
 foreach ($this->iniSettings as $key => $value) {
 ini_set($key, $value);
 }

 $this->iniSettings = [];
 }
}

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80000.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">Support</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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</span><span style="color: #f1ce61;">\</span><span style="color: #c7c7c7">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>

16 changes: 16 additions & 0 deletions
tests/_support/Debug/highlightFile_pre_80300.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -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>

31 changes: 31 additions & 0 deletions
tests/system/Debug/ExceptionHandlerTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@
use App\Controllers\Home;
use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\IniTestTrait;
use CodeIgniter\Test\StreamFilterTrait;
use Config\Exceptions as ExceptionsConfig;
use Config\Services;
Expand All@@ -27,6 +28,7 @@
final class ExceptionHandlerTest extends CIUnitTestCase
{
 use StreamFilterTrait;
 use IniTestTrait;

 private ExceptionHandler $handler;

Expand DownExpand Up@@ -237,4 +239,33 @@ public function testMaskSensitiveDataTraceDataKey(): void

 $this->assertSame('/var/www/CodeIgniter4/app/Controllers/Home.php', $newTrace[0]['file']);
 }

 public function testHighlightFile(): void
 {
 $this->backupIniValues([
 'highlight.comment', 'highlight.default', 'highlight.html', 'highlight.keyword', 'highlight.string',
 ]);

 $highlightFile = $this->getPrivateMethodInvoker($this->handler, 'highlightFile');
 $result = $highlightFile(SUPPORTPATH . 'Controllers' . DIRECTORY_SEPARATOR . 'Hello.php', 16);

 switch (true) {
 case PHP_VERSION_ID < 80000:
 $resultFile = 'highlightFile_pre_80000.html';
 break;

 case PHP_VERSION_ID < 80300:
 $resultFile = 'highlightFile_pre_80300.html';
 break;

 default:
 $resultFile = 'highlightFile.html';
 }

 $expected = file_get_contents(SUPPORTPATH . 'Debug' . DIRECTORY_SEPARATOR . $resultFile);

 $this->assertSame($expected, $result);

 $this->restoreIniValues();
 }
}

43 changes: 43 additions & 0 deletions
tests/system/Test/IniTestTraitTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use ReflectionException;

/**
 * @internal
 *
 * @group Others
 */
final class IniTestTraitTest extends CIUnitTestCase
{
 use IniTestTrait;

 /**
 * @throws ReflectionException
 */
 public function testBackupAndRestoreIniValues(): void
 {
 $this->backupIniValues(['highlight.default']);
 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame('#0000BB', $backup['highlight.default']);

 ini_set('highlight.default', '#FFFFFF');
 $this->assertSame('#FFFFFF', ini_get('highlight.default'));

 $this->restoreIniValues();
 $this->assertSame('#0000BB', ini_get('highlight.default'));

 $backup = $this->getPrivateProperty($this, 'iniSettings');
 $this->assertSame([], $backup);
 }
}