refactor: remove $_SERVER['HTTP_HOST']

Author: kenjis

system/Router/RouteCollection.php

@@ -218,13 +218,20 @@ class RouteCollection implements RouteCollectionInterface
      */
     protected $prioritizeDetected = false;
 
+    /**
+     * The current hostname from $_SERVER['HTTP_HOST']
+     */
+    private ?string $httpHost = null;
+
     /**
      * Constructor
      */
     public function __construct(FileLocator $locator, Modules $moduleConfig)
     {
         $this->fileLocator  = $locator;
         $this->moduleConfig = $moduleConfig;
+
+        $this->httpHost = Services::request()->getServer('HTTP_HOST');
     }
 
     /**
@@ -1176,7 +1183,7 @@ protected function create(string $verb, string $from, $to, ?array $options = nul
         // Hostname limiting?
         if (! empty($options['hostname'])) {
             // @todo determine if there's a way to whitelist hosts?
-            if (isset($_SERVER['HTTP_HOST']) && strtolower($_SERVER['HTTP_HOST']) !== strtolower($options['hostname'])) {
+            if (isset($this->httpHost) && strtolower($this->httpHost) !== strtolower($options['hostname'])) {
                 return;
             }
 
@@ -1302,7 +1309,7 @@ private function getMethodParams(string $from): string
     private function checkSubdomains($subdomains): bool
     {
         // CLI calls can't be on subdomain.
-        if (! isset($_SERVER['HTTP_HOST'])) {
+        if (! isset($this->httpHost)) {
             return false;
         }
 
@@ -1337,7 +1344,7 @@ private function determineCurrentSubdomain()
         // We have to ensure that a scheme exists
         // on the URL else parse_url will mis-interpret
         // 'host' as the 'path'.
-        $url = $_SERVER['HTTP_HOST'];
+        $url = $this->httpHost;
         if (strpos($url, 'http') !== 0) {
             $url = 'http://' . $url;
         }

tests/system/Router/RouteCollectionTest.php

@@ -18,12 +18,17 @@
 use Tests\Support\Controllers\Hello;
 
 /**
- * @backupGlobals enabled
- *
  * @internal
  */
 final class RouteCollectionTest extends CIUnitTestCase
 {
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->resetServices();
+    }
+
     protected function getCollector(array $config = [], array $files = [], $moduleConfig = null)
     {
         $defaults = [
@@ -1062,49 +1067,46 @@ public function testAddRedirectGetMethod()
      */
     public function testWithSubdomain()
     {
-        $routes = $this->getCollector();
-
         $_SERVER['HTTP_HOST'] = 'adm.example.com';
 
+        $routes = $this->getCollector();
+
         $routes->add('/objects/(:alphanum)', 'Admin::objectsList/$1', ['subdomain' => 'adm']);
         $routes->add('/objects/(:alphanum)', 'App::objectsList/$1');
 
         $expects = [
             'objects/([a-zA-Z0-9]+)' => '\Admin::objectsList/$1',
         ];
-
         $this->assertSame($expects, $routes->getRoutes());
     }
 
     public function testWithSubdomainMissing()
     {
-        $routes = $this->getCollector();
+        $_SERVER['HTTP_HOST'] = 'www.example.com';
 
-        //      $_SERVER['HTTP_HOST'] = 'adm.example.com';
+        $routes = $this->getCollector();
 
         $routes->add('/objects/(:alphanum)', 'Admin::objectsList/$1', ['subdomain' => 'adm']);
         $routes->add('/objects/(:alphanum)', 'App::objectsList/$1');
 
         $expects = [
             'objects/([a-zA-Z0-9]+)' => '\App::objectsList/$1',
         ];
-
         $this->assertSame($expects, $routes->getRoutes());
     }
 
     public function testWithDifferentSubdomain()
     {
-        $routes = $this->getCollector();
-
         $_SERVER['HTTP_HOST'] = 'adm.example.com';
 
+        $routes = $this->getCollector();
+
         $routes->add('/objects/(:alphanum)', 'Admin::objectsList/$1', ['subdomain' => 'sales']);
         $routes->add('/objects/(:alphanum)', 'App::objectsList/$1');
 
         $expects = [
             'objects/([a-zA-Z0-9]+)' => '\App::objectsList/$1',
         ];
-
         $this->assertSame($expects, $routes->getRoutes());
     }
 
@@ -1381,10 +1383,10 @@ public function testOffsetParameters()
      */
     public function testRouteToWithSubdomainMatch()
     {
-        $routes = $this->getCollector();
-
-        Services::request()->setMethod('get');
         $_SERVER['HTTP_HOST'] = 'doc.example.com';
+        Services::request()->setMethod('get');
+
+        $routes = $this->getCollector();
 
         $routes->get('i/(:any)', 'App\Controllers\Site\CDoc::item/$1', ['subdomain' => 'doc', 'as' => 'doc_item']);
 
@@ -1393,10 +1395,10 @@ public function testRouteToWithSubdomainMatch()
 
     public function testRouteToWithSubdomainMismatch()
     {
-        $routes = $this->getCollector();
-
-        Services::request()->setMethod('get');
         $_SERVER['HTTP_HOST'] = 'dev.example.com';
+        Services::request()->setMethod('get');
+
+        $routes = $this->getCollector();
 
         $routes->get('i/(:any)', 'App\Controllers\Site\CDoc::item/$1', ['subdomain' => 'doc', 'as' => 'doc_item']);
 
@@ -1453,10 +1455,10 @@ public function testRouteToWithGenericSubdomainNot()
 
     public function testRouteToWithoutSubdomainMatch()
     {
-        $routes = $this->getCollector();
-
-        Services::request()->setMethod('get');
         $_SERVER['HTTP_HOST'] = 'doc.example.com';
+        Services::request()->setMethod('get');
+
+        $routes = $this->getCollector();
 
         $routes->get('i/(:any)', 'App\Controllers\Site\CDoc::item/$1', ['hostname' => 'example.com', 'as' => 'doc_item']);
 
@@ -1477,10 +1479,10 @@ public function testRouteToWithoutSubdomainMismatch()
 
     public function testRouteToWithoutSubdomainNot()
     {
-        $routes = $this->getCollector();
-
-        Services::request()->setMethod('get');
         $_SERVER['HTTP_HOST'] = 'example.com';
+        Services::request()->setMethod('get');
+
+        $routes = $this->getCollector();
 
         $routes->get('i/(:any)', 'App\Controllers\Site\CDoc::item/$1', ['hostname' => 'example.com', 'as' => 'doc_item']);
 
@@ -1494,8 +1496,8 @@ public function testRouteToWithoutSubdomainNot()
      */
     public function testRouteOverwritingDifferentSubdomains()
     {
-        Services::request()->setMethod('get');
         $_SERVER['HTTP_HOST'] = 'doc.domain.com';
+        Services::request()->setMethod('get');
 
         $routes = $this->getCollector();
         $router = new Router($routes, Services::request());