RemoteIp::processPattern() - Code Metrics - Inspection of "updated README" - phossa2/session - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 892035...8bad1e )

by Hong

created 2016-10-11 03:12 UTC

RemoteIp::processPattern() A

↳ Parent: RemoteIp

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	16
rs	9.4285
cc	3
eloc	10
nc	3
nop	1

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Session
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Session\Validator;

use Phossa2\Shared\Base\ObjectAbstract;
use Phossa2\Session\Interfaces\ValidatorInterface;

/**
 * RemoteIp
 *
 * Check remote ip is allowed or not
 *
 * @package Phossa2\package
 * @author  Hong Zhang <[email protected]>
 * @see     ObjectAbstract
 * @see     ValidatorInterface
 * @version 2.1.0
 * @since   2.1.0 added
 */
class RemoteIp extends ObjectAbstract implements ValidatorInterface
{
    /**
     * Allowed ip patterns
     *
     * @var    array
     * @access protected
     */
    protected $allowed;

    /**
     * Denied ip patterns
     *
     * @var    array
     * @access protected
     */
    protected $denied;

    /**
     * Inject allowed or denied ip patterns like '216.110.124.0/24' etc.
     *
     * @param  array $denied
     * @param  array $allowed
     * @access protected
     */
    public function __construct(array $denied = [], array $allowed = [])
    {
        $this->allowed = $this->processPattern($allowed);
        $this->denied = $this->processPattern($denied);
    }

    /**
     * {@inheritDoc}
     */
    public function validate()/*# : bool */
// 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);
    }
}
    {
        $ip = $_SERVER['REMOTE_ADDR'];

        // allowed ?
        if ($this->matchIp($ip, $this->allowed)) {
            return true;
        }

        // blocked ?
        if ($this->matchIp($ip, $this->denied)) {
            return false;
        }

        return empty($this->allowed) ? true : false;
    }

    /**
     * Match ip with patterns
     *
     * @param  string $ip
     * @param  array $patterns
     * @return boolean
     * @access protected
     */
    protected function matchIp(/*# string */ $ip, array $patterns)/*# : bool */
    {
        $num = ip2long($ip);
        foreach ($patterns as $pat) {
            if ($num & $pat[1] == $pat[0]) {
                return true;
            }
        }
        return false;
    }

    /**
     * Pre-process ip matching pattern
     *
     * @param  array $patterns
     * @return array
     * @access protected
     */
    protected function processPattern(array $patterns)/*# : array */
    {
        $result = [];
        foreach ($patterns as $pat) {
            $part = explode('/', $pat);
            $addr = ip2long($part[0]);
            $mask = isset($part[1]) ? ((int) $part[1]) : 32;

            // fix
            $mask = $this->getMask($mask);
            $addr = ip2long($addr) & $mask;

            $result[] = [$addr, $mask];
        }
        return $result;
    }

    /**
     * Convert mask length to mask in decimal
     *
     * @param  int $length
     * @return int
     * @access protected
     */
    protected function getMask(/*# int */ $length = 32)/*# : int */
    {
        $bin = substr(str_repeat('1', $length) . str_repeat('0', 32), 0, 32);
        return bindec($bin);
    }
}


1			<?php
2			/**
3			* Phossa Project
4			*
5			* PHP version 5.4
6			*
7			* @category Library
8			* @package Phossa2\Session
9			* @copyright Copyright (c) 2016 phossa.com
10			* @license http://mit-license.org/ MIT License
11			* @link http://www.phossa.com/
12			*/
13			/# declare(strict_types=1); /
14
15			namespace Phossa2\Session\Validator;
16
17			use Phossa2\Shared\Base\ObjectAbstract;
18			use Phossa2\Session\Interfaces\ValidatorInterface;
19
20			/**
21			* RemoteIp
22			*
23			* Check remote ip is allowed or not
24			*
25			* @package Phossa2\package
26			* @author Hong Zhang <[email protected]>
27			* @see ObjectAbstract
28			* @see ValidatorInterface
29			* @version 2.1.0
30			* @since 2.1.0 added
31			*/
32			class RemoteIp extends ObjectAbstract implements ValidatorInterface
33			{
34			/**
35			* Allowed ip patterns
36			*
37			* @var array
38			* @access protected
39			*/
40			protected $allowed;
41
42			/**
43			* Denied ip patterns
44			*
45			* @var array
46			* @access protected
47			*/
48			protected $denied;
49
50			/**
51			* Inject allowed or denied ip patterns like '216.110.124.0/24' etc.
52			*
53			* @param array $denied
54			* @param array $allowed
55			* @access protected
56			*/
57			public function __construct(array $denied = [], array $allowed = [])
58			{
59			$this->allowed = $this->processPattern($allowed);
60			$this->denied = $this->processPattern($denied);
61			}
62
63			/**
64			* {@inheritDoc}
65			*/
66			public function validate()/# : bool /
			1 ignored issue – show Coding Style introduced 2016-10-11 03:14 UTC by Report Bug Copy Issue Report `validate` 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...
67			{
68			$ip = $_SERVER['REMOTE_ADDR'];
69
70			// allowed ?
71			if ($this->matchIp($ip, $this->allowed)) {
72			return true;
73			}
74
75			// blocked ?
76			if ($this->matchIp($ip, $this->denied)) {
77			return false;
78			}
79
80			return empty($this->allowed) ? true : false;
81			}
82
83			/**
84			* Match ip with patterns
85			*
86			* @param string $ip
87			* @param array $patterns
88			* @return boolean
89			* @access protected
90			*/
91			protected function matchIp(/# string / $ip, array $patterns)/# : bool /
92			{
93			$num = ip2long($ip);
94			foreach ($patterns as $pat) {
95			if ($num & $pat[1] == $pat[0]) {
96			return true;
97			}
98			}
99			return false;
100			}
101
102			/**
103			* Pre-process ip matching pattern
104			*
105			* @param array $patterns
106			* @return array
107			* @access protected
108			*/
109			protected function processPattern(array $patterns)/# : array /
110			{
111			$result = [];
112			foreach ($patterns as $pat) {
113			$part = explode('/', $pat);
114			$addr = ip2long($part[0]);
115			$mask = isset($part[1]) ? ((int) $part[1]) : 32;
116
117			// fix
118			$mask = $this->getMask($mask);
119			$addr = ip2long($addr) & $mask;
120
121			$result[] = [$addr, $mask];
122			}
123			return $result;
124			}
125
126			/**
127			* Convert mask length to mask in decimal
128			*
129			* @param int $length
130			* @return int
131			* @access protected
132			*/
133			protected function getMask(/# int / $length = 32)/# : int /
134			{
135			$bin = substr(str_repeat('1', $length) . str_repeat('0', 32), 0, 32);
136			return bindec($bin);
137			}
138			}
139

phossa2 / session

Push — master ( 892035...8bad1e )

RemoteIp::processPattern() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like