Your IP : 216.73.216.43
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\HTTP\PhpEnvironment;
use Magento\Framework\App\RequestInterface;
use Magento\Framework\ObjectManager\ResetAfterRequestInterface;
/**
* Library for working with client ip address.
*
* @api
*/
class RemoteAddress implements ResetAfterRequestInterface
{
/**
* Request object.
*
* @var RequestInterface
*
* phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
*/
protected readonly RequestInterface $request;
/**
* Remote address cache.
*
* @var string|null|bool|number
*/
protected $remoteAddress;
/**
* @var array
*
* phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
*/
protected readonly array $alternativeHeaders;
/**
* @var string[]|null
*
* phpcs:disable Magento2.Commenting.ClassPropertyPHPDocFormatting
*/
private readonly ?array $trustedProxies;
/**
* Constructor
*
* @param RequestInterface $httpRequest
* @param array $alternativeHeaders
* @param string[]|null $trustedProxies
*/
public function __construct(
RequestInterface $httpRequest,
array $alternativeHeaders = [],
array $trustedProxies = null
) {
$this->request = $httpRequest;
$this->alternativeHeaders = $alternativeHeaders;
$this->trustedProxies = $trustedProxies;
}
/**
* @inheritDoc
*/
public function _resetState(): void
{
$this->remoteAddress = null;
}
/**
* Read address based on settings.
*
* @return string|null
*/
private function readAddress()
{
$remoteAddress = null;
foreach ($this->alternativeHeaders as $var) {
if ($this->request->getServer($var, false)) {
$remoteAddress = $this->request->getServer($var);
break;
}
}
if (!$remoteAddress) {
$remoteAddress = $this->request->getServer('REMOTE_ADDR');
}
return $remoteAddress;
}
/**
* Filter addresses by trusted proxies list.
*
* @param string $remoteAddress
* @return string|null
*/
private function filterAddress(string $remoteAddress)
{
if (strpos($remoteAddress, ',') !== false) {
$ipList = explode(',', $remoteAddress);
} else {
$ipList = [$remoteAddress];
}
$ipList = array_filter(
$ipList,
function (string $ip) {
return filter_var(trim($ip), FILTER_VALIDATE_IP);
}
);
if ($this->trustedProxies !== null) {
$ipList = array_filter(
$ipList,
function (string $ip) {
return !in_array(trim($ip), $this->trustedProxies, true);
}
);
$remoteAddress = empty($ipList) ? '' : trim(array_pop($ipList));
} else {
$remoteAddress = trim(reset($ipList));
}
return $remoteAddress ?: null;
}
/**
* Retrieve Client Remote Address.
* If alternative headers are used and said headers allow multiple IPs
* it is suggested that trusted proxies is also used
* for more accurate IP recognition.
*
* @param bool $ipToLong converting IP to long format
*
* @return string IPv4|long
*/
public function getRemoteAddress(bool $ipToLong = false)
{
if ($this->remoteAddress !== null) {
return $ipToLong ? ip2long($this->remoteAddress) : $this->remoteAddress;
}
$remoteAddress = $this->readAddress();
if (!$remoteAddress) {
$this->remoteAddress = false;
return false;
}
$remoteAddress = $this->filterAddress($remoteAddress);
if (!$remoteAddress) {
$this->remoteAddress = false;
return false;
}
$this->remoteAddress = $remoteAddress;
return $ipToLong ? ip2long($this->remoteAddress) : $this->remoteAddress;
}
/**
* Returns internet host name corresponding to remote server
*
* @return string|null
*/
public function getRemoteHost()
{
return $this->getRemoteAddress()
? gethostbyaddr($this->getRemoteAddress())
: null;
}
}