feat(app): Allow turning off defined routes and/or auto routing

Author: lonnieezell

app/Config/Routing.php

@@ -18,6 +18,27 @@
  */
 class Routing extends BaseRouting
 {
+    /**
+     * If TRUE, the system will attempt to match the URI against
+     * Controllers by matching each segment against folders/files
+     * in APPPATH/Controllers, when a match wasn't found against
+     * defined routes.
+     *
+     * If FALSE, will stop searching and do NO automatic routing.
+     *
+     * Default: false
+     */
+    public bool $autoRoute = false;
+
+    /**
+     * If TRUE, the system will use route definition files to
+     * define routes. If FALSE, any routes defined in the Routes.php
+     * files will be ignored.
+     *
+     * Default: true
+     */
+    public bool $definedRoutes = true;
+
     /**
      * For Defined Routes.
      * An array of files that contain route definitions.
@@ -86,16 +107,6 @@ class Routing extends BaseRouting
      */
     public ?string $override404 = null;
 
-    /**
-     * If TRUE, the system will attempt to match the URI against
-     * Controllers by matching each segment against folders/files
-     * in APPPATH/Controllers, when a match wasn't found against
-     * defined routes.
-     *
-     * If FALSE, will stop searching and do NO automatic routing.
-     */
-    public bool $autoRoute = false;
-
     /**
      * For Defined Routes.
      * If TRUE, will enable the use of the 'prioritize' option

composer.json

@@ -120,7 +120,7 @@
             "phpstan analyse --ansi --generate-baseline=utils/phpstan-baseline/loader.neon",
             "split-phpstan-baseline utils/phpstan-baseline/loader.neon"
         ],
-        "phpstan:check": "vendor/bin/phpstan analyse --verbose --ansi",
+        "phpstan:check": "vendor/bin/phpstan analyse --verbose --ansi --memory-limit=512M",
         "sa": "@analyze",
         "style": "@cs-fix",
         "test": "phpunit"

system/CodeIgniter.php

@@ -785,7 +785,12 @@ protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
         $this->benchmark->start('routing');
 
         if (! $routes instanceof RouteCollectionInterface) {
-            $routes = service('routes')->loadRoutes();
+            $routes = Services::routes();
+
+            // Only load the routes if we are using definedRoutes
+            if (config('Routing')->definedRoutes) {
+                $routes->loadRoutes();
+            }
         }
 
         // $routes is defined in Config/Routes.php

system/Config/Routing.php

@@ -18,6 +18,25 @@
  */
 class Routing extends BaseConfig
 {
+    /**
+     * If TRUE, the system will attempt to match the URI against
+     * Controllers by matching each segment against folders/files
+     * in APPPATH/Controllers, when a match wasn't found against
+     * defined routes.
+     *
+     * If FALSE, will stop searching and do NO automatic routing.
+     */
+    public bool $autoRoute = false;
+
+    /**
+     * If TRUE, the system will use route definition files to
+     * define routes. If FALSE, any routes defined in the Routes.php
+     * files will be ignored.
+     *
+     * Default: true
+     */
+    public bool $definedRoutes = true;
+
     /**
      * For Defined Routes.
      * An array of files that contain route definitions.
@@ -86,16 +105,6 @@ class Routing extends BaseConfig
      */
     public ?string $override404 = null;
 
-    /**
-     * If TRUE, the system will attempt to match the URI against
-     * Controllers by matching each segment against folders/files
-     * in APPPATH/Controllers, when a match wasn't found against
-     * defined routes.
-     *
-     * If FALSE, will stop searching and do NO automatic routing.
-     */
-    public bool $autoRoute = false;
-
     /**
      * For Defined Routes.
      * If TRUE, will enable the use of the 'prioritize' option

system/Language/en/Router.php

@@ -16,5 +16,6 @@
     'invalidParameter'         => 'A parameter does not match the expected type.',
     'missingDefaultRoute'      => 'Unable to determine what should be displayed. A default route has not been specified in the routing file.',
     'invalidDynamicController' => 'A dynamic controller is not allowed for security reasons. Route handler: "{0}"',
-    'invalidControllerName'    => 'The namespace delimiter is a backslash (\), not a slash (/). Route handler: "{0}"',
+    'invalidControllerName'    => 'The namespace delimiter is a backslash (\\), not a slash (/). Route handler: "{0}"',
+    'noRoutingAvailable'       => 'No routing is available. Both auto-routing and defined routes are disabled.',
 ];

system/Router/Exceptions/RouterException.php

@@ -80,4 +80,12 @@ public static function forInvalidControllerName(string $handler)
     {
         return new static(lang('Router.invalidControllerName', [$handler]));
     }
+
+    /**
+     * Throw when no routing is available (both autoRoute and definedRoutes are false).
+     */
+    public static function forNoRoutingAvailable(): self
+    {
+        return new static(lang('Router.noRoutingAvailable'));
+    }
 }

system/Router/RouteCollection.php

@@ -86,6 +86,15 @@ class RouteCollection implements RouteCollectionInterface
      */
     protected $autoRoute = false;
 
+    /**
+     * Whether to use route definition files to define routes.
+     *
+     * Not used here. Pass-thru value for Router class.
+     *
+     * @var bool
+     */
+    protected $definedRoutes = true;
+
     /**
      * A callable that will be shown
      * when the route cannot be matched.
@@ -291,13 +300,17 @@ public function __construct(FileLocatorInterface $locator, Modules $moduleConfig
         $this->translateURIDashes = $routing->translateURIDashes;
         $this->override404        = $routing->override404;
         $this->autoRoute          = $routing->autoRoute;
+        $this->definedRoutes      = $routing->definedRoutes;
         $this->routeFiles         = $routing->routeFiles;
         $this->prioritize         = $routing->prioritize;
 
-        // Normalize the path string in routeFiles array.
-        foreach ($this->routeFiles as $routeKey => $routesFile) {
-            $realpath                    = realpath($routesFile);
-            $this->routeFiles[$routeKey] = ($realpath === false) ? $routesFile : $realpath;
+        // Only normalize route files if we're actually going to use them
+        if ($this->definedRoutes) {
+            // Normalize the path string in routeFiles array.
+            foreach ($this->routeFiles as $routeKey => $routesFile) {
+                $realpath                    = realpath($routesFile);
+                $this->routeFiles[$routeKey] = ($realpath === false) ? $routesFile : $realpath;
+            }
         }
     }
 
@@ -310,6 +323,13 @@ public function __construct(FileLocatorInterface $locator, Modules $moduleConfig
      */
     public function loadRoutes(string $routesFile = APPPATH . 'Config/Routes.php')
     {
+        // Skip loading if defined routes are disabled
+        if (! $this->definedRoutes) {
+            $this->didDiscover = true;
+
+            return $this;
+        }
+
         if ($this->didDiscover) {
             return $this;
         }
@@ -356,6 +376,13 @@ protected function discoverRoutes()
             return;
         }
 
+        // Skip discovery if defined routes are disabled
+        if (! $this->definedRoutes) {
+            $this->didDiscover = true;
+
+            return;
+        }
+
         // We need this var in local scope
         // so route files can access it.
         $routes = $this;
@@ -552,6 +579,14 @@ public function shouldAutoRoute(): bool
         return $this->autoRoute;
     }
 
