fix: filter except empty#7823

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 10 commits into from
Aug 21, 2023
Merged

fix: filter except empty #7823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bc1f279
test: add test for except empty array
kenjis Aug 15, 2023
e7297f1
fix: "except empty" means "except all"
kenjis Aug 15, 2023
fc3ae4c
test: fix test case
kenjis Aug 15, 2023
b6a3c7d
refactor: extract method
kenjis Aug 15, 2023
459ea26
docs: add/fix PHPDoc types
kenjis Aug 16, 2023
f9ecd03
test: use dataProvider
kenjis Aug 16, 2023
2ad0864
test: add test cases for except
kenjis Aug 16, 2023
79aaefb
fix: empty string should mean except only baseURL
kenjis Aug 16, 2023
9b93434
docs: add/update PHPDoc types
kenjis Aug 16, 2023
e510da9
docs: add changelog
kenjis Aug 16, 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
49 changes: 44 additions & 5 deletions system/Filters/Filters.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,9 @@ public function setResponse(ResponseInterface $response)
* Runs through all of the filters for the specified
* uri and position.
*
* @return mixed|RequestInterface|ResponseInterface
* @param string $uri URI path relative to baseURL
*
* @return RequestInterface|ResponseInterface|string|null
*
* @throws FilterException
*/
Expand DownExpand Up@@ -221,6 +223,8 @@ public function run(string $uri, string $position = 'before')
* run through both a before and after and don't want to double
* process the rows.
*
* @param string|null $uri URI path relative to baseURL (all lowercase)
*
* @return Filters
*/
public function initialize(?string $uri = null)
Expand DownExpand Up@@ -391,7 +395,7 @@ public function getArguments(?string $key = null)
/**
* Add any applicable (not excluded) global filter settings to the mix.
*
* @param string $uri
* @param string|null $uri URI path relative to baseURL (all lowercase)
*
* @return void
*/
Expand All@@ -416,7 +420,7 @@ protected function processGlobals(?string $uri = null)
if (isset($rules['except'])) {
// grab the exclusion rules
$check = $rules['except'];
if ($this->pathApplies($uri, $check)) {
if ($this->checkExcept($uri, $check)) {
$keep = false;
}
}
Expand DownExpand Up@@ -454,7 +458,7 @@ protected function processMethods()
/**
* Add any applicable configured filters to the mix.
*
* @param string $uri
* @param string|null $uri URI path relative to baseURL (all lowercase)
*
* @return void
*/
Expand DownExpand Up@@ -536,12 +540,47 @@ private function pathApplies(string $uri, $paths)
$paths = [$paths];
}

// treat each paths as pseudo-regex
return $this->checkPseudoRegex($uri, $paths);
}

/**
* Check except paths
*
* @param string $uri URI path relative to baseURL (all lowercase)
* @param array|string $paths The except path patterns
*
* @return bool True if the URI matches except paths.
*/
private function checkExcept(string $uri, $paths): bool
{
// empty array does not match anything
if ($paths === []) {
return false;
}

// make sure the paths are iterable
if (is_string($paths)) {
$paths = [$paths];
}

return $this->checkPseudoRegex($uri, $paths);
}

/**
* Check the URI path as pseudo-regex
*
* @param string $uri URI path relative to baseURL (all lowercase)
* @param array $paths The except path patterns
*/
private function checkPseudoRegex(string $uri, array $paths): bool
{
// treat each path as pseudo-regex
foreach ($paths as $path) {
// need to escape path separators
$path = str_replace('/', '\/', trim($path, '/ '));
// need to make pseudo wildcard real
$path = strtolower(str_replace('*', '.*', $path));

// Does this rule apply here?
if (preg_match('#^' . $path . '$#', $uri, $match) === 1) {
return true;
Expand Down
128 changes: 92 additions & 36 deletions tests/system/Filters/FiltersTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -215,15 +215,23 @@ public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
['admin/*'],
],
[
[],
['admin/*', 'foo/*'],
],
[
['*'],
],
[
'admin/*',
],
];
}

/**
* @dataProvider provideProcessMethodProcessGlobalsWithExcept
*
* @param array|string $except
*/
public function testProcessMethodProcessGlobalsWithExcept(array $except): void
public function testProcessMethodProcessGlobalsWithExcept($except): void
{
$_SERVER['REQUEST_METHOD'] = 'GET';

Expand DownExpand Up@@ -572,7 +580,12 @@ public function testOtherResult(): void
$this->assertSame('This is curious', $response);
}

