ServerManager::toPort() - Code Metrics - eduVPN/vpn-server-api - Measure and Improve Code Quality continuously with Scrutinizer

ServerManager::toPort() A
last analyzed 2017-07-23 14:51 UTC

↳ Parent: ServerManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	1
eloc	2
nc	1
nop	3

<?php

/**
 * eduVPN - End-user friendly VPN.
 *
 * Copyright: 2016-2017, The Commons Conservancy eduVPN Programme
 * SPDX-License-Identifier: AGPL-3.0+
 */

namespace SURFnet\VPN\Server\OpenVpn;

use Psr\Log\LoggerInterface;
use SURFnet\VPN\Common\Config;
use SURFnet\VPN\Common\ProfileConfig;
use SURFnet\VPN\Server\OpenVpn\Exception\ManagementSocketException;

/**
 * Manage all OpenVPN processes controlled by this service.
 */
class ServerManager
{
    /** @var \SURFnet\VPN\Common\Config */
    private $config;

    /** @var ManagementSocketInterface */
    private $managementSocket;

    /** @var \Psr\Log\LoggerInterface */
    private $logger;

    public function __construct(Config $config, ManagementSocketInterface $managementSocket, LoggerInterface $logger)
    {
        $this->config = $config;
        $this->managementSocket = $managementSocket;
        $this->logger = $logger;
    }

    /**
     * Get the connection information about connected clients.
     */
    public function connections()
    {
        $clientConnections = [];
        $instanceNumber = $this->config->getItem('instanceNumber');

        // loop over all profiles
        foreach (array_keys($this->config->getSection('vpnProfiles')->toArray()) as $profileId) {
            $profileConfig = new ProfileConfig($this->config->getSection('vpnProfiles')->getSection($profileId)->toArray());
            $managementIp = $profileConfig->getItem('managementIp');
            $profileNumber = $profileConfig->getItem('profileNumber');

            $profileConnections = [];
            // loop over all processes
            for ($i = 0; $i < count($profileConfig->getItem('vpnProtoPorts')); ++$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
}
                // add all connections from this instance to profileConnections
                try {
                    // open the socket connection
                    $this->managementSocket->open(
                        sprintf(
                            'tcp://%s:%d',
                            $managementIp,
                            11940 + $this->toPort($instanceNumber, $profileNumber, $i)
                        )
                    );
                    $profileConnections = array_merge(
                        $profileConnections,
                        StatusParser::parse($this->managementSocket->command('status 2'))
                    );
                    // close the socket connection
                    $this->managementSocket->close();
                } catch (ManagementSocketException $e) {
                    // we log the error, but continue with the next instance
                    $this->logger->error(
                        sprintf(
                            'error with socket "tcp://%s:%d", message: "%s"',
                            $managementIp,
                            11940 + $this->toPort($instanceNumber, $profileNumber, $i),
                            $e->getMessage()
                        )
                    );
                }
            }
            // we add the profileConnections to the clientConnections array
            $clientConnections[] = ['id' => $profileId, 'connections' => $profileConnections];
        }

        return $clientConnections;
    }

    /**
     * Disconnect all clients with this CN from all profiles and instances
     * managed by this service.
     *
     * @param string $commonName the CN to kill
     */
    public function kill($commonName)
    {
        $clientsKilled = 0;
        $instanceNumber = $this->config->getItem('instanceNumber');

        // loop over all profiles
        foreach (array_keys($this->config->getSection('vpnProfiles')->toArray()) as $profileId) {
            $profileConfig = new ProfileConfig($this->config->getSection('vpnProfiles')->getSection($profileId)->toArray());
            $managementIp = $profileConfig->getItem('managementIp');
            $profileNumber = $profileConfig->getItem('profileNumber');

            // loop over all processes
            for ($i = 0; $i < count($profileConfig->getItem('vpnProtoPorts')); ++$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
}
                // add all kills from this instance to profileKills
                try {
                    // open the socket connection
                    $this->managementSocket->open(
                        sprintf(
                            'tcp://%s:%d',
                            $managementIp,
                            11940 + $this->toPort($instanceNumber, $profileNumber, $i)
                        )
                    );

                    $response = $this->managementSocket->command(sprintf('kill %s', $commonName));
                    if (0 === mb_strpos($response[0], 'SUCCESS: ')) {
                        ++$clientsKilled;
                    }
                    // close the socket connection
                    $this->managementSocket->close();
                } catch (ManagementSocketException $e) {
                    // we log the error, but continue with the next instance
                    $this->logger->error(
                        sprintf(
                            'error with socket "tcp://%s:%d", message: "%s"',
                            $managementIp,
                            11940 + $this->toPort($instanceNumber, $profileNumber, $i),
                            $e->getMessage()
                        )
                    );
                }
            }
        }

        return 0 !== $clientsKilled;
    }

    private function toPort($instanceNumber, $profileNumber, $processNumber)
    {
        // convert an instanceNumber, $profileNumber and $processNumber to a management port

        // instanceId = 6 bits (max 64)
        // profileNumber = 4 bits (max 16)
        // processNumber = 4 bits  (max 16)
        return ($instanceNumber - 1 << 8) | ($profileNumber - 1 << 4) | ($processNumber);
    }
}


