Add normalize_path helper function#7718

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

Closed
paulbalandan wants to merge 3 commits into from
Closed

Add normalize_path helper function #7718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cf5679
Add `normalize_path`
paulbalandan Jul 26, 2023
5a50c4d
Fix path related failures
paulbalandan Jul 26, 2023
fd54020
Add documentation for normalize_path
paulbalandan Jul 26, 2023
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
7 changes: 5 additions & 2 deletions system/Autoloader/FileLocator.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,7 +94,7 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
// Check each path in the namespace
foreach ($paths as $path) {
// Ensure trailing slash
$path = rtrim($path, '/') . '/';
$path = rtrim($path, '\\/') . '/';

// If we have a folder name, then the calling function
// expects this file to be within that folder, like 'Views',
Expand All@@ -104,8 +104,11 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
}

$path .= $filename;

if (is_file($path)) {
return $path;
helper('filesystem');

return normalize_path($path);
}
}

Expand Down
25 changes: 22 additions & 3 deletions system/Helpers/filesystem_helper.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -253,15 +253,17 @@ function get_filenames(
function get_dir_file_info(string $sourceDir, bool $topLevelOnly = true, bool $recursion = false): array
{
static $fileData = [];
$relativePath = $sourceDir;

$sourceDir = realpath($sourceDir) ?: $sourceDir;
$relativePath = $sourceDir;

try {
$fp = opendir($sourceDir);

// reset the array and make sure $source_dir has a trailing slash on the initial call
// reset the array and make sure $sourceDir has a trailing slash on the initial call
if ($recursion === false) {
$fileData = [];
$sourceDir = rtrim(realpath($sourceDir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
$sourceDir = rtrim($sourceDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
}

// Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
Expand DownExpand Up@@ -448,3 +450,20 @@ function set_realpath(string $path, bool $checkExistence = false): string
return is_dir($path) ? rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : $path;
}
}

if (! function_exists('normalize_path')) {
/**
* Normalizes the given path.
*
* @param bool $native If true, this will normalize all slashes to `DIRECTORY_SEPARATOR`. Otherwise,
* this will change all slashes to forward slashes ("/").
*/
function normalize_path(string $path, bool $native = true): string
{
if ($native) {
return str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path);
}

return str_replace('\\', '/', $path);
}
}
14 changes: 10 additions & 4 deletions tests/system/Autoloader/AutoloaderTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,13 +85,13 @@ public function testInitializeTwice()

$ns = $loader->getNamespace();
$this->assertCount(1, $ns['App']);
$this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
$this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));

$loader->initialize(new Autoload(), new Modules());

$ns = $loader->getNamespace();
$this->assertCount(1, $ns['App']);
$this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
$this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));
}

public function testServiceAutoLoaderFromShareInstances()
Expand DownExpand Up@@ -284,9 +284,15 @@ public function testComposerNamespaceDoesNotOverwriteConfigAutoloadPsr4()
$loader = new Autoloader();
$loader->initialize($config, $modules);

$namespaces = $loader->getNamespace();
$namespaces = array_map(
static fn (array $paths): array => array_map(
static fn (string $path): string => normalize_path($path, false),
$paths
),
$loader->getNamespace()
);
$this->assertSame('/Config/Autoload/Psr/Log/', $namespaces['Psr\Log'][0]);
$this->assertStringContainsString(VENDORPATH, $namespaces['Psr\Log'][1]);
$this->assertStringContainsString(normalize_path(VENDORPATH, false), $namespaces['Psr\Log'][1]);
}

