Janitor\Excluder\IP

Complexity

Total Complexity

16

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	6
Bugs	2	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	addIP()	0	10	2
A	isExcluded()	0	12	3
C	determineCurrentIp()	0	29	8
A	isValidIp()	0	4	1

<?php
/**
 * Effortless maintenance management (http://juliangut.com/janitor)
 *
 * @link https://github.com/juliangut/janitor for the canonical source repository
 *
 * @license https://github.com/juliangut/janitor/blob/master/LICENSE
 */

namespace Janitor\Excluder;

use Janitor\Excluder as ExcluderInterface;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Maintenance excluder by route
 */
class IP implements ExcluderInterface
{
    /**
     * List of IPs to be excluded.
     *
     * @var array
     */
    protected $ips = [];

    /**
     * Allowe proxies.
     *
     * @var array
     */
    protected $trustedProxies;

    /**
     * @param array $ips
     * @param array $trustedProxies
     */
    public function __construct(array $ips = [], array $trustedProxies = [])
    {
        foreach ($ips as $ipAddress) {
            $this->addIP($ipAddress);
        }

        $this->trustedProxies = $trustedProxies;
    }

    /**
     * Add IP.
     *
     * @param string $ipAddress
     *
     * @throws \InvalidArgumentException
     */
    public function addIP($ipAddress)
    {
        if (!$this->isValidIp($ipAddress)) {
            throw new \InvalidArgumentException(sprintf('"%s" is not a valid IP address', $ipAddress));
        }

        $this->ips[] = $ipAddress;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function isExcluded(ServerRequestInterface $request)
    {
        $currentIP = $this->determineCurrentIp($request);

        foreach ($this->ips as $ipAddress) {
            if ($ipAddress === $currentIP) {
                return true;
            }
        }

        return false;
    }

    /**
     * Find client's IP.
     *
     * @param ServerRequestInterface $request
     *
     * @return string
     */
    protected function determineCurrentIp($request)
    {
        $inspectionHeaders = [
            'X-Forwarded-For',
            'X-Forwarded',
            'X-Cluster-Client-Ip',
            'Client-Ip',
        ];

        $currentIp = null;
        $serverParams = $request->getServerParams();
        if (isset($serverParams['REMOTE_ADDR']) && $this->isValidIp($serverParams['REMOTE_ADDR'])) {
            $currentIp = $serverParams['REMOTE_ADDR'];
        }

        if (empty($this->trustedProxies) || in_array($currentIp, $this->trustedProxies)) {
            foreach ($inspectionHeaders as $header) {
                if ($request->hasHeader($header)) {
                    $ipAddress = trim(current(explode(',', $request->getHeaderLine($header))));
                    if ($this->isValidIp($ipAddress)) {
                        $currentIp = $ipAddress;
                        break;
                    }
                }
            }
        }

        return $currentIp;
    }

    /**
     * Check IP validity.
     *
     * @param string $ipAddress
     *
     * @return bool
     */
    private function isValidIp($ipAddress)
    {
        return filter_var($ipAddress, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_IPV6) !== false;
    }
}