1			<?php
2
3			/**
4			* eduVPN - End-user friendly VPN.
5			*
6			* Copyright: 2016-2017, The Commons Conservancy eduVPN Programme
7			* SPDX-License-Identifier: AGPL-3.0+
8			*/
9
10			namespace SURFnet\VPN\Server\OpenVpn;
11
12			use Psr\Log\LoggerInterface;
13			use SURFnet\VPN\Common\Config;
14			use SURFnet\VPN\Common\ProfileConfig;
15			use SURFnet\VPN\Server\OpenVpn\Exception\ManagementSocketException;
16
17			/**
18			* Manage all OpenVPN processes controlled by this service.
19			*/
20			class ServerManager
21			{
22			/** @var \SURFnet\VPN\Common\Config */
23			private $config;
24
25			/** @var ManagementSocketInterface */
26			private $managementSocket;
27
28			/** @var \Psr\Log\LoggerInterface */
29			private $logger;
30
31			public function __construct(Config $config, ManagementSocketInterface $managementSocket, LoggerInterface $logger)
32			{
33			$this->config = $config;
34			$this->managementSocket = $managementSocket;
35			$this->logger = $logger;
36			}
37
38			/**
39			* Get the connection information about connected clients.
40			*/
41			public function connections()
42			{
43			$clientConnections = [];
44			$instanceNumber = $this->config->getItem('instanceNumber');
45
46			// loop over all profiles
47			foreach (array_keys($this->config->getSection('vpnProfiles')->toArray()) as $profileId) {
48			$profileConfig = new ProfileConfig($this->config->getSection('vpnProfiles')->getSection($profileId)->toArray());
49			$managementIp = $profileConfig->getItem('managementIp');
50			$profileNumber = $profileConfig->getItem('profileNumber');
51
52			$profileConnections = [];
53			// loop over all processes
54			for ($i = 0; $i < count($profileConfig->getItem('vpnProtoPorts')); ++$i) {
			0 ignored issues – show Performance Best Practice introduced 2017-05-13 14:37 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` 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...
55			// add all connections from this instance to profileConnections
56			try {
57			// open the socket connection
58			$this->managementSocket->open(
59			sprintf(
60			'tcp://%s:%d',
61			$managementIp,
62			11940 + $this->toPort($instanceNumber, $profileNumber, $i)
63			)
64			);
65			$profileConnections = array_merge(
66			$profileConnections,
67			StatusParser::parse($this->managementSocket->command('status 2'))
68			);
69			// close the socket connection
70			$this->managementSocket->close();
71			} catch (ManagementSocketException $e) {
72			// we log the error, but continue with the next instance
73			$this->logger->error(
74			sprintf(
75			'error with socket "tcp://%s:%d", message: "%s"',
76			$managementIp,
77			11940 + $this->toPort($instanceNumber, $profileNumber, $i),
78			$e->getMessage()
79			)
80			);
81			}
82			}
83			// we add the profileConnections to the clientConnections array
84			$clientConnections[] = ['id' => $profileId, 'connections' => $profileConnections];
85			}
86
87			return $clientConnections;
88			}
89
90			/**
91			* Disconnect all clients with this CN from all profiles and instances
92			* managed by this service.
93			*
94			* @param string $commonName the CN to kill
95			*/
96			public function kill($commonName)
97			{
98			$clientsKilled = 0;
99			$instanceNumber = $this->config->getItem('instanceNumber');
100
101			// loop over all profiles
102			foreach (array_keys($this->config->getSection('vpnProfiles')->toArray()) as $profileId) {
103			$profileConfig = new ProfileConfig($this->config->getSection('vpnProfiles')->getSection($profileId)->toArray());
104			$managementIp = $profileConfig->getItem('managementIp');
105			$profileNumber = $profileConfig->getItem('profileNumber');
106
107			// loop over all processes
108			for ($i = 0; $i < count($profileConfig->getItem('vpnProtoPorts')); ++$i) {
			0 ignored issues – show Performance Best Practice introduced 2017-05-13 14:37 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` 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...
109			// add all kills from this instance to profileKills
110			try {
111			// open the socket connection
112			$this->managementSocket->open(
113			sprintf(
114			'tcp://%s:%d',
115			$managementIp,
116			11940 + $this->toPort($instanceNumber, $profileNumber, $i)
117			)
118			);
119
120			$response = $this->managementSocket->command(sprintf('kill %s', $commonName));
121			if (0 === mb_strpos($response[0], 'SUCCESS: ')) {
122			++$clientsKilled;
123			}
124			// close the socket connection
125			$this->managementSocket->close();
126			} catch (ManagementSocketException $e) {
127			// we log the error, but continue with the next instance
128			$this->logger->error(
129			sprintf(
130			'error with socket "tcp://%s:%d", message: "%s"',
131			$managementIp,
132			11940 + $this->toPort($instanceNumber, $profileNumber, $i),
133			$e->getMessage()
134			)
135			);
136			}
137			}
138			}
139
140			return 0 !== $clientsKilled;
141			}
142
143			private function toPort($instanceNumber, $profileNumber, $processNumber)
144			{
145			// convert an instanceNumber, $profileNumber and $processNumber to a management port
146
147			// instanceId = 6 bits (max 64)
148			// profileNumber = 4 bits (max 16)
149			// processNumber = 4 bits (max 16)
150			return ($instanceNumber - 1 << 8) \| ($profileNumber - 1 << 4) \| ($processNumber);
151			}
152			}
153

eduVPN / vpn-server-api

GitHub Access Token became invalid

ServerManager::toPort() A last analyzed 2017-07-23 14:51 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ServerManager::toPort() A
last analyzed 2017-07-23 14:51 UTC