public function testComposerPackagesOnly()
Expand Down
31 changes: 15 additions & 16 deletions tests/system/Autoloader/FileLocatorTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ public function testLocateFileNotNamespacedFindsInAppDirectory()
{
$file = 'Controllers/Home'; // not namespaced

$expected = APPPATH . 'Controllers/Home.php';
$expected = normalize_path(APPPATH . 'Controllers/Home.php');

$this->assertSame($expected, $this->locator->locateFile($file));
}
Expand All@@ -71,7 +71,7 @@ public function testLocateFileNotNamespacedFindsWithFolderInAppDirectory()
{
$file = 'welcome_message'; // not namespaced

$expected = APPPATH . 'Views/welcome_message.php';
$expected = normalize_path(APPPATH . 'Views/welcome_message.php');

$this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
}
Expand All@@ -89,7 +89,7 @@ public function testLocateFileNotNamespacedWorksInNestedAppDirectory()
{
$file = 'Controllers/Home'; // not namespaced

$expected = APPPATH . 'Controllers/Home.php';
$expected = normalize_path(APPPATH . 'Controllers/Home.php');

// This works because $file contains `Controllers`.
$this->assertSame($expected, $this->locator->locateFile($file, 'Controllers'));
Expand All@@ -99,7 +99,7 @@ public function testLocateFileWithFolderNameInFile()
{
$file = '\App\Views/errors/html/error_404.php';

$expected = APPPATH . 'Views/errors/html/error_404.php';
$expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

// This works because $file contains `Views`.
$this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -109,7 +109,7 @@ public function testLocateFileNotNamespacedWithFolderNameInFile()
{
$file = 'Views/welcome_message.php'; // not namespaced

$expected = APPPATH . 'Views/welcome_message.php';
$expected = normalize_path(APPPATH . 'Views/welcome_message.php');

// This works because $file contains `Views`.
$this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -119,7 +119,7 @@ public function testLocateFileCanFindNamespacedView()
{
$file = '\Errors\error_404';

$expected = APPPATH . 'Views/errors/html/error_404.php';
$expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

// The namespace `Errors` (APPPATH . 'Views/errors') + the folder (`html`) + `error_404`
$this->assertSame($expected, $this->locator->locateFile($file, 'html'));
Expand All@@ -129,7 +129,7 @@ public function testLocateFileCanFindNestedNamespacedView()
{
$file = '\Errors\html/error_404';

$expected = APPPATH . 'Views/errors/html/error_404.php';
$expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

$this->assertSame($expected, $this->locator->locateFile($file, 'html'));
}
Expand All@@ -138,7 +138,7 @@ public function testLocateFileCanFindNamespacedViewWhenVendorHasTwoNamespaces()
{
$file = '\CodeIgniter\Devkit\View\Views/simple';

$expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
$expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

$this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
}
Expand All@@ -161,14 +161,14 @@ public function testLocateFileWithProperNamespace()
{
$file = 'Acme\SampleProject\View\Views\simple';

$expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
$expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

$this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
}

public function testSearchSimple()
{
$expected = APPPATH . 'Config/App.php';
$expected = normalize_path(APPPATH . 'Config/App.php');

$foundFiles = $this->locator->search('Config/App.php');

Expand All@@ -177,7 +177,7 @@ public function testSearchSimple()

public function testSearchWithFileExtension()
{
$expected = APPPATH . 'Config/App.php';
$expected = normalize_path(APPPATH . 'Config/App.php');

$foundFiles = $this->locator->search('Config/App', 'php');

Expand DownExpand Up@@ -208,8 +208,8 @@ public function testSearchPrioritizeSystemOverApp()

$this->assertSame(
[
SYSTEMPATH . 'Language/en/Validation.php',
APPPATH . 'Language/en/Validation.php',
normalize_path(SYSTEMPATH . 'Language/en/Validation.php'),
normalize_path(APPPATH . 'Language/en/Validation.php'),
],
$foundFiles
);
Expand All@@ -224,9 +224,8 @@ public function testListFilesSimple()
{
$files = $this->locator->listFiles('Config/');

$expectedWin = APPPATH . 'Config\App.php';
$expectedLin = APPPATH . 'Config/App.php';
$this->assertTrue(in_array($expectedWin, $files, true) || in_array($expectedLin, $files, true));
$expected = normalize_path(APPPATH . 'Config/App.php');
$this->assertTrue(in_array($expected, $files, true));
}

public function testListFilesDoesNotContainDirectories()
Expand Down
Loading
, '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
Add normalize_path helper function#7718

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

 Closed

paulbalandan
wants to merge
3
commits into

from

 Closed


Add normalize_path helper function
#7718
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6cf5679

Add `normalize_path`


paulbalandan Jul 26, 2023
5a50c4d

Fix path related failures


paulbalandan Jul 26, 2023
fd54020

Add documentation for normalize_path


paulbalandan Jul 26, 2023

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


7 changes: 5 additions & 2 deletions
system/Autoloader/FileLocator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,7 +94,7 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 // Check each path in the namespace
 foreach ($paths as $path) {
 // Ensure trailing slash
 $path = rtrim($path, '/') . '/';
 $path = rtrim($path, '\\/') . '/';

 // If we have a folder name, then the calling function
 // expects this file to be within that folder, like 'Views',
Expand All@@ -104,8 +104,11 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 }

 $path .= $filename;

 if (is_file($path)) {
 return $path;
 helper('filesystem');

 return normalize_path($path);
 }
 }

Expand Down

25 changes: 22 additions & 3 deletions
system/Helpers/filesystem_helper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,15 +253,17 @@ function get_filenames(
 function get_dir_file_info(string $sourceDir, bool $topLevelOnly = true, bool $recursion = false): array
 {
 static $fileData = [];
 $relativePath = $sourceDir;

 $sourceDir = realpath($sourceDir) ?: $sourceDir;
 $relativePath = $sourceDir;

 try {
 $fp = opendir($sourceDir);

 // reset the array and make sure $source_dir has a trailing slash on the initial call
 // reset the array and make sure $sourceDir has a trailing slash on the initial call
 if ($recursion === false) {
 $fileData = [];
 $sourceDir = rtrim(realpath($sourceDir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 $sourceDir = rtrim($sourceDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 }

 // Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
Expand DownExpand Up@@ -448,3 +450,20 @@ function set_realpath(string $path, bool $checkExistence = false): string
 return is_dir($path) ? rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : $path;
 }
}

if (! function_exists('normalize_path')) {
 /**
 * Normalizes the given path.
 *
 * @param bool $native If true, this will normalize all slashes to `DIRECTORY_SEPARATOR`. Otherwise,
 * this will change all slashes to forward slashes ("/").
 */
 function normalize_path(string $path, bool $native = true): string
 {
 if ($native) {
 return str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path);
 }

 return str_replace('\\', '/', $path);
 }
}

14 changes: 10 additions & 4 deletions
tests/system/Autoloader/AutoloaderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,13 +85,13 @@ public function testInitializeTwice()

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));

 $loader->initialize(new Autoload(), new Modules());

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));
 }

 public function testServiceAutoLoaderFromShareInstances()
Expand DownExpand Up@@ -284,9 +284,15 @@ public function testComposerNamespaceDoesNotOverwriteConfigAutoloadPsr4()
 $loader = new Autoloader();
 $loader->initialize($config, $modules);

 $namespaces = $loader->getNamespace();
 $namespaces = array_map(
 static fn (array $paths): array => array_map(
 static fn (string $path): string => normalize_path($path, false),
 $paths
 ),
 $loader->getNamespace()
 );
 $this->assertSame('/Config/Autoload/Psr/Log/', $namespaces['Psr\Log'][0]);
 $this->assertStringContainsString(VENDORPATH, $namespaces['Psr\Log'][1]);
 $this->assertStringContainsString(normalize_path(VENDORPATH, false), $namespaces['Psr\Log'][1]);
 }

 public function testComposerPackagesOnly()
Expand Down

31 changes: 15 additions & 16 deletions
tests/system/Autoloader/FileLocatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ public function testLocateFileNotNamespacedFindsInAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 $this->assertSame($expected, $this->locator->locateFile($file));
 }
Expand All@@ -71,7 +71,7 @@ public function testLocateFileNotNamespacedFindsWithFolderInAppDirectory()
 {
 $file = 'welcome_message'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -89,7 +89,7 @@ public function testLocateFileNotNamespacedWorksInNestedAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 // This works because $file contains `Controllers`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Controllers'));
Expand All@@ -99,7 +99,7 @@ public function testLocateFileWithFolderNameInFile()
 {
 $file = '\App\Views/errors/html/error_404.php';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -109,7 +109,7 @@ public function testLocateFileNotNamespacedWithFolderNameInFile()
 {
 $file = 'Views/welcome_message.php'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -119,7 +119,7 @@ public function testLocateFileCanFindNamespacedView()
 {
 $file = '\Errors\error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // The namespace `Errors` (APPPATH . 'Views/errors') + the folder (`html`) + `error_404`
 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
Expand All@@ -129,7 +129,7 @@ public function testLocateFileCanFindNestedNamespacedView()
 {
 $file = '\Errors\html/error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
 }
Expand All@@ -138,7 +138,7 @@ public function testLocateFileCanFindNamespacedViewWhenVendorHasTwoNamespaces()
 {
 $file = '\CodeIgniter\Devkit\View\Views/simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -161,14 +161,14 @@ public function testLocateFileWithProperNamespace()
 {
 $file = 'Acme\SampleProject\View\Views\simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }

 public function testSearchSimple()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App.php');

Expand All@@ -177,7 +177,7 @@ public function testSearchSimple()

 public function testSearchWithFileExtension()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App', 'php');

Expand DownExpand Up@@ -208,8 +208,8 @@ public function testSearchPrioritizeSystemOverApp()

 $this->assertSame(
 [
 SYSTEMPATH . 'Language/en/Validation.php',
 APPPATH . 'Language/en/Validation.php',
normalize_path(SYSTEMPATH . 'Language/en/Validation.php'),
normalize_path(APPPATH . 'Language/en/Validation.php'),
 ],
 $foundFiles
 );
Expand All@@ -224,9 +224,8 @@ public function testListFilesSimple()
 {
 $files = $this->locator->listFiles('Config/');

 $expectedWin = APPPATH . 'Config\App.php';
 $expectedLin = APPPATH . 'Config/App.php';
 $this->assertTrue(in_array($expectedWin, $files, true) || in_array($expectedLin, $files, true));
 $expected = normalize_path(APPPATH . 'Config/App.php');
 $this->assertTrue(in_array($expected, $files, true));
 }

 public function testListFilesDoesNotContainDirectories()
Expand Down
Loading

, '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
Add normalize_path helper function#7718

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

 Closed

paulbalandan
wants to merge
3
commits into

from

 Closed


Add normalize_path helper function
#7718
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6cf5679

Add `normalize_path`


paulbalandan Jul 26, 2023
5a50c4d

Fix path related failures


paulbalandan Jul 26, 2023
fd54020

Add documentation for normalize_path


paulbalandan Jul 26, 2023

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


7 changes: 5 additions & 2 deletions
system/Autoloader/FileLocator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,7 +94,7 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 // Check each path in the namespace
 foreach ($paths as $path) {
 // Ensure trailing slash
 $path = rtrim($path, '/') . '/';
 $path = rtrim($path, '\\/') . '/';

 // If we have a folder name, then the calling function
 // expects this file to be within that folder, like 'Views',
Expand All@@ -104,8 +104,11 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 }

 $path .= $filename;

 if (is_file($path)) {
 return $path;
 helper('filesystem');

 return normalize_path($path);
 }
 }

Expand Down

25 changes: 22 additions & 3 deletions
system/Helpers/filesystem_helper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,15 +253,17 @@ function get_filenames(
 function get_dir_file_info(string $sourceDir, bool $topLevelOnly = true, bool $recursion = false): array
 {
 static $fileData = [];
 $relativePath = $sourceDir;

 $sourceDir = realpath($sourceDir) ?: $sourceDir;
 $relativePath = $sourceDir;

 try {
 $fp = opendir($sourceDir);

 // reset the array and make sure $source_dir has a trailing slash on the initial call
 // reset the array and make sure $sourceDir has a trailing slash on the initial call
 if ($recursion === false) {
 $fileData = [];
 $sourceDir = rtrim(realpath($sourceDir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 $sourceDir = rtrim($sourceDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 }

 // Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
Expand DownExpand Up@@ -448,3 +450,20 @@ function set_realpath(string $path, bool $checkExistence = false): string
 return is_dir($path) ? rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : $path;
 }
}

if (! function_exists('normalize_path')) {
 /**
 * Normalizes the given path.
 *
 * @param bool $native If true, this will normalize all slashes to `DIRECTORY_SEPARATOR`. Otherwise,
 * this will change all slashes to forward slashes ("/").
 */
 function normalize_path(string $path, bool $native = true): string
 {
 if ($native) {
 return str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path);
 }

 return str_replace('\\', '/', $path);
 }
}

14 changes: 10 additions & 4 deletions
tests/system/Autoloader/AutoloaderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,13 +85,13 @@ public function testInitializeTwice()

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));

 $loader->initialize(new Autoload(), new Modules());

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));
 }

 public function testServiceAutoLoaderFromShareInstances()
Expand DownExpand Up@@ -284,9 +284,15 @@ public function testComposerNamespaceDoesNotOverwriteConfigAutoloadPsr4()
 $loader = new Autoloader();
 $loader->initialize($config, $modules);

 $namespaces = $loader->getNamespace();
 $namespaces = array_map(
 static fn (array $paths): array => array_map(
 static fn (string $path): string => normalize_path($path, false),
 $paths
 ),
 $loader->getNamespace()
 );
 $this->assertSame('/Config/Autoload/Psr/Log/', $namespaces['Psr\Log'][0]);
 $this->assertStringContainsString(VENDORPATH, $namespaces['Psr\Log'][1]);
 $this->assertStringContainsString(normalize_path(VENDORPATH, false), $namespaces['Psr\Log'][1]);
 }

 public function testComposerPackagesOnly()
Expand Down

31 changes: 15 additions & 16 deletions
tests/system/Autoloader/FileLocatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ public function testLocateFileNotNamespacedFindsInAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 $this->assertSame($expected, $this->locator->locateFile($file));
 }
Expand All@@ -71,7 +71,7 @@ public function testLocateFileNotNamespacedFindsWithFolderInAppDirectory()
 {
 $file = 'welcome_message'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -89,7 +89,7 @@ public function testLocateFileNotNamespacedWorksInNestedAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 // This works because $file contains `Controllers`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Controllers'));
Expand All@@ -99,7 +99,7 @@ public function testLocateFileWithFolderNameInFile()
 {
 $file = '\App\Views/errors/html/error_404.php';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -109,7 +109,7 @@ public function testLocateFileNotNamespacedWithFolderNameInFile()
 {
 $file = 'Views/welcome_message.php'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -119,7 +119,7 @@ public function testLocateFileCanFindNamespacedView()
 {
 $file = '\Errors\error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // The namespace `Errors` (APPPATH . 'Views/errors') + the folder (`html`) + `error_404`
 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
Expand All@@ -129,7 +129,7 @@ public function testLocateFileCanFindNestedNamespacedView()
 {
 $file = '\Errors\html/error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
 }
Expand All@@ -138,7 +138,7 @@ public function testLocateFileCanFindNamespacedViewWhenVendorHasTwoNamespaces()
 {
 $file = '\CodeIgniter\Devkit\View\Views/simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -161,14 +161,14 @@ public function testLocateFileWithProperNamespace()
 {
 $file = 'Acme\SampleProject\View\Views\simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }

 public function testSearchSimple()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App.php');

Expand All@@ -177,7 +177,7 @@ public function testSearchSimple()

 public function testSearchWithFileExtension()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App', 'php');

Expand DownExpand Up@@ -208,8 +208,8 @@ public function testSearchPrioritizeSystemOverApp()

 $this->assertSame(
 [
 SYSTEMPATH . 'Language/en/Validation.php',
 APPPATH . 'Language/en/Validation.php',
normalize_path(SYSTEMPATH . 'Language/en/Validation.php'),
normalize_path(APPPATH . 'Language/en/Validation.php'),
 ],
 $foundFiles
 );
Expand All@@ -224,9 +224,8 @@ public function testListFilesSimple()
 {
 $files = $this->locator->listFiles('Config/');

 $expectedWin = APPPATH . 'Config\App.php';
 $expectedLin = APPPATH . 'Config/App.php';
 $this->assertTrue(in_array($expectedWin, $files, true) || in_array($expectedLin, $files, true));
 $expected = normalize_path(APPPATH . 'Config/App.php');
 $this->assertTrue(in_array($expected, $files, true));
 }

 public function testListFilesDoesNotContainDirectories()
Expand Down
Loading

, '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
Add normalize_path helper function#7718

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

 Closed

paulbalandan
wants to merge
3
commits into

from

 Closed


Add normalize_path helper function
#7718
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6cf5679

Add `normalize_path`


paulbalandan Jul 26, 2023
5a50c4d

Fix path related failures


paulbalandan Jul 26, 2023
fd54020

Add documentation for normalize_path


paulbalandan Jul 26, 2023

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


7 changes: 5 additions & 2 deletions
system/Autoloader/FileLocator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,7 +94,7 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 // Check each path in the namespace
 foreach ($paths as $path) {
 // Ensure trailing slash
 $path = rtrim($path, '/') . '/';
 $path = rtrim($path, '\\/') . '/';

 // If we have a folder name, then the calling function
 // expects this file to be within that folder, like 'Views',
Expand All@@ -104,8 +104,11 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 }

 $path .= $filename;

 if (is_file($path)) {
 return $path;
 helper('filesystem');

 return normalize_path($path);
 }
 }

Expand Down

25 changes: 22 additions & 3 deletions
system/Helpers/filesystem_helper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,15 +253,17 @@ function get_filenames(
 function get_dir_file_info(string $sourceDir, bool $topLevelOnly = true, bool $recursion = false): array
 {
 static $fileData = [];
 $relativePath = $sourceDir;

 $sourceDir = realpath($sourceDir) ?: $sourceDir;
 $relativePath = $sourceDir;

 try {
 $fp = opendir($sourceDir);

 // reset the array and make sure $source_dir has a trailing slash on the initial call
 // reset the array and make sure $sourceDir has a trailing slash on the initial call
 if ($recursion === false) {
 $fileData = [];
 $sourceDir = rtrim(realpath($sourceDir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 $sourceDir = rtrim($sourceDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 }

 // Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
Expand DownExpand Up@@ -448,3 +450,20 @@ function set_realpath(string $path, bool $checkExistence = false): string
 return is_dir($path) ? rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : $path;
 }
}

if (! function_exists('normalize_path')) {
 /**
 * Normalizes the given path.
 *
 * @param bool $native If true, this will normalize all slashes to `DIRECTORY_SEPARATOR`. Otherwise,
 * this will change all slashes to forward slashes ("/").
 */
 function normalize_path(string $path, bool $native = true): string
 {
 if ($native) {
 return str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path);
 }

 return str_replace('\\', '/', $path);
 }
}

14 changes: 10 additions & 4 deletions
tests/system/Autoloader/AutoloaderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,13 +85,13 @@ public function testInitializeTwice()

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));

 $loader->initialize(new Autoload(), new Modules());

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));
 }

 public function testServiceAutoLoaderFromShareInstances()
Expand DownExpand Up@@ -284,9 +284,15 @@ public function testComposerNamespaceDoesNotOverwriteConfigAutoloadPsr4()
 $loader = new Autoloader();
 $loader->initialize($config, $modules);

 $namespaces = $loader->getNamespace();
 $namespaces = array_map(
 static fn (array $paths): array => array_map(
 static fn (string $path): string => normalize_path($path, false),
 $paths
 ),
 $loader->getNamespace()
 );
 $this->assertSame('/Config/Autoload/Psr/Log/', $namespaces['Psr\Log'][0]);
 $this->assertStringContainsString(VENDORPATH, $namespaces['Psr\Log'][1]);
 $this->assertStringContainsString(normalize_path(VENDORPATH, false), $namespaces['Psr\Log'][1]);
 }

 public function testComposerPackagesOnly()
Expand Down

31 changes: 15 additions & 16 deletions
tests/system/Autoloader/FileLocatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ public function testLocateFileNotNamespacedFindsInAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 $this->assertSame($expected, $this->locator->locateFile($file));
 }
Expand All@@ -71,7 +71,7 @@ public function testLocateFileNotNamespacedFindsWithFolderInAppDirectory()
 {
 $file = 'welcome_message'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -89,7 +89,7 @@ public function testLocateFileNotNamespacedWorksInNestedAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 // This works because $file contains `Controllers`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Controllers'));
Expand All@@ -99,7 +99,7 @@ public function testLocateFileWithFolderNameInFile()
 {
 $file = '\App\Views/errors/html/error_404.php';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -109,7 +109,7 @@ public function testLocateFileNotNamespacedWithFolderNameInFile()
 {
 $file = 'Views/welcome_message.php'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -119,7 +119,7 @@ public function testLocateFileCanFindNamespacedView()
 {
 $file = '\Errors\error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // The namespace `Errors` (APPPATH . 'Views/errors') + the folder (`html`) + `error_404`
 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
Expand All@@ -129,7 +129,7 @@ public function testLocateFileCanFindNestedNamespacedView()
 {
 $file = '\Errors\html/error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
 }
Expand All@@ -138,7 +138,7 @@ public function testLocateFileCanFindNamespacedViewWhenVendorHasTwoNamespaces()
 {
 $file = '\CodeIgniter\Devkit\View\Views/simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -161,14 +161,14 @@ public function testLocateFileWithProperNamespace()
 {
 $file = 'Acme\SampleProject\View\Views\simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }

 public function testSearchSimple()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App.php');

Expand All@@ -177,7 +177,7 @@ public function testSearchSimple()

 public function testSearchWithFileExtension()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App', 'php');

Expand DownExpand Up@@ -208,8 +208,8 @@ public function testSearchPrioritizeSystemOverApp()

 $this->assertSame(
 [
 SYSTEMPATH . 'Language/en/Validation.php',
 APPPATH . 'Language/en/Validation.php',
normalize_path(SYSTEMPATH . 'Language/en/Validation.php'),
normalize_path(APPPATH . 'Language/en/Validation.php'),
 ],
 $foundFiles
 );
Expand All@@ -224,9 +224,8 @@ public function testListFilesSimple()
 {
 $files = $this->locator->listFiles('Config/');

 $expectedWin = APPPATH . 'Config\App.php';
 $expectedLin = APPPATH . 'Config/App.php';
 $this->assertTrue(in_array($expectedWin, $files, true) || in_array($expectedLin, $files, true));
 $expected = normalize_path(APPPATH . 'Config/App.php');
 $this->assertTrue(in_array($expected, $files, true));
 }

 public function testListFilesDoesNotContainDirectories()
Expand Down
Loading

, '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
Add normalize_path helper function#7718

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

 Closed

paulbalandan
wants to merge
3
commits into

from

 Closed


Add normalize_path helper function
#7718
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6cf5679

Add `normalize_path`


paulbalandan Jul 26, 2023
5a50c4d

Fix path related failures


paulbalandan Jul 26, 2023
fd54020

Add documentation for normalize_path


paulbalandan Jul 26, 2023

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


7 changes: 5 additions & 2 deletions
system/Autoloader/FileLocator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,7 +94,7 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 // Check each path in the namespace
 foreach ($paths as $path) {
 // Ensure trailing slash
 $path = rtrim($path, '/') . '/';
 $path = rtrim($path, '\\/') . '/';

 // If we have a folder name, then the calling function
 // expects this file to be within that folder, like 'Views',
Expand All@@ -104,8 +104,11 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 }

 $path .= $filename;

 if (is_file($path)) {
 return $path;
 helper('filesystem');

 return normalize_path($path);
 }
 }

Expand Down

25 changes: 22 additions & 3 deletions
system/Helpers/filesystem_helper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,15 +253,17 @@ function get_filenames(
 function get_dir_file_info(string $sourceDir, bool $topLevelOnly = true, bool $recursion = false): array
 {
 static $fileData = [];
 $relativePath = $sourceDir;

 $sourceDir = realpath($sourceDir) ?: $sourceDir;
 $relativePath = $sourceDir;

 try {
 $fp = opendir($sourceDir);

 // reset the array and make sure $source_dir has a trailing slash on the initial call
 // reset the array and make sure $sourceDir has a trailing slash on the initial call
 if ($recursion === false) {
 $fileData = [];
 $sourceDir = rtrim(realpath($sourceDir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 $sourceDir = rtrim($sourceDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 }

 // Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
Expand DownExpand Up@@ -448,3 +450,20 @@ function set_realpath(string $path, bool $checkExistence = false): string
 return is_dir($path) ? rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : $path;
 }
}

if (! function_exists('normalize_path')) {
 /**
 * Normalizes the given path.
 *
 * @param bool $native If true, this will normalize all slashes to `DIRECTORY_SEPARATOR`. Otherwise,
 * this will change all slashes to forward slashes ("/").
 */
 function normalize_path(string $path, bool $native = true): string
 {
 if ($native) {
 return str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path);
 }

 return str_replace('\\', '/', $path);
 }
}

14 changes: 10 additions & 4 deletions
tests/system/Autoloader/AutoloaderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,13 +85,13 @@ public function testInitializeTwice()

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));

 $loader->initialize(new Autoload(), new Modules());

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));
 }

 public function testServiceAutoLoaderFromShareInstances()
Expand DownExpand Up@@ -284,9 +284,15 @@ public function testComposerNamespaceDoesNotOverwriteConfigAutoloadPsr4()
 $loader = new Autoloader();
 $loader->initialize($config, $modules);

 $namespaces = $loader->getNamespace();
 $namespaces = array_map(
 static fn (array $paths): array => array_map(
 static fn (string $path): string => normalize_path($path, false),
 $paths
 ),
 $loader->getNamespace()
 );
 $this->assertSame('/Config/Autoload/Psr/Log/', $namespaces['Psr\Log'][0]);
 $this->assertStringContainsString(VENDORPATH, $namespaces['Psr\Log'][1]);
 $this->assertStringContainsString(normalize_path(VENDORPATH, false), $namespaces['Psr\Log'][1]);
 }

 public function testComposerPackagesOnly()
Expand Down

31 changes: 15 additions & 16 deletions
tests/system/Autoloader/FileLocatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ public function testLocateFileNotNamespacedFindsInAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 $this->assertSame($expected, $this->locator->locateFile($file));
 }
Expand All@@ -71,7 +71,7 @@ public function testLocateFileNotNamespacedFindsWithFolderInAppDirectory()
 {
 $file = 'welcome_message'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -89,7 +89,7 @@ public function testLocateFileNotNamespacedWorksInNestedAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 // This works because $file contains `Controllers`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Controllers'));
Expand All@@ -99,7 +99,7 @@ public function testLocateFileWithFolderNameInFile()
 {
 $file = '\App\Views/errors/html/error_404.php';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -109,7 +109,7 @@ public function testLocateFileNotNamespacedWithFolderNameInFile()
 {
 $file = 'Views/welcome_message.php'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -119,7 +119,7 @@ public function testLocateFileCanFindNamespacedView()
 {
 $file = '\Errors\error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // The namespace `Errors` (APPPATH . 'Views/errors') + the folder (`html`) + `error_404`
 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
Expand All@@ -129,7 +129,7 @@ public function testLocateFileCanFindNestedNamespacedView()
 {
 $file = '\Errors\html/error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
 }
Expand All@@ -138,7 +138,7 @@ public function testLocateFileCanFindNamespacedViewWhenVendorHasTwoNamespaces()
 {
 $file = '\CodeIgniter\Devkit\View\Views/simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -161,14 +161,14 @@ public function testLocateFileWithProperNamespace()
 {
 $file = 'Acme\SampleProject\View\Views\simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }

 public function testSearchSimple()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App.php');

Expand All@@ -177,7 +177,7 @@ public function testSearchSimple()

 public function testSearchWithFileExtension()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App', 'php');

Expand DownExpand Up@@ -208,8 +208,8 @@ public function testSearchPrioritizeSystemOverApp()

 $this->assertSame(
 [
 SYSTEMPATH . 'Language/en/Validation.php',
 APPPATH . 'Language/en/Validation.php',
normalize_path(SYSTEMPATH . 'Language/en/Validation.php'),
normalize_path(APPPATH . 'Language/en/Validation.php'),
 ],
 $foundFiles
 );
Expand All@@ -224,9 +224,8 @@ public function testListFilesSimple()
 {
 $files = $this->locator->listFiles('Config/');

 $expectedWin = APPPATH . 'Config\App.php';
 $expectedLin = APPPATH . 'Config/App.php';
 $this->assertTrue(in_array($expectedWin, $files, true) || in_array($expectedLin, $files, true));
 $expected = normalize_path(APPPATH . 'Config/App.php');
 $this->assertTrue(in_array($expected, $files, true));
 }

 public function testListFilesDoesNotContainDirectories()
Expand Down
Loading

, '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
Add normalize_path helper function#7718

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

 Closed

paulbalandan
wants to merge
3
commits into

from

 Closed


Add normalize_path helper function
#7718
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6cf5679

Add `normalize_path`


paulbalandan Jul 26, 2023
5a50c4d

Fix path related failures


paulbalandan Jul 26, 2023
fd54020

Add documentation for normalize_path


paulbalandan Jul 26, 2023

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


7 changes: 5 additions & 2 deletions
system/Autoloader/FileLocator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,7 +94,7 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 // Check each path in the namespace
 foreach ($paths as $path) {
 // Ensure trailing slash
 $path = rtrim($path, '/') . '/';
 $path = rtrim($path, '\\/') . '/';

 // If we have a folder name, then the calling function
 // expects this file to be within that folder, like 'Views',
Expand All@@ -104,8 +104,11 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 }

 $path .= $filename;

 if (is_file($path)) {
 return $path;
 helper('filesystem');

 return normalize_path($path);
 }
 }

Expand Down

25 changes: 22 additions & 3 deletions
system/Helpers/filesystem_helper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,15 +253,17 @@ function get_filenames(
 function get_dir_file_info(string $sourceDir, bool $topLevelOnly = true, bool $recursion = false): array
 {
 static $fileData = [];
 $relativePath = $sourceDir;

 $sourceDir = realpath($sourceDir) ?: $sourceDir;
 $relativePath = $sourceDir;

 try {
 $fp = opendir($sourceDir);

 // reset the array and make sure $source_dir has a trailing slash on the initial call
 // reset the array and make sure $sourceDir has a trailing slash on the initial call
 if ($recursion === false) {
 $fileData = [];
 $sourceDir = rtrim(realpath($sourceDir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 $sourceDir = rtrim($sourceDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 }

 // Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
Expand DownExpand Up@@ -448,3 +450,20 @@ function set_realpath(string $path, bool $checkExistence = false): string
 return is_dir($path) ? rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : $path;
 }
}

if (! function_exists('normalize_path')) {
 /**
 * Normalizes the given path.
 *
 * @param bool $native If true, this will normalize all slashes to `DIRECTORY_SEPARATOR`. Otherwise,
 * this will change all slashes to forward slashes ("/").
 */
 function normalize_path(string $path, bool $native = true): string
 {
 if ($native) {
 return str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path);
 }

 return str_replace('\\', '/', $path);
 }
}

14 changes: 10 additions & 4 deletions
tests/system/Autoloader/AutoloaderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,13 +85,13 @@ public function testInitializeTwice()

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));

 $loader->initialize(new Autoload(), new Modules());

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));
 }

 public function testServiceAutoLoaderFromShareInstances()
Expand DownExpand Up@@ -284,9 +284,15 @@ public function testComposerNamespaceDoesNotOverwriteConfigAutoloadPsr4()
 $loader = new Autoloader();
 $loader->initialize($config, $modules);

 $namespaces = $loader->getNamespace();
 $namespaces = array_map(
 static fn (array $paths): array => array_map(
 static fn (string $path): string => normalize_path($path, false),
 $paths
 ),
 $loader->getNamespace()
 );
 $this->assertSame('/Config/Autoload/Psr/Log/', $namespaces['Psr\Log'][0]);
 $this->assertStringContainsString(VENDORPATH, $namespaces['Psr\Log'][1]);
 $this->assertStringContainsString(normalize_path(VENDORPATH, false), $namespaces['Psr\Log'][1]);
 }

 public function testComposerPackagesOnly()
Expand Down

31 changes: 15 additions & 16 deletions
tests/system/Autoloader/FileLocatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ public function testLocateFileNotNamespacedFindsInAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 $this->assertSame($expected, $this->locator->locateFile($file));
 }
Expand All@@ -71,7 +71,7 @@ public function testLocateFileNotNamespacedFindsWithFolderInAppDirectory()
 {
 $file = 'welcome_message'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -89,7 +89,7 @@ public function testLocateFileNotNamespacedWorksInNestedAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 // This works because $file contains `Controllers`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Controllers'));
Expand All@@ -99,7 +99,7 @@ public function testLocateFileWithFolderNameInFile()
 {
 $file = '\App\Views/errors/html/error_404.php';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -109,7 +109,7 @@ public function testLocateFileNotNamespacedWithFolderNameInFile()
 {
 $file = 'Views/welcome_message.php'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -119,7 +119,7 @@ public function testLocateFileCanFindNamespacedView()
 {
 $file = '\Errors\error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // The namespace `Errors` (APPPATH . 'Views/errors') + the folder (`html`) + `error_404`
 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
Expand All@@ -129,7 +129,7 @@ public function testLocateFileCanFindNestedNamespacedView()
 {
 $file = '\Errors\html/error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
 }
Expand All@@ -138,7 +138,7 @@ public function testLocateFileCanFindNamespacedViewWhenVendorHasTwoNamespaces()
 {
 $file = '\CodeIgniter\Devkit\View\Views/simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -161,14 +161,14 @@ public function testLocateFileWithProperNamespace()
 {
 $file = 'Acme\SampleProject\View\Views\simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }

 public function testSearchSimple()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App.php');

Expand All@@ -177,7 +177,7 @@ public function testSearchSimple()

 public function testSearchWithFileExtension()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App', 'php');

Expand DownExpand Up@@ -208,8 +208,8 @@ public function testSearchPrioritizeSystemOverApp()

 $this->assertSame(
 [
 SYSTEMPATH . 'Language/en/Validation.php',
 APPPATH . 'Language/en/Validation.php',
normalize_path(SYSTEMPATH . 'Language/en/Validation.php'),
normalize_path(APPPATH . 'Language/en/Validation.php'),
 ],
 $foundFiles
 );
Expand All@@ -224,9 +224,8 @@ public function testListFilesSimple()
 {
 $files = $this->locator->listFiles('Config/');

 $expectedWin = APPPATH . 'Config\App.php';
 $expectedLin = APPPATH . 'Config/App.php';
 $this->assertTrue(in_array($expectedWin, $files, true) || in_array($expectedLin, $files, true));
 $expected = normalize_path(APPPATH . 'Config/App.php');
 $this->assertTrue(in_array($expected, $files, true));
 }

 public function testListFilesDoesNotContainDirectories()
Expand Down
Loading

, '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
Add normalize_path helper function#7718

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

 Closed

paulbalandan
wants to merge
3
commits into

from

 Closed


Add normalize_path helper function
#7718
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6cf5679

Add `normalize_path`


paulbalandan Jul 26, 2023
5a50c4d

Fix path related failures


paulbalandan Jul 26, 2023
fd54020

Add documentation for normalize_path


paulbalandan Jul 26, 2023

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


7 changes: 5 additions & 2 deletions
system/Autoloader/FileLocator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,7 +94,7 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 // Check each path in the namespace
 foreach ($paths as $path) {
 // Ensure trailing slash
 $path = rtrim($path, '/') . '/';
 $path = rtrim($path, '\\/') . '/';

 // If we have a folder name, then the calling function
 // expects this file to be within that folder, like 'Views',
Expand All@@ -104,8 +104,11 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 }

 $path .= $filename;

 if (is_file($path)) {
 return $path;
 helper('filesystem');

 return normalize_path($path);
 }
 }

Expand Down

25 changes: 22 additions & 3 deletions
system/Helpers/filesystem_helper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,15 +253,17 @@ function get_filenames(
 function get_dir_file_info(string $sourceDir, bool $topLevelOnly = true, bool $recursion = false): array
 {
 static $fileData = [];
 $relativePath = $sourceDir;

 $sourceDir = realpath($sourceDir) ?: $sourceDir;
 $relativePath = $sourceDir;

 try {
 $fp = opendir($sourceDir);

 // reset the array and make sure $source_dir has a trailing slash on the initial call
 // reset the array and make sure $sourceDir has a trailing slash on the initial call
 if ($recursion === false) {
 $fileData = [];
 $sourceDir = rtrim(realpath($sourceDir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 $sourceDir = rtrim($sourceDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 }

 // Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
Expand DownExpand Up@@ -448,3 +450,20 @@ function set_realpath(string $path, bool $checkExistence = false): string
 return is_dir($path) ? rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : $path;
 }
}

if (! function_exists('normalize_path')) {
 /**
 * Normalizes the given path.
 *
 * @param bool $native If true, this will normalize all slashes to `DIRECTORY_SEPARATOR`. Otherwise,
 * this will change all slashes to forward slashes ("/").
 */
 function normalize_path(string $path, bool $native = true): string
 {
 if ($native) {
 return str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path);
 }

 return str_replace('\\', '/', $path);
 }
}

14 changes: 10 additions & 4 deletions
tests/system/Autoloader/AutoloaderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,13 +85,13 @@ public function testInitializeTwice()

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));

 $loader->initialize(new Autoload(), new Modules());

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));
 }

 public function testServiceAutoLoaderFromShareInstances()
Expand DownExpand Up@@ -284,9 +284,15 @@ public function testComposerNamespaceDoesNotOverwriteConfigAutoloadPsr4()
 $loader = new Autoloader();
 $loader->initialize($config, $modules);

 $namespaces = $loader->getNamespace();
 $namespaces = array_map(
 static fn (array $paths): array => array_map(
 static fn (string $path): string => normalize_path($path, false),
 $paths
 ),
 $loader->getNamespace()
 );
 $this->assertSame('/Config/Autoload/Psr/Log/', $namespaces['Psr\Log'][0]);
 $this->assertStringContainsString(VENDORPATH, $namespaces['Psr\Log'][1]);
 $this->assertStringContainsString(normalize_path(VENDORPATH, false), $namespaces['Psr\Log'][1]);
 }

 public function testComposerPackagesOnly()
Expand Down

31 changes: 15 additions & 16 deletions
tests/system/Autoloader/FileLocatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ public function testLocateFileNotNamespacedFindsInAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 $this->assertSame($expected, $this->locator->locateFile($file));
 }
Expand All@@ -71,7 +71,7 @@ public function testLocateFileNotNamespacedFindsWithFolderInAppDirectory()
 {
 $file = 'welcome_message'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -89,7 +89,7 @@ public function testLocateFileNotNamespacedWorksInNestedAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 // This works because $file contains `Controllers`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Controllers'));
Expand All@@ -99,7 +99,7 @@ public function testLocateFileWithFolderNameInFile()
 {
 $file = '\App\Views/errors/html/error_404.php';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -109,7 +109,7 @@ public function testLocateFileNotNamespacedWithFolderNameInFile()
 {
 $file = 'Views/welcome_message.php'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -119,7 +119,7 @@ public function testLocateFileCanFindNamespacedView()
 {
 $file = '\Errors\error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // The namespace `Errors` (APPPATH . 'Views/errors') + the folder (`html`) + `error_404`
 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
Expand All@@ -129,7 +129,7 @@ public function testLocateFileCanFindNestedNamespacedView()
 {
 $file = '\Errors\html/error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
 }
Expand All@@ -138,7 +138,7 @@ public function testLocateFileCanFindNamespacedViewWhenVendorHasTwoNamespaces()
 {
 $file = '\CodeIgniter\Devkit\View\Views/simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -161,14 +161,14 @@ public function testLocateFileWithProperNamespace()
 {
 $file = 'Acme\SampleProject\View\Views\simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }

 public function testSearchSimple()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App.php');

Expand All@@ -177,7 +177,7 @@ public function testSearchSimple()

 public function testSearchWithFileExtension()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App', 'php');

Expand DownExpand Up@@ -208,8 +208,8 @@ public function testSearchPrioritizeSystemOverApp()

 $this->assertSame(
 [
 SYSTEMPATH . 'Language/en/Validation.php',
 APPPATH . 'Language/en/Validation.php',
normalize_path(SYSTEMPATH . 'Language/en/Validation.php'),
normalize_path(APPPATH . 'Language/en/Validation.php'),
 ],
 $foundFiles
 );
Expand All@@ -224,9 +224,8 @@ public function testListFilesSimple()
 {
 $files = $this->locator->listFiles('Config/');

 $expectedWin = APPPATH . 'Config\App.php';
 $expectedLin = APPPATH . 'Config/App.php';
 $this->assertTrue(in_array($expectedWin, $files, true) || in_array($expectedLin, $files, true));
 $expected = normalize_path(APPPATH . 'Config/App.php');
 $this->assertTrue(in_array($expected, $files, true));
 }

 public function testListFilesDoesNotContainDirectories()
Expand Down
Loading

, '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
Add normalize_path helper function#7718

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

 Closed

paulbalandan
wants to merge
3
commits into

from

 Closed


Add normalize_path helper function
#7718
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
6cf5679

Add `normalize_path`


paulbalandan Jul 26, 2023
5a50c4d

Fix path related failures


paulbalandan Jul 26, 2023
fd54020

Add documentation for normalize_path


paulbalandan Jul 26, 2023

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


7 changes: 5 additions & 2 deletions
system/Autoloader/FileLocator.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -94,7 +94,7 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 // Check each path in the namespace
 foreach ($paths as $path) {
 // Ensure trailing slash
 $path = rtrim($path, '/') . '/';
 $path = rtrim($path, '\\/') . '/';

 // If we have a folder name, then the calling function
 // expects this file to be within that folder, like 'Views',
Expand All@@ -104,8 +104,11 @@ public function locateFile(string $file, ?string $folder = null, string $ext = '
 }

 $path .= $filename;

 if (is_file($path)) {
 return $path;
 helper('filesystem');

 return normalize_path($path);
 }
 }

Expand Down

25 changes: 22 additions & 3 deletions
system/Helpers/filesystem_helper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -253,15 +253,17 @@ function get_filenames(
 function get_dir_file_info(string $sourceDir, bool $topLevelOnly = true, bool $recursion = false): array
 {
 static $fileData = [];
 $relativePath = $sourceDir;

 $sourceDir = realpath($sourceDir) ?: $sourceDir;
 $relativePath = $sourceDir;

 try {
 $fp = opendir($sourceDir);

 // reset the array and make sure $source_dir has a trailing slash on the initial call
 // reset the array and make sure $sourceDir has a trailing slash on the initial call
 if ($recursion === false) {
 $fileData = [];
 $sourceDir = rtrim(realpath($sourceDir), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 $sourceDir = rtrim($sourceDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
 }

 // Used to be foreach (scandir($source_dir, 1) as $file), but scandir() is simply not as fast
Expand DownExpand Up@@ -448,3 +450,20 @@ function set_realpath(string $path, bool $checkExistence = false): string
 return is_dir($path) ? rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : $path;
 }
}

if (! function_exists('normalize_path')) {
 /**
 * Normalizes the given path.
 *
 * @param bool $native If true, this will normalize all slashes to `DIRECTORY_SEPARATOR`. Otherwise,
 * this will change all slashes to forward slashes ("/").
 */
 function normalize_path(string $path, bool $native = true): string
 {
 if ($native) {
 return str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path);
 }

 return str_replace('\\', '/', $path);
 }
}

14 changes: 10 additions & 4 deletions
tests/system/Autoloader/AutoloaderTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,13 +85,13 @@ public function testInitializeTwice()

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));

 $loader->initialize(new Autoload(), new Modules());

 $ns = $loader->getNamespace();
 $this->assertCount(1, $ns['App']);
 $this->assertSame('ROOTPATH/app', clean_path($ns['App'][0]));
 $this->assertSame('ROOTPATH/app', normalize_path(clean_path($ns['App'][0]), false));
 }

 public function testServiceAutoLoaderFromShareInstances()
Expand DownExpand Up@@ -284,9 +284,15 @@ public function testComposerNamespaceDoesNotOverwriteConfigAutoloadPsr4()
 $loader = new Autoloader();
 $loader->initialize($config, $modules);

 $namespaces = $loader->getNamespace();
 $namespaces = array_map(
 static fn (array $paths): array => array_map(
 static fn (string $path): string => normalize_path($path, false),
 $paths
 ),
 $loader->getNamespace()
 );
 $this->assertSame('/Config/Autoload/Psr/Log/', $namespaces['Psr\Log'][0]);
 $this->assertStringContainsString(VENDORPATH, $namespaces['Psr\Log'][1]);
 $this->assertStringContainsString(normalize_path(VENDORPATH, false), $namespaces['Psr\Log'][1]);
 }

 public function testComposerPackagesOnly()
Expand Down

31 changes: 15 additions & 16 deletions
tests/system/Autoloader/FileLocatorTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -55,7 +55,7 @@ public function testLocateFileNotNamespacedFindsInAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 $this->assertSame($expected, $this->locator->locateFile($file));
 }
Expand All@@ -71,7 +71,7 @@ public function testLocateFileNotNamespacedFindsWithFolderInAppDirectory()
 {
 $file = 'welcome_message'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -89,7 +89,7 @@ public function testLocateFileNotNamespacedWorksInNestedAppDirectory()
 {
 $file = 'Controllers/Home'; // not namespaced

 $expected = APPPATH . 'Controllers/Home.php';
 $expected = normalize_path(APPPATH . 'Controllers/Home.php');

 // This works because $file contains `Controllers`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Controllers'));
Expand All@@ -99,7 +99,7 @@ public function testLocateFileWithFolderNameInFile()
 {
 $file = '\App\Views/errors/html/error_404.php';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -109,7 +109,7 @@ public function testLocateFileNotNamespacedWithFolderNameInFile()
 {
 $file = 'Views/welcome_message.php'; // not namespaced

 $expected = APPPATH . 'Views/welcome_message.php';
 $expected = normalize_path(APPPATH . 'Views/welcome_message.php');

 // This works because $file contains `Views`.
 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
Expand All@@ -119,7 +119,7 @@ public function testLocateFileCanFindNamespacedView()
 {
 $file = '\Errors\error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 // The namespace `Errors` (APPPATH . 'Views/errors') + the folder (`html`) + `error_404`
 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
Expand All@@ -129,7 +129,7 @@ public function testLocateFileCanFindNestedNamespacedView()
 {
 $file = '\Errors\html/error_404';

 $expected = APPPATH . 'Views/errors/html/error_404.php';
 $expected = normalize_path(APPPATH . 'Views/errors/html/error_404.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'html'));
 }
Expand All@@ -138,7 +138,7 @@ public function testLocateFileCanFindNamespacedViewWhenVendorHasTwoNamespaces()
 {
 $file = '\CodeIgniter\Devkit\View\Views/simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }
Expand All@@ -161,14 +161,14 @@ public function testLocateFileWithProperNamespace()
 {
 $file = 'Acme\SampleProject\View\Views\simple';

 $expected = ROOTPATH . 'tests/_support/View/Views/simple.php';
 $expected = normalize_path(ROOTPATH . 'tests/_support/View/Views/simple.php');

 $this->assertSame($expected, $this->locator->locateFile($file, 'Views'));
 }

 public function testSearchSimple()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App.php');

Expand All@@ -177,7 +177,7 @@ public function testSearchSimple()

 public function testSearchWithFileExtension()
 {
 $expected = APPPATH . 'Config/App.php';
 $expected = normalize_path(APPPATH . 'Config/App.php');

 $foundFiles = $this->locator->search('Config/App', 'php');

Expand DownExpand Up@@ -208,8 +208,8 @@ public function testSearchPrioritizeSystemOverApp()

 $this->assertSame(
 [
 SYSTEMPATH . 'Language/en/Validation.php',
 APPPATH . 'Language/en/Validation.php',
normalize_path(SYSTEMPATH . 'Language/en/Validation.php'),
normalize_path(APPPATH . 'Language/en/Validation.php'),
 ],
 $foundFiles
 );
Expand All@@ -224,9 +224,8 @@ public function testListFilesSimple()
 {
 $files = $this->locator->listFiles('Config/');

 $expectedWin = APPPATH . 'Config\App.php';
 $expectedLin = APPPATH . 'Config/App.php';
 $this->assertTrue(in_array($expectedWin, $files, true) || in_array($expectedLin, $files, true));
 $expected = normalize_path(APPPATH . 'Config/App.php');
 $this->assertTrue(in_array($expected, $files, true));
 }

 public function testListFilesDoesNotContainDirectories()
Expand Down
Loading