fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true#7422

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
Jul 3, 2023
Merged

fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true #7422

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
2bb2cd3
refactor: rename parameter name
kenjis Apr 12, 2023
e7cf718
refactor: add property $segments
kenjis Apr 12, 2023
0070c4a
feat: add properties for positions in the URI segments
kenjis Apr 12, 2023
e49cf11
fix: add check for underscores in URI when $translateURIDashes is true
kenjis Apr 12, 2023
cde3889
test: add tests
kenjis Apr 12, 2023
9be93dd
test: add tests for getPos()
kenjis Apr 12, 2023
fb0d8d6
docs: add changelog and note
kenjis Jun 2, 2023
989ef70
docs: add upgrade guide
kenjis Jun 2, 2023
78b450c
test: add new param for getRoute()
kenjis Jun 14, 2023
c7b9da2
docs: remove @phpstan-ignore-line
kenjis Jun 14, 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
132 changes: 114 additions & 18 deletions system/Router/AutoRouterImproved.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,29 @@ final class AutoRouterImproved implements AutoRouterInterface
*/
private string $defaultMethod;

/**
* The URI segments.
*/
private array $segments = [];

/**
* The position of the Controller in the URI segments.
* Null for the default controller.
*/
private ?int $controllerPos = null;

/**
* The position of the Method in the URI segments.
* Null for the default method.
*/
private ?int $methodPos = null;

/**
* The position of the first Parameter in the URI segments.
* Null for the no parameters.
*/
private ?int $paramPos = null;

