DP\VoipServer\TeamspeakServerBundle\ServerQuery\QueryGateway

Complexity

Total Complexity

33

Size/Duplication

Total Lines	225
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	1
Bugs	1	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	2
B	login()	0	23	4
B	createInstance()	0	27	5
A	deleteInstance()	0	18	2
A	getInstanceList()	0	4	1
A	startInstance()	0	6	1
A	stopInstance()	0	6	1
A	restartInstance()	0	8	1
A	isInstanceOnline()	0	10	2
A	isInstanceOffline()	0	8	2
A	getInstance()	0	6	1
A	updateInstanceConfig()	0	20	4
A	getInstanceParams()	0	13	1
A	isOnline()	0	4	1
A	isConnected()	0	4	1
A	needConnected()	0	6	3
A	getHostButtonParams()	0	8	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);

It seems like \TeamSpeak3::factory($uri) of type object<TeamSpeak3_Adapter_Abstract> is incompatible with the declared type object<DP\VoipServer\TeamspeakServerBundle\ServerQuery\TeamSpeak3_Adapter_ServerQuery> of property $query.

            $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)

The parameter $instance is not used and could be removed.

    {
        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',
        ];
    }
}