QueryGateway::getInstanceParams() - Code Metrics - dedicated-panel/dedipanel - Measure and Improve Code Quality continuously with Scrutinizer

QueryGateway::getInstanceParams() A
last analyzed 2016-08-19 23:54 UTC

↳ Parent: QueryGateway

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	13
rs	9.4285
cc	1
eloc	9
nc	1
nop	1

<?php

/**
 * This file is part of Dedipanel project
 *
 * (c) 2010-2015 Dedipanel <http://www.dedicated-panel.net>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace DP\VoipServer\TeamspeakServerBundle\ServerQuery;

use DP\Core\CoreBundle\Exception\MaxSlotsLimitReachedException;
use DP\Core\CoreBundle\Exception\PortAlreadyInUseException;
use DP\Core\CoreBundle\Socket\Exception\SocketException;
use DP\VoipServer\TeamspeakServerBundle\Entity\TeamspeakServerInstance;
use DP\Core\CoreBundle\Exception\MaxServerException;
use DP\VoipServer\VoipServerBundle\Exception\OfflineServerException;
use DP\Core\CoreBundle\Exception\IPBannedException;

class QueryGateway
{
    /** @var TeamSpeak3_Adapter_ServerQuery */
    private $query;
    /** @var string $user */
    private $user;
    /** @var string $pass */
    private $pass;
    /** @var boolean $online */
    private $online;
    /** @var boolean $connected */
    private $connected = false;


    /**
     * @param integer $port
     * @param string $user
     * @param string $pass
     */
    public function __construct($host, $port, $user, $pass, $timeout = 1)
    {
        $this->user = $user;
        $this->pass = $pass;

        try {
            $uri  = 'serverquery://' . $host . ':' . $port;
            $uri .= '?timeout=' . $timeout . '&use_offline_as_virtual=1#no_query_clients';
            $this->query = \TeamSpeak3::factory($uri);


            $this->online = true;
        } catch (\TeamSpeak3_Transport_Exception $e) {
            $this->online = false;
        }
    }

    public function login()
    {
        if (!$this->online) {
            throw new OfflineServerException("You need to start the server before log in.");
        }

        try {
            $this->query->login($this->user, $this->pass);

            $this->connected = true;
        }
        catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {
            $matches = [];
            $this->connected = false;

            if (preg_match('#^connection failed, you are banned \(you may retry in ([\d]*) seconds\)$#', $e->getMessage(), $matches) === 1) {

                throw new IPBannedException('Banned from the server for ' . $matches[1] . ' seconds.', $matches[1]);
            }
        }

        return $this->connected;
    }

    public function createInstance(TeamspeakServerInstance $instance)
    {
        $this->needConnected();

        $params = $this->getInstanceParams($instance);

        try {
            $details = $this->query->serverCreate($params);
        }
        catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {
            $message = $e->getMessage();

            if ('virtualserver limit reached' === $message) {
                throw new MaxServerException;
            }
            elseif ('unable to bind network port' === $message) {
                throw new PortAlreadyInUseException;
            }
            elseif ('max slot limit reached' === $message) {
                throw new MaxSlotsLimitReachedException;
            }

            return false;
        }

        return $details;
    }

    public function deleteInstance($sid)
    {
        $this->needConnected();

        /** @var \TeamSpeak3_Node_Server $instance */
        $instance = $this->getInstance($sid);

        if ($instance->isOnline()) {
            $instance->stop();
        }

        // Need to unselect the current virtual server
        // before deleting it
        $this->query->serverDeselect();
        $instance->delete();

        return true;
    }

    public function getInstanceList()
    {
        return $this->query->serverList();
    }

    public function startInstance($sid)
    {
        $this->needConnected();

        return $this->query->serverStart($sid);
    }

    public function stopInstance($sid)
    {
        $this->needConnected();

        return $this->query->serverStop($sid);
    }

    /**
     * @param integer $sid
     */
    public function restartInstance($sid)
    {
        $this->needConnected();

        $this->stopInstance($sid);

        return $this->startInstance($sid);
    }

    public function isInstanceOnline($sid)
    {
        $this->needConnected();

        try {
            return $this->getInstance($sid)->isOnline();
        } catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {}

        return false;
    }

    public function isInstanceOffline($sid)
    {
        try {
            return $this->getInstance($sid)->isOffline();
        } catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {}

        return true;
    }

    public function getInstance($sid)
    {
        $this->needConnected();

        return $this->query->serverGetById($sid);
    }

    public function updateInstanceConfig(TeamspeakServerInstance $instance)
    {
        $sid    = $instance->getInstanceId();
        $params = $this->getInstanceParams($instance);

        try {
            if ($this->getInstance($sid)->modify($params)) {
                return $this->restartInstance($sid);
            }
        }
        catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {
            $message = $e->getMessage();

            if ('max slot limit reached' === $message) {
                throw new MaxSlotsLimitReachedException;
            }
        }

        return false;
    }

    public function getInstanceParams(TeamspeakServerInstance $instance)
    {
        $params = [
            'virtualserver_name'           => $instance->getFullName(),
            'virtualserver_maxclients'     => $instance->getMaxClients(),
            'virtualserver_autostart'      => intval($instance->isAutostart()),
            'virtualserver_port'           => $instance->getPort(),
            'virtualserver_password'       => $instance->getPassword(),
            'virtualserver_welcomemessage' => $instance->getBanner(),
        ];

        return array_merge($params, $this->getHostButtonParams($instance));
    }

    public function isOnline()
    {
        return $this->online;
    }

    public function isConnected()
    {
        return $this->connected;
    }

    private function needConnected()
    {
        if (!$this->connected && !$this->login()) {
            throw new OfflineServerException("You need to start the server.");
        }
    }

    private function getHostButtonParams(TeamspeakServerInstance $instance)

    {
        return [
            'virtualserver_hostbutton_tooltip' => 'DediPanel',
            'virtualserver_hostbutton_url'     => 'http://www.dedicated-panel.net',
            'virtualserver_hostbutton_gfx_url' => 'http://www.dedicated-panel.net/assets/img/icone/logo-ts.png',
        ];
    }
}


