Whip - Code Metrics - Inspection of "Proposed Changes for v0.3" - Vectorface/whip - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — dev (#8)

by Jonathan

created 2015-12-21 13:49 UTC

Whip A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
wmc	26
c	4
b	1
f	0
lcom	1
cbo	4
dl	0
loc	216
ccs	61
cts	61
cp	1
rs	10

9 Methods

Rating	Name	Size	Complexity
A	getValidIpAddress()	8	3
A	isMethodUsable()	10	3
A	__construct()	11	3
A	addCustomHeader()	8	2
A	getRequestAdapter()	12	4
A	coalesceSources()	10	3
A	setSource()	6	1
A	getIpAddress()	15	4
A	extractAddressFromHeaders()	10	3

<?php

/*
The MIT License (MIT)

Copyright (c) 2015 Vectorface, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

namespace Vectorface\Whip;

use \Exception;
use Vectorface\Whip\IpRange\IpWhitelist;
use Vectorface\Whip\Request\RequestAdapter;
use Vectorface\Whip\Request\Psr7RequestAdapter;
use Vectorface\Whip\Request\SuperglobalRequestAdapter;
use Psr\Http\Message\ServerRequestInterface;

/**
 * A class for accurately looking up a client's IP address.
 * This class checks a call time configurable list of headers in the $_SERVER
 * superglobal to determine the client's IP address.
 * @copyright Vectorface, Inc 2015
 * @author Daniel Bruce <[email protected]>
 * @author Cory Darby <[email protected]>
 */
class Whip
{

    /** Indicates all header methods will be used. */
    const ALL_METHODS        = 255;
    /** Indicates the REMOTE_ADDR method will be used. */
    const REMOTE_ADDR        = 1;
    /** Indicates a set of possible proxy headers will be used. */
    const PROXY_HEADERS      = 2;
    /** Indicates any CloudFlare specific headers will be used. */
    const CLOUDFLARE_HEADERS = 4;
    /** Indicates any Incapsula specific headers will be used. */
    const INCAPSULA_HEADERS  = 8;
    /** Indicates custom listed headers will be used. */
    const CUSTOM_HEADERS     = 128;

    /** The array of mapped header strings. */
    private static $headers = array(
        self::CUSTOM_HEADERS     => array(),
        self::INCAPSULA_HEADERS  => array(
            'incap-client-ip'
        ),
        self::CLOUDFLARE_HEADERS => array(
            'cf-connecting-ip'
        ),
        self::PROXY_HEADERS      => array(
            'client-ip',
            'x-forwarded-for',
            'x-forwarded',
            'x-cluster-client-ip',
            'forwarded-for',
            'forwarded',
            'x-real-ip',
        ),
    );

    /** the bitmask of enabled methods */
    private $enabled;

    /** the array of IP whitelist ranges to check against */
    private $whitelist;

    /**
     * An object holding the source of addresses we will check
     *
     * @var RequestAdapter
     */
    private $source;

    /**
     * Constructor for the class.
     * @param int $enabled The bitmask of enabled headers.
     * @param array $whitelists The array of IP ranges to be whitelisted.
     * @param mixed $source A supported source of IP data.
     */
    public function __construct($enabled = self::ALL_METHODS, array $whitelists = array(), $source = null)
    {
        $this->enabled   = (int) $enabled;
        if (isset($source)) {
            $this->setSource($source);
        }
        $this->whitelist = array();
        foreach ($whitelists as $header => $ipRanges) {
            $this->whitelist[$header] = new IpWhitelist($ipRanges);
        }
    }

    /**
     * Adds a custom header to the list.
     * @param string $header The custom header to add.
     * @return Whip Returns $this.
     */
    public function addCustomHeader($header)
    {
        if (strpos($header, 'HTTP_') === 0) {
            $header = str_replace('_', '-', substr($header, 5));
        }
        self::$headers[self::CUSTOM_HEADERS][] = strtolower($header);
        return $this;
    }

    /**
     * Get a source/request adapter for a given source of IP data.
     *
     * @param mixed $source A supported source of request data.
     * @return RequestAdapter A RequestAdapter implementation for the given source.
     */
    private function getRequestAdapter($source)
    {
        if ($source instanceof RequestAdapter) {
            return $source;
        } elseif ($source instanceof ServerRequestInterface) {
            return new Psr7RequestAdapter($source);
        } elseif (is_array($source)) {
            return new SuperglobalRequestAdapter($source);
        }

        throw new \InvalidArgumentException("Unknown IP source.");
    }

    /**
     * Given available sources, get the first available source of IP data.
     *
     * @param mixed $source A source data argument, if available.
     * @return mixed The best available source, after fallbacks.
     */
    private function coalesceSources($source = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (isset($source)) {
            return $source;
        } elseif (isset($this->source)) {
            return $this->source;
        }

        return $_SERVER;
    }

    /**
     * Sets the source data used to lookup the addresses.
     *
     * @param $source The source array.
     * @return Whip Returns $this.
     */
    public function setSource($source)
    {
        $this->source = $this->getRequestAdapter($source);

        return $this;
    }

    /**
     * Returns the IP address of the client using the given methods.
     * @param mixed $source (optional) The source data. If omitted, the class
     *        will use the value passed to Whip::setSource or fallback to
     *        $_SERVER.
     * @return string Returns the IP address as a string or false if no
     *         IP address could be found.
     */
    public function getIpAddress($source = null)
    {
        $source = $this->getRequestAdapter($this->coalesceSources($source));
        $remoteAddr = $source->getRemoteAddr();
        $requestHeaders = $source->getHeaders();

        foreach (self::$headers as $key => $headers) {
            if (!$this->isMethodUsable($key, $remoteAddr)) {
                continue;
            }
            return $this->extractAddressFromHeaders($requestHeaders, $headers);
        }

        return ($this->enabled & self::REMOTE_ADDR) ? $remoteAddr : false;
    }

    /**
     * Returns the valid IP address or false if no valid IP address was found.
     * @param mixed $source (optional) The source data. If omitted, the class
     *        will use the value passed to Whip::setSource or fallback to
     *        $_SERVER.
     * @return string|false Returns the IP address (as a string) of the client or false
     *         if no valid IP address was found.
     */
    public function getValidIpAddress($source = null)
    {
        $ipAddress = $this->getIpAddress($source);
        if (false === $ipAddress || false === @inet_pton($ipAddress)) {
            return false;
        }
        return $ipAddress;
    }

    /**
     * Finds the first element in $headers that is present in $_SERVER and
     * returns the IP address mapped to that value.
     * If the IP address is a list of comma separated values, the last value
     * in the list will be returned.
     * If no IP address is found, we return false.
     * @param array $requestHeaders The request headers to pull data from.
     * @param array $headers The list of headers to check.
     * @return string|false Returns the IP address as a string or false if no IP
     *         IP address was found.
     */
    private function extractAddressFromHeaders($requestHeaders, $headers)
    {
        foreach ($headers as $header) {
            if (!empty($requestHeaders[$header])) {
                $list = explode(',', $requestHeaders[$header]);
                return trim(end($list));
            }
        }
        return false;
    }

    /**
     * Returns whether or not the given method is enabled and usable.
     *
     * This method checks if the method is enabled and whether the method's data
     * is usable given it's IP whitelist.
     *
     * @param string $key The source key.
     * @param string $ipAddress The IP address.
     * @return boolean Returns true if the IP address is whitelisted and false
     *         otherwise. Returns true if the source does not have a whitelist
     *         specified.
     */
    private function isMethodUsable($key, $ipAddress)
    {
        if (!($key & $this->enabled)) {
            return false;
        }
        if (!isset($this->whitelist[$key])) {
            return true;
        }
        return $this->whitelist[$key]->isIpWhitelisted($ipAddress);
    }
}


1		<?php
2
3		/*
4		The MIT License (MIT)
5
6		Copyright (c) 2015 Vectorface, Inc.
7
8		Permission is hereby granted, free of charge, to any person obtaining a copy
9		of this software and associated documentation files (the "Software"), to deal
10		in the Software without restriction, including without limitation the rights
11		to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12		copies of the Software, and to permit persons to whom the Software is
13		furnished to do so, subject to the following conditions:
14
15		The above copyright notice and this permission notice shall be included in
16		all copies or substantial portions of the Software.
17
18		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19		IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20		FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21		AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22		LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23		OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24		THE SOFTWARE.
25		*/
26
27		namespace Vectorface\Whip;
28
29		use \Exception;
30		use Vectorface\Whip\IpRange\IpWhitelist;
31		use Vectorface\Whip\Request\RequestAdapter;
32		use Vectorface\Whip\Request\Psr7RequestAdapter;
33		use Vectorface\Whip\Request\SuperglobalRequestAdapter;
34		use Psr\Http\Message\ServerRequestInterface;
35
36		/**
37		* A class for accurately looking up a client's IP address.
38		* This class checks a call time configurable list of headers in the $_SERVER
39		* superglobal to determine the client's IP address.
40		* @copyright Vectorface, Inc 2015
41		* @author Daniel Bruce <[email protected]>
42		* @author Cory Darby <[email protected]>
43		*/
44		class Whip
45		{
46
47		/** Indicates all header methods will be used. */
48		const ALL_METHODS = 255;
49		/** Indicates the REMOTE_ADDR method will be used. */
50		const REMOTE_ADDR = 1;
51		/** Indicates a set of possible proxy headers will be used. */
52		const PROXY_HEADERS = 2;
53		/** Indicates any CloudFlare specific headers will be used. */
54		const CLOUDFLARE_HEADERS = 4;
55		/** Indicates any Incapsula specific headers will be used. */
56		const INCAPSULA_HEADERS = 8;
57		/** Indicates custom listed headers will be used. */
58		const CUSTOM_HEADERS = 128;
59
60		/** The array of mapped header strings. */
61		private static $headers = array(
62		self::CUSTOM_HEADERS => array(),
63		self::INCAPSULA_HEADERS => array(
64		'incap-client-ip'
65		),
66		self::CLOUDFLARE_HEADERS => array(
67		'cf-connecting-ip'
68		),
69		self::PROXY_HEADERS => array(
70		'client-ip',
71		'x-forwarded-for',
72		'x-forwarded',
73		'x-cluster-client-ip',
74		'forwarded-for',
75		'forwarded',
76		'x-real-ip',
77		),
78		);
79
80		/** the bitmask of enabled methods */
81		private $enabled;
82
83		/** the array of IP whitelist ranges to check against */
84		private $whitelist;
85
86		/**
87		* An object holding the source of addresses we will check
88		*
89		* @var RequestAdapter
90		*/
91		private $source;
92
93		/**
94		* Constructor for the class.
95		* @param int $enabled The bitmask of enabled headers.
96		* @param array $whitelists The array of IP ranges to be whitelisted.
97		* @param mixed $source A supported source of IP data.
98		*/
99	22	public function __construct($enabled = self::ALL_METHODS, array $whitelists = array(), $source = null)
100		{
101	22	$this->enabled = (int) $enabled;
102	22	if (isset($source)) {
103	16	$this->setSource($source);
104	15	}
105	21	$this->whitelist = array();
106	21	foreach ($whitelists as $header => $ipRanges) {
107	12	$this->whitelist[$header] = new IpWhitelist($ipRanges);
108	21	}
109	21	}
110
111		/**
112		* Adds a custom header to the list.
113		* @param string $header The custom header to add.
114		* @return Whip Returns $this.
115		*/
116	1	public function addCustomHeader($header)
117		{
118	1	if (strpos($header, 'HTTP_') === 0) {
119	1	$header = str_replace('_', '-', substr($header, 5));
120	1	}
121	1	self::$headers[self::CUSTOM_HEADERS][] = strtolower($header);
122	1	return $this;
123		}
124
125		/**
126		* Get a source/request adapter for a given source of IP data.
127		*
128		* @param mixed $source A supported source of request data.
129		* @return RequestAdapter A RequestAdapter implementation for the given source.
130		*/
131	22	private function getRequestAdapter($source)
132		{
133	22	if ($source instanceof RequestAdapter) {
134	19	return $source;
135	22	} elseif ($source instanceof ServerRequestInterface) {
136	1	return new Psr7RequestAdapter($source);
137	21	} elseif (is_array($source)) {
138	20	return new SuperglobalRequestAdapter($source);
139		}
140
141	1	throw new \InvalidArgumentException("Unknown IP source.");
142		}
143
144		/**
145		* Given available sources, get the first available source of IP data.
146		*
147		* @param mixed $source A source data argument, if available.
148		* @return mixed The best available source, after fallbacks.
149		*/
150	21	private function coalesceSources($source = null)
		0 ignored issues – show Coding Style introduced 2015-12-21 03:02 UTC by Report Bug Copy Issue Report `coalesceSources` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
151		{
152	21	if (isset($source)) {
153	1	return $source;
154	21	} elseif (isset($this->source)) {
155	19	return $this->source;
156		}
157
158	2	return $_SERVER;
159		}
160
161		/**
162		* Sets the source data used to lookup the addresses.
163		*
164		* @param $source The source array.
165		* @return Whip Returns $this.
166		*/
167	20	public function setSource($source)
168		{
169	20	$this->source = $this->getRequestAdapter($source);
170
171	19	return $this;
172		}
173
174		/**
175		* Returns the IP address of the client using the given methods.
176		* @param mixed $source (optional) The source data. If omitted, the class
177		* will use the value passed to Whip::setSource or fallback to
178		* $_SERVER.
179		* @return string Returns the IP address as a string or false if no
180		* IP address could be found.
181		*/
182	21	public function getIpAddress($source = null)
183		{
184	21	$source = $this->getRequestAdapter($this->coalesceSources($source));
185	21	$remoteAddr = $source->getRemoteAddr();
186	21	$requestHeaders = $source->getHeaders();
187
188	21	foreach (self::$headers as $key => $headers) {
189	21	if (!$this->isMethodUsable($key, $remoteAddr)) {
190	19	continue;
191		}
192	11	return $this->extractAddressFromHeaders($requestHeaders, $headers);
193	10	}
194
195	10	return ($this->enabled & self::REMOTE_ADDR) ? $remoteAddr : false;
196		}
197
198		/**
199		* Returns the valid IP address or false if no valid IP address was found.
200		* @param mixed $source (optional) The source data. If omitted, the class
201		* will use the value passed to Whip::setSource or fallback to
202		* $_SERVER.
203		* @return string\|false Returns the IP address (as a string) of the client or false
204		* if no valid IP address was found.
205		*/
206	4	public function getValidIpAddress($source = null)
207		{
208	4	$ipAddress = $this->getIpAddress($source);
209	4	if (false === $ipAddress \|\| false === @inet_pton($ipAddress)) {
210	1	return false;
211		}
212	3	return $ipAddress;
213		}
214
215		/**
216		* Finds the first element in $headers that is present in $_SERVER and
217		* returns the IP address mapped to that value.
218		* If the IP address is a list of comma separated values, the last value
219		* in the list will be returned.
220		* If no IP address is found, we return false.
221		* @param array $requestHeaders The request headers to pull data from.
222		* @param array $headers The list of headers to check.
223		* @return string\|false Returns the IP address as a string or false if no IP
224		* IP address was found.
225		*/
226	11	private function extractAddressFromHeaders($requestHeaders, $headers)
227		{
228	11	foreach ($headers as $header) {
229	10	if (!empty($requestHeaders[$header])) {
230	9	$list = explode(',', $requestHeaders[$header]);
231	9	return trim(end($list));
232		}
233	10	}
234	2	return false;
235		}
236
237		/**
238		* Returns whether or not the given method is enabled and usable.
239		*
240		* This method checks if the method is enabled and whether the method's data
241		* is usable given it's IP whitelist.
242		*
243		* @param string $key The source key.
244		* @param string $ipAddress The IP address.
245		* @return boolean Returns true if the IP address is whitelisted and false
246		* otherwise. Returns true if the source does not have a whitelist
247		* specified.
248		*/
249	21	private function isMethodUsable($key, $ipAddress)
250		{
251	21	if (!($key & $this->enabled)) {
252	19	return false;
253		}
254	15	if (!isset($this->whitelist[$key])) {
255	3	return true;
256		}
257	12	return $this->whitelist[$key]->isIpWhitelisted($ipAddress);
258		}
259		}
260

Vectorface / whip

Pull Request — dev (#8)

Whip A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Duplication Side-by-Side

Filter issues like