/**
* @param class-string[] $protectedControllers
* @param string $defaultController Short classname
Expand DownExpand Up@@ -108,17 +131,21 @@ private function createSegments(string $uri)
* If there is a controller corresponding to the first segment, the search
* ends there. The remaining segments are parameters to the controller.
*
* @param array $segments URI segments
*
* @return bool true if a controller class is found.
*/
private function searchFirstController(array $segments): bool
private function searchFirstController(): bool
{
$segments = $this->segments;

$controller = '\\' . $this->namespace;

$controllerPos = -1;

while ($segments !== []) {
$segment = array_shift($segments);
$class = $this->translateURIDashes(ucfirst($segment));
$controllerPos++;

$class = $this->translateURIDashes(ucfirst($segment));

// as soon as we encounter any segment that is not PSR-4 compliant, stop searching
if (! $this->isValidSegment($class)) {
Expand All@@ -128,9 +155,14 @@ private function searchFirstController(array $segments): bool
$controller .= '\\' . $class;

if (class_exists($controller)) {
$this->controller = $controller;
$this->controller = $controller;
$this->controllerPos = $controllerPos;

// The first item may be a method name.
$this->params = $segments;
if ($segments !== []) {
$this->paramPos = $this->controllerPos + 1;
}

return true;
}
Expand All@@ -142,15 +174,21 @@ private function searchFirstController(array $segments): bool
/**
* Search for the last default controller corresponding to the URI segments.
*
* @param array $segments URI segments
*
* @return bool true if a controller class is found.
*/
private function searchLastDefaultController(array $segments): bool
private function searchLastDefaultController(): bool
{
$params = [];
$segments = $this->segments;

$segmentCount = count($this->segments);
$paramPos = null;
$params = [];

while ($segments !== []) {
if ($segmentCount > count($segments)) {
$paramPos = count($segments);
}

$namespaces = array_map(
fn ($segment) => $this->translateURIDashes(ucfirst($segment)),
$segments
Expand All@@ -164,6 +202,10 @@ private function searchLastDefaultController(array $segments): bool
$this->controller = $controller;
$this->params = $params;

if ($params !== []) {
$this->paramPos = $paramPos;
}

return true;
}

Expand All@@ -179,6 +221,10 @@ private function searchLastDefaultController(array $segments): bool
$this->controller = $controller;
$this->params = $params;

if ($params !== []) {
$this->paramPos = 0;
}

return true;
}

Expand All@@ -195,19 +241,19 @@ public function getRoute(string $uri, string $httpVerb): array
$defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
$this->method = $defaultMethod;

$segments = $this->createSegments($uri);
$this->segments = $this->createSegments($uri);

// Check for Module Routes.
if (
$segments !== []
$this->segments !== []
&& ($routingConfig = config(Routing::class))
&& array_key_exists($segments[0], $routingConfig->moduleRoutes)
&& array_key_exists($this->segments[0], $routingConfig->moduleRoutes)
) {
$uriSegment = array_shift($segments);
$uriSegment = array_shift($this->segments);
$this->namespace = rtrim($routingConfig->moduleRoutes[$uriSegment], '\\');
}

if ($this->searchFirstController($segments)) {
if ($this->searchFirstController()) {
// Controller is found.
$baseControllerName = class_basename($this->controller);

Expand All@@ -219,14 +265,15 @@ public function getRoute(string $uri, string $httpVerb): array
'Cannot access the default controller "' . $this->controller . '" with the controller name URI path.'
);
}
} elseif ($this->searchLastDefaultController($segments)) {
} elseif ($this->searchLastDefaultController()) {
// The default Controller is found.
$baseControllerName = class_basename($this->controller);
} else {
// No Controller is found.
throw new PageNotFoundException('No controller is found for: ' . $uri);
}

// The first item may be a method name.
$params = $this->params;

$methodParam = array_shift($params);
Expand All@@ -241,6 +288,15 @@ public function getRoute(string $uri, string $httpVerb): array
$this->method = $method;
$this->params = $params;

// Update the positions.
$this->methodPos = $this->paramPos;
if ($params === []) {
$this->paramPos = null;
}
if ($this->paramPos !== null) {
$this->paramPos++;
}

// Prevent access to default controller's method
if (strtolower($baseControllerName) === strtolower($this->defaultController)) {
throw new PageNotFoundException(
Expand DownExpand Up@@ -268,6 +324,10 @@ public function getRoute(string $uri, string $httpVerb): array
// Ensure the controller does not have _remap() method.
$this->checkRemap();

// Ensure the URI segments for the controller and method do not contain
// underscores when $translateURIDashes is true.
$this->checkUnderscore($uri);

// Check parameter count
try {
$this->checkParameters($uri);
Expand All@@ -280,6 +340,20 @@ public function getRoute(string $uri, string $httpVerb): array
return [$this->directory, $this->controller, $this->method, $this->params];
}

/**
* @internal For test purpose only.
*
* @return array<string, int|null>
*/
public function getPos(): array
{
return [
'controller' => $this->controllerPos,
'method' => $this->methodPos,
'params' => $this->paramPos,
];
}

/**
* Get the directory path from the controller and set it to the property.
*
Expand DownExpand Up@@ -363,6 +437,28 @@ private function checkRemap(): void
}
}

private function checkUnderscore(string $uri): void
{
if ($this->translateURIDashes === false) {
return;
}

$paramPos = $this->paramPos ?? count($this->segments);

for ($i = 0; $i < $paramPos; $i++) {
if (strpos($this->segments[$i], '_') !== false) {
throw new PageNotFoundException(
'AutoRouterImproved prohibits access to the URI'
. ' containing underscores ("' . $this->segments[$i] . '")'
. ' when $translateURIDashes is enabled.'
. ' Please use the dash.'
. ' Handler:' . $this->controller . '::' . $this->method
. ', URI:' . $uri
);
}
}
}

/**
* Returns true if the supplied $segment string represents a valid PSR-4 compliant namespace/directory segment
*
Expand All@@ -373,10 +469,10 @@ private function isValidSegment(string $segment): bool
return (bool) preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $segment);
}

private function translateURIDashes(string $classname): string
private function translateURIDashes(string $segment): string
{
return $this->translateURIDashes
? str_replace('-', '_', $classname)
: $classname;
? str_replace('-', '_', $segment)
: $segment;
}
}
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
fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true#7422

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

Jul 3, 2023
 Merged


fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true
#7422
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
2bb2cd3

refactor: rename parameter name


kenjis Apr 12, 2023
e7cf718

refactor: add property $segments


kenjis Apr 12, 2023
0070c4a

feat: add properties for positions in the URI segments


kenjis Apr 12, 2023
e49cf11

fix: add check for underscores in URI when $translateURIDashes is true


kenjis Apr 12, 2023
cde3889

test: add tests


kenjis Apr 12, 2023
9be93dd

test: add tests for getPos()


kenjis Apr 12, 2023
fb0d8d6

docs: add changelog and note


kenjis Jun 2, 2023
989ef70

docs: add upgrade guide


kenjis Jun 2, 2023
78b450c

test: add new param for getRoute()


kenjis Jun 14, 2023
c7b9da2

docs: remove @phpstan-ignore-line


kenjis Jun 14, 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


132 changes: 114 additions & 18 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,29 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private string $defaultMethod;

 /**
 * The URI segments.
 */
 private array $segments = [];

 /**
 * The position of the Controller in the URI segments.
 * Null for the default controller.
 */
 private ?int $controllerPos = null;

 /**
 * The position of the Method in the URI segments.
 * Null for the default method.
 */
 private ?int $methodPos = null;

 /**
 * The position of the first Parameter in the URI segments.
 * Null for the no parameters.
 */
 private ?int $paramPos = null;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
Expand DownExpand Up@@ -108,17 +131,21 @@ private function createSegments(string $uri)
 * If there is a controller corresponding to the first segment, the search
 * ends there. The remaining segments are parameters to the controller.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchFirstController(array $segments): bool
 private function searchFirstController(): bool
 {
 $segments = $this->segments;

 $controller = '\\' . $this->namespace;

 $controllerPos = -1;

 while ($segments !== []) {
 $segment = array_shift($segments);
 $class = $this->translateURIDashes(ucfirst($segment));
 $controllerPos++;

 $class = $this->translateURIDashes(ucfirst($segment));

 // as soon as we encounter any segment that is not PSR-4 compliant, stop searching
 if (! $this->isValidSegment($class)) {
Expand All@@ -128,9 +155,14 @@ private function searchFirstController(array $segments): bool
 $controller .= '\\' . $class;

 if (class_exists($controller)) {
 $this->controller = $controller;
 $this->controller = $controller;
 $this->controllerPos = $controllerPos;

 // The first item may be a method name.
 $this->params = $segments;
 if ($segments !== []) {
 $this->paramPos = $this->controllerPos + 1;
 }

 return true;
 }
Expand All@@ -142,15 +174,21 @@ private function searchFirstController(array $segments): bool
 /**
 * Search for the last default controller corresponding to the URI segments.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchLastDefaultController(array $segments): bool
 private function searchLastDefaultController(): bool
 {
 $params = [];
 $segments = $this->segments;

 $segmentCount = count($this->segments);
 $paramPos = null;
 $params = [];

 while ($segments !== []) {
 if ($segmentCount > count($segments)) {
 $paramPos = count($segments);
 }

 $namespaces = array_map(
 fn ($segment) => $this->translateURIDashes(ucfirst($segment)),
 $segments
Expand All@@ -164,6 +202,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = $paramPos;
 }

 return true;
 }

Expand All@@ -179,6 +221,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = 0;
 }

 return true;
 }

Expand All@@ -195,19 +241,19 @@ public function getRoute(string $uri, string $httpVerb): array
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = $this->createSegments($uri);
 $this->segments = $this->createSegments($uri);

 // Check for Module Routes.
 if (
 $segments !== []
 $this->segments !== []
 && ($routingConfig = config(Routing::class))
 && array_key_exists($segments[0], $routingConfig->moduleRoutes)
 && array_key_exists($this->segments[0], $routingConfig->moduleRoutes)
 ) {
 $uriSegment = array_shift($segments);
 $uriSegment = array_shift($this->segments);
 $this->namespace = rtrim($routingConfig->moduleRoutes[$uriSegment], '\\');
 }

 if ($this->searchFirstController($segments)) {
 if ($this->searchFirstController()) {
 // Controller is found.
 $baseControllerName = class_basename($this->controller);

Expand All@@ -219,14 +265,15 @@ public function getRoute(string $uri, string $httpVerb): array
 'Cannot access the default controller "' . $this->controller . '" with the controller name URI path.'
 );
 }
 } elseif ($this->searchLastDefaultController($segments)) {
 } elseif ($this->searchLastDefaultController()) {
 // The default Controller is found.
 $baseControllerName = class_basename($this->controller);
 } else {
 // No Controller is found.
 throw new PageNotFoundException('No controller is found for: ' . $uri);
 }

 // The first item may be a method name.
 $params = $this->params;

 $methodParam = array_shift($params);
Expand All@@ -241,6 +288,15 @@ public function getRoute(string $uri, string $httpVerb): array
 $this->method = $method;
 $this->params = $params;

 // Update the positions.
 $this->methodPos = $this->paramPos;
 if ($params === []) {
 $this->paramPos = null;
 }
 if ($this->paramPos !== null) {
 $this->paramPos++;
 }

 // Prevent access to default controller's method
 if (strtolower($baseControllerName) === strtolower($this->defaultController)) {
 throw new PageNotFoundException(
Expand DownExpand Up@@ -268,6 +324,10 @@ public function getRoute(string $uri, string $httpVerb): array
 // Ensure the controller does not have _remap() method.
 $this->checkRemap();

 // Ensure the URI segments for the controller and method do not contain
 // underscores when $translateURIDashes is true.
 $this->checkUnderscore($uri);

 // Check parameter count
 try {
 $this->checkParameters($uri);
Expand All@@ -280,6 +340,20 @@ public function getRoute(string $uri, string $httpVerb): array
 return [$this->directory, $this->controller, $this->method, $this->params];
 }

 /**
 * @internal For test purpose only.
 *
 * @return array<string, int|null>
 */
 public function getPos(): array
 {
 return [
 'controller' => $this->controllerPos,
 'method' => $this->methodPos,
 'params' => $this->paramPos,
 ];
 }

 /**
 * Get the directory path from the controller and set it to the property.
 *
Expand DownExpand Up@@ -363,6 +437,28 @@ private function checkRemap(): void
 }
 }

 private function checkUnderscore(string $uri): void
 {
 if ($this->translateURIDashes === false) {
 return;
 }

 $paramPos = $this->paramPos ?? count($this->segments);

 for ($i = 0; $i < $paramPos; $i++) {
 if (strpos($this->segments[$i], '_') !== false) {
 throw new PageNotFoundException(
 'AutoRouterImproved prohibits access to the URI'
 . ' containing underscores ("' . $this->segments[$i] . '")'
 . ' when $translateURIDashes is enabled.'
 . ' Please use the dash.'
 . ' Handler:' . $this->controller . '::' . $this->method
 . ', URI:' . $uri
 );
 }
 }
 }

 /**
 * Returns true if the supplied $segment string represents a valid PSR-4 compliant namespace/directory segment
 *
Expand All@@ -373,10 +469,10 @@ private function isValidSegment(string $segment): bool
 return (bool) preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $segment);
 }

 private function translateURIDashes(string $classname): string
 private function translateURIDashes(string $segment): string
 {
 return $this->translateURIDashes
 ? str_replace('-', '_', $classname)
 : $classname;
 ? str_replace('-', '_', $segment)
 : $segment;
 }
}
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
fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true#7422

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

Jul 3, 2023
 Merged


fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true
#7422
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
2bb2cd3

refactor: rename parameter name


kenjis Apr 12, 2023
e7cf718

refactor: add property $segments


kenjis Apr 12, 2023
0070c4a

feat: add properties for positions in the URI segments


kenjis Apr 12, 2023
e49cf11

fix: add check for underscores in URI when $translateURIDashes is true


kenjis Apr 12, 2023
cde3889

test: add tests


kenjis Apr 12, 2023
9be93dd

test: add tests for getPos()


kenjis Apr 12, 2023
fb0d8d6

docs: add changelog and note


kenjis Jun 2, 2023
989ef70

docs: add upgrade guide


kenjis Jun 2, 2023
78b450c

test: add new param for getRoute()


kenjis Jun 14, 2023
c7b9da2

docs: remove @phpstan-ignore-line


kenjis Jun 14, 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


132 changes: 114 additions & 18 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,29 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private string $defaultMethod;

 /**
 * The URI segments.
 */
 private array $segments = [];

 /**
 * The position of the Controller in the URI segments.
 * Null for the default controller.
 */
 private ?int $controllerPos = null;

 /**
 * The position of the Method in the URI segments.
 * Null for the default method.
 */
 private ?int $methodPos = null;

 /**
 * The position of the first Parameter in the URI segments.
 * Null for the no parameters.
 */
 private ?int $paramPos = null;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
Expand DownExpand Up@@ -108,17 +131,21 @@ private function createSegments(string $uri)
 * If there is a controller corresponding to the first segment, the search
 * ends there. The remaining segments are parameters to the controller.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchFirstController(array $segments): bool
 private function searchFirstController(): bool
 {
 $segments = $this->segments;

 $controller = '\\' . $this->namespace;

 $controllerPos = -1;

 while ($segments !== []) {
 $segment = array_shift($segments);
 $class = $this->translateURIDashes(ucfirst($segment));
 $controllerPos++;

 $class = $this->translateURIDashes(ucfirst($segment));

 // as soon as we encounter any segment that is not PSR-4 compliant, stop searching
 if (! $this->isValidSegment($class)) {
Expand All@@ -128,9 +155,14 @@ private function searchFirstController(array $segments): bool
 $controller .= '\\' . $class;

 if (class_exists($controller)) {
 $this->controller = $controller;
 $this->controller = $controller;
 $this->controllerPos = $controllerPos;

 // The first item may be a method name.
 $this->params = $segments;
 if ($segments !== []) {
 $this->paramPos = $this->controllerPos + 1;
 }

 return true;
 }
Expand All@@ -142,15 +174,21 @@ private function searchFirstController(array $segments): bool
 /**
 * Search for the last default controller corresponding to the URI segments.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchLastDefaultController(array $segments): bool
 private function searchLastDefaultController(): bool
 {
 $params = [];
 $segments = $this->segments;

 $segmentCount = count($this->segments);
 $paramPos = null;
 $params = [];

 while ($segments !== []) {
 if ($segmentCount > count($segments)) {
 $paramPos = count($segments);
 }

 $namespaces = array_map(
 fn ($segment) => $this->translateURIDashes(ucfirst($segment)),
 $segments
Expand All@@ -164,6 +202,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = $paramPos;
 }

 return true;
 }

Expand All@@ -179,6 +221,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = 0;
 }

 return true;
 }

Expand All@@ -195,19 +241,19 @@ public function getRoute(string $uri, string $httpVerb): array
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = $this->createSegments($uri);
 $this->segments = $this->createSegments($uri);

 // Check for Module Routes.
 if (
 $segments !== []
 $this->segments !== []
 && ($routingConfig = config(Routing::class))
 && array_key_exists($segments[0], $routingConfig->moduleRoutes)
 && array_key_exists($this->segments[0], $routingConfig->moduleRoutes)
 ) {
 $uriSegment = array_shift($segments);
 $uriSegment = array_shift($this->segments);
 $this->namespace = rtrim($routingConfig->moduleRoutes[$uriSegment], '\\');
 }

 if ($this->searchFirstController($segments)) {
 if ($this->searchFirstController()) {
 // Controller is found.
 $baseControllerName = class_basename($this->controller);

Expand All@@ -219,14 +265,15 @@ public function getRoute(string $uri, string $httpVerb): array
 'Cannot access the default controller "' . $this->controller . '" with the controller name URI path.'
 );
 }
 } elseif ($this->searchLastDefaultController($segments)) {
 } elseif ($this->searchLastDefaultController()) {
 // The default Controller is found.
 $baseControllerName = class_basename($this->controller);
 } else {
 // No Controller is found.
 throw new PageNotFoundException('No controller is found for: ' . $uri);
 }

 // The first item may be a method name.
 $params = $this->params;

 $methodParam = array_shift($params);
Expand All@@ -241,6 +288,15 @@ public function getRoute(string $uri, string $httpVerb): array
 $this->method = $method;
 $this->params = $params;

 // Update the positions.
 $this->methodPos = $this->paramPos;
 if ($params === []) {
 $this->paramPos = null;
 }
 if ($this->paramPos !== null) {
 $this->paramPos++;
 }

 // Prevent access to default controller's method
 if (strtolower($baseControllerName) === strtolower($this->defaultController)) {
 throw new PageNotFoundException(
Expand DownExpand Up@@ -268,6 +324,10 @@ public function getRoute(string $uri, string $httpVerb): array
 // Ensure the controller does not have _remap() method.
 $this->checkRemap();

 // Ensure the URI segments for the controller and method do not contain
 // underscores when $translateURIDashes is true.
 $this->checkUnderscore($uri);

 // Check parameter count
 try {
 $this->checkParameters($uri);
Expand All@@ -280,6 +340,20 @@ public function getRoute(string $uri, string $httpVerb): array
 return [$this->directory, $this->controller, $this->method, $this->params];
 }

 /**
 * @internal For test purpose only.
 *
 * @return array<string, int|null>
 */
 public function getPos(): array
 {
 return [
 'controller' => $this->controllerPos,
 'method' => $this->methodPos,
 'params' => $this->paramPos,
 ];
 }

 /**
 * Get the directory path from the controller and set it to the property.
 *
Expand DownExpand Up@@ -363,6 +437,28 @@ private function checkRemap(): void
 }
 }

 private function checkUnderscore(string $uri): void
 {
 if ($this->translateURIDashes === false) {
 return;
 }

 $paramPos = $this->paramPos ?? count($this->segments);

 for ($i = 0; $i < $paramPos; $i++) {
 if (strpos($this->segments[$i], '_') !== false) {
 throw new PageNotFoundException(
 'AutoRouterImproved prohibits access to the URI'
 . ' containing underscores ("' . $this->segments[$i] . '")'
 . ' when $translateURIDashes is enabled.'
 . ' Please use the dash.'
 . ' Handler:' . $this->controller . '::' . $this->method
 . ', URI:' . $uri
 );
 }
 }
 }

 /**
 * Returns true if the supplied $segment string represents a valid PSR-4 compliant namespace/directory segment
 *
Expand All@@ -373,10 +469,10 @@ private function isValidSegment(string $segment): bool
 return (bool) preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $segment);
 }

 private function translateURIDashes(string $classname): string
 private function translateURIDashes(string $segment): string
 {
 return $this->translateURIDashes
 ? str_replace('-', '_', $classname)
 : $classname;
 ? str_replace('-', '_', $segment)
 : $segment;
 }
}
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
fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true#7422

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

Jul 3, 2023
 Merged


fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true
#7422
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
2bb2cd3

refactor: rename parameter name


kenjis Apr 12, 2023
e7cf718

refactor: add property $segments


kenjis Apr 12, 2023
0070c4a

feat: add properties for positions in the URI segments


kenjis Apr 12, 2023
e49cf11

fix: add check for underscores in URI when $translateURIDashes is true


kenjis Apr 12, 2023
cde3889

test: add tests


kenjis Apr 12, 2023
9be93dd

test: add tests for getPos()


kenjis Apr 12, 2023
fb0d8d6

docs: add changelog and note


kenjis Jun 2, 2023
989ef70

docs: add upgrade guide


kenjis Jun 2, 2023
78b450c

test: add new param for getRoute()


kenjis Jun 14, 2023
c7b9da2

docs: remove @phpstan-ignore-line


kenjis Jun 14, 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


132 changes: 114 additions & 18 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,29 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private string $defaultMethod;

 /**
 * The URI segments.
 */
 private array $segments = [];

 /**
 * The position of the Controller in the URI segments.
 * Null for the default controller.
 */
 private ?int $controllerPos = null;

 /**
 * The position of the Method in the URI segments.
 * Null for the default method.
 */
 private ?int $methodPos = null;

 /**
 * The position of the first Parameter in the URI segments.
 * Null for the no parameters.
 */
 private ?int $paramPos = null;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
Expand DownExpand Up@@ -108,17 +131,21 @@ private function createSegments(string $uri)
 * If there is a controller corresponding to the first segment, the search
 * ends there. The remaining segments are parameters to the controller.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchFirstController(array $segments): bool
 private function searchFirstController(): bool
 {
 $segments = $this->segments;

 $controller = '\\' . $this->namespace;

 $controllerPos = -1;

 while ($segments !== []) {
 $segment = array_shift($segments);
 $class = $this->translateURIDashes(ucfirst($segment));
 $controllerPos++;

 $class = $this->translateURIDashes(ucfirst($segment));

 // as soon as we encounter any segment that is not PSR-4 compliant, stop searching
 if (! $this->isValidSegment($class)) {
Expand All@@ -128,9 +155,14 @@ private function searchFirstController(array $segments): bool
 $controller .= '\\' . $class;

 if (class_exists($controller)) {
 $this->controller = $controller;
 $this->controller = $controller;
 $this->controllerPos = $controllerPos;

 // The first item may be a method name.
 $this->params = $segments;
 if ($segments !== []) {
 $this->paramPos = $this->controllerPos + 1;
 }

 return true;
 }
Expand All@@ -142,15 +174,21 @@ private function searchFirstController(array $segments): bool
 /**
 * Search for the last default controller corresponding to the URI segments.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchLastDefaultController(array $segments): bool
 private function searchLastDefaultController(): bool
 {
 $params = [];
 $segments = $this->segments;

 $segmentCount = count($this->segments);
 $paramPos = null;
 $params = [];

 while ($segments !== []) {
 if ($segmentCount > count($segments)) {
 $paramPos = count($segments);
 }

 $namespaces = array_map(
 fn ($segment) => $this->translateURIDashes(ucfirst($segment)),
 $segments
Expand All@@ -164,6 +202,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = $paramPos;
 }

 return true;
 }

Expand All@@ -179,6 +221,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = 0;
 }

 return true;
 }

Expand All@@ -195,19 +241,19 @@ public function getRoute(string $uri, string $httpVerb): array
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = $this->createSegments($uri);
 $this->segments = $this->createSegments($uri);

 // Check for Module Routes.
 if (
 $segments !== []
 $this->segments !== []
 && ($routingConfig = config(Routing::class))
 && array_key_exists($segments[0], $routingConfig->moduleRoutes)
 && array_key_exists($this->segments[0], $routingConfig->moduleRoutes)
 ) {
 $uriSegment = array_shift($segments);
 $uriSegment = array_shift($this->segments);
 $this->namespace = rtrim($routingConfig->moduleRoutes[$uriSegment], '\\');
 }

 if ($this->searchFirstController($segments)) {
 if ($this->searchFirstController()) {
 // Controller is found.
 $baseControllerName = class_basename($this->controller);

Expand All@@ -219,14 +265,15 @@ public function getRoute(string $uri, string $httpVerb): array
 'Cannot access the default controller "' . $this->controller . '" with the controller name URI path.'
 );
 }
 } elseif ($this->searchLastDefaultController($segments)) {
 } elseif ($this->searchLastDefaultController()) {
 // The default Controller is found.
 $baseControllerName = class_basename($this->controller);
 } else {
 // No Controller is found.
 throw new PageNotFoundException('No controller is found for: ' . $uri);
 }

 // The first item may be a method name.
 $params = $this->params;

 $methodParam = array_shift($params);
Expand All@@ -241,6 +288,15 @@ public function getRoute(string $uri, string $httpVerb): array
 $this->method = $method;
 $this->params = $params;

 // Update the positions.
 $this->methodPos = $this->paramPos;
 if ($params === []) {
 $this->paramPos = null;
 }
 if ($this->paramPos !== null) {
 $this->paramPos++;
 }

 // Prevent access to default controller's method
 if (strtolower($baseControllerName) === strtolower($this->defaultController)) {
 throw new PageNotFoundException(
Expand DownExpand Up@@ -268,6 +324,10 @@ public function getRoute(string $uri, string $httpVerb): array
 // Ensure the controller does not have _remap() method.
 $this->checkRemap();

 // Ensure the URI segments for the controller and method do not contain
 // underscores when $translateURIDashes is true.
 $this->checkUnderscore($uri);

 // Check parameter count
 try {
 $this->checkParameters($uri);
Expand All@@ -280,6 +340,20 @@ public function getRoute(string $uri, string $httpVerb): array
 return [$this->directory, $this->controller, $this->method, $this->params];
 }

 /**
 * @internal For test purpose only.
 *
 * @return array<string, int|null>
 */
 public function getPos(): array
 {
 return [
 'controller' => $this->controllerPos,
 'method' => $this->methodPos,
 'params' => $this->paramPos,
 ];
 }

 /**
 * Get the directory path from the controller and set it to the property.
 *
Expand DownExpand Up@@ -363,6 +437,28 @@ private function checkRemap(): void
 }
 }

 private function checkUnderscore(string $uri): void
 {
 if ($this->translateURIDashes === false) {
 return;
 }

 $paramPos = $this->paramPos ?? count($this->segments);

 for ($i = 0; $i < $paramPos; $i++) {
 if (strpos($this->segments[$i], '_') !== false) {
 throw new PageNotFoundException(
 'AutoRouterImproved prohibits access to the URI'
 . ' containing underscores ("' . $this->segments[$i] . '")'
 . ' when $translateURIDashes is enabled.'
 . ' Please use the dash.'
 . ' Handler:' . $this->controller . '::' . $this->method
 . ', URI:' . $uri
 );
 }
 }
 }

 /**
 * Returns true if the supplied $segment string represents a valid PSR-4 compliant namespace/directory segment
 *
Expand All@@ -373,10 +469,10 @@ private function isValidSegment(string $segment): bool
 return (bool) preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $segment);
 }

 private function translateURIDashes(string $classname): string
 private function translateURIDashes(string $segment): string
 {
 return $this->translateURIDashes
 ? str_replace('-', '_', $classname)
 : $classname;
 ? str_replace('-', '_', $segment)
 : $segment;
 }
}
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
fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true#7422

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

Jul 3, 2023
 Merged


fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true
#7422
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
2bb2cd3

refactor: rename parameter name


kenjis Apr 12, 2023
e7cf718

refactor: add property $segments


kenjis Apr 12, 2023
0070c4a

feat: add properties for positions in the URI segments


kenjis Apr 12, 2023
e49cf11

fix: add check for underscores in URI when $translateURIDashes is true


kenjis Apr 12, 2023
cde3889

test: add tests


kenjis Apr 12, 2023
9be93dd

test: add tests for getPos()


kenjis Apr 12, 2023
fb0d8d6

docs: add changelog and note


kenjis Jun 2, 2023
989ef70

docs: add upgrade guide


kenjis Jun 2, 2023
78b450c

test: add new param for getRoute()


kenjis Jun 14, 2023
c7b9da2

docs: remove @phpstan-ignore-line


kenjis Jun 14, 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


132 changes: 114 additions & 18 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,29 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private string $defaultMethod;

 /**
 * The URI segments.
 */
 private array $segments = [];

 /**
 * The position of the Controller in the URI segments.
 * Null for the default controller.
 */
 private ?int $controllerPos = null;

 /**
 * The position of the Method in the URI segments.
 * Null for the default method.
 */
 private ?int $methodPos = null;

 /**
 * The position of the first Parameter in the URI segments.
 * Null for the no parameters.
 */
 private ?int $paramPos = null;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
Expand DownExpand Up@@ -108,17 +131,21 @@ private function createSegments(string $uri)
 * If there is a controller corresponding to the first segment, the search
 * ends there. The remaining segments are parameters to the controller.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchFirstController(array $segments): bool
 private function searchFirstController(): bool
 {
 $segments = $this->segments;

 $controller = '\\' . $this->namespace;

 $controllerPos = -1;

 while ($segments !== []) {
 $segment = array_shift($segments);
 $class = $this->translateURIDashes(ucfirst($segment));
 $controllerPos++;

 $class = $this->translateURIDashes(ucfirst($segment));

 // as soon as we encounter any segment that is not PSR-4 compliant, stop searching
 if (! $this->isValidSegment($class)) {
Expand All@@ -128,9 +155,14 @@ private function searchFirstController(array $segments): bool
 $controller .= '\\' . $class;

 if (class_exists($controller)) {
 $this->controller = $controller;
 $this->controller = $controller;
 $this->controllerPos = $controllerPos;

 // The first item may be a method name.
 $this->params = $segments;
 if ($segments !== []) {
 $this->paramPos = $this->controllerPos + 1;
 }

 return true;
 }
Expand All@@ -142,15 +174,21 @@ private function searchFirstController(array $segments): bool
 /**
 * Search for the last default controller corresponding to the URI segments.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchLastDefaultController(array $segments): bool
 private function searchLastDefaultController(): bool
 {
 $params = [];
 $segments = $this->segments;

 $segmentCount = count($this->segments);
 $paramPos = null;
 $params = [];

 while ($segments !== []) {
 if ($segmentCount > count($segments)) {
 $paramPos = count($segments);
 }

 $namespaces = array_map(
 fn ($segment) => $this->translateURIDashes(ucfirst($segment)),
 $segments
Expand All@@ -164,6 +202,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = $paramPos;
 }

 return true;
 }

Expand All@@ -179,6 +221,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = 0;
 }

 return true;
 }

Expand All@@ -195,19 +241,19 @@ public function getRoute(string $uri, string $httpVerb): array
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = $this->createSegments($uri);
 $this->segments = $this->createSegments($uri);

 // Check for Module Routes.
 if (
 $segments !== []
 $this->segments !== []
 && ($routingConfig = config(Routing::class))
 && array_key_exists($segments[0], $routingConfig->moduleRoutes)
 && array_key_exists($this->segments[0], $routingConfig->moduleRoutes)
 ) {
 $uriSegment = array_shift($segments);
 $uriSegment = array_shift($this->segments);
 $this->namespace = rtrim($routingConfig->moduleRoutes[$uriSegment], '\\');
 }

 if ($this->searchFirstController($segments)) {
 if ($this->searchFirstController()) {
 // Controller is found.
 $baseControllerName = class_basename($this->controller);

Expand All@@ -219,14 +265,15 @@ public function getRoute(string $uri, string $httpVerb): array
 'Cannot access the default controller "' . $this->controller . '" with the controller name URI path.'
 );
 }
 } elseif ($this->searchLastDefaultController($segments)) {
 } elseif ($this->searchLastDefaultController()) {
 // The default Controller is found.
 $baseControllerName = class_basename($this->controller);
 } else {
 // No Controller is found.
 throw new PageNotFoundException('No controller is found for: ' . $uri);
 }

 // The first item may be a method name.
 $params = $this->params;

 $methodParam = array_shift($params);
Expand All@@ -241,6 +288,15 @@ public function getRoute(string $uri, string $httpVerb): array
 $this->method = $method;
 $this->params = $params;

 // Update the positions.
 $this->methodPos = $this->paramPos;
 if ($params === []) {
 $this->paramPos = null;
 }
 if ($this->paramPos !== null) {
 $this->paramPos++;
 }

 // Prevent access to default controller's method
 if (strtolower($baseControllerName) === strtolower($this->defaultController)) {
 throw new PageNotFoundException(
Expand DownExpand Up@@ -268,6 +324,10 @@ public function getRoute(string $uri, string $httpVerb): array
 // Ensure the controller does not have _remap() method.
 $this->checkRemap();

 // Ensure the URI segments for the controller and method do not contain
 // underscores when $translateURIDashes is true.
 $this->checkUnderscore($uri);

 // Check parameter count
 try {
 $this->checkParameters($uri);
Expand All@@ -280,6 +340,20 @@ public function getRoute(string $uri, string $httpVerb): array
 return [$this->directory, $this->controller, $this->method, $this->params];
 }

 /**
 * @internal For test purpose only.
 *
 * @return array<string, int|null>
 */
 public function getPos(): array
 {
 return [
 'controller' => $this->controllerPos,
 'method' => $this->methodPos,
 'params' => $this->paramPos,
 ];
 }

 /**
 * Get the directory path from the controller and set it to the property.
 *
Expand DownExpand Up@@ -363,6 +437,28 @@ private function checkRemap(): void
 }
 }

 private function checkUnderscore(string $uri): void
 {
 if ($this->translateURIDashes === false) {
 return;
 }

 $paramPos = $this->paramPos ?? count($this->segments);

 for ($i = 0; $i < $paramPos; $i++) {
 if (strpos($this->segments[$i], '_') !== false) {
 throw new PageNotFoundException(
 'AutoRouterImproved prohibits access to the URI'
 . ' containing underscores ("' . $this->segments[$i] . '")'
 . ' when $translateURIDashes is enabled.'
 . ' Please use the dash.'
 . ' Handler:' . $this->controller . '::' . $this->method
 . ', URI:' . $uri
 );
 }
 }
 }

 /**
 * Returns true if the supplied $segment string represents a valid PSR-4 compliant namespace/directory segment
 *
Expand All@@ -373,10 +469,10 @@ private function isValidSegment(string $segment): bool
 return (bool) preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $segment);
 }

 private function translateURIDashes(string $classname): string
 private function translateURIDashes(string $segment): string
 {
 return $this->translateURIDashes
 ? str_replace('-', '_', $classname)
 : $classname;
 ? str_replace('-', '_', $segment)
 : $segment;
 }
}
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
fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true#7422

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

Jul 3, 2023
 Merged


fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true
#7422
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
2bb2cd3

refactor: rename parameter name


kenjis Apr 12, 2023
e7cf718

refactor: add property $segments


kenjis Apr 12, 2023
0070c4a

feat: add properties for positions in the URI segments


kenjis Apr 12, 2023
e49cf11

fix: add check for underscores in URI when $translateURIDashes is true


kenjis Apr 12, 2023
cde3889

test: add tests


kenjis Apr 12, 2023
9be93dd

test: add tests for getPos()


kenjis Apr 12, 2023
fb0d8d6

docs: add changelog and note


kenjis Jun 2, 2023
989ef70

docs: add upgrade guide


kenjis Jun 2, 2023
78b450c

test: add new param for getRoute()


kenjis Jun 14, 2023
c7b9da2

docs: remove @phpstan-ignore-line


kenjis Jun 14, 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


132 changes: 114 additions & 18 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,29 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private string $defaultMethod;

 /**
 * The URI segments.
 */
 private array $segments = [];

 /**
 * The position of the Controller in the URI segments.
 * Null for the default controller.
 */
 private ?int $controllerPos = null;

 /**
 * The position of the Method in the URI segments.
 * Null for the default method.
 */
 private ?int $methodPos = null;

 /**
 * The position of the first Parameter in the URI segments.
 * Null for the no parameters.
 */
 private ?int $paramPos = null;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
Expand DownExpand Up@@ -108,17 +131,21 @@ private function createSegments(string $uri)
 * If there is a controller corresponding to the first segment, the search
 * ends there. The remaining segments are parameters to the controller.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchFirstController(array $segments): bool
 private function searchFirstController(): bool
 {
 $segments = $this->segments;

 $controller = '\\' . $this->namespace;

 $controllerPos = -1;

 while ($segments !== []) {
 $segment = array_shift($segments);
 $class = $this->translateURIDashes(ucfirst($segment));
 $controllerPos++;

 $class = $this->translateURIDashes(ucfirst($segment));

 // as soon as we encounter any segment that is not PSR-4 compliant, stop searching
 if (! $this->isValidSegment($class)) {
Expand All@@ -128,9 +155,14 @@ private function searchFirstController(array $segments): bool
 $controller .= '\\' . $class;

 if (class_exists($controller)) {
 $this->controller = $controller;
 $this->controller = $controller;
 $this->controllerPos = $controllerPos;

 // The first item may be a method name.
 $this->params = $segments;
 if ($segments !== []) {
 $this->paramPos = $this->controllerPos + 1;
 }

 return true;
 }
Expand All@@ -142,15 +174,21 @@ private function searchFirstController(array $segments): bool
 /**
 * Search for the last default controller corresponding to the URI segments.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchLastDefaultController(array $segments): bool
 private function searchLastDefaultController(): bool
 {
 $params = [];
 $segments = $this->segments;

 $segmentCount = count($this->segments);
 $paramPos = null;
 $params = [];

 while ($segments !== []) {
 if ($segmentCount > count($segments)) {
 $paramPos = count($segments);
 }

 $namespaces = array_map(
 fn ($segment) => $this->translateURIDashes(ucfirst($segment)),
 $segments
Expand All@@ -164,6 +202,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = $paramPos;
 }

 return true;
 }

Expand All@@ -179,6 +221,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = 0;
 }

 return true;
 }

Expand All@@ -195,19 +241,19 @@ public function getRoute(string $uri, string $httpVerb): array
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = $this->createSegments($uri);
 $this->segments = $this->createSegments($uri);

 // Check for Module Routes.
 if (
 $segments !== []
 $this->segments !== []
 && ($routingConfig = config(Routing::class))
 && array_key_exists($segments[0], $routingConfig->moduleRoutes)
 && array_key_exists($this->segments[0], $routingConfig->moduleRoutes)
 ) {
 $uriSegment = array_shift($segments);
 $uriSegment = array_shift($this->segments);
 $this->namespace = rtrim($routingConfig->moduleRoutes[$uriSegment], '\\');
 }

 if ($this->searchFirstController($segments)) {
 if ($this->searchFirstController()) {
 // Controller is found.
 $baseControllerName = class_basename($this->controller);

Expand All@@ -219,14 +265,15 @@ public function getRoute(string $uri, string $httpVerb): array
 'Cannot access the default controller "' . $this->controller . '" with the controller name URI path.'
 );
 }
 } elseif ($this->searchLastDefaultController($segments)) {
 } elseif ($this->searchLastDefaultController()) {
 // The default Controller is found.
 $baseControllerName = class_basename($this->controller);
 } else {
 // No Controller is found.
 throw new PageNotFoundException('No controller is found for: ' . $uri);
 }

 // The first item may be a method name.
 $params = $this->params;

 $methodParam = array_shift($params);
Expand All@@ -241,6 +288,15 @@ public function getRoute(string $uri, string $httpVerb): array
 $this->method = $method;
 $this->params = $params;

 // Update the positions.
 $this->methodPos = $this->paramPos;
 if ($params === []) {
 $this->paramPos = null;
 }
 if ($this->paramPos !== null) {
 $this->paramPos++;
 }

 // Prevent access to default controller's method
 if (strtolower($baseControllerName) === strtolower($this->defaultController)) {
 throw new PageNotFoundException(
Expand DownExpand Up@@ -268,6 +324,10 @@ public function getRoute(string $uri, string $httpVerb): array
 // Ensure the controller does not have _remap() method.
 $this->checkRemap();

 // Ensure the URI segments for the controller and method do not contain
 // underscores when $translateURIDashes is true.
 $this->checkUnderscore($uri);

 // Check parameter count
 try {
 $this->checkParameters($uri);
Expand All@@ -280,6 +340,20 @@ public function getRoute(string $uri, string $httpVerb): array
 return [$this->directory, $this->controller, $this->method, $this->params];
 }

 /**
 * @internal For test purpose only.
 *
 * @return array<string, int|null>
 */
 public function getPos(): array
 {
 return [
 'controller' => $this->controllerPos,
 'method' => $this->methodPos,
 'params' => $this->paramPos,
 ];
 }

 /**
 * Get the directory path from the controller and set it to the property.
 *
Expand DownExpand Up@@ -363,6 +437,28 @@ private function checkRemap(): void
 }
 }

 private function checkUnderscore(string $uri): void
 {
 if ($this->translateURIDashes === false) {
 return;
 }

 $paramPos = $this->paramPos ?? count($this->segments);

 for ($i = 0; $i < $paramPos; $i++) {
 if (strpos($this->segments[$i], '_') !== false) {
 throw new PageNotFoundException(
 'AutoRouterImproved prohibits access to the URI'
 . ' containing underscores ("' . $this->segments[$i] . '")'
 . ' when $translateURIDashes is enabled.'
 . ' Please use the dash.'
 . ' Handler:' . $this->controller . '::' . $this->method
 . ', URI:' . $uri
 );
 }
 }
 }

 /**
 * Returns true if the supplied $segment string represents a valid PSR-4 compliant namespace/directory segment
 *
Expand All@@ -373,10 +469,10 @@ private function isValidSegment(string $segment): bool
 return (bool) preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $segment);
 }

 private function translateURIDashes(string $classname): string
 private function translateURIDashes(string $segment): string
 {
 return $this->translateURIDashes
 ? str_replace('-', '_', $classname)
 : $classname;
 ? str_replace('-', '_', $segment)
 : $segment;
 }
}
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
fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true#7422

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

Jul 3, 2023
 Merged


fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true
#7422
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
2bb2cd3

refactor: rename parameter name


kenjis Apr 12, 2023
e7cf718

refactor: add property $segments


kenjis Apr 12, 2023
0070c4a

feat: add properties for positions in the URI segments


kenjis Apr 12, 2023
e49cf11

fix: add check for underscores in URI when $translateURIDashes is true


kenjis Apr 12, 2023
cde3889

test: add tests


kenjis Apr 12, 2023
9be93dd

test: add tests for getPos()


kenjis Apr 12, 2023
fb0d8d6

docs: add changelog and note


kenjis Jun 2, 2023
989ef70

docs: add upgrade guide


kenjis Jun 2, 2023
78b450c

test: add new param for getRoute()


kenjis Jun 14, 2023
c7b9da2

docs: remove @phpstan-ignore-line


kenjis Jun 14, 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


132 changes: 114 additions & 18 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,29 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private string $defaultMethod;

 /**
 * The URI segments.
 */
 private array $segments = [];

 /**
 * The position of the Controller in the URI segments.
 * Null for the default controller.
 */
 private ?int $controllerPos = null;

 /**
 * The position of the Method in the URI segments.
 * Null for the default method.
 */
 private ?int $methodPos = null;

 /**
 * The position of the first Parameter in the URI segments.
 * Null for the no parameters.
 */
 private ?int $paramPos = null;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
Expand DownExpand Up@@ -108,17 +131,21 @@ private function createSegments(string $uri)
 * If there is a controller corresponding to the first segment, the search
 * ends there. The remaining segments are parameters to the controller.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchFirstController(array $segments): bool
 private function searchFirstController(): bool
 {
 $segments = $this->segments;

 $controller = '\\' . $this->namespace;

 $controllerPos = -1;

 while ($segments !== []) {
 $segment = array_shift($segments);
 $class = $this->translateURIDashes(ucfirst($segment));
 $controllerPos++;

 $class = $this->translateURIDashes(ucfirst($segment));

 // as soon as we encounter any segment that is not PSR-4 compliant, stop searching
 if (! $this->isValidSegment($class)) {
Expand All@@ -128,9 +155,14 @@ private function searchFirstController(array $segments): bool
 $controller .= '\\' . $class;

 if (class_exists($controller)) {
 $this->controller = $controller;
 $this->controller = $controller;
 $this->controllerPos = $controllerPos;

 // The first item may be a method name.
 $this->params = $segments;
 if ($segments !== []) {
 $this->paramPos = $this->controllerPos + 1;
 }

 return true;
 }
Expand All@@ -142,15 +174,21 @@ private function searchFirstController(array $segments): bool
 /**
 * Search for the last default controller corresponding to the URI segments.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchLastDefaultController(array $segments): bool
 private function searchLastDefaultController(): bool
 {
 $params = [];
 $segments = $this->segments;

 $segmentCount = count($this->segments);
 $paramPos = null;
 $params = [];

 while ($segments !== []) {
 if ($segmentCount > count($segments)) {
 $paramPos = count($segments);
 }

 $namespaces = array_map(
 fn ($segment) => $this->translateURIDashes(ucfirst($segment)),
 $segments
Expand All@@ -164,6 +202,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = $paramPos;
 }

 return true;
 }

Expand All@@ -179,6 +221,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = 0;
 }

 return true;
 }

Expand All@@ -195,19 +241,19 @@ public function getRoute(string $uri, string $httpVerb): array
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = $this->createSegments($uri);
 $this->segments = $this->createSegments($uri);

 // Check for Module Routes.
 if (
 $segments !== []
 $this->segments !== []
 && ($routingConfig = config(Routing::class))
 && array_key_exists($segments[0], $routingConfig->moduleRoutes)
 && array_key_exists($this->segments[0], $routingConfig->moduleRoutes)
 ) {
 $uriSegment = array_shift($segments);
 $uriSegment = array_shift($this->segments);
 $this->namespace = rtrim($routingConfig->moduleRoutes[$uriSegment], '\\');
 }

 if ($this->searchFirstController($segments)) {
 if ($this->searchFirstController()) {
 // Controller is found.
 $baseControllerName = class_basename($this->controller);

Expand All@@ -219,14 +265,15 @@ public function getRoute(string $uri, string $httpVerb): array
 'Cannot access the default controller "' . $this->controller . '" with the controller name URI path.'
 );
 }
 } elseif ($this->searchLastDefaultController($segments)) {
 } elseif ($this->searchLastDefaultController()) {
 // The default Controller is found.
 $baseControllerName = class_basename($this->controller);
 } else {
 // No Controller is found.
 throw new PageNotFoundException('No controller is found for: ' . $uri);
 }

 // The first item may be a method name.
 $params = $this->params;

 $methodParam = array_shift($params);
Expand All@@ -241,6 +288,15 @@ public function getRoute(string $uri, string $httpVerb): array
 $this->method = $method;
 $this->params = $params;

 // Update the positions.
 $this->methodPos = $this->paramPos;
 if ($params === []) {
 $this->paramPos = null;
 }
 if ($this->paramPos !== null) {
 $this->paramPos++;
 }

 // Prevent access to default controller's method
 if (strtolower($baseControllerName) === strtolower($this->defaultController)) {
 throw new PageNotFoundException(
Expand DownExpand Up@@ -268,6 +324,10 @@ public function getRoute(string $uri, string $httpVerb): array
 // Ensure the controller does not have _remap() method.
 $this->checkRemap();

 // Ensure the URI segments for the controller and method do not contain
 // underscores when $translateURIDashes is true.
 $this->checkUnderscore($uri);

 // Check parameter count
 try {
 $this->checkParameters($uri);
Expand All@@ -280,6 +340,20 @@ public function getRoute(string $uri, string $httpVerb): array
 return [$this->directory, $this->controller, $this->method, $this->params];
 }

 /**
 * @internal For test purpose only.
 *
 * @return array<string, int|null>
 */
 public function getPos(): array
 {
 return [
 'controller' => $this->controllerPos,
 'method' => $this->methodPos,
 'params' => $this->paramPos,
 ];
 }

 /**
 * Get the directory path from the controller and set it to the property.
 *
Expand DownExpand Up@@ -363,6 +437,28 @@ private function checkRemap(): void
 }
 }

 private function checkUnderscore(string $uri): void
 {
 if ($this->translateURIDashes === false) {
 return;
 }

 $paramPos = $this->paramPos ?? count($this->segments);

 for ($i = 0; $i < $paramPos; $i++) {
 if (strpos($this->segments[$i], '_') !== false) {
 throw new PageNotFoundException(
 'AutoRouterImproved prohibits access to the URI'
 . ' containing underscores ("' . $this->segments[$i] . '")'
 . ' when $translateURIDashes is enabled.'
 . ' Please use the dash.'
 . ' Handler:' . $this->controller . '::' . $this->method
 . ', URI:' . $uri
 );
 }
 }
 }

 /**
 * Returns true if the supplied $segment string represents a valid PSR-4 compliant namespace/directory segment
 *
Expand All@@ -373,10 +469,10 @@ private function isValidSegment(string $segment): bool
 return (bool) preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $segment);
 }

 private function translateURIDashes(string $classname): string
 private function translateURIDashes(string $segment): string
 {
 return $this->translateURIDashes
 ? str_replace('-', '_', $classname)
 : $classname;
 ? str_replace('-', '_', $segment)
 : $segment;
 }
}
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
fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true#7422

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

Jul 3, 2023
 Merged


fix: [Auto Routing Improved] one controller method has more than one URI when $translateURIDashes is true
#7422
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
2bb2cd3

refactor: rename parameter name


kenjis Apr 12, 2023
e7cf718

refactor: add property $segments


kenjis Apr 12, 2023
0070c4a

feat: add properties for positions in the URI segments


kenjis Apr 12, 2023
e49cf11

fix: add check for underscores in URI when $translateURIDashes is true


kenjis Apr 12, 2023
cde3889

test: add tests


kenjis Apr 12, 2023
9be93dd

test: add tests for getPos()


kenjis Apr 12, 2023
fb0d8d6

docs: add changelog and note


kenjis Jun 2, 2023
989ef70

docs: add upgrade guide


kenjis Jun 2, 2023
78b450c

test: add new param for getRoute()


kenjis Jun 14, 2023
c7b9da2

docs: remove @phpstan-ignore-line


kenjis Jun 14, 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


132 changes: 114 additions & 18 deletions
system/Router/AutoRouterImproved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,6 +70,29 @@ final class AutoRouterImproved implements AutoRouterInterface
 */
 private string $defaultMethod;

 /**
 * The URI segments.
 */
 private array $segments = [];

 /**
 * The position of the Controller in the URI segments.
 * Null for the default controller.
 */
 private ?int $controllerPos = null;

 /**
 * The position of the Method in the URI segments.
 * Null for the default method.
 */
 private ?int $methodPos = null;

 /**
 * The position of the first Parameter in the URI segments.
 * Null for the no parameters.
 */
 private ?int $paramPos = null;

 /**
 * @param class-string[] $protectedControllers
 * @param string $defaultController Short classname
Expand DownExpand Up@@ -108,17 +131,21 @@ private function createSegments(string $uri)
 * If there is a controller corresponding to the first segment, the search
 * ends there. The remaining segments are parameters to the controller.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchFirstController(array $segments): bool
 private function searchFirstController(): bool
 {
 $segments = $this->segments;

 $controller = '\\' . $this->namespace;

 $controllerPos = -1;

 while ($segments !== []) {
 $segment = array_shift($segments);
 $class = $this->translateURIDashes(ucfirst($segment));
 $controllerPos++;

 $class = $this->translateURIDashes(ucfirst($segment));

 // as soon as we encounter any segment that is not PSR-4 compliant, stop searching
 if (! $this->isValidSegment($class)) {
Expand All@@ -128,9 +155,14 @@ private function searchFirstController(array $segments): bool
 $controller .= '\\' . $class;

 if (class_exists($controller)) {
 $this->controller = $controller;
 $this->controller = $controller;
 $this->controllerPos = $controllerPos;

 // The first item may be a method name.
 $this->params = $segments;
 if ($segments !== []) {
 $this->paramPos = $this->controllerPos + 1;
 }

 return true;
 }
Expand All@@ -142,15 +174,21 @@ private function searchFirstController(array $segments): bool
 /**
 * Search for the last default controller corresponding to the URI segments.
 *
 * @param array $segments URI segments
 *
 * @return bool true if a controller class is found.
 */
 private function searchLastDefaultController(array $segments): bool
 private function searchLastDefaultController(): bool
 {
 $params = [];
 $segments = $this->segments;

 $segmentCount = count($this->segments);
 $paramPos = null;
 $params = [];

 while ($segments !== []) {
 if ($segmentCount > count($segments)) {
 $paramPos = count($segments);
 }

 $namespaces = array_map(
 fn ($segment) => $this->translateURIDashes(ucfirst($segment)),
 $segments
Expand All@@ -164,6 +202,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = $paramPos;
 }

 return true;
 }

Expand All@@ -179,6 +221,10 @@ private function searchLastDefaultController(array $segments): bool
 $this->controller = $controller;
 $this->params = $params;

 if ($params !== []) {
 $this->paramPos = 0;
 }

 return true;
 }

Expand All@@ -195,19 +241,19 @@ public function getRoute(string $uri, string $httpVerb): array
 $defaultMethod = strtolower($httpVerb) . ucfirst($this->defaultMethod);
 $this->method = $defaultMethod;

 $segments = $this->createSegments($uri);
 $this->segments = $this->createSegments($uri);

 // Check for Module Routes.
 if (
 $segments !== []
 $this->segments !== []
 && ($routingConfig = config(Routing::class))
 && array_key_exists($segments[0], $routingConfig->moduleRoutes)
 && array_key_exists($this->segments[0], $routingConfig->moduleRoutes)
 ) {
 $uriSegment = array_shift($segments);
 $uriSegment = array_shift($this->segments);
 $this->namespace = rtrim($routingConfig->moduleRoutes[$uriSegment], '\\');
 }

 if ($this->searchFirstController($segments)) {
 if ($this->searchFirstController()) {
 // Controller is found.
 $baseControllerName = class_basename($this->controller);

Expand All@@ -219,14 +265,15 @@ public function getRoute(string $uri, string $httpVerb): array
 'Cannot access the default controller "' . $this->controller . '" with the controller name URI path.'
 );
 }
 } elseif ($this->searchLastDefaultController($segments)) {
 } elseif ($this->searchLastDefaultController()) {
 // The default Controller is found.
 $baseControllerName = class_basename($this->controller);
 } else {
 // No Controller is found.
 throw new PageNotFoundException('No controller is found for: ' . $uri);
 }

 // The first item may be a method name.
 $params = $this->params;

 $methodParam = array_shift($params);
Expand All@@ -241,6 +288,15 @@ public function getRoute(string $uri, string $httpVerb): array
 $this->method = $method;
 $this->params = $params;

 // Update the positions.
 $this->methodPos = $this->paramPos;
 if ($params === []) {
 $this->paramPos = null;
 }
 if ($this->paramPos !== null) {
 $this->paramPos++;
 }

 // Prevent access to default controller's method
 if (strtolower($baseControllerName) === strtolower($this->defaultController)) {
 throw new PageNotFoundException(
Expand DownExpand Up@@ -268,6 +324,10 @@ public function getRoute(string $uri, string $httpVerb): array
 // Ensure the controller does not have _remap() method.
 $this->checkRemap();

 // Ensure the URI segments for the controller and method do not contain
 // underscores when $translateURIDashes is true.
 $this->checkUnderscore($uri);

 // Check parameter count
 try {
 $this->checkParameters($uri);
Expand All@@ -280,6 +340,20 @@ public function getRoute(string $uri, string $httpVerb): array
 return [$this->directory, $this->controller, $this->method, $this->params];
 }

 /**
 * @internal For test purpose only.
 *
 * @return array<string, int|null>
 */
 public function getPos(): array
 {
 return [
 'controller' => $this->controllerPos,
 'method' => $this->methodPos,
 'params' => $this->paramPos,
 ];
 }

 /**
 * Get the directory path from the controller and set it to the property.
 *
Expand DownExpand Up@@ -363,6 +437,28 @@ private function checkRemap(): void
 }
 }

 private function checkUnderscore(string $uri): void
 {
 if ($this->translateURIDashes === false) {
 return;
 }

 $paramPos = $this->paramPos ?? count($this->segments);

 for ($i = 0; $i < $paramPos; $i++) {
 if (strpos($this->segments[$i], '_') !== false) {
 throw new PageNotFoundException(
 'AutoRouterImproved prohibits access to the URI'
 . ' containing underscores ("' . $this->segments[$i] . '")'
 . ' when $translateURIDashes is enabled.'
 . ' Please use the dash.'
 . ' Handler:' . $this->controller . '::' . $this->method
 . ', URI:' . $uri
 );
 }
 }
 }

 /**
 * Returns true if the supplied $segment string represents a valid PSR-4 compliant namespace/directory segment
 *
Expand All@@ -373,10 +469,10 @@ private function isValidSegment(string $segment): bool
 return (bool) preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $segment);
 }

 private function translateURIDashes(string $classname): string
 private function translateURIDashes(string $segment): string
 {
 return $this->translateURIDashes
 ? str_replace('-', '_', $classname)
 : $classname;
 ? str_replace('-', '_', $segment)
 : $segment;
 }
}
Loading