1			<?php
2
3			/**
4			* This file is part of Dedipanel project
5			*
6			* (c) 2010-2015 Dedipanel <http://www.dedicated-panel.net>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace DP\VoipServer\TeamspeakServerBundle\ServerQuery;
13
14			use DP\Core\CoreBundle\Exception\MaxSlotsLimitReachedException;
15			use DP\Core\CoreBundle\Exception\PortAlreadyInUseException;
16			use DP\Core\CoreBundle\Socket\Exception\SocketException;
17			use DP\VoipServer\TeamspeakServerBundle\Entity\TeamspeakServerInstance;
18			use DP\Core\CoreBundle\Exception\MaxServerException;
19			use DP\VoipServer\VoipServerBundle\Exception\OfflineServerException;
20			use DP\Core\CoreBundle\Exception\IPBannedException;
21
22			class QueryGateway
23			{
24			/** @var TeamSpeak3_Adapter_ServerQuery */
25			private $query;
26			/** @var string $user */
27			private $user;
28			/** @var string $pass */
29			private $pass;
30			/** @var boolean $online */
31			private $online;
32			/** @var boolean $connected */
33			private $connected = false;
34
35
36			/**
37			* @param integer $port
38			* @param string $user
39			* @param string $pass
40			*/
41			public function __construct($host, $port, $user, $pass, $timeout = 1)
42			{
43			$this->user = $user;
44			$this->pass = $pass;
45
46			try {
47			$uri = 'serverquery://' . $host . ':' . $port;
48			$uri .= '?timeout=' . $timeout . '&use_offline_as_virtual=1#no_query_clients';
49			$this->query = \TeamSpeak3::factory($uri);
			0 ignored issues – show Documentation Bug introduced 2016-08-19 18:13 UTC by Report Bug Copy Issue Report It seems like `\TeamSpeak3::factory($uri)` of type `object<TeamSpeak3_Adapter_Abstract>` is incompatible with the declared type `object<DP\VoipServer\Tea...k3_Adapter_ServerQuery>` of property `$query`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
50
51			$this->online = true;
52			} catch (\TeamSpeak3_Transport_Exception $e) {
53			$this->online = false;
54			}
55			}
56
57			public function login()
58			{
59			if (!$this->online) {
60			throw new OfflineServerException("You need to start the server before log in.");
61			}
62
63			try {
64			$this->query->login($this->user, $this->pass);
65
66			$this->connected = true;
67			}
68			catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {
69			$matches = [];
70			$this->connected = false;
71
72			if (preg_match('#^connection failed, you are banned \(you may retry in ([\d]*) seconds\)$#', $e->getMessage(), $matches) === 1) {
73
74			throw new IPBannedException('Banned from the server for ' . $matches[1] . ' seconds.', $matches[1]);
75			}
76			}
77
78			return $this->connected;
79			}
80
81			public function createInstance(TeamspeakServerInstance $instance)
82			{
83			$this->needConnected();
84
85			$params = $this->getInstanceParams($instance);
86
87			try {
88			$details = $this->query->serverCreate($params);
89			}
90			catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {
91			$message = $e->getMessage();
92
93			if ('virtualserver limit reached' === $message) {
94			throw new MaxServerException;
95			}
96			elseif ('unable to bind network port' === $message) {
97			throw new PortAlreadyInUseException;
98			}
99			elseif ('max slot limit reached' === $message) {
100			throw new MaxSlotsLimitReachedException;
101			}
102
103			return false;
104			}
105
106			return $details;
107			}
108
109			public function deleteInstance($sid)
110			{
111			$this->needConnected();
112
113			/** @var \TeamSpeak3_Node_Server $instance */
114			$instance = $this->getInstance($sid);
115
116			if ($instance->isOnline()) {
117			$instance->stop();
118			}
119
120			// Need to unselect the current virtual server
121			// before deleting it
122			$this->query->serverDeselect();
123			$instance->delete();
124
125			return true;
126			}
127
128			public function getInstanceList()
129			{
130			return $this->query->serverList();
131			}
132
133			public function startInstance($sid)
134			{
135			$this->needConnected();
136
137			return $this->query->serverStart($sid);
138			}
139
140			public function stopInstance($sid)
141			{
142			$this->needConnected();
143
144			return $this->query->serverStop($sid);
145			}
146
147			/**
148			* @param integer $sid
149			*/
150			public function restartInstance($sid)
151			{
152			$this->needConnected();
153
154			$this->stopInstance($sid);
155
156			return $this->startInstance($sid);
157			}
158
159			public function isInstanceOnline($sid)
160			{
161			$this->needConnected();
162
163			try {
164			return $this->getInstance($sid)->isOnline();
165			} catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {}
166
167			return false;
168			}
169
170			public function isInstanceOffline($sid)
171			{
172			try {
173			return $this->getInstance($sid)->isOffline();
174			} catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {}
175
176			return true;
177			}
178
179			public function getInstance($sid)
180			{
181			$this->needConnected();
182
183			return $this->query->serverGetById($sid);
184			}
185
186			public function updateInstanceConfig(TeamspeakServerInstance $instance)
187			{
188			$sid = $instance->getInstanceId();
189			$params = $this->getInstanceParams($instance);
190
191			try {
192			if ($this->getInstance($sid)->modify($params)) {
193			return $this->restartInstance($sid);
194			}
195			}
196			catch (\TeamSpeak3_Adapter_ServerQuery_Exception $e) {
197			$message = $e->getMessage();
198
199			if ('max slot limit reached' === $message) {
200			throw new MaxSlotsLimitReachedException;
201			}
202			}
203
204			return false;
205			}
206
207			public function getInstanceParams(TeamspeakServerInstance $instance)
208			{
209			$params = [
210			'virtualserver_name' => $instance->getFullName(),
211			'virtualserver_maxclients' => $instance->getMaxClients(),
212			'virtualserver_autostart' => intval($instance->isAutostart()),
213			'virtualserver_port' => $instance->getPort(),
214			'virtualserver_password' => $instance->getPassword(),
215			'virtualserver_welcomemessage' => $instance->getBanner(),
216			];
217
218			return array_merge($params, $this->getHostButtonParams($instance));
219			}
220
221			public function isOnline()
222			{
223			return $this->online;
224			}
225
226			public function isConnected()
227			{
228			return $this->connected;
229			}
230
231			private function needConnected()
232			{
233			if (!$this->connected && !$this->login()) {
234			throw new OfflineServerException("You need to start the server.");
235			}
236			}
237
238			private function getHostButtonParams(TeamspeakServerInstance $instance)
			0 ignored issues – show Unused Code introduced 2016-08-19 18:13 UTC by Report Bug Copy Issue Report The parameter `$instance` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
239			{
240			return [
241			'virtualserver_hostbutton_tooltip' => 'DediPanel',
242			'virtualserver_hostbutton_url' => 'http://www.dedicated-panel.net',
243			'virtualserver_hostbutton_gfx_url' => 'http://www.dedicated-panel.net/assets/img/icone/logo-ts.png',
244			];
245			}
246			}
247

dedicated-panel / dedipanel

QueryGateway::getInstanceParams() A last analyzed 2016-08-19 23:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

QueryGateway::getInstanceParams() A
last analyzed 2016-08-19 23:54 UTC