public function testBeforeExceptString(): void
/**
* @dataProvider provideBeforeExcept
*
* @param array|string $except
*/
public function testBeforeExcept(string $uri, $except, array $expected): void
{
$_SERVER['REQUEST_METHOD'] = 'GET';

Expand All@@ -584,7 +597,7 @@ public function testBeforeExceptString(): void
],
'globals' => [
'before' => [
'foo' => ['except' => 'admin/*'],
'foo' => ['except' => $except],
'bar',
],
'after' => [
Expand All@@ -595,48 +608,91 @@ public function testBeforeExceptString(): void
$filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
$filters = $this->createFilters($filtersConfig);

$uri = 'admin/foo/bar';
$expected = [
'before' => [
'bar',
],
'after' => ['baz'],
];
$this->assertSame($expected, $filters->initialize($uri)->getFilters());
}

public function testBeforeExceptInapplicable(): void
public static function provideBeforeExcept(): iterable
{
$_SERVER['REQUEST_METHOD'] = 'GET';

$config = [
'aliases' => [
'foo' => '',
'bar' => '',
'baz' => '',
return [
'string exclude' => [
'admin/foo/bar',
'admin/*',
[
'before' => [
'bar',
],
'after' => ['baz'],
],
],
'globals' => [
'before' => [
'foo' => ['except' => 'george/*'],
'bar',
'string not exclude' => [
'admin/foo/bar',
'george/*',
[
'before' => [
'foo',
'bar',
],
'after' => ['baz'],
],
'after' => [
'baz',
],
'empty array not exclude' => [
'admin/foo/bar',
[],
[
'before' => [
'foo',
'bar',
],
'after' => ['baz'],
],
],
];
$filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
$filters = $this->createFilters($filtersConfig);

$uri = 'admin/foo/bar';
$expected = [
'before' => [
'foo',
'bar',
'empty string not exclude' => [
'admin/foo/bar',
// The URI path '' means the baseURL.
'',
[
'before' => [
'foo',
'bar',
],
'after' => ['baz'],
],
],
'empty string exclude' => [
// The URI path '' means the baseURL.
'',
// So this setting excludes `foo` filter only to the baseURL.
'',
[
'before' => [
'bar',
],
'after' => ['baz'],
],
],
'slash not exclude' => [
'admin/foo/bar',
'/',
[
'before' => [
'foo',
'bar',
],
'after' => ['baz'],
],
],
'slash exclude' => [
// The URI path '' means the baseURL.
'',
'/',
[
'before' => [
'bar',
],
'after' => ['baz'],
],
],
'after' => ['baz'],
];
$this->assertSame($expected, $filters->initialize($uri)->getFilters());
}

public function testAfterExceptString(): void
Expand Down
6 changes: 6 additions & 0 deletions user_guide_src/source/changelogs/v4.3.8.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,12 @@ Deprecations
Bugs Fixed
**********

- **Controller Filters:** In previous versions, ``['except' => []]`` or ``['except' => '']``
meant "except all". The bug has been fixed, and now

- ``['except' => []]`` means to exclude nothing.
- ``['except' => '']`` means to exclude the baseURL only.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
for a complete list of bugs fixed.
, '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: filter except empty#7823

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 10 commits into

from

Aug 21, 2023
 Merged


fix: filter except empty
#7823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
bc1f279

test: add test for except empty array


kenjis Aug 15, 2023
e7297f1

fix: "except empty" means "except all"


kenjis Aug 15, 2023
fc3ae4c

test: fix test case


kenjis Aug 15, 2023
b6a3c7d

refactor: extract method


kenjis Aug 15, 2023
459ea26

docs: add/fix PHPDoc types


kenjis Aug 16, 2023
f9ecd03

test: use dataProvider


kenjis Aug 16, 2023
2ad0864

test: add test cases for except


kenjis Aug 16, 2023
79aaefb

fix: empty string should mean except only baseURL


kenjis Aug 16, 2023
9b93434

docs: add/update PHPDoc types


kenjis Aug 16, 2023
e510da9

docs: add changelog


kenjis Aug 16, 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


49 changes: 44 additions & 5 deletions
system/Filters/Filters.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,9 @@ public function setResponse(ResponseInterface $response)
 * Runs through all of the filters for the specified
 * uri and position.
 *
 * @return mixed|RequestInterface|ResponseInterface
 * @param string $uri URI path relative to baseURL
 *
 * @return RequestInterface|ResponseInterface|string|null
 *
 * @throws FilterException
 */
Expand DownExpand Up@@ -221,6 +223,8 @@ public function run(string $uri, string $position = 'before')
 * run through both a before and after and don't want to double
 * process the rows.
 *
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return Filters
 */
 public function initialize(?string $uri = null)
Expand DownExpand Up@@ -391,7 +395,7 @@ public function getArguments(?string $key = null)
 /**
 * Add any applicable (not excluded) global filter settings to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand All@@ -416,7 +420,7 @@ protected function processGlobals(?string $uri = null)
 if (isset($rules['except'])) {
 // grab the exclusion rules
 $check = $rules['except'];
 if ($this->pathApplies($uri, $check)) {
 if ($this->checkExcept($uri, $check)) {
 $keep = false;
 }
 }
Expand DownExpand Up@@ -454,7 +458,7 @@ protected function processMethods()
 /**
 * Add any applicable configured filters to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand DownExpand Up@@ -536,12 +540,47 @@ private function pathApplies(string $uri, $paths)
 $paths = [$paths];
 }

 // treat each paths as pseudo-regex
 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check except paths
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array|string $paths The except path patterns
 *
 * @return bool True if the URI matches except paths.
 */
 private function checkExcept(string $uri, $paths): bool
 {
 // empty array does not match anything
 if ($paths === []) {
 return false;
 }

 // make sure the paths are iterable
 if (is_string($paths)) {
 $paths = [$paths];
 }

 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check the URI path as pseudo-regex
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array $paths The except path patterns
 */
 private function checkPseudoRegex(string $uri, array $paths): bool
 {
 // treat each path as pseudo-regex
 foreach ($paths as $path) {
 // need to escape path separators
 $path = str_replace('/', '\/', trim($path, '/ '));
 // need to make pseudo wildcard real
 $path = strtolower(str_replace('*', '.*', $path));

 // Does this rule apply here?
 if (preg_match('#^' . $path . '$#', $uri, $match) === 1) {
 return true;
Expand Down

128 changes: 92 additions & 36 deletions
tests/system/Filters/FiltersTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -215,15 +215,23 @@ public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
 ['admin/*'],
 ],
 [
 [],
 ['admin/*', 'foo/*'],
 ],
 [
 ['*'],
 ],
 [
 'admin/*',
 ],
 ];
 }

 /**
 * @dataProvider provideProcessMethodProcessGlobalsWithExcept
 *
 * @param array|string $except
 */
 public function testProcessMethodProcessGlobalsWithExcept(array $except): void
 public function testProcessMethodProcessGlobalsWithExcept($except): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand DownExpand Up@@ -572,7 +580,12 @@ public function testOtherResult(): void
 $this->assertSame('This is curious', $response);
 }

 public function testBeforeExceptString(): void
 /**
 * @dataProvider provideBeforeExcept
 *
 * @param array|string $except
 */
 public function testBeforeExcept(string $uri, $except, array $expected): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand All@@ -584,7 +597,7 @@ public function testBeforeExceptString(): void
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'admin/*'],
 'foo' => ['except' => $except],
 'bar',
 ],
 'after' => [
Expand All@@ -595,48 +608,91 @@ public function testBeforeExceptString(): void
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testBeforeExceptInapplicable(): void
 public static function provideBeforeExcept(): iterable
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

 $config = [
 'aliases' => [
 'foo' => '',
 'bar' => '',
 'baz' => '',
 return [
 'string exclude' => [
 'admin/foo/bar',
 'admin/*',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'george/*'],
 'bar',
 'string not exclude' => [
 'admin/foo/bar',
 'george/*',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 'after' => [
 'baz',
 ],
 'empty array not exclude' => [
 'admin/foo/bar',
 [],
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 ];
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'foo',
 'bar',
 'empty string not exclude' => [
 'admin/foo/bar',
 // The URI path '' means the baseURL.
 '',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'empty string exclude' => [
 // The URI path '' means the baseURL.
 '',
 // So this setting excludes `foo` filter only to the baseURL.
 '',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash not exclude' => [
 'admin/foo/bar',
 '/',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash exclude' => [
 // The URI path '' means the baseURL.
 '',
 '/',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testAfterExceptString(): void
Expand Down

6 changes: 6 additions & 0 deletions
user_guide_src/source/changelogs/v4.3.8.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,12 @@ Deprecations
Bugs Fixed
**********

- **Controller Filters:** In previous versions, ``['except' => []]`` or ``['except' => '']``
 meant "except all". The bug has been fixed, and now

 - ``['except' => []]`` means to exclude nothing.
 - ``['except' => '']`` means to exclude the baseURL only.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
for a complete list of bugs fixed.

, '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: filter except empty#7823

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 10 commits into

from

Aug 21, 2023
 Merged


fix: filter except empty
#7823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
bc1f279

test: add test for except empty array


kenjis Aug 15, 2023
e7297f1

fix: "except empty" means "except all"


kenjis Aug 15, 2023
fc3ae4c

test: fix test case


kenjis Aug 15, 2023
b6a3c7d

refactor: extract method


kenjis Aug 15, 2023
459ea26

docs: add/fix PHPDoc types


kenjis Aug 16, 2023
f9ecd03

test: use dataProvider


kenjis Aug 16, 2023
2ad0864

test: add test cases for except


kenjis Aug 16, 2023
79aaefb

fix: empty string should mean except only baseURL


kenjis Aug 16, 2023
9b93434

docs: add/update PHPDoc types


kenjis Aug 16, 2023
e510da9

docs: add changelog


kenjis Aug 16, 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


49 changes: 44 additions & 5 deletions
system/Filters/Filters.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,9 @@ public function setResponse(ResponseInterface $response)
 * Runs through all of the filters for the specified
 * uri and position.
 *
 * @return mixed|RequestInterface|ResponseInterface
 * @param string $uri URI path relative to baseURL
 *
 * @return RequestInterface|ResponseInterface|string|null
 *
 * @throws FilterException
 */
Expand DownExpand Up@@ -221,6 +223,8 @@ public function run(string $uri, string $position = 'before')
 * run through both a before and after and don't want to double
 * process the rows.
 *
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return Filters
 */
 public function initialize(?string $uri = null)
Expand DownExpand Up@@ -391,7 +395,7 @@ public function getArguments(?string $key = null)
 /**
 * Add any applicable (not excluded) global filter settings to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand All@@ -416,7 +420,7 @@ protected function processGlobals(?string $uri = null)
 if (isset($rules['except'])) {
 // grab the exclusion rules
 $check = $rules['except'];
 if ($this->pathApplies($uri, $check)) {
 if ($this->checkExcept($uri, $check)) {
 $keep = false;
 }
 }
Expand DownExpand Up@@ -454,7 +458,7 @@ protected function processMethods()
 /**
 * Add any applicable configured filters to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand DownExpand Up@@ -536,12 +540,47 @@ private function pathApplies(string $uri, $paths)
 $paths = [$paths];
 }

 // treat each paths as pseudo-regex
 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check except paths
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array|string $paths The except path patterns
 *
 * @return bool True if the URI matches except paths.
 */
 private function checkExcept(string $uri, $paths): bool
 {
 // empty array does not match anything
 if ($paths === []) {
 return false;
 }

 // make sure the paths are iterable
 if (is_string($paths)) {
 $paths = [$paths];
 }

 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check the URI path as pseudo-regex
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array $paths The except path patterns
 */
 private function checkPseudoRegex(string $uri, array $paths): bool
 {
 // treat each path as pseudo-regex
 foreach ($paths as $path) {
 // need to escape path separators
 $path = str_replace('/', '\/', trim($path, '/ '));
 // need to make pseudo wildcard real
 $path = strtolower(str_replace('*', '.*', $path));

 // Does this rule apply here?
 if (preg_match('#^' . $path . '$#', $uri, $match) === 1) {
 return true;
Expand Down

128 changes: 92 additions & 36 deletions
tests/system/Filters/FiltersTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -215,15 +215,23 @@ public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
 ['admin/*'],
 ],
 [
 [],
 ['admin/*', 'foo/*'],
 ],
 [
 ['*'],
 ],
 [
 'admin/*',
 ],
 ];
 }

 /**
 * @dataProvider provideProcessMethodProcessGlobalsWithExcept
 *
 * @param array|string $except
 */
 public function testProcessMethodProcessGlobalsWithExcept(array $except): void
 public function testProcessMethodProcessGlobalsWithExcept($except): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand DownExpand Up@@ -572,7 +580,12 @@ public function testOtherResult(): void
 $this->assertSame('This is curious', $response);
 }

 public function testBeforeExceptString(): void
 /**
 * @dataProvider provideBeforeExcept
 *
 * @param array|string $except
 */
 public function testBeforeExcept(string $uri, $except, array $expected): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand All@@ -584,7 +597,7 @@ public function testBeforeExceptString(): void
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'admin/*'],
 'foo' => ['except' => $except],
 'bar',
 ],
 'after' => [
Expand All@@ -595,48 +608,91 @@ public function testBeforeExceptString(): void
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testBeforeExceptInapplicable(): void
 public static function provideBeforeExcept(): iterable
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

 $config = [
 'aliases' => [
 'foo' => '',
 'bar' => '',
 'baz' => '',
 return [
 'string exclude' => [
 'admin/foo/bar',
 'admin/*',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'george/*'],
 'bar',
 'string not exclude' => [
 'admin/foo/bar',
 'george/*',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 'after' => [
 'baz',
 ],
 'empty array not exclude' => [
 'admin/foo/bar',
 [],
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 ];
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'foo',
 'bar',
 'empty string not exclude' => [
 'admin/foo/bar',
 // The URI path '' means the baseURL.
 '',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'empty string exclude' => [
 // The URI path '' means the baseURL.
 '',
 // So this setting excludes `foo` filter only to the baseURL.
 '',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash not exclude' => [
 'admin/foo/bar',
 '/',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash exclude' => [
 // The URI path '' means the baseURL.
 '',
 '/',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testAfterExceptString(): void
Expand Down

6 changes: 6 additions & 0 deletions
user_guide_src/source/changelogs/v4.3.8.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,12 @@ Deprecations
Bugs Fixed
**********

- **Controller Filters:** In previous versions, ``['except' => []]`` or ``['except' => '']``
 meant "except all". The bug has been fixed, and now

 - ``['except' => []]`` means to exclude nothing.
 - ``['except' => '']`` means to exclude the baseURL only.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
for a complete list of bugs fixed.

, '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: filter except empty#7823

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 10 commits into

from

Aug 21, 2023
 Merged


fix: filter except empty
#7823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
bc1f279

test: add test for except empty array


kenjis Aug 15, 2023
e7297f1

fix: "except empty" means "except all"


kenjis Aug 15, 2023
fc3ae4c

test: fix test case


kenjis Aug 15, 2023
b6a3c7d

refactor: extract method


kenjis Aug 15, 2023
459ea26

docs: add/fix PHPDoc types


kenjis Aug 16, 2023
f9ecd03

test: use dataProvider


kenjis Aug 16, 2023
2ad0864

test: add test cases for except


kenjis Aug 16, 2023
79aaefb

fix: empty string should mean except only baseURL


kenjis Aug 16, 2023
9b93434

docs: add/update PHPDoc types


kenjis Aug 16, 2023
e510da9

docs: add changelog


kenjis Aug 16, 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


49 changes: 44 additions & 5 deletions
system/Filters/Filters.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,9 @@ public function setResponse(ResponseInterface $response)
 * Runs through all of the filters for the specified
 * uri and position.
 *
 * @return mixed|RequestInterface|ResponseInterface
 * @param string $uri URI path relative to baseURL
 *
 * @return RequestInterface|ResponseInterface|string|null
 *
 * @throws FilterException
 */
Expand DownExpand Up@@ -221,6 +223,8 @@ public function run(string $uri, string $position = 'before')
 * run through both a before and after and don't want to double
 * process the rows.
 *
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return Filters
 */
 public function initialize(?string $uri = null)
Expand DownExpand Up@@ -391,7 +395,7 @@ public function getArguments(?string $key = null)
 /**
 * Add any applicable (not excluded) global filter settings to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand All@@ -416,7 +420,7 @@ protected function processGlobals(?string $uri = null)
 if (isset($rules['except'])) {
 // grab the exclusion rules
 $check = $rules['except'];
 if ($this->pathApplies($uri, $check)) {
 if ($this->checkExcept($uri, $check)) {
 $keep = false;
 }
 }
Expand DownExpand Up@@ -454,7 +458,7 @@ protected function processMethods()
 /**
 * Add any applicable configured filters to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand DownExpand Up@@ -536,12 +540,47 @@ private function pathApplies(string $uri, $paths)
 $paths = [$paths];
 }

 // treat each paths as pseudo-regex
 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check except paths
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array|string $paths The except path patterns
 *
 * @return bool True if the URI matches except paths.
 */
 private function checkExcept(string $uri, $paths): bool
 {
 // empty array does not match anything
 if ($paths === []) {
 return false;
 }

 // make sure the paths are iterable
 if (is_string($paths)) {
 $paths = [$paths];
 }

 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check the URI path as pseudo-regex
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array $paths The except path patterns
 */
 private function checkPseudoRegex(string $uri, array $paths): bool
 {
 // treat each path as pseudo-regex
 foreach ($paths as $path) {
 // need to escape path separators
 $path = str_replace('/', '\/', trim($path, '/ '));
 // need to make pseudo wildcard real
 $path = strtolower(str_replace('*', '.*', $path));

 // Does this rule apply here?
 if (preg_match('#^' . $path . '$#', $uri, $match) === 1) {
 return true;
Expand Down

128 changes: 92 additions & 36 deletions
tests/system/Filters/FiltersTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -215,15 +215,23 @@ public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
 ['admin/*'],
 ],
 [
 [],
 ['admin/*', 'foo/*'],
 ],
 [
 ['*'],
 ],
 [
 'admin/*',
 ],
 ];
 }

 /**
 * @dataProvider provideProcessMethodProcessGlobalsWithExcept
 *
 * @param array|string $except
 */
 public function testProcessMethodProcessGlobalsWithExcept(array $except): void
 public function testProcessMethodProcessGlobalsWithExcept($except): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand DownExpand Up@@ -572,7 +580,12 @@ public function testOtherResult(): void
 $this->assertSame('This is curious', $response);
 }

 public function testBeforeExceptString(): void
 /**
 * @dataProvider provideBeforeExcept
 *
 * @param array|string $except
 */
 public function testBeforeExcept(string $uri, $except, array $expected): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand All@@ -584,7 +597,7 @@ public function testBeforeExceptString(): void
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'admin/*'],
 'foo' => ['except' => $except],
 'bar',
 ],
 'after' => [
Expand All@@ -595,48 +608,91 @@ public function testBeforeExceptString(): void
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testBeforeExceptInapplicable(): void
 public static function provideBeforeExcept(): iterable
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

 $config = [
 'aliases' => [
 'foo' => '',
 'bar' => '',
 'baz' => '',
 return [
 'string exclude' => [
 'admin/foo/bar',
 'admin/*',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'george/*'],
 'bar',
 'string not exclude' => [
 'admin/foo/bar',
 'george/*',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 'after' => [
 'baz',
 ],
 'empty array not exclude' => [
 'admin/foo/bar',
 [],
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 ];
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'foo',
 'bar',
 'empty string not exclude' => [
 'admin/foo/bar',
 // The URI path '' means the baseURL.
 '',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'empty string exclude' => [
 // The URI path '' means the baseURL.
 '',
 // So this setting excludes `foo` filter only to the baseURL.
 '',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash not exclude' => [
 'admin/foo/bar',
 '/',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash exclude' => [
 // The URI path '' means the baseURL.
 '',
 '/',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testAfterExceptString(): void
Expand Down

6 changes: 6 additions & 0 deletions
user_guide_src/source/changelogs/v4.3.8.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,12 @@ Deprecations
Bugs Fixed
**********

- **Controller Filters:** In previous versions, ``['except' => []]`` or ``['except' => '']``
 meant "except all". The bug has been fixed, and now

 - ``['except' => []]`` means to exclude nothing.
 - ``['except' => '']`` means to exclude the baseURL only.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
for a complete list of bugs fixed.

, '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: filter except empty#7823

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 10 commits into

from

Aug 21, 2023
 Merged


fix: filter except empty
#7823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
bc1f279

test: add test for except empty array


kenjis Aug 15, 2023
e7297f1

fix: "except empty" means "except all"


kenjis Aug 15, 2023
fc3ae4c

test: fix test case


kenjis Aug 15, 2023
b6a3c7d

refactor: extract method


kenjis Aug 15, 2023
459ea26

docs: add/fix PHPDoc types


kenjis Aug 16, 2023
f9ecd03

test: use dataProvider


kenjis Aug 16, 2023
2ad0864

test: add test cases for except


kenjis Aug 16, 2023
79aaefb

fix: empty string should mean except only baseURL


kenjis Aug 16, 2023
9b93434

docs: add/update PHPDoc types


kenjis Aug 16, 2023
e510da9

docs: add changelog


kenjis Aug 16, 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


49 changes: 44 additions & 5 deletions
system/Filters/Filters.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,9 @@ public function setResponse(ResponseInterface $response)
 * Runs through all of the filters for the specified
 * uri and position.
 *
 * @return mixed|RequestInterface|ResponseInterface
 * @param string $uri URI path relative to baseURL
 *
 * @return RequestInterface|ResponseInterface|string|null
 *
 * @throws FilterException
 */
Expand DownExpand Up@@ -221,6 +223,8 @@ public function run(string $uri, string $position = 'before')
 * run through both a before and after and don't want to double
 * process the rows.
 *
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return Filters
 */
 public function initialize(?string $uri = null)
Expand DownExpand Up@@ -391,7 +395,7 @@ public function getArguments(?string $key = null)
 /**
 * Add any applicable (not excluded) global filter settings to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand All@@ -416,7 +420,7 @@ protected function processGlobals(?string $uri = null)
 if (isset($rules['except'])) {
 // grab the exclusion rules
 $check = $rules['except'];
 if ($this->pathApplies($uri, $check)) {
 if ($this->checkExcept($uri, $check)) {
 $keep = false;
 }
 }
Expand DownExpand Up@@ -454,7 +458,7 @@ protected function processMethods()
 /**
 * Add any applicable configured filters to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand DownExpand Up@@ -536,12 +540,47 @@ private function pathApplies(string $uri, $paths)
 $paths = [$paths];
 }

 // treat each paths as pseudo-regex
 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check except paths
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array|string $paths The except path patterns
 *
 * @return bool True if the URI matches except paths.
 */
 private function checkExcept(string $uri, $paths): bool
 {
 // empty array does not match anything
 if ($paths === []) {
 return false;
 }

 // make sure the paths are iterable
 if (is_string($paths)) {
 $paths = [$paths];
 }

 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check the URI path as pseudo-regex
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array $paths The except path patterns
 */
 private function checkPseudoRegex(string $uri, array $paths): bool
 {
 // treat each path as pseudo-regex
 foreach ($paths as $path) {
 // need to escape path separators
 $path = str_replace('/', '\/', trim($path, '/ '));
 // need to make pseudo wildcard real
 $path = strtolower(str_replace('*', '.*', $path));

 // Does this rule apply here?
 if (preg_match('#^' . $path . '$#', $uri, $match) === 1) {
 return true;
Expand Down

128 changes: 92 additions & 36 deletions
tests/system/Filters/FiltersTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -215,15 +215,23 @@ public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
 ['admin/*'],
 ],
 [
 [],
 ['admin/*', 'foo/*'],
 ],
 [
 ['*'],
 ],
 [
 'admin/*',
 ],
 ];
 }

 /**
 * @dataProvider provideProcessMethodProcessGlobalsWithExcept
 *
 * @param array|string $except
 */
 public function testProcessMethodProcessGlobalsWithExcept(array $except): void
 public function testProcessMethodProcessGlobalsWithExcept($except): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand DownExpand Up@@ -572,7 +580,12 @@ public function testOtherResult(): void
 $this->assertSame('This is curious', $response);
 }

 public function testBeforeExceptString(): void
 /**
 * @dataProvider provideBeforeExcept
 *
 * @param array|string $except
 */
 public function testBeforeExcept(string $uri, $except, array $expected): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand All@@ -584,7 +597,7 @@ public function testBeforeExceptString(): void
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'admin/*'],
 'foo' => ['except' => $except],
 'bar',
 ],
 'after' => [
Expand All@@ -595,48 +608,91 @@ public function testBeforeExceptString(): void
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testBeforeExceptInapplicable(): void
 public static function provideBeforeExcept(): iterable
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

 $config = [
 'aliases' => [
 'foo' => '',
 'bar' => '',
 'baz' => '',
 return [
 'string exclude' => [
 'admin/foo/bar',
 'admin/*',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'george/*'],
 'bar',
 'string not exclude' => [
 'admin/foo/bar',
 'george/*',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 'after' => [
 'baz',
 ],
 'empty array not exclude' => [
 'admin/foo/bar',
 [],
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 ];
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'foo',
 'bar',
 'empty string not exclude' => [
 'admin/foo/bar',
 // The URI path '' means the baseURL.
 '',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'empty string exclude' => [
 // The URI path '' means the baseURL.
 '',
 // So this setting excludes `foo` filter only to the baseURL.
 '',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash not exclude' => [
 'admin/foo/bar',
 '/',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash exclude' => [
 // The URI path '' means the baseURL.
 '',
 '/',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testAfterExceptString(): void
Expand Down

6 changes: 6 additions & 0 deletions
user_guide_src/source/changelogs/v4.3.8.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,12 @@ Deprecations
Bugs Fixed
**********

- **Controller Filters:** In previous versions, ``['except' => []]`` or ``['except' => '']``
 meant "except all". The bug has been fixed, and now

 - ``['except' => []]`` means to exclude nothing.
 - ``['except' => '']`` means to exclude the baseURL only.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
for a complete list of bugs fixed.

, '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: filter except empty#7823

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 10 commits into

from

Aug 21, 2023
 Merged


fix: filter except empty
#7823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
bc1f279

test: add test for except empty array


kenjis Aug 15, 2023
e7297f1

fix: "except empty" means "except all"


kenjis Aug 15, 2023
fc3ae4c

test: fix test case


kenjis Aug 15, 2023
b6a3c7d

refactor: extract method


kenjis Aug 15, 2023
459ea26

docs: add/fix PHPDoc types


kenjis Aug 16, 2023
f9ecd03

test: use dataProvider


kenjis Aug 16, 2023
2ad0864

test: add test cases for except


kenjis Aug 16, 2023
79aaefb

fix: empty string should mean except only baseURL


kenjis Aug 16, 2023
9b93434

docs: add/update PHPDoc types


kenjis Aug 16, 2023
e510da9

docs: add changelog


kenjis Aug 16, 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


49 changes: 44 additions & 5 deletions
system/Filters/Filters.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,9 @@ public function setResponse(ResponseInterface $response)
 * Runs through all of the filters for the specified
 * uri and position.
 *
 * @return mixed|RequestInterface|ResponseInterface
 * @param string $uri URI path relative to baseURL
 *
 * @return RequestInterface|ResponseInterface|string|null
 *
 * @throws FilterException
 */
Expand DownExpand Up@@ -221,6 +223,8 @@ public function run(string $uri, string $position = 'before')
 * run through both a before and after and don't want to double
 * process the rows.
 *
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return Filters
 */
 public function initialize(?string $uri = null)
Expand DownExpand Up@@ -391,7 +395,7 @@ public function getArguments(?string $key = null)
 /**
 * Add any applicable (not excluded) global filter settings to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand All@@ -416,7 +420,7 @@ protected function processGlobals(?string $uri = null)
 if (isset($rules['except'])) {
 // grab the exclusion rules
 $check = $rules['except'];
 if ($this->pathApplies($uri, $check)) {
 if ($this->checkExcept($uri, $check)) {
 $keep = false;
 }
 }
Expand DownExpand Up@@ -454,7 +458,7 @@ protected function processMethods()
 /**
 * Add any applicable configured filters to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand DownExpand Up@@ -536,12 +540,47 @@ private function pathApplies(string $uri, $paths)
 $paths = [$paths];
 }

 // treat each paths as pseudo-regex
 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check except paths
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array|string $paths The except path patterns
 *
 * @return bool True if the URI matches except paths.
 */
 private function checkExcept(string $uri, $paths): bool
 {
 // empty array does not match anything
 if ($paths === []) {
 return false;
 }

 // make sure the paths are iterable
 if (is_string($paths)) {
 $paths = [$paths];
 }

 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check the URI path as pseudo-regex
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array $paths The except path patterns
 */
 private function checkPseudoRegex(string $uri, array $paths): bool
 {
 // treat each path as pseudo-regex
 foreach ($paths as $path) {
 // need to escape path separators
 $path = str_replace('/', '\/', trim($path, '/ '));
 // need to make pseudo wildcard real
 $path = strtolower(str_replace('*', '.*', $path));

 // Does this rule apply here?
 if (preg_match('#^' . $path . '$#', $uri, $match) === 1) {
 return true;
Expand Down

128 changes: 92 additions & 36 deletions
tests/system/Filters/FiltersTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -215,15 +215,23 @@ public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
 ['admin/*'],
 ],
 [
 [],
 ['admin/*', 'foo/*'],
 ],
 [
 ['*'],
 ],
 [
 'admin/*',
 ],
 ];
 }

 /**
 * @dataProvider provideProcessMethodProcessGlobalsWithExcept
 *
 * @param array|string $except
 */
 public function testProcessMethodProcessGlobalsWithExcept(array $except): void
 public function testProcessMethodProcessGlobalsWithExcept($except): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand DownExpand Up@@ -572,7 +580,12 @@ public function testOtherResult(): void
 $this->assertSame('This is curious', $response);
 }

 public function testBeforeExceptString(): void
 /**
 * @dataProvider provideBeforeExcept
 *
 * @param array|string $except
 */
 public function testBeforeExcept(string $uri, $except, array $expected): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand All@@ -584,7 +597,7 @@ public function testBeforeExceptString(): void
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'admin/*'],
 'foo' => ['except' => $except],
 'bar',
 ],
 'after' => [
Expand All@@ -595,48 +608,91 @@ public function testBeforeExceptString(): void
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testBeforeExceptInapplicable(): void
 public static function provideBeforeExcept(): iterable
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

 $config = [
 'aliases' => [
 'foo' => '',
 'bar' => '',
 'baz' => '',
 return [
 'string exclude' => [
 'admin/foo/bar',
 'admin/*',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'george/*'],
 'bar',
 'string not exclude' => [
 'admin/foo/bar',
 'george/*',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 'after' => [
 'baz',
 ],
 'empty array not exclude' => [
 'admin/foo/bar',
 [],
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 ];
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'foo',
 'bar',
 'empty string not exclude' => [
 'admin/foo/bar',
 // The URI path '' means the baseURL.
 '',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'empty string exclude' => [
 // The URI path '' means the baseURL.
 '',
 // So this setting excludes `foo` filter only to the baseURL.
 '',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash not exclude' => [
 'admin/foo/bar',
 '/',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash exclude' => [
 // The URI path '' means the baseURL.
 '',
 '/',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testAfterExceptString(): void
Expand Down

6 changes: 6 additions & 0 deletions
user_guide_src/source/changelogs/v4.3.8.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,12 @@ Deprecations
Bugs Fixed
**********

- **Controller Filters:** In previous versions, ``['except' => []]`` or ``['except' => '']``
 meant "except all". The bug has been fixed, and now

 - ``['except' => []]`` means to exclude nothing.
 - ``['except' => '']`` means to exclude the baseURL only.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
for a complete list of bugs fixed.

, '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: filter except empty#7823

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 10 commits into

from

Aug 21, 2023
 Merged


fix: filter except empty
#7823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
bc1f279

test: add test for except empty array


kenjis Aug 15, 2023
e7297f1

fix: "except empty" means "except all"


kenjis Aug 15, 2023
fc3ae4c

test: fix test case


kenjis Aug 15, 2023
b6a3c7d

refactor: extract method


kenjis Aug 15, 2023
459ea26

docs: add/fix PHPDoc types


kenjis Aug 16, 2023
f9ecd03

test: use dataProvider


kenjis Aug 16, 2023
2ad0864

test: add test cases for except


kenjis Aug 16, 2023
79aaefb

fix: empty string should mean except only baseURL


kenjis Aug 16, 2023
9b93434

docs: add/update PHPDoc types


kenjis Aug 16, 2023
e510da9

docs: add changelog


kenjis Aug 16, 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


49 changes: 44 additions & 5 deletions
system/Filters/Filters.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,9 @@ public function setResponse(ResponseInterface $response)
 * Runs through all of the filters for the specified
 * uri and position.
 *
 * @return mixed|RequestInterface|ResponseInterface
 * @param string $uri URI path relative to baseURL
 *
 * @return RequestInterface|ResponseInterface|string|null
 *
 * @throws FilterException
 */
Expand DownExpand Up@@ -221,6 +223,8 @@ public function run(string $uri, string $position = 'before')
 * run through both a before and after and don't want to double
 * process the rows.
 *
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return Filters
 */
 public function initialize(?string $uri = null)
Expand DownExpand Up@@ -391,7 +395,7 @@ public function getArguments(?string $key = null)
 /**
 * Add any applicable (not excluded) global filter settings to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand All@@ -416,7 +420,7 @@ protected function processGlobals(?string $uri = null)
 if (isset($rules['except'])) {
 // grab the exclusion rules
 $check = $rules['except'];
 if ($this->pathApplies($uri, $check)) {
 if ($this->checkExcept($uri, $check)) {
 $keep = false;
 }
 }
Expand DownExpand Up@@ -454,7 +458,7 @@ protected function processMethods()
 /**
 * Add any applicable configured filters to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand DownExpand Up@@ -536,12 +540,47 @@ private function pathApplies(string $uri, $paths)
 $paths = [$paths];
 }

 // treat each paths as pseudo-regex
 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check except paths
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array|string $paths The except path patterns
 *
 * @return bool True if the URI matches except paths.
 */
 private function checkExcept(string $uri, $paths): bool
 {
 // empty array does not match anything
 if ($paths === []) {
 return false;
 }

 // make sure the paths are iterable
 if (is_string($paths)) {
 $paths = [$paths];
 }

 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check the URI path as pseudo-regex
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array $paths The except path patterns
 */
 private function checkPseudoRegex(string $uri, array $paths): bool
 {
 // treat each path as pseudo-regex
 foreach ($paths as $path) {
 // need to escape path separators
 $path = str_replace('/', '\/', trim($path, '/ '));
 // need to make pseudo wildcard real
 $path = strtolower(str_replace('*', '.*', $path));

 // Does this rule apply here?
 if (preg_match('#^' . $path . '$#', $uri, $match) === 1) {
 return true;
Expand Down

128 changes: 92 additions & 36 deletions
tests/system/Filters/FiltersTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -215,15 +215,23 @@ public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
 ['admin/*'],
 ],
 [
 [],
 ['admin/*', 'foo/*'],
 ],
 [
 ['*'],
 ],
 [
 'admin/*',
 ],
 ];
 }

 /**
 * @dataProvider provideProcessMethodProcessGlobalsWithExcept
 *
 * @param array|string $except
 */
 public function testProcessMethodProcessGlobalsWithExcept(array $except): void
 public function testProcessMethodProcessGlobalsWithExcept($except): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand DownExpand Up@@ -572,7 +580,12 @@ public function testOtherResult(): void
 $this->assertSame('This is curious', $response);
 }

 public function testBeforeExceptString(): void
 /**
 * @dataProvider provideBeforeExcept
 *
 * @param array|string $except
 */
 public function testBeforeExcept(string $uri, $except, array $expected): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand All@@ -584,7 +597,7 @@ public function testBeforeExceptString(): void
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'admin/*'],
 'foo' => ['except' => $except],
 'bar',
 ],
 'after' => [
Expand All@@ -595,48 +608,91 @@ public function testBeforeExceptString(): void
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testBeforeExceptInapplicable(): void
 public static function provideBeforeExcept(): iterable
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

 $config = [
 'aliases' => [
 'foo' => '',
 'bar' => '',
 'baz' => '',
 return [
 'string exclude' => [
 'admin/foo/bar',
 'admin/*',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'george/*'],
 'bar',
 'string not exclude' => [
 'admin/foo/bar',
 'george/*',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 'after' => [
 'baz',
 ],
 'empty array not exclude' => [
 'admin/foo/bar',
 [],
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 ];
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'foo',
 'bar',
 'empty string not exclude' => [
 'admin/foo/bar',
 // The URI path '' means the baseURL.
 '',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'empty string exclude' => [
 // The URI path '' means the baseURL.
 '',
 // So this setting excludes `foo` filter only to the baseURL.
 '',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash not exclude' => [
 'admin/foo/bar',
 '/',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash exclude' => [
 // The URI path '' means the baseURL.
 '',
 '/',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testAfterExceptString(): void
Expand Down

6 changes: 6 additions & 0 deletions
user_guide_src/source/changelogs/v4.3.8.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,12 @@ Deprecations
Bugs Fixed
**********

- **Controller Filters:** In previous versions, ``['except' => []]`` or ``['except' => '']``
 meant "except all". The bug has been fixed, and now

 - ``['except' => []]`` means to exclude nothing.
 - ``['except' => '']`` means to exclude the baseURL only.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
for a complete list of bugs fixed.

, '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: filter except empty#7823

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 10 commits into

from

Aug 21, 2023
 Merged


fix: filter except empty
#7823
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
bc1f279

test: add test for except empty array


kenjis Aug 15, 2023
e7297f1

fix: "except empty" means "except all"


kenjis Aug 15, 2023
fc3ae4c

test: fix test case


kenjis Aug 15, 2023
b6a3c7d

refactor: extract method


kenjis Aug 15, 2023
459ea26

docs: add/fix PHPDoc types


kenjis Aug 16, 2023
f9ecd03

test: use dataProvider


kenjis Aug 16, 2023
2ad0864

test: add test cases for except


kenjis Aug 16, 2023
79aaefb

fix: empty string should mean except only baseURL


kenjis Aug 16, 2023
9b93434

docs: add/update PHPDoc types


kenjis Aug 16, 2023
e510da9

docs: add changelog


kenjis Aug 16, 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


49 changes: 44 additions & 5 deletions
system/Filters/Filters.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,7 +156,9 @@ public function setResponse(ResponseInterface $response)
 * Runs through all of the filters for the specified
 * uri and position.
 *
 * @return mixed|RequestInterface|ResponseInterface
 * @param string $uri URI path relative to baseURL
 *
 * @return RequestInterface|ResponseInterface|string|null
 *
 * @throws FilterException
 */
Expand DownExpand Up@@ -221,6 +223,8 @@ public function run(string $uri, string $position = 'before')
 * run through both a before and after and don't want to double
 * process the rows.
 *
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return Filters
 */
 public function initialize(?string $uri = null)
Expand DownExpand Up@@ -391,7 +395,7 @@ public function getArguments(?string $key = null)
 /**
 * Add any applicable (not excluded) global filter settings to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand All@@ -416,7 +420,7 @@ protected function processGlobals(?string $uri = null)
 if (isset($rules['except'])) {
 // grab the exclusion rules
 $check = $rules['except'];
 if ($this->pathApplies($uri, $check)) {
 if ($this->checkExcept($uri, $check)) {
 $keep = false;
 }
 }
Expand DownExpand Up@@ -454,7 +458,7 @@ protected function processMethods()
 /**
 * Add any applicable configured filters to the mix.
 *
 * @param string $uri
 * @param string|null $uri URI path relative to baseURL (all lowercase)
 *
 * @return void
 */
Expand DownExpand Up@@ -536,12 +540,47 @@ private function pathApplies(string $uri, $paths)
 $paths = [$paths];
 }

 // treat each paths as pseudo-regex
 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check except paths
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array|string $paths The except path patterns
 *
 * @return bool True if the URI matches except paths.
 */
 private function checkExcept(string $uri, $paths): bool
 {
 // empty array does not match anything
 if ($paths === []) {
 return false;
 }

 // make sure the paths are iterable
 if (is_string($paths)) {
 $paths = [$paths];
 }

 return $this->checkPseudoRegex($uri, $paths);
 }

 /**
 * Check the URI path as pseudo-regex
 *
 * @param string $uri URI path relative to baseURL (all lowercase)
 * @param array $paths The except path patterns
 */
 private function checkPseudoRegex(string $uri, array $paths): bool
 {
 // treat each path as pseudo-regex
 foreach ($paths as $path) {
 // need to escape path separators
 $path = str_replace('/', '\/', trim($path, '/ '));
 // need to make pseudo wildcard real
 $path = strtolower(str_replace('*', '.*', $path));

 // Does this rule apply here?
 if (preg_match('#^' . $path . '$#', $uri, $match) === 1) {
 return true;
Expand Down

128 changes: 92 additions & 36 deletions
tests/system/Filters/FiltersTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -215,15 +215,23 @@ public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
 ['admin/*'],
 ],
 [
 [],
 ['admin/*', 'foo/*'],
 ],
 [
 ['*'],
 ],
 [
 'admin/*',
 ],
 ];
 }

 /**
 * @dataProvider provideProcessMethodProcessGlobalsWithExcept
 *
 * @param array|string $except
 */
 public function testProcessMethodProcessGlobalsWithExcept(array $except): void
 public function testProcessMethodProcessGlobalsWithExcept($except): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand DownExpand Up@@ -572,7 +580,12 @@ public function testOtherResult(): void
 $this->assertSame('This is curious', $response);
 }

 public function testBeforeExceptString(): void
 /**
 * @dataProvider provideBeforeExcept
 *
 * @param array|string $except
 */
 public function testBeforeExcept(string $uri, $except, array $expected): void
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

Expand All@@ -584,7 +597,7 @@ public function testBeforeExceptString(): void
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'admin/*'],
 'foo' => ['except' => $except],
 'bar',
 ],
 'after' => [
Expand All@@ -595,48 +608,91 @@ public function testBeforeExceptString(): void
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testBeforeExceptInapplicable(): void
 public static function provideBeforeExcept(): iterable
 {
 $_SERVER['REQUEST_METHOD'] = 'GET';

 $config = [
 'aliases' => [
 'foo' => '',
 'bar' => '',
 'baz' => '',
 return [
 'string exclude' => [
 'admin/foo/bar',
 'admin/*',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'globals' => [
 'before' => [
 'foo' => ['except' => 'george/*'],
 'bar',
 'string not exclude' => [
 'admin/foo/bar',
 'george/*',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 'after' => [
 'baz',
 ],
 'empty array not exclude' => [
 'admin/foo/bar',
 [],
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 ];
 $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
 $filters = $this->createFilters($filtersConfig);

 $uri = 'admin/foo/bar';
 $expected = [
 'before' => [
 'foo',
 'bar',
 'empty string not exclude' => [
 'admin/foo/bar',
 // The URI path '' means the baseURL.
 '',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'empty string exclude' => [
 // The URI path '' means the baseURL.
 '',
 // So this setting excludes `foo` filter only to the baseURL.
 '',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash not exclude' => [
 'admin/foo/bar',
 '/',
 [
 'before' => [
 'foo',
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'slash exclude' => [
 // The URI path '' means the baseURL.
 '',
 '/',
 [
 'before' => [
 'bar',
 ],
 'after' => ['baz'],
 ],
 ],
 'after' => ['baz'],
 ];
 $this->assertSame($expected, $filters->initialize($uri)->getFilters());
 }

 public function testAfterExceptString(): void
Expand Down

6 changes: 6 additions & 0 deletions
user_guide_src/source/changelogs/v4.3.8.rst

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,12 @@ Deprecations
Bugs Fixed
**********

- **Controller Filters:** In previous versions, ``['except' => []]`` or ``['except' => '']``
 meant "except all". The bug has been fixed, and now

 - ``['except' => []]`` means to exclude nothing.
 - ``['except' => '']`` means to exclude the baseURL only.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
for a complete list of bugs fixed.