Request::getRemoteHost() is deprecated and returns null [Closes #218]

Author: dg

readme.md

@@ -169,10 +169,6 @@ getRemoteAddress(): ?string
 ---------------------------
 Returns the user's IP address. You may need to [set up a proxy|configuring#HTTP proxy] for proper functionality.
 
-getRemoteHost(): ?string
-------------------------
-Returns DNS translation of the user's IP address. You may need to [set up a proxy|configuring#HTTP proxy] for proper functionality.
-
 getRawBody(): ?string
 ---------------------
 Returns the body of the HTTP request:

src/Http/IRequest.php

@@ -129,9 +129,7 @@ function isAjax(): bool;
 	 */
 	function getRemoteAddress(): ?string;
 
-	/**
-	 * Returns the host of the remote client.
-	 */
+	#[\Deprecated]
 	function getRemoteHost(): ?string;
 
 	/**

src/Http/Request.php

@@ -8,7 +8,7 @@
 namespace Nette\Http;
 
 use Nette;
-use function array_change_key_case, base64_decode, count, explode, func_num_args, gethostbyaddr, implode, in_array, preg_match, preg_match_all, rsort, strcasecmp, strtr;
+use function array_change_key_case, base64_decode, count, explode, implode, in_array, preg_match, preg_match_all, rsort, strcasecmp, strtr;
 
 
 /**
@@ -25,7 +25,7 @@
  * @property-read bool $secured
  * @property-read bool $ajax
  * @property-read ?string $remoteAddress
- * @property-read ?string $remoteHost
+ * @property-deprecated ?string $remoteHost
  * @property-read ?string $rawBody
  */
 class Request implements IRequest
@@ -278,16 +278,11 @@ public function getRemoteAddress(): ?string
 	}
 
 
-	/**
-	 * Returns the host of the remote client.
-	 */
+	#[\Deprecated]
 	public function getRemoteHost(): ?string
 	{
-		if ($this->remoteHost === null && $this->remoteAddress !== null) {
-			$this->remoteHost = gethostbyaddr($this->remoteAddress) ?: null;
-		}
-
-		return $this->remoteHost;
+		trigger_error(__METHOD__ . '() is deprecated.', E_USER_DEPRECATED);
+		return null;
 	}
 
 

src/Http/RequestFactory.php

@@ -79,7 +79,7 @@ public function fromGlobals(): Request
 		$this->getServer($url);
 		$this->getPathAndQuery($url);
 		[$post, $cookies] = $this->getGetPostCookie($url);
-		[$remoteAddr, $remoteHost] = $this->getClient($url);
+		$remoteAddr = $this->getClient($url);
 		if ($this->forceHttps) {
 			$url->setScheme('https');
 		}
@@ -92,7 +92,7 @@ public function fromGlobals(): Request
 			$this->getHeaders(),
 			$this->getMethod(),
 			$remoteAddr,
-			$remoteHost,
+			null,
 			fn() => (string) file_get_contents('php://input'),
 		);
 	}
@@ -295,24 +295,19 @@ private function getMethod(): string
 	}
 
 
-	/** @return array{?string, ?string}  [remoteAddr, remoteHost] */
-	private function getClient(Url $url): array
+	private function getClient(Url $url): ?string
 	{
 		$remoteAddr = !empty($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : null;
 
-		// use real client address and host if trusted proxy is used
+		// use real client address if trusted proxy is used
 		$usingTrustedProxy = $remoteAddr && Arrays::some($this->proxies, fn(string $proxy): bool => Helpers::ipMatch($remoteAddr, $proxy));
 		if ($usingTrustedProxy) {
-			$remoteHost = null;
-			$remoteAddr = empty($_SERVER['HTTP_FORWARDED'])
+			return empty($_SERVER['HTTP_FORWARDED'])
 				? $this->useNonstandardProxy($url)
 				: $this->useForwardedProxy($url);
-
-		} else {
-			$remoteHost = !empty($_SERVER['REMOTE_HOST']) ? $_SERVER['REMOTE_HOST'] : null;
 		}
 
-		return [$remoteAddr, $remoteHost];
+		return $remoteAddr;
 	}
 
 

tests/Http/RequestFactory.proxy.forwarded.phpt

@@ -19,7 +19,6 @@ test('forwarded header handling with proxy', function () {
 	$factory = new RequestFactory;
 	$factory->setProxy('127.0.0.1');
 	Assert::same('127.0.0.3', $factory->fromGlobals()->getRemoteAddress());
-	Assert::same('localhost', $factory->fromGlobals()->getRemoteHost());
 
 	$factory->setProxy('127.0.0.1/8');
 	Assert::same('23.75.45.200', $factory->fromGlobals()->getRemoteAddress());
@@ -58,7 +57,6 @@ test('IPv6 addresses in Forwarded header', function () {
 
 	$factory->setProxy('127.0.0.3');
 	Assert::same('2001:db8:cafe::17', $factory->fromGlobals()->getRemoteAddress());
-	Assert::same('2001:db8:cafe::17', $factory->fromGlobals()->getRemoteHost());
 
 	$url = $factory->fromGlobals()->getUrl();
 	Assert::same('[2001:db8:cafe::18]', $url->getHost());
@@ -75,7 +73,6 @@ test('IPv6 addresses and ports in Forwarded header', function () {
 
 	$factory->setProxy('127.0.0.3');
 	Assert::same('2001:db8:cafe::17', $factory->fromGlobals()->getRemoteAddress());
-	Assert::same('2001:db8:cafe::17', $factory->fromGlobals()->getRemoteHost());
 
 	$url = $factory->fromGlobals()->getUrl();
 	Assert::same(47832, $url->getPort());

tests/Http/RequestFactory.proxy.x-forwarded.phpt

@@ -21,7 +21,6 @@ test('X-Forwarded headers handling with proxy', function () {
 	$factory = new RequestFactory;
 	$factory->setProxy('127.0.0.1');
 	Assert::same('127.0.0.3', $factory->fromGlobals()->getRemoteAddress());
-	Assert::same('localhost', $factory->fromGlobals()->getRemoteHost());
 
 	$factory->setProxy('127.0.0.1/8');
 	Assert::same('23.75.45.200', $factory->fromGlobals()->getRemoteAddress());