Client.php

Go to the documentation of this file.

<?php
 
namespace PlanetTeamSpeak\TeamSpeak3Framework\Node;
 
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\AdapterException;
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\HelperException;
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\ServerQueryException;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper;
use PlanetTeamSpeak\TeamSpeak3Framework\TeamSpeak3;

class Client extends Node
{
    public function __construct(Server $server, array $info, string $index = "clid")
    {
        $this->parent = $server;
        $this->nodeInfo = $info;
 
        if (!array_key_exists($index, $this->nodeInfo)) {
            throw new ServerQueryException("invalid clientID", 0x200);
        }
 
        $this->nodeId = $this->nodeInfo[$index];
    }

    public function modify(array $properties): void
    {
        $properties["clid"] = $this->getId();
 
        $this->execute("clientedit", $properties);
        $this->resetNodeInfo();
    }

    public function modifyDb(array $properties): void
    {
        $this->getParent()->clientModifyDb($this["client_database_id"], $properties);
    }

    public function deleteDb(): void
    {
        $this->getParent()->clientDeleteDb($this["client_database_id"]);
    }

    public function infoDb(): array
    {
        return $this->getParent()->clientInfoDb($this["client_database_id"]);
    }

    public function message(string $msg): void
    {
        $this->execute("sendtextmessage", ["msg" => $msg, "target" => $this->getId(), "targetmode" => TeamSpeak3::TEXTMSG_CLIENT]);
    }

    public function move(int $cid, string $cpw = null): void
    {
        $this->getParent()->clientMove($this->getId(), $cid, $cpw);
    }

    public function kick(int $reasonid = TeamSpeak3::KICK_CHANNEL, string $reasonmsg = null): void
    {
        $this->getParent()->clientKick($this->getId(), $reasonid, $reasonmsg);
    }

    public function poke(string $msg): void
    {
        $this->getParent()->clientPoke($this->getId(), $msg);
    }

    public function ban(int $timeseconds = null, string $reason = null): array
    {
        return $this->getParent()->clientBan($this->getId(), $timeseconds, $reason);
    }

    public function customInfo(): array
    {
        return $this->getParent()->customInfo($this["client_database_id"]);
    }

    public function customSet(string $ident, string $value): void
    {
        $this->getParent()->customSet($this["client_database_id"], $ident, $value);
    }

    public function customDelete(string $ident): void
    {
        $this->getParent()->customDelete($this["client_database_id"], $ident);
    }

    public function permOverview(int $cid): array
    {
        return $this->execute("permoverview", ["cldbid" => $this["client_database_id"], "cid" => $cid, "permid" => 0])->toArray();
    }

    public function permList(bool $permsid = false): array
    {
        return $this->getParent()->clientPermList($this["client_database_id"], $permsid);
    }

    public function permAssign(int|array $permid, int|array $permvalue, array|bool $permskip = false): void
    {
        $this->getParent()->clientPermAssign($this["client_database_id"], $permid, $permvalue, $permskip);
    }

    public function permAssignByName($permname, $permvalue, $permskip = false)
    {
        $this->permAssign($permname, $permvalue, $permskip);
    }

    public function permRemove(int $permid): void
    {
        $this->getParent()->clientPermRemove($this["client_database_id"], $permid);
    }

    public function permRemoveByName($permname)
    {
        $this->permRemove($permname);
    }

    public function setChannelGroup(int $cid, int $cgid): void
    {
        $this->getParent()->clientSetChannelGroup($this["client_database_id"], $cid, $cgid);
    }

    public function addServerGroup(int $sgid): void
    {
        $this->getParent()->serverGroupClientAdd($sgid, $this["client_database_id"]);
    }

    public function remServerGroup(int $sgid): void
    {
        $this->getParent()->serverGroupClientDel($sgid, $this["client_database_id"]);
    }

    public function avatarGetName(): StringHelper
    {
        return new StringHelper("/avatar_" . $this["client_base64HashClientUID"]);
    }

    public function avatarDownload()
    {
        if ($this["client_flag_avatar"] == null) {
            return;
        }
 
        $download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->avatarGetName());
        $transfer = TeamSpeak3::factory("filetransfer://" . (str_contains($download["host"], ":") ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
 
        return $transfer->download($download["ftkey"], $download["size"]);
    }

    public function getClones(): array
    {
        return $this->execute("clientgetids", ["cluid" => $this["client_unique_identifier"]])->toAssocArray("clid");
    }

    public function hasOverwolf(): bool
    {
        return str_contains($this["client_badges"], "overwolf=1");
    }

    public function getBadges(): array
    {
        $badges = [];
 
        foreach (explode(":", $this["client_badges"]) as $set) {
            if (str_starts_with($set, "badges=")) {
                $badges[] = array_map("trim", explode(",", substr($set, 7)));
            }
        }
 
        return $badges;
    }

    public function getRev(): ?int
    {
        return $this["client_type"] ? null : $this["client_version"]->section("[", 1)->filterDigits();
    }

    public function memberOf(): array
    {
        $channelGroups = [$this->getParent()->channelGroupGetById($this["client_channel_group_id"])];
        $serverGroups = [];
 
        foreach (explode(",", $this["client_servergroups"]) as $sgid) {
            $serverGroups[] = $this->getParent()->serverGroupGetById($sgid);
        }
 
        uasort($serverGroups, [__CLASS__, "sortGroupList"]);
 
        return array_merge($channelGroups, $serverGroups);
    }

    public function iconDownload()
    {
        $iconid = $this['client_icon_id'];
        if (!is_int($iconid)) {
            $iconid = $iconid->toInt();
        }
 
        if ($this->iconIsLocal("client_icon_id") || $iconid == 0) {
            return;
        }
 
        $download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("client_icon_id"));
        $transfer = TeamSpeak3::factory("filetransfer://" . (str_contains($download["host"], ":") ? "[" . $download["host"] . "]" : $download["host"]) . ":" . $download["port"]);
 
        return $transfer->download($download["ftkey"], $download["size"]);
    }

    public function sendPluginCmd(string $plugin, string $data): void
    {
        $this->execute("plugincmd", ["name" => $plugin, "data" => $data, "targetmode" => TeamSpeak3::PLUGINCMD_CLIENT, "target" => $this->getId()]);
    }

    protected function fetchNodeInfo()
    {
        if ($this->offsetExists("client_type") && $this["client_type"] == 1) {
            return;
        }
 
        $this->nodeInfo = array_merge($this->nodeInfo, $this->execute("clientinfo", ["clid" => $this->getId()])->toList());
    }

    public function getUniqueId(): string
    {
        return $this->getParent()->getUniqueId() . "_cl" . $this->getId();
    }

    public function getIcon(): string
    {
        if ($this["client_type"]) {
            return "client_query";
        } elseif ($this["client_away"]) {
            return "client_away";
        } elseif (!$this["client_output_hardware"]) {
            return "client_snd_disabled";
        } elseif ($this["client_output_muted"]) {
            return "client_snd_muted";
        } elseif (!$this["client_input_hardware"]) {
            return "client_mic_disabled";
        } elseif ($this["client_input_muted"]) {
            return "client_mic_muted";
        } elseif ($this["client_is_channel_commander"]) {
            return $this["client_flag_talking"] ? "client_cc_talk" : "client_cc_idle";
        } else {
            return $this["client_flag_talking"] ? "client_talk" : "client_idle";
        }
    }

    public function getSymbol(): string
    {
        return "@";
    }

    public function __toString()
    {
        return (string)$this["client_nickname"];
    }
}