refactor: use superglobals service in the UserAgent class (codeigniter4#9783)

michalsn · web-flow · commit 50116bba4a6c · 2025-10-31T19:45:48.000+01:00
* refactor: use superglobals service in the UserAgent class

* update phpstan baseline

* cs fix

* update test

* update phpstan baseline
diff --git a/system/HTTP/UserAgent.php b/system/HTTP/UserAgent.php
@@ -109,8 +109,10 @@ public function __construct(?UserAgents $config = null)
     {
         $this->config = $config ?? config(UserAgents::class);
 
-        if (isset($_SERVER['HTTP_USER_AGENT'])) {
-            $this->agent = trim($_SERVER['HTTP_USER_AGENT']);
+        $userAgent = service('superglobals')->server('HTTP_USER_AGENT');
+
+        if ($userAgent !== null) {
+            $this->agent = trim($userAgent);
             $this->compileData();
         }
     }
@@ -175,10 +177,11 @@ public function isMobile(?string $key = null): bool
     public function isReferral(): bool
     {
         if (! isset($this->referrer)) {
-            if (empty($_SERVER['HTTP_REFERER'])) {
+            $referer = service('superglobals')->server('HTTP_REFERER');
+            if ($referer === null || $referer === '') {
                 $this->referrer = false;
             } else {
-                $refererHost = @parse_url($_SERVER['HTTP_REFERER'], PHP_URL_HOST);
+                $refererHost = @parse_url($referer, PHP_URL_HOST);
                 $ownHost     = parse_url(\base_url(), PHP_URL_HOST);
 
                 $this->referrer = ($refererHost && $refererHost !== $ownHost);
@@ -241,7 +244,9 @@ public function getMobile(): string
      */
     public function getReferrer(): string
     {
-        return empty($_SERVER['HTTP_REFERER']) ? '' : trim($_SERVER['HTTP_REFERER']);
+        $referrer = service('superglobals')->server('HTTP_REFERER');
+
+        return $referrer === null ? '' : trim($referrer);
     }
 
     /**
diff --git a/tests/system/HTTP/IncomingRequestTest.php b/tests/system/HTTP/IncomingRequestTest.php
@@ -760,7 +760,7 @@ public function testIsSecureForwarded(): void
 
     public function testUserAgent(): void
     {
-        $_SERVER['HTTP_USER_AGENT'] = 'Mozilla';
+        service('superglobals')->setServer('HTTP_USER_AGENT', 'Mozilla');
 
         $config  = new App();
         $request = $this->createRequest($config);
diff --git a/tests/system/HTTP/UserAgentTest.php b/tests/system/HTTP/UserAgentTest.php
@@ -31,17 +31,16 @@ protected function setUp(): void
         parent::setUp();
 
         // set a baseline user agent
-        $_SERVER['HTTP_USER_AGENT'] = $this->_user_agent;
+        service('superglobals')->setServer('HTTP_USER_AGENT', $this->_user_agent);
 
         $this->agent = new UserAgent();
     }
 
     public function testMobile(): void
     {
         // Mobile Not Set
-        $_SERVER['HTTP_USER_AGENT'] = $this->_mobile_ua;
+        service('superglobals')->setServer('HTTP_USER_AGENT', $this->_mobile_ua);
         $this->assertFalse($this->agent->isMobile());
-        unset($_SERVER['HTTP_USER_AGENT']);
     }
 
     public function testIsFunctions(): void
@@ -55,12 +54,13 @@ public function testIsFunctions(): void
 
     public function testReferrer(): void
     {
-        $_SERVER['HTTP_REFERER'] = 'http://codeigniter.com/user_guide/';
+        service('superglobals')->setServer('HTTP_REFERER', 'http://codeigniter.com/user_guide/');
+
         $this->assertTrue($this->agent->isReferral());
         $this->assertSame('http://codeigniter.com/user_guide/', $this->agent->getReferrer());
 
         $this->setPrivateProperty($this->agent, 'referrer', null);
-        unset($_SERVER['HTTP_REFERER']);
+        service('superglobals')->setServer('HTTP_REFERER', '');
         $this->assertFalse($this->agent->isReferral());
         $this->assertSame('', $this->agent->getReferrer());
     }
@@ -108,7 +108,7 @@ public function testParseBot(): void
 
     public function testEmptyUserAgentVariable(): void
     {
-        unset($_SERVER['HTTP_USER_AGENT']);
+        service('superglobals')->setServer('HTTP_USER_AGENT', '');
         $agent = new UserAgent();
         $this->assertEmpty((string) $agent);
     }
diff --git a/utils/phpstan-baseline/codeigniter.superglobalAccess.neon b/utils/phpstan-baseline/codeigniter.superglobalAccess.neon
@@ -1,4 +1,4 @@
-# total 77 errors
+# total 68 errors
 
 parameters:
     ignoreErrors:
@@ -117,16 +117,6 @@ parameters:
             count: 2
             path: ../../system/HTTP/Response.php
 
-        -
-            message: '#^Accessing offset ''HTTP_REFERER'' directly on \$_SERVER is discouraged\.$#'
-            count: 4
-            path: ../../system/HTTP/UserAgent.php
-
-        -
-            message: '#^Accessing offset ''HTTP_USER_AGENT'' directly on \$_SERVER is discouraged\.$#'
-            count: 2
-            path: ../../system/HTTP/UserAgent.php
-
         -
             message: '#^Accessing offset mixed directly on \$_GET is discouraged\.$#'
             count: 1
@@ -212,16 +202,6 @@ parameters:
             count: 1
             path: ../../tests/system/HTTP/SiteURIFactoryDetectRoutePathTest.php
 
-        -
-            message: '#^Accessing offset ''HTTP_REFERER'' directly on \$_SERVER is discouraged\.$#'
-            count: 1
-            path: ../../tests/system/HTTP/UserAgentTest.php
-
-        -
-            message: '#^Accessing offset ''HTTP_USER_AGENT'' directly on \$_SERVER is discouraged\.$#'
-            count: 2
-            path: ../../tests/system/HTTP/UserAgentTest.php
-
         -
             message: '#^Accessing offset ''HTTP_HOST'' directly on \$_SERVER is discouraged\.$#'
             count: 1
diff --git a/utils/phpstan-baseline/codeigniter.superglobalAccessAssign.neon b/utils/phpstan-baseline/codeigniter.superglobalAccessAssign.neon
@@ -1,4 +1,4 @@
-# total 463 errors
+# total 459 errors
 
 parameters:
     ignoreErrors:
@@ -337,11 +337,6 @@ parameters:
             count: 2
             path: ../../tests/system/HTTP/IncomingRequestTest.php
 
-        -
-            message: '#^Assigning ''Mozilla'' directly on offset ''HTTP_USER_AGENT'' of \$_SERVER is discouraged\.$#'
-            count: 1
-            path: ../../tests/system/HTTP/IncomingRequestTest.php
-
         -
             message: '#^Assigning ''fr\-FR; q\=1\.0, en; q\=0\.5'' directly on offset ''HTTP_ACCEPT_LANGUAGE'' of \$_SERVER is discouraged\.$#'
             count: 1
@@ -662,16 +657,6 @@ parameters:
             count: 3
             path: ../../tests/system/HTTP/URITest.php
 
-        -
-            message: '#^Assigning ''http\://codeigniter\.com/user_guide/'' directly on offset ''HTTP_REFERER'' of \$_SERVER is discouraged\.$#'
-            count: 1
-            path: ../../tests/system/HTTP/UserAgentTest.php
-
-        -
-            message: '#^Assigning string directly on offset ''HTTP_USER_AGENT'' of \$_SERVER is discouraged\.$#'
-            count: 2
-            path: ../../tests/system/HTTP/UserAgentTest.php
-
         -
             message: '#^Assigning ''/'' directly on offset ''REQUEST_URI'' of \$_SERVER is discouraged\.$#'
             count: 1
diff --git a/utils/phpstan-baseline/empty.notAllowed.neon b/utils/phpstan-baseline/empty.notAllowed.neon
@@ -1,4 +1,4 @@
-# total 239 errors
+# total 237 errors
 
 parameters:
     ignoreErrors:
@@ -242,11 +242,6 @@ parameters:
             count: 2
             path: ../../system/HTTP/Response.php
 
-        -
-            message: '#^Construct empty\(\) is not allowed\. Use more strict comparison\.$#'
-            count: 2
-            path: ../../system/HTTP/UserAgent.php
-
         -
             message: '#^Construct empty\(\) is not allowed\. Use more strict comparison\.$#'
             count: 1
diff --git a/utils/phpstan-baseline/loader.neon b/utils/phpstan-baseline/loader.neon
@@ -1,4 +1,4 @@
-# total 2788 errors
+# total 2773 errors
 
 includes:
     - argument.type.neon

Original file line number	Diff line number	Diff line change
`@@ -109,8 +109,10 @@ public function __construct(?UserAgents $config = null)`
`109`	`109`	`{`
`110`	`110`	`$this->config = $config ?? config(UserAgents::class);`
`111`	`111`
`112`		`- if (isset($_SERVER['HTTP_USER_AGENT'])) {`
`113`		`- $this->agent = trim($_SERVER['HTTP_USER_AGENT']);`
	`112`	`+ $userAgent = service('superglobals')->server('HTTP_USER_AGENT');`
	`113`	`+`
	`114`	`+ if ($userAgent !== null) {`
	`115`	`+ $this->agent = trim($userAgent);`
`114`	`116`	`$this->compileData();`
`115`	`117`	`}`
`116`	`118`	`}`
`@@ -175,10 +177,11 @@ public function isMobile(?string $key = null): bool`
`175`	`177`	`public function isReferral(): bool`
`176`	`178`	`{`
`177`	`179`	`if (! isset($this->referrer)) {`
`178`		`- if (empty($_SERVER['HTTP_REFERER'])) {`
	`180`	`+ $referer = service('superglobals')->server('HTTP_REFERER');`
	`181`	`+ if ($referer === null \|\| $referer === '') {`
`179`	`182`	`$this->referrer = false;`
`180`	`183`	`} else {`
`181`		`- $refererHost = @parse_url($_SERVER['HTTP_REFERER'], PHP_URL_HOST);`
	`184`	`+ $refererHost = @parse_url($referer, PHP_URL_HOST);`
`182`	`185`	`$ownHost = parse_url(\base_url(), PHP_URL_HOST);`
`183`	`186`
`184`	`187`	`$this->referrer = ($refererHost && $refererHost !== $ownHost);`
`@@ -241,7 +244,9 @@ public function getMobile(): string`
`241`	`244`	`*/`
`242`	`245`	`public function getReferrer(): string`
`243`	`246`	`{`
`244`		`- return empty($_SERVER['HTTP_REFERER']) ? '' : trim($_SERVER['HTTP_REFERER']);`
	`247`	`+ $referrer = service('superglobals')->server('HTTP_REFERER');`
	`248`	`+`
	`249`	`+ return $referrer === null ? '' : trim($referrer);`
`245`	`250`	`}`
`246`	`251`
`247`	`252`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -760,7 +760,7 @@ public function testIsSecureForwarded(): void`
`760`	`760`
`761`	`761`	`public function testUserAgent(): void`
`762`	`762`	`{`
`763`		`- $_SERVER['HTTP_USER_AGENT'] = 'Mozilla';`
	`763`	`+ service('superglobals')->setServer('HTTP_USER_AGENT', 'Mozilla');`
`764`	`764`
`765`	`765`	`$config = new App();`
`766`	`766`	`$request = $this->createRequest($config);`
Original file line number	Diff line number	Diff line change
`@@ -31,17 +31,16 @@ protected function setUp(): void`
`31`	`31`	`parent::setUp();`
`32`	`32`
`33`	`33`	`// set a baseline user agent`
`34`		`- $_SERVER['HTTP_USER_AGENT'] = $this->_user_agent;`
	`34`	`+ service('superglobals')->setServer('HTTP_USER_AGENT', $this->_user_agent);`
`35`	`35`
`36`	`36`	`$this->agent = new UserAgent();`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`public function testMobile(): void`
`40`	`40`	`{`
`41`	`41`	`// Mobile Not Set`
`42`		`- $_SERVER['HTTP_USER_AGENT'] = $this->_mobile_ua;`
	`42`	`+ service('superglobals')->setServer('HTTP_USER_AGENT', $this->_mobile_ua);`
`43`	`43`	`$this->assertFalse($this->agent->isMobile());`
`44`		`- unset($_SERVER['HTTP_USER_AGENT']);`
`45`	`44`	`}`
`46`	`45`
`47`	`46`	`public function testIsFunctions(): void`
`@@ -55,12 +54,13 @@ public function testIsFunctions(): void`
`55`	`54`
`56`	`55`	`public function testReferrer(): void`
`57`	`56`	`{`
`58`		`- $_SERVER['HTTP_REFERER'] = 'http://codeigniter.com/user_guide/';`
	`57`	`+ service('superglobals')->setServer('HTTP_REFERER', 'http://codeigniter.com/user_guide/');`
	`58`	`+`
`59`	`59`	`$this->assertTrue($this->agent->isReferral());`
`60`	`60`	`$this->assertSame('http://codeigniter.com/user_guide/', $this->agent->getReferrer());`
`61`	`61`
`62`	`62`	`$this->setPrivateProperty($this->agent, 'referrer', null);`
`63`		`- unset($_SERVER['HTTP_REFERER']);`
	`63`	`+ service('superglobals')->setServer('HTTP_REFERER', '');`
`64`	`64`	`$this->assertFalse($this->agent->isReferral());`
`65`	`65`	`$this->assertSame('', $this->agent->getReferrer());`
`66`	`66`	`}`
`@@ -108,7 +108,7 @@ public function testParseBot(): void`
`108`	`108`
`109`	`109`	`public function testEmptyUserAgentVariable(): void`
`110`	`110`	`{`
`111`		`- unset($_SERVER['HTTP_USER_AGENT']);`
	`111`	`+ service('superglobals')->setServer('HTTP_USER_AGENT', '');`
`112`	`112`	`$agent = new UserAgent();`
`113`	`113`	`$this->assertEmpty((string) $agent);`
`114`	`114`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# total 2788 errors`
	`1`	`+# total 2773 errors`
`2`	`2`
`3`	`3`	`includes:`
`4`	`4`	`- argument.type.neon`