Merge pull request #8235 from kenjis/fix-route-HTTP-verb

fix: route key lowercase HTTP verbs
codeigniter4 · Nov 26, 2023 · 59fa588 · 59fa588
2 parents 21e117b + 72f16ab
commit 59fa588
Show file tree

Hide file tree

Showing 22 changed files with 232 additions and 163 deletions.
diff --git a/system/CodeIgniter.php b/system/CodeIgniter.php
@@ -453,7 +453,7 @@ public function disableFilters(): void
      */
     protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
     {
-        if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
+        if ($this->request instanceof IncomingRequest && $this->request->getMethod() === 'CLI') {
             return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
         }
 

diff --git a/system/Commands/Utilities/FilterCheck.php b/system/Commands/Utilities/FilterCheck.php
@@ -56,7 +56,7 @@ class FilterCheck extends BaseCommand
      * @var array<string, string>
      */
     protected $arguments = [
-        'method' => 'The HTTP method. get, post, put, etc.',
+        'method' => 'The HTTP method. GET, POST, PUT, etc.',
         'route'  => 'The route (URI path) to check filters.',
     ];
 
@@ -76,13 +76,13 @@ public function run(array $params)
         if (! isset($params[0], $params[1])) {
             CLI::error('You must specify a HTTP verb and a route.');
             CLI::write('  Usage: ' . $this->usage);
-            CLI::write('Example: filter:check get /');
-            CLI::write('         filter:check put products/1');
+            CLI::write('Example: filter:check GET /');
+            CLI::write('         filter:check PUT products/1');
 
             return EXIT_ERROR;
         }
 
-        $method = strtolower($params[0]);
+        $method = $params[0];
         $route  = $params[1];
 
         // Load Routes

diff --git a/system/Commands/Utilities/Routes.php b/system/Commands/Utilities/Routes.php
@@ -18,6 +18,7 @@
 use CodeIgniter\Commands\Utilities\Routes\FilterCollector;
 use CodeIgniter\Commands\Utilities\Routes\SampleURIGenerator;
 use CodeIgniter\Router\DefinedRouteCollector;
+use CodeIgniter\Router\Router;
 use Config\Feature;
 use Config\Routing;
 use Config\Services;
@@ -98,18 +99,7 @@ public function run(array $params)
             unset($_SERVER['HTTP_HOST']);
         }
 
-        $methods = [
-            'get',
-            'head',
-            'post',
-            'patch',
-            'put',
-            'delete',
-            'options',
-            'trace',
-            'connect',
-            'cli',
-        ];
+        $methods = Router::HTTP_METHODS;
 
         $tbody           = [];
         $uriGenerator    = new SampleURIGenerator();
@@ -172,8 +162,8 @@ public function run(array $params)
                 $autoRoutes = $autoRouteCollector->get();
 
                 foreach ($autoRoutes as &$routes) {
-                    // There is no `auto` method, but it is intentional not to get route filters.
-                    $filters = $filterCollector->get('auto', $uriGenerator->get($routes[1]));
+                    // There is no `AUTO` method, but it is intentional not to get route filters.
+                    $filters = $filterCollector->get('AUTO', $uriGenerator->get($routes[1]));
 
                     $routes[] = implode(' ', array_map('class_basename', $filters['before']));
                     $routes[] = implode(' ', array_map('class_basename', $filters['after']));

diff --git a/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php b/system/Commands/Utilities/Routes/AutoRouterImproved/ControllerMethodReader.php
@@ -65,7 +65,7 @@ public function read(string $class, string $defaultController = 'Home', string $
             $methodName = $method->getName();
 
             foreach ($this->httpMethods as $httpVerb) {
-                if (strpos($methodName, $httpVerb) === 0) {
+                if (strpos($methodName, strtolower($httpVerb)) === 0) {
                     // Remove HTTP verb prefix.
                     $methodInUri = lcfirst(substr($methodName, strlen($httpVerb)));
 

diff --git a/system/Commands/Utilities/Routes/FilterCollector.php b/system/Commands/Utilities/Routes/FilterCollector.php
@@ -37,14 +37,28 @@ public function __construct(bool $resetRoutes = false)
     }
 
     /**
-     * @param string $method HTTP method
+     * @param string $method HTTP verb like `GET`,`POST` or `CLI`.
      * @param string $uri    URI path to find filters for
      *
      * @return array{before: list<string>, after: list<string>} array of filter alias or classname
      */
     public function get(string $method, string $uri): array
     {
-        if ($method === 'cli') {
+        if ($method === strtolower($method)) {
+            @trigger_error(
+                'Passing lowercase HTTP method "' . $method . '" is deprecated.'
+                . ' Use uppercase HTTP method like "' . strtoupper($method) . '".',
+                E_USER_DEPRECATED
+            );
+        }
+
+        /**
+         * @deprecated 4.5.0
+         * @TODO Remove this in the future.
+         */
+        $method = strtoupper($method);
+
+        if ($method === 'CLI') {
             return [
                 'before' => [],
                 'after'  => [],

diff --git a/system/HTTP/CLIRequest.php b/system/HTTP/CLIRequest.php
@@ -316,7 +316,6 @@ public function getLocale(): string
      * Checks this request type.
      *
      * @param string $type HTTP verb or 'json' or 'ajax'
-     * @phpstan-param string|'get'|'post'|'put'|'delete'|'head'|'patch'|'options'|'json'|'ajax' $type
      */
     public function is(string $type): bool
     {

diff --git a/system/HTTP/IncomingRequest.php b/system/HTTP/IncomingRequest.php
@@ -398,7 +398,6 @@ public function negotiate(string $type, array $supported, bool $strictMatch = fa
      *
      * @param string $type HTTP verb or 'json' or 'ajax'.
      *                     HTTP verb should be case-sensitive, but this is case-insensitive.
-     * @phpstan-param string|'get'|'post'|'put'|'delete'|'head'|'patch'|'options'|'json'|'ajax' $type
      */
     public function is(string $type): bool
     {

diff --git a/system/Router/AutoRouter.php b/system/Router/AutoRouter.php
@@ -120,7 +120,7 @@ public function getRoute(string $uri, string $httpVerb): array
         }
 
         // Ensure routes registered via $routes->cli() are not accessible via web.
-        if ($this->httpVerb !== 'cli') {
+        if ($this->httpVerb !== 'CLI') {
             $controller = '\\' . $this->defaultNamespace;
 
             $controller .= $this->directory ? str_replace('/', '\\', $this->directory) : '';

diff --git a/system/Router/DefinedRouteCollector.php b/system/Router/DefinedRouteCollector.php
@@ -33,18 +33,7 @@ public function __construct(RouteCollection $routes)
      */
     public function collect(): Generator
     {
-        $methods = [
-            'get',
-            'head',
-            'post',
-            'patch',
-            'put',
-            'delete',
-            'options',
-            'trace',
-            'connect',
-            'cli',
-        ];
+        $methods = Router::HTTP_METHODS;
 
         foreach ($methods as $method) {
             $routes = $this->routeCollection->getRoutes($method);