Server::ip() - Code Metrics - Inspection of "Added tests for `cs\Request\Server` trait" - nazar-pc/CleverStyle-Framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fcbcfe...f20db1 )

by Nazar

created 2016-07-04 23:37 UTC

Server::ip() A

↳ Parent: Server

Complexity

Conditions	4
Paths	4

Size

Total Lines	19
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	14
c	0
b	0
f	0
nc	4
nop	1
dl	0
loc	19
ccs	8
cts	8
cp	1
crap	4
rs	9.2

<?php
/**
 * @package   CleverStyle Framework
 * @author    Nazar Mokrynskyi <[email protected]>
 * @copyright Copyright (c) 2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs\Request;

trait Server {
	/**
	 * Uppercase method, GET by default
	 *
	 * @var string
	 */
	public $method;
	/**
	 * The best guessed host
	 *
	 * @var string
	 */
	public $host;
	/**
	 * Schema `http` or `https`
	 *
	 * @var string
	 */
	public $scheme;
	/**
	 * Is requested with HTTPS
	 *
	 * @var bool
	 */
	public $secure;
	/**
	 * Protocol, for instance: `HTTP/1.0`, `HTTP/1.1` (default), HTTP/2.0
	 *
	 * @var string
	 */
	public $protocol;
	/**
	 * Path
	 *
	 * @var string
	 */
	public $path;
	/**
	 * URI, basically `$path?$query_string` (without `?` is query string is empty), `/` by default
	 *
	 * @var string
	 */
	public $uri;
	/**
	 * Query string
	 *
	 * @var string
	 */
	public $query_string;
	/**
	 * Where request came from, not necessary real IP of client, `127.0.0.1` by default
	 *
	 * @var string
	 */
	public $remote_addr;
	/**
	 * The best guessed IP of client (based on all known headers), `$this->remote_addr` by default
	 *
	 * @var string
	 */
	public $ip;
	/**
	 * Headers are normalized to lowercase keys with hyphen as separator, for instance: `connection`, `referer`, `content-type`, `accept-language`
	 *
	 * @var string[]
	 */
	public $headers;
	/**
	 * @var bool
	 */
	protected $cli;
	/**
	 * @param string[] $server Typically `$_SERVER`
	 */
	function init_server ($server = []) {
		$this->fill_headers($server);
		/**
		 * Add some defaults to avoid isset() hell afterwards
		 */
		$server += [
			'QUERY_STRING'    => '',
			'REMOTE_ADDR'     => '127.0.0.1',
			'REQUEST_URI'     => '/',
			'REQUEST_METHOD'  => 'GET',
			'SERVER_PROTOCOL' => 'HTTP/1.1'
		];
		$this->fill_server_properties($server);
	}
	/**
	 * @param string[] $server
	 */
	protected function fill_server_properties ($server) {
		$this->cli          = @$server['CLI'] === true;
		$this->method       = strtoupper($server['REQUEST_METHOD']);
		$this->host         = $this->host($server);
		$this->secure       = $this->secure($server);
		$this->scheme       = $this->secure ? 'https' : 'http';
		$this->protocol     = $server['SERVER_PROTOCOL'];
		$this->query_string = $server['QUERY_STRING'];
		$this->uri          = null_byte_filter(urldecode($server['REQUEST_URI'])) ?: '/';
		if (strpos($this->uri, '/index.php') === 0) {
			$this->uri = substr($this->uri, 10);
		}
		$this->path         = explode('?', $this->uri, 2)[0];
		$this->remote_addr  = $server['REMOTE_ADDR'];
		$this->ip           = $this->ip($server);
	}
	/**
	 * @param string[] $server
	 */
	protected function fill_headers ($server) {
		$headers = [];
		foreach ($server as $header => $header_content) {
			if (strpos($header, 'HTTP_') === 0) {
				$header = substr($header, 5);
			} elseif (strpos($header, 'CONTENT_') !== 0) {
				continue;
			}
			$header           = strtolower(str_replace('_', '-', $header));
			$headers[$header] = $header_content;
		}
		$this->headers = $headers;
	}
	/**
	 * The best guessed IP of client (based on all known headers), `127.0.0.1` by default
	 *
	 * @param string[] $server
	 *
	 * @return string
	 */
	protected function ip ($server) {
		$all_possible_keys = [
			'HTTP_X_FORWARDED_FOR',
			'HTTP_CLIENT_IP',
			'HTTP_X_FORWARDED',
			'HTTP_X_CLUSTER_CLIENT_IP',
			'HTTP_FORWARDED_FOR',
			'HTTP_FORWARDED'
		];
		foreach ($all_possible_keys as $key) {
			if (isset($server[$key])) {
				$ip = trim(explode(',', $server[$key])[0]);
				if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE)) {
					return $ip;
				}
			}
		}
		return $this->remote_addr;
	}
	/**
	 * The best guessed host
	 *
	 * @param string[] $server
	 *
	 * @return string
	 */
	protected function host ($server) {
		$host          = @$server['SERVER_NAME'] ?: '';
		$port          = '';
		$expected_port = $this->secure ? 443 : 80;
		if (!$host && isset($server['HTTP_X_FORWARDED_HOST'])) {
			$host = $server['HTTP_X_FORWARDED_HOST'];
			if (
				isset($server['HTTP_X_FORWARDED_PORT']) &&
				$server['HTTP_X_FORWARDED_PORT'] != $expected_port
			) {
				$port = (int)$server['HTTP_X_FORWARDED_PORT'];
			}
		} elseif (isset($server['HTTP_HOST'])) {
			/** @noinspection NotOptimalIfConditionsInspection */
			if (!$host || filter_var($host, FILTER_VALIDATE_IP)) {
				$host = $server['HTTP_HOST'];
			} elseif (strpos($server['HTTP_HOST'], ':') !== false) {
				$port = (int)explode(':', $server['HTTP_HOST'])[1];
				if ($port == $expected_port) {
					$port = '';
				}
			}
		}
		if (preg_replace('/(?:^\[)?[a-zA-Z0-9-:\]_]+\.?/', '', $host) !== '') {
			return '';
		}
		return $host.($port ? ":$port" : '');
	}
	/**
	 * Secure protocol detection
	 *
	 * @param array $server
	 *
	 * @return bool
	 */
	protected function secure ($server) {
		return @$server['HTTPS'] ? $server['HTTPS'] !== 'off' : (
			@$server['REQUEST_SCHEME'] === 'https' ||
			@$server['HTTP_X_FORWARDED_PROTO'] === 'https'
		);
	}
	/**
	 * Get header by name
	 *
	 * @param string $name Case-insensitive
	 *
	 * @return string Header content if exists or empty string otherwise
	 */
	function header ($name) {
		$name = strtolower($name);
		return isset($this->headers[$name]) ? $this->headers[$name] : '';
	}
}


