ServerQuery.php

Go to the documentation of this file.

<?php
 
namespace PlanetTeamSpeak\TeamSpeak3Framework\Adapter;
 
use PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event;
use PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Reply;
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\AdapterException;
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\ServerQueryException;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\Profiler;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper;
use PlanetTeamSpeak\TeamSpeak3Framework\Node\Host;
use PlanetTeamSpeak\TeamSpeak3Framework\Node\Node;
use PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3;
use PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport;

class ServerQuery extends Adapter
{
    protected ?Host $host = null;

    protected ?int $timer = null;

    protected int $count = 0;

    protected array $block = ["help"];

    protected function syn(): void
    {
        $this->initTransport($this->options);
        $this->transport->setAdapter($this);
 
        Profiler::init(spl_object_hash($this));
 
        $rdy = $this->getTransport()->readLine();
 
        if (!$rdy->startsWith(TeamSpeak3::TS3_PROTO_IDENT) && !$rdy->startsWith(TeamSpeak3::TEA_PROTO_IDENT) && !(defined("CUSTOM_PROTO_IDENT") && $rdy->startsWith(CUSTOM_PROTO_IDENT))) {
            throw new AdapterException("invalid reply from the server (" . $rdy . ")");
        }
 
        Signal::getInstance()->emit("serverqueryConnected", $this);
    }

    public function __destruct()
    {
        // do not disconnect, when acting as bot in non-blocking mode
        if (! $this->getTransport()->getConfig("blocking")) {
            return;
        }
 
        if ($this->getTransport() instanceof Transport && $this->transport->isConnected()) {
            try {
                $this->request("quit");
            } catch (AdapterException) {
                return;
            }
        }
    }

    public function request(string $cmd, bool $throw = true): Reply
    {
        $query = StringHelper::factory($cmd)->section(TeamSpeak3::SEPARATOR_CELL);
 
        if (strstr($cmd, "\r") || strstr($cmd, "\n")) {
            throw new AdapterException("illegal characters in command '" . $query . "'");
        } elseif (in_array($query, $this->block)) {
            throw new ServerQueryException("command not found", 0x100);
        }
 
        Signal::getInstance()->emit("serverqueryCommandStarted", $cmd);
 
        $this->getProfiler()->start();
        $this->getTransport()->sendLine($cmd);
        $this->timer = time();
        $this->count++;
 
        $rpl = [];
 
        do {
            if (! $this->getTransport()->isConnected()) {
                break;
            }
            $str = $this->getTransport()->readLine();
            $rpl[] = $str;
        } while ($str->section(TeamSpeak3::SEPARATOR_CELL) != TeamSpeak3::ERROR);
 
        $this->getProfiler()->stop();
 
        $reply = new Reply($rpl, $cmd, $this->getHost(), $throw);
 
        Signal::getInstance()->emit("serverqueryCommandFinished", $cmd, $reply);
 
        return $reply;
    }

    public function wait(): Event
    {
        if ($this->getTransport()->getConfig("blocking")) {
            throw new AdapterException("only available in non-blocking mode");
        }
 
        do {
            if (! $this->getTransport()->isConnected()) {
                break;
            }
            $evt = $this->getTransport()->readLine();
        } while (!$evt->section(TeamSpeak3::SEPARATOR_CELL)->startsWith(TeamSpeak3::EVENT));
 
        return new Event($evt, $this->getHost());
    }

    public function prepare(string $cmd, array $params = []): string
    {
        $args = [];
        $cells = [];
 
        foreach ($params as $ident => $value) {
            $ident = is_numeric($ident) ? "" : strtolower($ident) . TeamSpeak3::SEPARATOR_PAIR;
 
            if (is_array($value)) {
                $value = array_values($value);
 
                for ($i = 0; $i < count($value); $i++) {
                    if ($value[$i] === null) {
                        continue;
                    } elseif ($value[$i] === false) {
                        $value[$i] = 0x00;
                    } elseif ($value[$i] === true) {
                        $value[$i] = 0x01;
                    } elseif ($value[$i] instanceof Node) {
                        $value[$i] = $value[$i]->getId();
                    }
 
                    $cells[$i][] = $ident . StringHelper::factory($value[$i])->escape()->toUtf8();
                }
            } else {
                if ($value === null) {
                    continue;
                } elseif ($value === false) {
                    $value = 0x00;
                } elseif ($value === true) {
                    $value = 0x01;
                } elseif ($value instanceof Node) {
                    $value = $value->getId();
                }
 
                $args[] = $ident . StringHelper::factory($value)->escape()->toUtf8();
            }
        }
 
        foreach (array_keys($cells) as $ident) {
            $cells[$ident] = implode(TeamSpeak3::SEPARATOR_CELL, $cells[$ident]);
        }
 
        if (count($args)) {
            $cmd .= " " . implode(TeamSpeak3::SEPARATOR_CELL, $args);
        }
        if (count($cells)) {
            $cmd .= " " . implode(TeamSpeak3::SEPARATOR_LIST, $cells);
        }
 
        return trim($cmd);
    }

    public function getQueryLastTimestamp(): ?int
    {
        return $this->timer;
    }

    public function getQueryCount(): int
    {
        return $this->count;
    }

    public function getQueryRuntime(): float
    {
        return $this->getProfiler()->getRuntime();
    }

    public function getHost(): ?Host
    {
        if ($this->host === null) {
            $this->host = new Host($this);
        }
 
        return $this->host;
    }
}