Allow set custom key to get IP address from _SERVER

Author: natanfelles

src/Debug/HTTPCollector.php

@@ -77,7 +77,10 @@ protected function renderRequest() : string
             return '<p>A Request instance has not been set on this collector.</p>';
         }
         \ob_start(); ?>
-        <p title="REMOTE_ADDR"><strong>IP:</strong> <?= $this->request->getIp() ?></p>
+        <p>
+            <strong>IP:</strong> <?= $this->request->getIp() ?>
+            <span class="opaque">(<?= $this->request->getIpKey() ?>)</span>
+        </p>
         <p><strong>Is Secure:</strong> <?= $this->request->isSecure() ? 'Yes' : 'No' ?></p>
         <p><strong>Protocol:</strong> <?= $this->request->getProtocol() ?></p>
         <p><strong>Method:</strong> <?= $this->request->getMethod() ?></p>

src/Request.php

@@ -71,6 +71,7 @@ class Request extends Message implements RequestInterface
      */
     protected bool $isSecure;
     protected int $jsonFlags = 0;
+    protected string $ipKey = 'REMOTE_ADDR';
 
     /**
      * Request constructor.
@@ -822,7 +823,37 @@ public function getId() : ?string
      */
     public function getIp() : string
     {
-        return $_SERVER['REMOTE_ADDR'];
+        return $_SERVER[$this->getIpKey()];
+    }
+
+    /**
+     * Set the key used to get the IP address from the superglobal $_SERVER.
+     *
+     * @param string $ipKey
+     *
+     * @throws InvalidArgumentException for IP key not set in the $_SERVER var
+     *
+     * @return static
+     */
+    public function setIpKey(string $ipKey) : static
+    {
+        if (!isset($_SERVER[$ipKey])) {
+            throw new InvalidArgumentException(
+                'The IP Key "' . $ipKey . '" is not set in the $_SERVER'
+            );
+        }
+        $this->ipKey = $ipKey;
+        return $this;
+    }
+
+    /**
+     * Get the key used to get the IP address from the superglobal $_SERVER.
+     *
+     * @return string
+     */
+    public function getIpKey() : string
+    {
+        return $this->ipKey;
     }
 
     #[Override]

tests/RequestMock.php

@@ -31,6 +31,7 @@ class RequestMock extends \Framework\HTTP\Request
             'HTTP_HOST' => 'domain.tld',
             'HTTP_REFERER' => 'http://domain.tld/contact.html',
             'HTTP_USER_AGENT' => 'Mozilla/5.0 (X11; Linux x86_64; rv:61.0) Gecko/20100101 Firefox/61.0',
+            'HTTP_X_FORWARDED_FOR' => '45.167.104.99',
             'HTTP_X_REQUEST_ID' => 'abc123',
             'HTTP_X_REQUESTED_WITH' => 'XMLHTTPREQUEST',
             'REMOTE_ADDR' => '192.168.1.100',

tests/RequestTest.php

@@ -266,6 +266,7 @@ public function testToString() : void
             'Host: domain.tld',
             'Referer: http://domain.tld/contact.html',
             'User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:61.0) Gecko/20100101 Firefox/61.0',
+            'X-Forwarded-For: 45.167.104.99',
             'X-Request-ID: abc123',
             'X-Requested-With: XMLHTTPREQUEST',
         ];
@@ -642,6 +643,7 @@ public function testHeaders() : void
             'host' => 'domain.tld',
             'referer' => 'http://domain.tld/contact.html',
             'user-agent' => 'Mozilla/5.0 (X11; Linux x86_64; rv:61.0) Gecko/20100101 Firefox/61.0',
+            'x-forwarded-for' => '45.167.104.99',
             'x-request-id' => 'abc123',
             'x-requested-with' => 'XMLHTTPREQUEST',
         ], $this->request->getHeaders());
@@ -652,6 +654,21 @@ public function testIP() : void
         self::assertSame('192.168.1.100', $this->request->getIp());
     }
 
+    public function testIpKey() : void
+    {
+        $this->request->setIpKey('HTTP_X_FORWARDED_FOR');
+        self::assertSame('45.167.104.99', $this->request->getIp());
+    }
+
+    public function testIpKeyException() : void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage(
+            'The IP Key "HTTP_CF_CONNECTING_IP" is not set in the $_SERVER'
+        );
+        $this->request->setIpKey('HTTP_CF_CONNECTING_IP');
+    }
+
     public function testIsAjax() : void
     {
         self::assertTrue($this->request->isAjax());