1		<?php
2		/**
3		* @package CleverStyle Framework
4		* @author Nazar Mokrynskyi <[email protected]>
5		* @copyright Copyright (c) 2016, Nazar Mokrynskyi
6		* @license MIT License, see license.txt
7		*/
8		namespace cs\Request;
9
10		trait Server {
11		/**
12		* Uppercase method, GET by default
13		*
14		* @var string
15		*/
16		public $method;
17		/**
18		* The best guessed host
19		*
20		* @var string
21		*/
22		public $host;
23		/**
24		* Schema `http` or `https`
25		*
26		* @var string
27		*/
28		public $scheme;
29		/**
30		* Is requested with HTTPS
31		*
32		* @var bool
33		*/
34		public $secure;
35		/**
36		* Protocol, for instance: `HTTP/1.0`, `HTTP/1.1` (default), HTTP/2.0
37		*
38		* @var string
39		*/
40		public $protocol;
41		/**
42		* Path
43		*
44		* @var string
45		*/
46		public $path;
47		/**
48		* URI, basically `$path?$query_string` (without `?` is query string is empty), `/` by default
49		*
50		* @var string
51		*/
52		public $uri;
53		/**
54		* Query string
55		*
56		* @var string
57		*/
58		public $query_string;
59		/**
60		* Where request came from, not necessary real IP of client, `127.0.0.1` by default
61		*
62		* @var string
63		*/
64		public $remote_addr;
65		/**
66		* The best guessed IP of client (based on all known headers), `$this->remote_addr` by default
67		*
68		* @var string
69		*/
70		public $ip;
71		/**
72		* Headers are normalized to lowercase keys with hyphen as separator, for instance: `connection`, `referer`, `content-type`, `accept-language`
73		*
74		* @var string[]
75		*/
76		public $headers;
77		/**
78		* @var bool
79		*/
80		protected $cli;
81		/**
82		* @param string[] $server Typically `$_SERVER`
83		*/
84	34	function init_server ($server = []) {
85	34	$this->fill_headers($server);
86		/**
87		* Add some defaults to avoid isset() hell afterwards
88		*/
89		$server += [
90	34	'QUERY_STRING' => '',
91		'REMOTE_ADDR' => '127.0.0.1',
92		'REQUEST_URI' => '/',
93		'REQUEST_METHOD' => 'GET',
94		'SERVER_PROTOCOL' => 'HTTP/1.1'
95		];
96	34	$this->fill_server_properties($server);
97	34	}
98		/**
99		* @param string[] $server
100		*/
101	34	protected function fill_server_properties ($server) {
102	34	$this->cli = @$server['CLI'] === true;
103	34	$this->method = strtoupper($server['REQUEST_METHOD']);
104	34	$this->host = $this->host($server);
105	34	$this->secure = $this->secure($server);
106	34	$this->scheme = $this->secure ? 'https' : 'http';
107	34	$this->protocol = $server['SERVER_PROTOCOL'];
108	34	$this->query_string = $server['QUERY_STRING'];
109	34	$this->uri = null_byte_filter(urldecode($server['REQUEST_URI'])) ?: '/';
110	34	if (strpos($this->uri, '/index.php') === 0) {
111	2	$this->uri = substr($this->uri, 10);
112		}
113	34	$this->path = explode('?', $this->uri, 2)[0];
114	34	$this->remote_addr = $server['REMOTE_ADDR'];
115	34	$this->ip = $this->ip($server);
116	34	}
117		/**
118		* @param string[] $server
119		*/
120	34	protected function fill_headers ($server) {
121	34	$headers = [];
122	34	foreach ($server as $header => $header_content) {
123	34	if (strpos($header, 'HTTP_') === 0) {
124	34	$header = substr($header, 5);
125	34	} elseif (strpos($header, 'CONTENT_') !== 0) {
126	34	continue;
127		}
128	34	$header = strtolower(str_replace('_', '-', $header));
129	34	$headers[$header] = $header_content;
130		}
131	34	$this->headers = $headers;
132	34	}
133		/**
134		* The best guessed IP of client (based on all known headers), `127.0.0.1` by default
135		*
136		* @param string[] $server
137		*
138		* @return string
139		*/
140	34	protected function ip ($server) {
141		$all_possible_keys = [
142	34	'HTTP_X_FORWARDED_FOR',
143		'HTTP_CLIENT_IP',
144		'HTTP_X_FORWARDED',
145		'HTTP_X_CLUSTER_CLIENT_IP',
146		'HTTP_FORWARDED_FOR',
147		'HTTP_FORWARDED'
148		];
149	34	foreach ($all_possible_keys as $key) {
150	34	if (isset($server[$key])) {
151	2	$ip = trim(explode(',', $server[$key])[0]);
152	2	if (filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_NO_PRIV_RANGE \| FILTER_FLAG_NO_RES_RANGE)) {
153	34	return $ip;
154		}
155		}
156		}
157	34	return $this->remote_addr;
158		}
159		/**
160		* The best guessed host
161		*
162		* @param string[] $server
163		*
164		* @return string
165		*/
166	34	protected function host ($server) {
167	34	$host = @$server['SERVER_NAME'] ?: '';
168	34	$port = '';
169	34	$expected_port = $this->secure ? 443 : 80;
170	34	if (!$host && isset($server['HTTP_X_FORWARDED_HOST'])) {
171	2	$host = $server['HTTP_X_FORWARDED_HOST'];
172		if (
173	2	isset($server['HTTP_X_FORWARDED_PORT']) &&
174	2	$server['HTTP_X_FORWARDED_PORT'] != $expected_port
175		) {
176	2	$port = (int)$server['HTTP_X_FORWARDED_PORT'];
177		}
178	34	} elseif (isset($server['HTTP_HOST'])) {
179		/** @noinspection NotOptimalIfConditionsInspection */
180	34	if (!$host \|\| filter_var($host, FILTER_VALIDATE_IP)) {
181	2	$host = $server['HTTP_HOST'];
182	34	} elseif (strpos($server['HTTP_HOST'], ':') !== false) {
183	2	$port = (int)explode(':', $server['HTTP_HOST'])[1];
184	2	if ($port == $expected_port) {
185	2	$port = '';
186		}
187		}
188		}
189	34	if (preg_replace('/(?:^\[)?[a-zA-Z0-9-:\]_]+\.?/', '', $host) !== '') {
190	2	return '';
191		}
192	34	return $host.($port ? ":$port" : '');
193		}
194		/**
195		* Secure protocol detection
196		*
197		* @param array $server
198		*
199		* @return bool
200		*/
201	34	protected function secure ($server) {
202	34	return @$server['HTTPS'] ? $server['HTTPS'] !== 'off' : (
203	34	@$server['REQUEST_SCHEME'] === 'https' \|\|
204	34	@$server['HTTP_X_FORWARDED_PROTO'] === 'https'
205		);
206		}
207		/**
208		* Get header by name
209		*
210		* @param string $name Case-insensitive
211		*
212		* @return string Header content if exists or empty string otherwise
213		*/
214	46	function header ($name) {
215	46	$name = strtolower($name);
216	46	return isset($this->headers[$name]) ? $this->headers[$name] : '';
217		}
218		}
219

nazar-pc / CleverStyle-Framework

Push — master ( fcbcfe...f20db1 )

Server::ip() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like