+    /**
+     * Returns the flag that tells whether to use defined routes.
+     */
+    public function shouldUseDefinedRoutes(): bool
+    {
+        return $this->definedRoutes;
+    }
+
     /**
      * Returns the raw array of available routes.
      *
@@ -560,6 +595,11 @@ public function shouldAutoRoute(): bool
      */
     public function getRoutes(?string $verb = null, bool $includeWildcard = true): array
     {
+        // Early exit if defined routes are disabled
+        if (! $this->definedRoutes) {
+            return [];
+        }
+
         if ((string) $verb === '') {
             $verb = $this->getHTTPVerb();
         }

system/Router/RouteCollectionInterface.php

@@ -172,6 +172,13 @@ public function shouldTranslateURIDashes();
      */
     public function shouldAutoRoute();
 
+    /**
+     * Returns the flag that tells whether to use defined routes.
+     *
+     * @return bool
+     */
+    public function shouldUseDefinedRoutes();
+
     /**
      * Returns the raw array of available routes.
      *

system/Router/Router.php

@@ -158,29 +158,47 @@ public function __construct(RouteCollectionInterface $routes, ?Request $request
         $this->collection->setHTTPVerb($request->getMethod() === '' ? $_SERVER['REQUEST_METHOD'] : $request->getMethod());
 
         $this->translateURIDashes = $this->collection->shouldTranslateURIDashes();
+    }
 
-        if ($this->collection->shouldAutoRoute()) {
+    /**
+     * Gets the AutoRouter instance
+     */
+    private function getAutoRouter(): AutoRouterInterface
+    {
+        if ($this->autoRouter === null) {
             $autoRoutesImproved = config(Feature::class)->autoRoutesImproved ?? false;
             if ($autoRoutesImproved) {
                 assert($this->collection instanceof RouteCollection);
 
+                // Only get protected controllers if we're using defined routes
+                $protectedControllers = $this->collection->shouldUseDefinedRoutes()
+                    ? $this->collection->getRegisteredControllers('*')
+                    : [];
+
                 $this->autoRouter = new AutoRouterImproved(
-                    $this->collection->getRegisteredControllers('*'),
+                    $protectedControllers,
                     $this->collection->getDefaultNamespace(),
                     $this->collection->getDefaultController(),
                     $this->collection->getDefaultMethod(),
                     $this->translateURIDashes,
                 );
             } else {
+                // Only get CLI routes if we're using defined routes
+                $cliRoutes = $this->collection->shouldUseDefinedRoutes()
+                    ? $this->collection->getRoutes('CLI', false)
+                    : [];
+
                 $this->autoRouter = new AutoRouter(
-                    $this->collection->getRoutes('CLI', false),
+                    $cliRoutes,
                     $this->collection->getDefaultNamespace(),
                     $this->collection->getDefaultController(),
                     $this->collection->getDefaultMethod(),
                     $this->translateURIDashes,
                 );
             }
         }
+
+        return $this->autoRouter;
     }
 
     /**
@@ -209,6 +227,37 @@ public function handle(?string $uri = null)
         // Restart filterInfo
         $this->filtersInfo = [];
 
+        $useDefinedRoutes = $this->collection->shouldUseDefinedRoutes();
+        $useAutoRoute     = $this->collection->shouldAutoRoute();
+
+        // Let devs know if both are disabled
+        if (! $useDefinedRoutes && ! $useAutoRoute) {
+            throw RouterException::forNoRoutingAvailable();
+        }
+
+        // Fast path 1: Auto-routing ONLY (no defined routes to check)
+        if ($useAutoRoute && ! $useDefinedRoutes) {
+            $this->autoRoute($uri);
+
+            return $this->controllerName();
+        }
+
+        // Fast path 2: Defined routes ONLY (no auto-routing fallback)
+        if ($useDefinedRoutes && ! $useAutoRoute) {
+            if ($this->checkRoutes($uri)) {
+                if ($this->collection->isFiltered($this->matchedRoute[0])) {
+                    $this->filtersInfo = $this->collection->getFiltersForRoute($this->matchedRoute[0]);
+                }
+
+                return $this->controller;
+            }
+
+            throw new PageNotFoundException(
+                "Can't find a route for '{$this->collection->getHTTPVerb()}: {$uri}'.",
+            );
+        }
+
+        // Original path: BOTH enabled (check defined routes first, then auto-route)
         // Checks defined routes
         if ($this->checkRoutes($uri)) {
             if ($this->collection->isFiltered($this->matchedRoute[0])) {
@@ -361,8 +410,11 @@ public function setIndexPage($page): self
      */
     public function setTranslateURIDashes(bool $val = false): self
     {
-        if ($this->autoRouter instanceof AutoRouter) {
-            $this->autoRouter->setTranslateURIDashes($val);
+        // Need to get or create the AutoRouter instance
+        $autoRouter = $this->collection->shouldAutoRoute() ? $this->getAutoRouter() : null;
+
+        if ($autoRouter instanceof AutoRouter) {
+            $autoRouter->setTranslateURIDashes($val);
 
             return $this;
         }
@@ -564,7 +616,7 @@ static function ($match) use ($matches) {
     public function autoRoute(string $uri)
     {
         [$this->directory, $this->controller, $this->method, $this->params]
-            = $this->autoRouter->getRoute($uri, $this->collection->getHTTPVerb());
+             = $this->getAutoRouter()->getRoute($uri, $this->collection->getHTTPVerb());
     }
 
     /**
@@ -646,8 +698,11 @@ public function setDirectory(?string $dir = null, bool $append = false, bool $va
             $this->directory = null;
         }
 
-        if ($this->autoRouter instanceof AutoRouter) {
-            $this->autoRouter->setDirectory($dir, $append, $validate);
+        // Need to get or create the AutoRouter instance
+        $autoRouter = $this->collection->shouldAutoRoute() ? $this->getAutoRouter() : null;
+
+        if ($autoRouter instanceof AutoRouter) {
+            $autoRouter->setDirectory($dir, $append, $validate);
         }
     }