StatusParser::parseClientList() - Code Metrics - Inspection of "fix totp_log" - eduVPN/vpn-server-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6c4153...d181b6 )

by François

created 2016-11-29 21:58 UTC

StatusParser::parseClientList() A

↳ Parent: StatusParser

Complexity

Conditions	4
Paths	5

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.2
c	0
b	0
f	0
cc	4
eloc	10
nc	5
nop	1

<?php
/**
 *  Copyright (C) 2016 SURFnet.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace SURFnet\VPN\Server\OpenVpn;

/**
 * Parses the response from the OpenVPN `status 2` command.
 *
 * NOTE: The OpenVPN instance MUST NOT have --duplicate-cn in the configuration
 * as we do not deal with multiple connections with the same CN, due to bugs in
 * udp6 status report where the client port is not mentioned in the
 * 'Real Address' column
 */
class StatusParser
{
    public static function parse(array $statusData)
    {
        $clientListStart = 0;
        $routingTableStart = 0;
        $globalStatsStart = 0;

        for ($i = 0; $i < sizeof($statusData); ++$i) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            if (0 === mb_strpos($statusData[$i], 'HEADER,CLIENT_LIST')) {
                $clientListStart = $i;
            }
            if (0 === mb_strpos($statusData[$i], 'HEADER,ROUTING_TABLE')) {
                $routingTableStart = $i;
            }
            if (0 === mb_strpos($statusData[$i], 'GLOBAL_STATS')) {
                $globalStatsStart = $i;
            }
        }

        $parsedClientList = self::parseClientList(array_slice($statusData, $clientListStart, $routingTableStart - $clientListStart));
        $parsedRoutingTable = self::parseRoutingTable(array_slice($statusData, $routingTableStart, $globalStatsStart - $routingTableStart));

        // merge routing table in client list
        foreach (array_keys($parsedClientList) as $key) {
            if (!array_key_exists($key, $parsedRoutingTable)) {
                $parsedClientList[$key]['virtual_address'] = array();
            } else {
                $parsedClientList[$key]['virtual_address'] = $parsedRoutingTable[$key];
            }
        }

        return array_values($parsedClientList);
    }

    private static function parseClientList(array $clientList)
    {
        $parsedClientList = array();
        for ($i = 1; $i < sizeof($clientList); ++$i) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $parsedClient = str_getcsv($clientList[$i]);
            $commonName = $parsedClient[1];
            if (array_key_exists($commonName, $parsedClientList)) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
                //syslog(LOG_ERR('duplicate common name, possibly --duplicate-cn enabled in server configuration'));

            }
            $parsedClientList[$commonName] = array(
                'common_name' => $commonName,
                'proto' => 3 === substr_count($parsedClient[2], '.') ? 4 : 6,
            );
        }

        return $parsedClientList;
    }

    private static function parseRoutingTable(array $routingTable)
    {
        $parsedRoutingTable = array();
        for ($i = 1; $i < sizeof($routingTable); ++$i) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $parsedRoute = str_getcsv($routingTable[$i]);
            $commonName = $parsedRoute[2];
            if (!array_key_exists($commonName, $parsedRoutingTable)) {
                $parsedRoutingTable[$commonName] = array();
            }
            $parsedRoutingTable[$commonName][] = $parsedRoute[1];
        }

        return $parsedRoutingTable;
    }
}


1			<?php
2			/**
3			* Copyright (C) 2016 SURFnet.
4			*
5			* This program is free software: you can redistribute it and/or modify
6			* it under the terms of the GNU Affero General Public License as
7			* published by the Free Software Foundation, either version 3 of the
8			* License, or (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU Affero General Public License for more details.
14			*
15			* You should have received a copy of the GNU Affero General Public License
16			* along with this program. If not, see <http://www.gnu.org/licenses/>.
17			*/
18
19			namespace SURFnet\VPN\Server\OpenVpn;
20
21			/**
22			* Parses the response from the OpenVPN `status 2` command.
23			*
24			* NOTE: The OpenVPN instance MUST NOT have --duplicate-cn in the configuration
25			* as we do not deal with multiple connections with the same CN, due to bugs in
26			* udp6 status report where the client port is not mentioned in the
27			* 'Real Address' column
28			*/
29			class StatusParser
30			{
31			public static function parse(array $statusData)
32			{
33			$clientListStart = 0;
34			$routingTableStart = 0;
35			$globalStatsStart = 0;
36
37			for ($i = 0; $i < sizeof($statusData); ++$i) {
			0 ignored issues – show Performance Best Practice introduced 2015-12-27 23:56 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `sizeof()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
38			if (0 === mb_strpos($statusData[$i], 'HEADER,CLIENT_LIST')) {
39			$clientListStart = $i;
40			}
41			if (0 === mb_strpos($statusData[$i], 'HEADER,ROUTING_TABLE')) {
42			$routingTableStart = $i;
43			}
44			if (0 === mb_strpos($statusData[$i], 'GLOBAL_STATS')) {
45			$globalStatsStart = $i;
46			}
47			}
48
49			$parsedClientList = self::parseClientList(array_slice($statusData, $clientListStart, $routingTableStart - $clientListStart));
50			$parsedRoutingTable = self::parseRoutingTable(array_slice($statusData, $routingTableStart, $globalStatsStart - $routingTableStart));
51
52			// merge routing table in client list
53			foreach (array_keys($parsedClientList) as $key) {
54			if (!array_key_exists($key, $parsedRoutingTable)) {
55			$parsedClientList[$key]['virtual_address'] = array();
56			} else {
57			$parsedClientList[$key]['virtual_address'] = $parsedRoutingTable[$key];
58			}
59			}
60
61			return array_values($parsedClientList);
62			}
63
64			private static function parseClientList(array $clientList)
65			{
66			$parsedClientList = array();
67			for ($i = 1; $i < sizeof($clientList); ++$i) {
			0 ignored issues – show Performance Best Practice introduced 2015-12-27 23:56 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `sizeof()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
68			$parsedClient = str_getcsv($clientList[$i]);
69			$commonName = $parsedClient[1];
70			if (array_key_exists($commonName, $parsedClientList)) {
			0 ignored issues – show Unused Code introduced 2016-02-22 11:11 UTC by Report Bug Copy Issue Report This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
71			//syslog(LOG_ERR('duplicate common name, possibly --duplicate-cn enabled in server configuration'));
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-22 11:11 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
72			}
73			$parsedClientList[$commonName] = array(
74			'common_name' => $commonName,
75			'proto' => 3 === substr_count($parsedClient[2], '.') ? 4 : 6,
76			);
77			}
78
79			return $parsedClientList;
80			}
81
82			private static function parseRoutingTable(array $routingTable)
83			{
84			$parsedRoutingTable = array();
85			for ($i = 1; $i < sizeof($routingTable); ++$i) {
			0 ignored issues – show Performance Best Practice introduced 2015-12-27 23:56 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `sizeof()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
86			$parsedRoute = str_getcsv($routingTable[$i]);
87			$commonName = $parsedRoute[2];
88			if (!array_key_exists($commonName, $parsedRoutingTable)) {
89			$parsedRoutingTable[$commonName] = array();
90			}
91			$parsedRoutingTable[$commonName][] = $parsedRoute[1];
92			}
93
94			return $parsedRoutingTable;
95			}
96			}
97

eduVPN / vpn-server-api

GitHub Access Token became invalid

Push — master ( 6c4153...d181b6 )

StatusParser::parseClientList() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like