Channel.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 Channel extends Node
{
    private array|null $clientList = null;
    private array $channelList = [];

    public function __construct(Server $server, array $info, string $index = "cid")
    {
        $this->parent = $server;
        $this->nodeInfo = $info;
 
        if (!array_key_exists($index, $this->nodeInfo)) {
            throw new ServerQueryException("invalid channelID", 0x300);
        }
 
        $this->nodeId = $this->nodeInfo[$index];
    }

    public function subChannelList(array $filter = []): array
    {
        $channels = [];
 
        foreach ($this->getParent()->channelList() as $channel) {
            if ($channel["pid"] == $this->getId()) {
                $channels[$channel->getId()] = $channel;
            }
        }
 
        return $this->filterList($channels, $filter);
    }

    public function subChannelGetById(int $cid): Channel
    {
        if (!array_key_exists($cid, $this->subChannelList())) {
            throw new ServerQueryException("invalid channelID", 0x300);
        }
 
        return $this->channelList[$cid];
    }

    public function subChannelGetByName(int $name): Channel
    {
        foreach ($this->subChannelList() as $channel) {
            if ($channel["channel_name"] == $name) {
                return $channel;
            }
        }
 
        throw new ServerQueryException("invalid channelID", 0x300);
    }

    public function clientList(array $filter = []): array
    {
        $clients = [];
 
        foreach ($this->getParent()->clientList() as $client) {
            if ($client["cid"] == $this->getId()) {
                $clients[$client->getId()] = $client;
            }
        }
 
        return $this->filterList($clients, $filter);
    }

    public function clientGetById(int $clid): Client
    {
        if (!array_key_exists($clid, $this->clientList())) {
            throw new ServerQueryException("invalid clientID", 0x200);
        }
 
        return $this->clientList[$clid];
    }

    public function clientGetByName(int $name): Client
    {
        foreach ($this->clientList() as $client) {
            if ($client["client_nickname"] == $name) {
                return $client;
            }
        }
 
        throw new ServerQueryException("invalid clientID", 0x200);
    }

    public function clientPermList(int $cldbid, bool $permsid = false): array
    {
        return $this->getParent()->channelClientPermList($this->getId(), $cldbid, $permsid);
    }

    public function clientPermAssign(int $cldbid, int|array $permid, int|array $permvalue): void
    {
        $this->getParent()->channelClientPermAssign($this->getId(), $cldbid, $permid, $permvalue);
    }

    public function clientPermAssignByName($cldbid, $permname, $permvalue)
    {
        $this->clientPermAssign($cldbid, $permname, $permvalue);
    }

    public function clientPermRemove(int $cldbid, int|array $permid): void
    {
        $this->getParent()->channelClientPermRemove($this->getId(), $cldbid, $permid);
    }

    public function clientPermRemoveByName($cldbid, $permname)
    {
        $this->clientPermRemove($cldbid, $permname);
    }

    public function permList(bool $permsid = false): array
    {
        return $this->getParent()->channelPermList($this->getId(), $permsid);
    }

    public function permAssign(int|array $permid, int|array $permvalue): void
    {
        $this->getParent()->channelPermAssign($this->getId(), $permid, $permvalue);
    }

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

    public function permRemove(int|array $permid): void
    {
        $this->getParent()->channelPermRemove($this->getId(), $permid);
    }

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

    public function fileList(string $cpw = "", string $path = "/", bool $recursive = false): array
    {
        return $this->getParent()->channelFileList($this->getId(), $cpw, $path, $recursive);
    }

    public function fileInfo(string $cpw = "", string $name = "/"): array
    {
        return $this->getParent()->channelFileInfo($this->getId(), $cpw, $name);
    }

    public function fileRename(string $cpw = "", string $oldname = "/", string $newname = "/", int $tcid = null, string $tcpw = null): void
    {
        $this->getParent()->channelFileRename($this->getId(), $cpw, $oldname, $newname, $tcid, $tcpw);
    }

    public function fileDelete(string $cpw = "", string $name = "/"): void
    {
        $this->getParent()->channelFileDelete($this->getId(), $cpw, $name);
    }

    public function dirCreate(string $cpw = "", string $dirname = "/"): void
    {
        $this->getParent()->channelDirCreate($this->getId(), $cpw, $dirname);
    }

    public function getLevel(): int
    {
        return $this->getParent()->channelGetLevel($this->getId());
    }

    public function getPathway(): string
    {
        return $this->getParent()->channelGetPathway($this->getId());
    }

    public function spacerGetType(): int
    {
        return $this->getParent()->channelSpacerGetType($this->getId());
    }

    public function spacerGetAlign(): int
    {
        return $this->getParent()->channelSpacerGetAlign($this->getId());
    }

    public function isSpacer(): bool
    {
        return $this->getParent()->channelIsSpacer($this);
    }

    public function iconDownload()
    {
        $iconid = $this['channel_icon_id'];
        if (!is_int($iconid)) {
            $iconid = $iconid->toInt();
        }
 
        if ($this->iconIsLocal("channel_icon_id") || $iconid == 0) {
            return;
        }
 
        $download = $this->getParent()->transferInitDownload(rand(0x0000, 0xFFFF), 0, $this->iconGetName("channel_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 modify(array $properties): void
    {
        $properties["cid"] = $this->getId();
 
        $this->execute("channeledit", $properties);
        $this->resetNodeInfo();
    }

    public function message(string $msg, string $cpw = null): void
    {
        if ($this->getId() != $this->getParent()->whoamiGet("client_channel_id")) {
            $this->getParent()->clientMove($this->getParent()->whoamiGet("client_id"), $this->getId(), $cpw);
        }
 
        $this->execute("sendtextmessage", ["msg" => $msg, "target" => $this->getId(), "targetmode" => TeamSpeak3::TEXTMSG_CHANNEL]);
    }

    public function delete(bool $force = false): void
    {
        $this->getParent()->channelDelete($this->getId(), $force);
    }

    public function move(int $pid, int $order = null): void
    {
        $this->getParent()->channelMove($this->getId(), $pid, $order);
    }

    public function sendPluginCmd(string $plugin, string $data, string $cpw = null, bool $subscribed = false): void
    {
        if ($this->getId() != $this->getParent()->whoamiGet("client_channel_id")) {
            $this->getParent()->clientMove($this->getParent()->whoamiGet("client_id"), $this->getId(), $cpw);
        }
 
        $this->execute("plugincmd", ["name" => $plugin, "data" => $data, "targetmode" => $subscribed ? TeamSpeak3::PLUGINCMD_CHANNEL_SUBSCRIBED : TeamSpeak3::PLUGINCMD_CHANNEL]);
    }

    protected function fetchNodeList()
    {
        $this->nodeList = [];
 
        if ($this->getParent()->getLoadClientlistFirst()) {
            foreach ($this->clientList() as $client) {
                if ($client["cid"] == $this->getId()) {
                    $this->nodeList[] = $client;
                }
            }
 
            foreach ($this->subChannelList() as $channel) {
                if ($channel["pid"] == $this->getId()) {
                    $this->nodeList[] = $channel;
                }
            }
        } else {
            foreach ($this->subChannelList() as $channel) {
                if ($channel["pid"] == $this->getId()) {
                    $this->nodeList[] = $channel;
                }
            }
 
            foreach ($this->clientList() as $client) {
                if ($client["cid"] == $this->getId()) {
                    $this->nodeList[] = $client;
                }
            }
        }
    }

    protected function fetchNodeInfo()
    {
        $this->nodeInfo = array_merge($this->nodeInfo, $this->execute("channelinfo", ["cid" => $this->getId()])->toList());
    }

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

    public function getIcon(): string
    {
        if (!$this["channel_maxclients"] || ($this["channel_maxclients"] != -1 && $this["channel_maxclients"] <= $this["total_clients"])) {
            return "channel_full";
        } elseif ($this["channel_flag_password"]) {
            return "channel_pass";
        } else {
            return "channel_open";
        }
    }

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

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