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

Completed

Push — master ( bca83a...1ac405 )

by François

created 2016-02-22 10:50 UTC

StatusParser::parseClientList() B

↳ Parent: StatusParser

Complexity

Conditions	3
Paths	3

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	24
rs	8.9713
cc	3
eloc	14
nc	3
nop	1

<?php
/**
 * Copyright 2015 François Kooman <[email protected]>.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace fkooman\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)
    {
        #TITLE,OpenVPN 2.3.9 x86_64-redhat-linux-gnu [SSL (OpenSSL)] [LZO] [EPOLL] [PKCS11] [MH] [IPv6] built on Dec 16 2015

        #TIME,Wed Dec 23 12:52:08 2015,1450875128

        #HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t),Username
        #CLIENT_LIST,fkooman_ziptest,::ffff:91.64.87.183,10.42.42.2,127707,127903,Wed Dec 23 12:49:15 2015,1450874955,UNDEF

        #CLIENT_LIST,sebas_tuxed_SGS6,::ffff:83.83.194.107,10.42.42.3,127229,180419,Wed Dec 23 12:05:28 2015,1450872328,UNDEF

        #HEADER,ROUTING_TABLE,Virtual Address,Common Name,Real Address,Last Ref,Last Ref (time_t)
        #ROUTING_TABLE,10.42.42.2,fkooman_ziptest,::ffff:91.64.87.183,Wed Dec 23 12:52:07 2015,1450875127

        #ROUTING_TABLE,fd00:4242:4242::1000,fkooman_ziptest,::ffff:91.64.87.183,Wed Dec 23 12:50:42 2015,1450875042

        #ROUTING_TABLE,fd00:4242:4242::1001,sebas_tuxed_SGS6,::ffff:83.83.194.107,Wed Dec 23 12:28:53 2015,1450873733

        #ROUTING_TABLE,10.42.42.3,sebas_tuxed_SGS6,::ffff:83.83.194.107,Wed Dec 23 12:50:46 2015,1450875046

        #GLOBAL_STATS,Max bcast/mcast queue length,0
        #END

        // for now, we log all statusData to get a good corpus for writing
        // tests

        //error_log(json_encode($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 === strpos($statusData[$i], 'HEADER,CLIENT_LIST')) {
                $clientListStart = $i;
            }
            if (0 === strpos($statusData[$i], 'HEADER,ROUTING_TABLE')) {
                $routingTableStart = $i;
            }
            if (0 === 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 ($parsedClientList as $key => $value) {
            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)
    {
        #HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t),Username
        #CLIENT_LIST,fkooman_ziptest,::ffff:91.64.87.183,10.42.42.2,127707,127903,Wed Dec 23 12:49:15 2015,1450874955,UNDEF

        #CLIENT_LIST,sebas_tuxed_SGS6,::ffff:83.83.194.107,10.42.42.3,127229,180419,Wed Dec 23 12:05:28 2015,1450872328,UNDEF

        $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)) {
                error_log('duplicate common name, possibly --duplicate-cn enabled in server configuration');
            }
            $parsedClientList[$commonName] = array(
                'common_name' => $commonName,
                'real_address' => $parsedClient[2],
                //'virtual_address' => $parsedClient[3],

                'bytes_in' => intval($parsedClient[4]),
                'bytes_out' => intval($parsedClient[5]),
                'connected_since' => intval($parsedClient[7]),
            );
        }

        return $parsedClientList;
    }

    private static function parseRoutingTable(array $routingTable)
    {
        #HEADER,ROUTING_TABLE,Virtual Address,Common Name,Real Address,Last Ref,Last Ref (time_t)
        #ROUTING_TABLE,10.42.42.2,fkooman_ziptest,::ffff:91.64.87.183,Wed Dec 23 12:52:07 2015,1450875127

        #ROUTING_TABLE,fd00:4242:4242::1000,fkooman_ziptest,::ffff:91.64.87.183,Wed Dec 23 12:50:42 2015,1450875042

        #ROUTING_TABLE,fd00:4242:4242::1001,sebas_tuxed_SGS6,::ffff:83.83.194.107,Wed Dec 23 12:28:53 2015,1450873733

        #ROUTING_TABLE,10.42.42.3,sebas_tuxed_SGS6,::ffff:83.83.194.107,Wed Dec 23 12:50:46 2015,1450875046

        $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 2015 François Kooman <[email protected]>.
4			*
5			* Licensed under the Apache License, Version 2.0 (the "License");
6			* you may not use this file except in compliance with the License.
7			* You may obtain a copy of the License at
8			*
9			* http://www.apache.org/licenses/LICENSE-2.0
10			*
11			* Unless required by applicable law or agreed to in writing, software
12			* distributed under the License is distributed on an "AS IS" BASIS,
13			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14			* See the License for the specific language governing permissions and
15			* limitations under the License.
16			*/
17			namespace fkooman\VPN\Server\OpenVpn;
18
19			/**
20			* Parses the response from the OpenVPN `status 2` command.
21			*
22			* NOTE: The OpenVPN instance MUST NOT have --duplicate-cn in the configuration
23			* as we do not deal with multiple connections with the same CN, due to bugs in
24			* udp6 status report where the client port is not mentioned in the
25			* 'Real Address' column
26			*/
27			class StatusParser
28			{
29			public static function parse(array $statusData)
30			{
31			#TITLE,OpenVPN 2.3.9 x86_64-redhat-linux-gnu [SSL (OpenSSL)] [LZO] [EPOLL] [PKCS11] [MH] [IPv6] built on Dec 16 2015
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `37%` 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...
32			#TIME,Wed Dec 23 12:52:08 2015,1450875128
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `59%` 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...
33			#HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t),Username
34			#CLIENT_LIST,fkooman_ziptest,::ffff:91.64.87.183,10.42.42.2,127707,127903,Wed Dec 23 12:49:15 2015,1450874955,UNDEF
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `73%` 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...
35			#CLIENT_LIST,sebas_tuxed_SGS6,::ffff:83.83.194.107,10.42.42.3,127229,180419,Wed Dec 23 12:05:28 2015,1450872328,UNDEF
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `73%` 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...
36			#HEADER,ROUTING_TABLE,Virtual Address,Common Name,Real Address,Last Ref,Last Ref (time_t)
37			#ROUTING_TABLE,10.42.42.2,fkooman_ziptest,::ffff:91.64.87.183,Wed Dec 23 12:52:07 2015,1450875127
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `70%` 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...
38			#ROUTING_TABLE,fd00:4242:4242::1000,fkooman_ziptest,::ffff:91.64.87.183,Wed Dec 23 12:50:42 2015,1450875042
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `73%` 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...
39			#ROUTING_TABLE,fd00:4242:4242::1001,sebas_tuxed_SGS6,::ffff:83.83.194.107,Wed Dec 23 12:28:53 2015,1450873733
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `73%` 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...
40			#ROUTING_TABLE,10.42.42.3,sebas_tuxed_SGS6,::ffff:83.83.194.107,Wed Dec 23 12:50:46 2015,1450875046
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `70%` 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...
41			#GLOBAL_STATS,Max bcast/mcast queue length,0
42			#END
43
44			// for now, we log all statusData to get a good corpus for writing
45			// tests
46
47			//error_log(json_encode($statusData));
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 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...
48
49			$clientListStart = 0;
50			$routingTableStart = 0;
51			$globalStatsStart = 0;
52
53			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...
54			if (0 === strpos($statusData[$i], 'HEADER,CLIENT_LIST')) {
55			$clientListStart = $i;
56			}
57			if (0 === strpos($statusData[$i], 'HEADER,ROUTING_TABLE')) {
58			$routingTableStart = $i;
59			}
60			if (0 === strpos($statusData[$i], 'GLOBAL_STATS')) {
61			$globalStatsStart = $i;
62			}
63			}
64
65			$parsedClientList = self::parseClientList(array_slice($statusData, $clientListStart, $routingTableStart - $clientListStart));
66			$parsedRoutingTable = self::parseRoutingTable(array_slice($statusData, $routingTableStart, $globalStatsStart - $routingTableStart));
67
68			// merge routing table in client list
69			foreach ($parsedClientList as $key => $value) {
70			if (!array_key_exists($key, $parsedRoutingTable)) {
71			$parsedClientList[$key]['virtual_address'] = array();
72			} else {
73			$parsedClientList[$key]['virtual_address'] = $parsedRoutingTable[$key];
74			}
75			}
76
77			return array_values($parsedClientList);
78			}
79
80			private static function parseClientList(array $clientList)
81			{
82			#HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t),Username
83			#CLIENT_LIST,fkooman_ziptest,::ffff:91.64.87.183,10.42.42.2,127707,127903,Wed Dec 23 12:49:15 2015,1450874955,UNDEF
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `73%` 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...
84			#CLIENT_LIST,sebas_tuxed_SGS6,::ffff:83.83.194.107,10.42.42.3,127229,180419,Wed Dec 23 12:05:28 2015,1450872328,UNDEF
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `73%` 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...
85			$parsedClientList = array();
86			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...
87			$parsedClient = str_getcsv($clientList[$i]);
88			$commonName = $parsedClient[1];
89			if (array_key_exists($commonName, $parsedClientList)) {
90			error_log('duplicate common name, possibly --duplicate-cn enabled in server configuration');
91			}
92			$parsedClientList[$commonName] = array(
93			'common_name' => $commonName,
94			'real_address' => $parsedClient[2],
95			//'virtual_address' => $parsedClient[3],
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `78%` 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...
96			'bytes_in' => intval($parsedClient[4]),
97			'bytes_out' => intval($parsedClient[5]),
98			'connected_since' => intval($parsedClient[7]),
99			);
100			}
101
102			return $parsedClientList;
103			}
104
105			private static function parseRoutingTable(array $routingTable)
106			{
107			#HEADER,ROUTING_TABLE,Virtual Address,Common Name,Real Address,Last Ref,Last Ref (time_t)
108			#ROUTING_TABLE,10.42.42.2,fkooman_ziptest,::ffff:91.64.87.183,Wed Dec 23 12:52:07 2015,1450875127
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `70%` 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...
109			#ROUTING_TABLE,fd00:4242:4242::1000,fkooman_ziptest,::ffff:91.64.87.183,Wed Dec 23 12:50:42 2015,1450875042
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `73%` 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...
110			#ROUTING_TABLE,fd00:4242:4242::1001,sebas_tuxed_SGS6,::ffff:83.83.194.107,Wed Dec 23 12:28:53 2015,1450873733
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `73%` 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...
111			#ROUTING_TABLE,10.42.42.3,sebas_tuxed_SGS6,::ffff:83.83.194.107,Wed Dec 23 12:50:46 2015,1450875046
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-11 12:27 UTC by Report Bug Copy Issue Report `70%` 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...
112			$parsedRoutingTable = array();
113			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...
114			$parsedRoute = str_getcsv($routingTable[$i]);
115			$commonName = $parsedRoute[2];
116			if (!array_key_exists($commonName, $parsedRoutingTable)) {
117			$parsedRoutingTable[$commonName] = array();
118			}
119			$parsedRoutingTable[$commonName][] = $parsedRoute[1];
120			}
121
122			return $parsedRoutingTable;
123			}
124			}
125

eduVPN / vpn-server-api

GitHub Access Token became invalid

Push — master ( bca83a...1ac405 )

StatusParser::parseClientList() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like